clicksend_client 1.0.2

data/docs/CreditCard.md

@@ -0,0 +1,13 @@
+# ClickSendClient::CreditCard
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**number** | **String** | Credit card number | 
+**expiry_month** | **Integer** | Expiry month of credit card | 
+**expiry_year** | **Integer** | Expiry year of credit card | 
+**cvc** | **Integer** | CVC number of credit card | 
+**name** | **String** | Name printed on credit card | 
+**bank_name** | **String** | Name of bank that credit card belongs to | 
+
+

data/docs/DateBefore.md

@@ -0,0 +1,8 @@
+# ClickSendClient::DateBefore
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_before** | **Float** | An optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read. | [optional] 
+
+

data/docs/DeliveryIssue.md

@@ -0,0 +1,12 @@
+# ClickSendClient::DeliveryIssue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message_id** | **String** | The message id of the message. | [optional] 
+**type** | **String** | The type of message, must be one of the following values SMS, MMS, VOICE, EMAIL_MARKETING, EMAIL_TRANSACTIONAL, FAX, POST. | 
+**description** | **String** | The description of the message. | 
+**client_comments** | **String** | The user's comments. | [optional] 
+**email_address** | **String** | The user's email address. | 
+
+

data/docs/DeliveryIssuesApi.md

@@ -0,0 +1,119 @@
+# ClickSendClient::DeliveryIssuesApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delivery_issues_get**](DeliveryIssuesApi.md#delivery_issues_get) | **GET** /delivery-issues | Get all delivery issues
+[**delivery_issues_post**](DeliveryIssuesApi.md#delivery_issues_post) | **POST** /delivery-issues | Create delivery Issue
+
+
+# **delivery_issues_get**
+> String delivery_issues_get(opts)
+
+Get all delivery issues
+
+Get all delivery issues
+
+### 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::DeliveryIssuesApi.new
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get all delivery issues
+  result = api_instance.delivery_issues_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling DeliveryIssuesApi->delivery_issues_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
+
+
+
+# **delivery_issues_post**
+> String delivery_issues_post(delivery_issue)
+
+Create delivery Issue
+
+Create delivery Issue
+
+### 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::DeliveryIssuesApi.new
+
+delivery_issue = ClickSendClient::DeliveryIssue.new # DeliveryIssue | DeliveryIssue model
+
+
+begin
+  #Create delivery Issue
+  result = api_instance.delivery_issues_post(delivery_issue)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling DeliveryIssuesApi->delivery_issues_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **delivery_issue** | [**DeliveryIssue**](DeliveryIssue.md)| DeliveryIssue model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/DeliveryReceiptRule.md

@@ -0,0 +1,12 @@
+# ClickSendClient::DeliveryReceiptRule
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rule_name** | **String** | Rule Name. | 
+**match_type** | **Float** | Match Type. 0=All reports. | 
+**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/DetectAddressApi.md

@@ -0,0 +1,62 @@
+# ClickSendClient::DetectAddressApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**detect_address_post**](DetectAddressApi.md#detect_address_post) | **POST** /post/letters/detect-address | Detects address in uploaded file.
+
+
+# **detect_address_post**
+> String detect_address_post(upload_file)
+
+Detects address in uploaded file.
+
+Detects address in uploaded file.
+
+### 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::DetectAddressApi.new
+
+upload_file = ClickSendClient::UploadFile.new # UploadFile | Your file to be uploaded
+
+
+begin
+  #Detects address in uploaded file.
+  result = api_instance.detect_address_post(upload_file)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling DetectAddressApi->detect_address_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **upload_file** | [**UploadFile**](UploadFile.md)| Your file to be uploaded | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Email.md

@@ -0,0 +1,15 @@
+# ClickSendClient::Email
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**to** | [**Array<EmailRecipient>**](EmailRecipient.md) | Array of To Recipient items. | 
+**cc** | [**Array<EmailRecipient>**](EmailRecipient.md) | Array of Cc Recipient items. | [optional] 
+**bcc** | [**Array<EmailRecipient>**](EmailRecipient.md) | Array of Bcc Recipient items. | [optional] 
+**from** | [**EmailFrom**](EmailFrom.md) |  | 
+**subject** | **String** | Subject of the email. | [optional] 
+**body** | **String** | Body of the email. | 
+**attachments** | [**Array<Attachment>**](Attachment.md) | Array of Attachment items. | [optional] 
+**schedule** | **Float** | Schedule. | [optional] 
+
+

data/docs/EmailAddress.md

@@ -0,0 +1,8 @@
+# ClickSendClient::EmailAddress
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email_address** | **String** | Email to be allowed. | 
+
+

data/docs/EmailCampaign.md

@@ -0,0 +1,15 @@
+# ClickSendClient::EmailCampaign
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Your campaign name. | 
+**subject** | **String** | Your campaign subject. | 
+**body** | **String** | Your campaign message. | 
+**from_email_address_id** | **Float** | The allowed email address id. | 
+**from_name** | **String** | Your name or business name. | 
+**template_id** | **Float** | Your template id. | [optional] 
+**list_id** | **Float** | Your contact list id. | 
+**schedule** | **Integer** | Your schedule timestamp. | [optional] [default to 0]
+
+

data/docs/EmailDeliveryReceiptRulesApi.md

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