clicksend_client 1.0.2

data/docs/FAXDeliveryReceiptRulesApi.md

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

@@ -0,0 +1,15 @@
+# ClickSendClient::FaxMessage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source** | **String** | Your method of sending e.g. 'wordpress', 'php', 'c#'. | [optional] [default to 'sdk']
+**to** | **String** | Recipient fax number in E.164 format. | 
+**list_id** | **Integer** | Your list ID if sending to a whole list. Can be used instead of 'to'. | [optional] 
+**from** | **String** | Your sender id. Must be a valid fax number. | [optional] 
+**schedule** | **Integer** | Leave blank for immediate delivery. Your schedule time in unix format http://help.clicksend.com/what-is-a-unix-timestamp | [optional] 
+**custom_string** | **String** | Your reference. Will be passed back with all replies and delivery reports. | [optional] 
+**country** | **String** | Recipient country. | [optional] 
+**from_email** | **String** | An email address where the reply should be emailed to. | [optional] 
+
+

data/docs/FaxMessageCollection.md

@@ -0,0 +1,9 @@
+# ClickSendClient::FaxMessageCollection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages** | [**Array<FaxMessage>**](FaxMessage.md) | Array of FaxMessage items | 
+**file_url** | **String** | URL of file to send | 
+
+

data/docs/Fields.md

@@ -0,0 +1,8 @@
+# ClickSendClient::Fields
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fields** | [**FieldsFields**](FieldsFields.md) |  | [optional] 
+
+

data/docs/FieldsFields.md

@@ -0,0 +1,23 @@
+# ClickSendClient::FieldsFields
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**phone_number** | **String** | Your phone number in E.164 format. Must be provided if no fax number or email. | [optional] 
+**custom_1** | **String** |  | [optional] 
+**email** | **String** | Your email. Must be provided if no phone number or fax number. | [optional] 
+**fax_number** | **String** | Your fax number. Must be provided if no phone number or email. | [optional] 
+**first_name** | **String** | Your first name. | [optional] 
+**address_line_1** | **String** | Your street address | [optional] 
+**address_line_2** | **String** |  | [optional] 
+**address_city** | **String** | Your nearest city | [optional] 
+**address_state** | **String** | Your current state | [optional] 
+**address_postal_code** | **String** | Your current postcode | [optional] 
+**address_country** | **String** | Your current country | [optional] 
+**organization_name** | **String** | Your organisation name | [optional] 
+**custom_2** | **String** |  | [optional] 
+**custom_3** | **String** |  | [optional] 
+**custom_4** | **String** |  | [optional] 
+**last_name** | **String** | Your last name | [optional] 
+
+

data/docs/ForgotPassword.md

@@ -0,0 +1,8 @@
+# ClickSendClient::ForgotPassword
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **String** | Username belonging to account. | 
+
+

data/docs/ForgotUsername.md

@@ -0,0 +1,9 @@
+# ClickSendClient::ForgotUsername
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email belonging to account. | [optional] 
+**phone_number** | **String** | Phone number belonging to account. | [optional] 
+
+

data/docs/InboundFAXRulesApi.md

@@ -0,0 +1,286 @@
+# ClickSendClient::InboundFAXRulesApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**fax_inbound_automation_delete**](InboundFAXRulesApi.md#fax_inbound_automation_delete) | **DELETE** /automations/fax/inbound/{inbound_rule_id} | Delete inbound fax automation
+[**fax_inbound_automation_get**](InboundFAXRulesApi.md#fax_inbound_automation_get) | **GET** /automations/fax/inbound/{inbound_rule_id} | Get specific inbound fax automation
+[**fax_inbound_automation_post**](InboundFAXRulesApi.md#fax_inbound_automation_post) | **POST** /automations/fax/inbound | Create new inbound fax automation
+[**fax_inbound_automation_put**](InboundFAXRulesApi.md#fax_inbound_automation_put) | **PUT** /automations/fax/inbound/{inbound_rule_id} | Update inbound fax automation
+[**fax_inbound_automations_get**](InboundFAXRulesApi.md#fax_inbound_automations_get) | **GET** /automations/fax/inbound | Get all inbound fax automations
+
+
+# **fax_inbound_automation_delete**
+> String fax_inbound_automation_delete(inbound_rule_id)
+
+Delete inbound fax automation
+
+Delete inbound fax 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::InboundFAXRulesApi.new
+
+inbound_rule_id = 56 # Integer | Inbound rule id
+
+
+begin
+  #Delete inbound fax automation
+  result = api_instance.fax_inbound_automation_delete(inbound_rule_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling InboundFAXRulesApi->fax_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
+
+
+
+# **fax_inbound_automation_get**
+> String fax_inbound_automation_get(inbound_rule_id)
+
+Get specific inbound fax automation
+
+Get specific inbound fax 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::InboundFAXRulesApi.new
+
+inbound_rule_id = 56 # Integer | Inbound rule id
+
+
+begin
+  #Get specific inbound fax automation
+  result = api_instance.fax_inbound_automation_get(inbound_rule_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling InboundFAXRulesApi->fax_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
+
+
+
+# **fax_inbound_automation_post**
+> String fax_inbound_automation_post(inbound_fax_rule)
+
+Create new inbound fax automation
+
+Create new inbound fax 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::InboundFAXRulesApi.new
+
+inbound_fax_rule = ClickSendClient::InboundFaxRule.new # InboundFaxRule | Inbound fax rule model
+
+
+begin
+  #Create new inbound fax automation
+  result = api_instance.fax_inbound_automation_post(inbound_fax_rule)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling InboundFAXRulesApi->fax_inbound_automation_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **inbound_fax_rule** | [**InboundFaxRule**](InboundFaxRule.md)| Inbound fax rule model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **fax_inbound_automation_put**
+> String fax_inbound_automation_put(inbound_rule_id, inbound_fax_rule)
+
+Update inbound fax automation
+
+Update inbound fax 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::InboundFAXRulesApi.new
+
+inbound_rule_id = 56 # Integer | Inbound rule id
+
+inbound_fax_rule = ClickSendClient::InboundFaxRule.new # InboundFaxRule | Inbound fax rule model
+
+
+begin
+  #Update inbound fax automation
+  result = api_instance.fax_inbound_automation_put(inbound_rule_id, inbound_fax_rule)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling InboundFAXRulesApi->fax_inbound_automation_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **inbound_rule_id** | **Integer**| Inbound rule id | 
+ **inbound_fax_rule** | [**InboundFaxRule**](InboundFaxRule.md)| Inbound fax rule model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **fax_inbound_automations_get**
+> String fax_inbound_automations_get(opts)
+
+Get all inbound fax automations
+
+Get all inbound fax 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::InboundFAXRulesApi.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 fax automations
+  result = api_instance.fax_inbound_automations_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling InboundFAXRulesApi->fax_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
+
+
+