clicksend_client 1.0.2

data/docs/AccountForgotPasswordVerify.md

@@ -0,0 +1,10 @@
+# ClickSendClient::AccountForgotPasswordVerify
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subaccount_id** | **Integer** | ID of subaccount | 
+**activation_token** | **String** | Activation token | 
+**password** | **String** | Password | 
+
+

data/docs/AccountRechargeApi.md

@@ -0,0 +1,330 @@
+# ClickSendClient::AccountRechargeApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**recharge_credit_card_get**](AccountRechargeApi.md#recharge_credit_card_get) | **GET** /recharge/credit-card | Get Credit Card info
+[**recharge_credit_card_put**](AccountRechargeApi.md#recharge_credit_card_put) | **PUT** /recharge/credit-card | Update credit card info
+[**recharge_packages_get**](AccountRechargeApi.md#recharge_packages_get) | **GET** /recharge/packages | Get list of all packages
+[**recharge_purchase_by_package_id_put**](AccountRechargeApi.md#recharge_purchase_by_package_id_put) | **PUT** /recharge/purchase/{package_id} | Purchase a package
+[**recharge_transactions_by_transaction_id_get**](AccountRechargeApi.md#recharge_transactions_by_transaction_id_get) | **GET** /recharge/transactions/{transaction_id} | Get specific Transaction
+[**recharge_transactions_get**](AccountRechargeApi.md#recharge_transactions_get) | **GET** /recharge/transactions | Purchase a package
+
+
+# **recharge_credit_card_get**
+> String recharge_credit_card_get
+
+Get Credit Card info
+
+Get Credit Card info
+
+### 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::AccountRechargeApi.new
+
+begin
+  #Get Credit Card info
+  result = api_instance.recharge_credit_card_get
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling AccountRechargeApi->recharge_credit_card_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **recharge_credit_card_put**
+> String recharge_credit_card_put(credit_card)
+
+Update credit card info
+
+Update credit card info
+
+### 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::AccountRechargeApi.new
+
+credit_card = ClickSendClient::CreditCard.new # CreditCard | CreditCard model
+
+
+begin
+  #Update credit card info
+  result = api_instance.recharge_credit_card_put(credit_card)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling AccountRechargeApi->recharge_credit_card_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **credit_card** | [**CreditCard**](CreditCard.md)| CreditCard model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **recharge_packages_get**
+> String recharge_packages_get(opts)
+
+Get list of all packages
+
+Get list of all packages
+
+### 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::AccountRechargeApi.new
+
+opts = { 
+  country: 'country_example' # String | Country code
+}
+
+begin
+  #Get list of all packages
+  result = api_instance.recharge_packages_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling AccountRechargeApi->recharge_packages_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **country** | **String**| Country code | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **recharge_purchase_by_package_id_put**
+> String recharge_purchase_by_package_id_put(package_id)
+
+Purchase a package
+
+Purchase a package
+
+### 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::AccountRechargeApi.new
+
+package_id = 56 # Integer | ID of package to purchase
+
+
+begin
+  #Purchase a package
+  result = api_instance.recharge_purchase_by_package_id_put(package_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling AccountRechargeApi->recharge_purchase_by_package_id_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **package_id** | **Integer**| ID of package to purchase | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **recharge_transactions_by_transaction_id_get**
+> String recharge_transactions_by_transaction_id_get(transaction_id)
+
+Get specific Transaction
+
+Get specific Transaction
+
+### 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::AccountRechargeApi.new
+
+transaction_id = 'transaction_id_example' # String | ID of transaction to retrieve
+
+
+begin
+  #Get specific Transaction
+  result = api_instance.recharge_transactions_by_transaction_id_get(transaction_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling AccountRechargeApi->recharge_transactions_by_transaction_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transaction_id** | **String**| ID of transaction to retrieve | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **recharge_transactions_get**
+> String recharge_transactions_get(opts)
+
+Purchase a package
+
+Get all transactions
+
+### 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::AccountRechargeApi.new
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Purchase a package
+  result = api_instance.recharge_transactions_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling AccountRechargeApi->recharge_transactions_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
+
+
+

data/docs/AccountVerify.md

@@ -0,0 +1,10 @@
+# ClickSendClient::AccountVerify
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**country** | **String** | Country code | 
+**user_phone** | **String** | User's phone number | 
+**type** | **String** | Type of verification | 
+
+

data/docs/Address.md

@@ -0,0 +1,14 @@
+# ClickSendClient::Address
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address_name** | **String** | Your address name. | 
+**address_line_1** | **String** | Your address line 1 | 
+**address_city** | **String** | Your city | 
+**address_postal_code** | **String** | Your postal code | 
+**address_country** | **String** | Your country | 
+**address_line_2** | **String** | Your address line 2 | [optional] 
+**address_state** | **String** | Your state | [optional] 
+
+

data/docs/Attachment.md

@@ -0,0 +1,12 @@
+# ClickSendClient::Attachment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **String** | The base64-encoded contents of the file. | 
+**type** | **String** | The type of file being attached. | 
+**filename** | **String** | The name of the file being attached. | 
+**disposition** | **String** | Inline for content that can be displayed within the email, or attachment for any other files. | 
+**content_id** | **String** | An ID for the content. | 
+
+

data/docs/Contact.md

@@ -0,0 +1,23 @@
+# ClickSendClient::Contact
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**phone_number** | **String** | Your phone number in E.164 format. Must be provided if no fax number or email. | 
+**custom_1** | **String** |  | 
+**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/ContactApi.md

@@ -0,0 +1,416 @@
+# ClickSendClient::ContactApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**lists_contacts_by_list_id_and_contact_id_delete**](ContactApi.md#lists_contacts_by_list_id_and_contact_id_delete) | **DELETE** /lists/{list_id}/contacts/{contact_id} | Delete a contact
+[**lists_contacts_by_list_id_and_contact_id_get**](ContactApi.md#lists_contacts_by_list_id_and_contact_id_get) | **GET** /lists/{list_id}/contacts/{contact_id} | Get a specific contact
+[**lists_contacts_by_list_id_and_contact_id_put**](ContactApi.md#lists_contacts_by_list_id_and_contact_id_put) | **PUT** /lists/{list_id}/contacts/{contact_id} | Update specific contact
+[**lists_contacts_by_list_id_get**](ContactApi.md#lists_contacts_by_list_id_get) | **GET** /lists/{list_id}/contacts | Get all contacts in a list
+[**lists_contacts_by_list_id_post**](ContactApi.md#lists_contacts_by_list_id_post) | **POST** /lists/{list_id}/contacts | Create new contact
+[**lists_remove_opted_out_contacts_by_list_id_and_opt_out_list_id_put**](ContactApi.md#lists_remove_opted_out_contacts_by_list_id_and_opt_out_list_id_put) | **PUT** /lists/{list_id}/remove-opted-out-contacts/{opt_out_list_id} | Remove all opted out contacts
+[**lists_transfer_contact_put**](ContactApi.md#lists_transfer_contact_put) | **PUT** /lists/{from_list_id}/contacts/{contact_id}/transfer/{to_list_id} | Transfer contact to another list
+
+
+# **lists_contacts_by_list_id_and_contact_id_delete**
+> String lists_contacts_by_list_id_and_contact_id_delete(list_id, contact_id)
+
+Delete a contact
+
+Delete a contact
+
+### 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::ContactApi.new
+
+list_id = 56 # Integer | List ID
+
+contact_id = 56 # Integer | Contact ID
+
+
+begin
+  #Delete a contact
+  result = api_instance.lists_contacts_by_list_id_and_contact_id_delete(list_id, contact_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling ContactApi->lists_contacts_by_list_id_and_contact_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **list_id** | **Integer**| List ID | 
+ **contact_id** | **Integer**| Contact ID | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **lists_contacts_by_list_id_and_contact_id_get**
+> String lists_contacts_by_list_id_and_contact_id_get(list_id, contact_id)
+
+Get a specific contact
+
+Get a specific contact
+
+### 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::ContactApi.new
+
+list_id = 56 # Integer | Your contact list id you want to access.
+
+contact_id = 56 # Integer | Your contact id you want to access.
+
+
+begin
+  #Get a specific contact
+  result = api_instance.lists_contacts_by_list_id_and_contact_id_get(list_id, contact_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling ContactApi->lists_contacts_by_list_id_and_contact_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **list_id** | **Integer**| Your contact list id you want to access. | 
+ **contact_id** | **Integer**| Your contact id you want to access. | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **lists_contacts_by_list_id_and_contact_id_put**
+> String lists_contacts_by_list_id_and_contact_id_put(list_id, contact_id, contact)
+
+Update specific contact
+
+Update specific contact
+
+### 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::ContactApi.new
+
+list_id = 56 # Integer | Contact list id
+
+contact_id = 56 # Integer | Contact ID
+
+contact = ClickSendClient::Contact.new # Contact | Contact model
+
+
+begin
+  #Update specific contact
+  result = api_instance.lists_contacts_by_list_id_and_contact_id_put(list_id, contact_id, contact)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling ContactApi->lists_contacts_by_list_id_and_contact_id_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **list_id** | **Integer**| Contact list id | 
+ **contact_id** | **Integer**| Contact ID | 
+ **contact** | [**Contact**](Contact.md)| Contact model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **lists_contacts_by_list_id_get**
+> String lists_contacts_by_list_id_get(list_id, opts)
+
+Get all contacts in a list
+
+Get all contacts in a 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::ContactApi.new
+
+list_id = 56 # Integer | Contact list ID
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get all contacts in a list
+  result = api_instance.lists_contacts_by_list_id_get(list_id, opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling ContactApi->lists_contacts_by_list_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **list_id** | **Integer**| Contact list 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
+
+
+
+# **lists_contacts_by_list_id_post**
+> String lists_contacts_by_list_id_post(contact, list_id)
+
+Create new contact
+
+Create new contact
+
+### 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::ContactApi.new
+
+contact = ClickSendClient::Contact.new # Contact | Contact model
+
+list_id = 56 # Integer | List id
+
+
+begin
+  #Create new contact
+  result = api_instance.lists_contacts_by_list_id_post(contact, list_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling ContactApi->lists_contacts_by_list_id_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **contact** | [**Contact**](Contact.md)| Contact model | 
+ **list_id** | **Integer**| List id | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **lists_remove_opted_out_contacts_by_list_id_and_opt_out_list_id_put**
+> String lists_remove_opted_out_contacts_by_list_id_and_opt_out_list_id_put(list_id, opt_out_list_id)
+
+Remove all opted out contacts
+
+Remove all opted out contacts
+
+### 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::ContactApi.new
+
+list_id = 56 # Integer | Your list id
+
+opt_out_list_id = 56 # Integer | Your opt out list id
+
+
+begin
+  #Remove all opted out contacts
+  result = api_instance.lists_remove_opted_out_contacts_by_list_id_and_opt_out_list_id_put(list_id, opt_out_list_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling ContactApi->lists_remove_opted_out_contacts_by_list_id_and_opt_out_list_id_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **list_id** | **Integer**| Your list id | 
+ **opt_out_list_id** | **Integer**| Your opt out list id | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **lists_transfer_contact_put**
+> String lists_transfer_contact_put(from_list_id, contact_id, to_list_id)
+
+Transfer contact to another list
+
+Transfer contact to another 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::ContactApi.new
+
+from_list_id = 56 # Integer | List ID for list that contains contact.
+
+contact_id = 56 # Integer | Contact ID
+
+to_list_id = 56 # Integer | List ID for list you want to transfer contact to.
+
+
+begin
+  #Transfer contact to another list
+  result = api_instance.lists_transfer_contact_put(from_list_id, contact_id, to_list_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling ContactApi->lists_transfer_contact_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **from_list_id** | **Integer**| List ID for list that contains contact. | 
+ **contact_id** | **Integer**| Contact ID | 
+ **to_list_id** | **Integer**| List ID for list you want to transfer contact to. | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+