clicksend_client 1.0.2

data/docs/PostPostcard.md

@@ -0,0 +1,9 @@
+# ClickSendClient::PostPostcard
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file_urls** | **Array<String>** | Postcard file URLs | 
+**recipients** | [**Array<PostRecipient>**](PostRecipient.md) | Array of recipients | 
+
+

data/docs/PostPostcardApi.md

@@ -0,0 +1,227 @@
+# ClickSendClient::PostPostcardApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**post_postcards_history_export_get**](PostPostcardApi.md#post_postcards_history_export_get) | **GET** /post/postcards/history/export | Export postcard history to a CSV file
+[**post_postcards_history_get**](PostPostcardApi.md#post_postcards_history_get) | **GET** /post/postcards/history | Retrieve the history of postcards sent or scheduled
+[**post_postcards_price_post**](PostPostcardApi.md#post_postcards_price_post) | **POST** /post/postcards/price | Calculate price for sending one or more postcards
+[**post_postcards_send_post**](PostPostcardApi.md#post_postcards_send_post) | **POST** /post/postcards/send | Send one or more postcards
+
+
+# **post_postcards_history_export_get**
+> String post_postcards_history_export_get(filename)
+
+Export postcard history to a CSV file
+
+Export postcard history to a CSV 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::PostPostcardApi.new
+
+filename = 'filename_example' # String | Filename to export to
+
+
+begin
+  #Export postcard history to a CSV file
+  result = api_instance.post_postcards_history_export_get(filename)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling PostPostcardApi->post_postcards_history_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_postcards_history_get**
+> String post_postcards_history_get(opts)
+
+Retrieve the history of postcards sent or scheduled
+
+Retrieve the history of postcards sent or scheduled
+
+### 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::PostPostcardApi.new
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Retrieve the history of postcards sent or scheduled
+  result = api_instance.post_postcards_history_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling PostPostcardApi->post_postcards_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_postcards_price_post**
+> String post_postcards_price_post(post_postcards)
+
+Calculate price for sending one or more postcards
+
+Calculate price for sending one or more postcards
+
+### 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::PostPostcardApi.new
+
+post_postcards = ClickSendClient::PostPostcard.new # PostPostcard | PostPostcard model
+
+
+begin
+  #Calculate price for sending one or more postcards
+  result = api_instance.post_postcards_price_post(post_postcards)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling PostPostcardApi->post_postcards_price_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **post_postcards** | [**PostPostcard**](PostPostcard.md)| PostPostcard model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_postcards_send_post**
+> String post_postcards_send_post(post_postcards)
+
+Send one or more postcards
+
+Send one or more postcards
+
+### 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::PostPostcardApi.new
+
+post_postcards = ClickSendClient::PostPostcard.new # PostPostcard | PostPostcard model
+
+
+begin
+  #Send one or more postcards
+  result = api_instance.post_postcards_send_post(post_postcards)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling PostPostcardApi->post_postcards_send_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **post_postcards** | [**PostPostcard**](PostPostcard.md)| PostPostcard model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/PostRecipient.md

@@ -0,0 +1,16 @@
+# ClickSendClient::PostRecipient
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address_name** | **String** | Name of address | 
+**address_line_1** | **String** | First line of address | 
+**address_line_2** | **String** | Second line of address | [optional] 
+**address_city** | **String** | City | 
+**address_state** | **String** | State | 
+**address_postal_code** | **String** | Postal code | 
+**address_country** | **String** | Country | 
+**return_address_id** | **Integer** | ID of return address to use | 
+**schedule** | **Integer** | When to send letter (0/null=now) | [optional] [default to 0]
+
+

data/docs/PostReturnAddressApi.md

@@ -0,0 +1,284 @@
+# ClickSendClient::PostReturnAddressApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**post_return_addresses_by_return_address_id_delete**](PostReturnAddressApi.md#post_return_addresses_by_return_address_id_delete) | **DELETE** /post/return-addresses/{return_address_id} | Delete specific post return address
+[**post_return_addresses_by_return_address_id_get**](PostReturnAddressApi.md#post_return_addresses_by_return_address_id_get) | **GET** /post/return-addresses/{return_address_id} | Get specific post return address
+[**post_return_addresses_by_return_address_id_put**](PostReturnAddressApi.md#post_return_addresses_by_return_address_id_put) | **PUT** /post/return-addresses/{return_address_id} | Update post return address
+[**post_return_addresses_get**](PostReturnAddressApi.md#post_return_addresses_get) | **GET** /post/return-addresses | Get list of post return addresses
+[**post_return_addresses_post**](PostReturnAddressApi.md#post_return_addresses_post) | **POST** /post/return-addresses | Create post return address
+
+
+# **post_return_addresses_by_return_address_id_delete**
+> String post_return_addresses_by_return_address_id_delete(return_address_id)
+
+Delete specific post return address
+
+Delete specific post return address
+
+### 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::PostReturnAddressApi.new
+
+return_address_id = 56 # Integer | Return address ID
+
+
+begin
+  #Delete specific post return address
+  result = api_instance.post_return_addresses_by_return_address_id_delete(return_address_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling PostReturnAddressApi->post_return_addresses_by_return_address_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **return_address_id** | **Integer**| Return address ID | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_return_addresses_by_return_address_id_get**
+> String post_return_addresses_by_return_address_id_get(return_address_id)
+
+Get specific post return address
+
+Get specific post return address
+
+### 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::PostReturnAddressApi.new
+
+return_address_id = 56 # Integer | Return address ID
+
+
+begin
+  #Get specific post return address
+  result = api_instance.post_return_addresses_by_return_address_id_get(return_address_id)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling PostReturnAddressApi->post_return_addresses_by_return_address_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **return_address_id** | **Integer**| Return address ID | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_return_addresses_by_return_address_id_put**
+> String post_return_addresses_by_return_address_id_put(return_address_id, return_address)
+
+Update post return address
+
+Update post return address
+
+### 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::PostReturnAddressApi.new
+
+return_address_id = 56 # Integer | Return address ID
+
+return_address = ClickSendClient::Address.new # Address | Address model
+
+
+begin
+  #Update post return address
+  result = api_instance.post_return_addresses_by_return_address_id_put(return_address_id, return_address)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling PostReturnAddressApi->post_return_addresses_by_return_address_id_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **return_address_id** | **Integer**| Return address ID | 
+ **return_address** | [**Address**](Address.md)| Address model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_return_addresses_get**
+> String post_return_addresses_get(opts)
+
+Get list of post return addresses
+
+Get list of post return addresses
+
+### 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::PostReturnAddressApi.new
+
+opts = { 
+  page: 1, # Integer | Page number
+  limit: 10 # Integer | Number of records per page
+}
+
+begin
+  #Get list of post return addresses
+  result = api_instance.post_return_addresses_get(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling PostReturnAddressApi->post_return_addresses_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_return_addresses_post**
+> String post_return_addresses_post(return_address)
+
+Create post return address
+
+Create post return address
+
+### 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::PostReturnAddressApi.new
+
+return_address = ClickSendClient::Address.new # Address | Address model
+
+
+begin
+  #Create post return address
+  result = api_instance.post_return_addresses_post(return_address)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling PostReturnAddressApi->post_return_addresses_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **return_address** | [**Address**](Address.md)| Address model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+