checkbook 1.0.1

data/docs/Subscription.md

@@ -0,0 +1,453 @@
+# Checkbook::Subscription
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_subscription**](Subscription.md#delete_subscription) | **DELETE** /v3/subscription/{subscription_id} | Remove subscription |
+| [**get_subscription**](Subscription.md#get_subscription) | **GET** /v3/subscription/{subscription_id} | Get subscription |
+| [**get_subscriptions**](Subscription.md#get_subscriptions) | **GET** /v3/subscription | Get subscriptions |
+| [**post_subscription_check**](Subscription.md#post_subscription_check) | **POST** /v3/subscription/check | Create payment subscription |
+| [**post_subscription_invoice**](Subscription.md#post_subscription_invoice) | **POST** /v3/subscription/invoice | Create invoice subscription |
+| [**put_subscription**](Subscription.md#put_subscription) | **PUT** /v3/subscription/{subscription_id} | Update subscription |
+
+
+## delete_subscription
+
+> delete_subscription(subscription_id)
+
+Remove subscription
+
+Remove the specified subscription
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Subscription.new
+subscription_id = 'subscription_id_example' # String | 
+
+begin
+  # Remove subscription
+  api_instance.delete_subscription(subscription_id)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Subscription->delete_subscription: #{e}"
+end
+```
+
+#### Using the delete_subscription_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_subscription_with_http_info(subscription_id)
+
+```ruby
+begin
+  # Remove subscription
+  data, status_code, headers = api_instance.delete_subscription_with_http_info(subscription_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Subscription->delete_subscription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscription_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_subscription
+
+> <GetSubscriptionResponse> get_subscription(subscription_id)
+
+Get subscription
+
+Get the specified subscription
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Subscription.new
+subscription_id = 'subscription_id_example' # String | 
+
+begin
+  # Get subscription
+  result = api_instance.get_subscription(subscription_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Subscription->get_subscription: #{e}"
+end
+```
+
+#### Using the get_subscription_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetSubscriptionResponse>, Integer, Hash)> get_subscription_with_http_info(subscription_id)
+
+```ruby
+begin
+  # Get subscription
+  data, status_code, headers = api_instance.get_subscription_with_http_info(subscription_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetSubscriptionResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Subscription->get_subscription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscription_id** | **String** |  |  |
+
+### Return type
+
+[**GetSubscriptionResponse**](GetSubscriptionResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_subscriptions
+
+> <GetSubscriptionsResponse> get_subscriptions(opts)
+
+Get subscriptions
+
+Return the subscriptions
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Subscription.new
+opts = {
+  direction: 'INCOMING', # String | Direction
+  end_date: Date.parse('2013-10-20'), # Date | End date
+  page: 56, # Integer | Page number
+  per_page: 10, # Integer | Items per page
+  q: 'q_example', # String | Query
+  sort: '+NUMBER', # String | Sort
+  start_date: Date.parse('2013-10-20'), # Date | Start date
+  status: 'PAID' # String | Status
+}
+
+begin
+  # Get subscriptions
+  result = api_instance.get_subscriptions(opts)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Subscription->get_subscriptions: #{e}"
+end
+```
+
+#### Using the get_subscriptions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetSubscriptionsResponse>, Integer, Hash)> get_subscriptions_with_http_info(opts)
+
+```ruby
+begin
+  # Get subscriptions
+  data, status_code, headers = api_instance.get_subscriptions_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetSubscriptionsResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Subscription->get_subscriptions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **direction** | **String** | Direction | [optional] |
+| **end_date** | **Date** | End date | [optional] |
+| **page** | **Integer** | Page number | [optional][default to 1] |
+| **per_page** | **Integer** | Items per page | [optional][default to 50] |
+| **q** | **String** | Query | [optional] |
+| **sort** | **String** | Sort | [optional] |
+| **start_date** | **Date** | Start date | [optional] |
+| **status** | **String** | Status | [optional] |
+
+### Return type
+
+[**GetSubscriptionsResponse**](GetSubscriptionsResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## post_subscription_check
+
+> <CreateSubscriptionResponse> post_subscription_check(create_check_subscription_request)
+
+Create payment subscription
+
+Create a new payment subscription
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Subscription.new
+create_check_subscription_request = Checkbook::CreateCheckSubscriptionRequest.new({amount: 3.56, interval: 'WEEKLY', name: 'name_example', recipient: nil}) # CreateCheckSubscriptionRequest | 
+
+begin
+  # Create payment subscription
+  result = api_instance.post_subscription_check(create_check_subscription_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Subscription->post_subscription_check: #{e}"
+end
+```
+
+#### Using the post_subscription_check_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateSubscriptionResponse>, Integer, Hash)> post_subscription_check_with_http_info(create_check_subscription_request)
+
+```ruby
+begin
+  # Create payment subscription
+  data, status_code, headers = api_instance.post_subscription_check_with_http_info(create_check_subscription_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateSubscriptionResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Subscription->post_subscription_check_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_check_subscription_request** | [**CreateCheckSubscriptionRequest**](CreateCheckSubscriptionRequest.md) |  |  |
+
+### Return type
+
+[**CreateSubscriptionResponse**](CreateSubscriptionResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_subscription_invoice
+
+> <CreateSubscriptionResponse> post_subscription_invoice(create_invoice_subscription_request)
+
+Create invoice subscription
+
+Create a new invoice subscription
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Subscription.new
+create_invoice_subscription_request = Checkbook::CreateInvoiceSubscriptionRequest.new({amount: 3.56, description: 'description_example', interval: 'WEEKLY', name: 'name_example', recipient: 'recipient_example'}) # CreateInvoiceSubscriptionRequest | 
+
+begin
+  # Create invoice subscription
+  result = api_instance.post_subscription_invoice(create_invoice_subscription_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Subscription->post_subscription_invoice: #{e}"
+end
+```
+
+#### Using the post_subscription_invoice_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateSubscriptionResponse>, Integer, Hash)> post_subscription_invoice_with_http_info(create_invoice_subscription_request)
+
+```ruby
+begin
+  # Create invoice subscription
+  data, status_code, headers = api_instance.post_subscription_invoice_with_http_info(create_invoice_subscription_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateSubscriptionResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Subscription->post_subscription_invoice_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_invoice_subscription_request** | [**CreateInvoiceSubscriptionRequest**](CreateInvoiceSubscriptionRequest.md) |  |  |
+
+### Return type
+
+[**CreateSubscriptionResponse**](CreateSubscriptionResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## put_subscription
+
+> put_subscription(subscription_id, update_subscription_request)
+
+Update subscription
+
+Update the specified subscription
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Subscription.new
+subscription_id = 'subscription_id_example' # String | 
+update_subscription_request = Checkbook::UpdateSubscriptionRequest.new # UpdateSubscriptionRequest | 
+
+begin
+  # Update subscription
+  api_instance.put_subscription(subscription_id, update_subscription_request)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Subscription->put_subscription: #{e}"
+end
+```
+
+#### Using the put_subscription_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> put_subscription_with_http_info(subscription_id, update_subscription_request)
+
+```ruby
+begin
+  # Update subscription
+  data, status_code, headers = api_instance.put_subscription_with_http_info(subscription_id, update_subscription_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Subscription->put_subscription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscription_id** | **String** |  |  |
+| **update_subscription_request** | [**UpdateSubscriptionRequest**](UpdateSubscriptionRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+