checkbook 1.0.1

data/docs/Vcc.md

@@ -0,0 +1,448 @@
+# Checkbook::Vcc
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_vcc**](Vcc.md#delete_vcc) | **DELETE** /v3/account/vcc/{vcc_id} | Remove virtual card |
+| [**get_vcc_transaction**](Vcc.md#get_vcc_transaction) | **GET** /v3/account/vcc/{vcc_id}/transaction | Get virtual card transactions |
+| [**get_vcc_transaction_by_id**](Vcc.md#get_vcc_transaction_by_id) | **GET** /v3/account/vcc/{vcc_id}/transaction/{transaction_id} | Get virtual card transaction by ID |
+| [**get_vccs**](Vcc.md#get_vccs) | **GET** /v3/account/vcc | Get virtual cards |
+| [**post_vcc**](Vcc.md#post_vcc) | **POST** /v3/account/vcc | Create virtual card |
+| [**put_vcc**](Vcc.md#put_vcc) | **PUT** /v3/account/vcc/{vcc_id} | Update virtual card |
+
+
+## delete_vcc
+
+> delete_vcc(vcc_id)
+
+Remove virtual card
+
+Remove the specified vcc
+
+### 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::Vcc.new
+vcc_id = 'vcc_id_example' # String | 
+
+begin
+  # Remove virtual card
+  api_instance.delete_vcc(vcc_id)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Vcc->delete_vcc: #{e}"
+end
+```
+
+#### Using the delete_vcc_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_vcc_with_http_info(vcc_id)
+
+```ruby
+begin
+  # Remove virtual card
+  data, status_code, headers = api_instance.delete_vcc_with_http_info(vcc_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Vcc->delete_vcc_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **vcc_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_vcc_transaction
+
+> <VccTransactionsResponse> get_vcc_transaction(vcc_id, opts)
+
+Get virtual card transactions
+
+Get the transactions for the specified VCC
+
+### 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::Vcc.new
+vcc_id = 'vcc_id_example' # String | 
+opts = {
+  beta: true, # Boolean | 
+  end_date: Date.parse('2013-10-20'), # Date | End date
+  page: 1, # Integer | Page number
+  per_page: 10, # Integer | Items per page
+  start_date: Date.parse('2013-10-20') # Date | Start date
+}
+
+begin
+  # Get virtual card transactions
+  result = api_instance.get_vcc_transaction(vcc_id, opts)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Vcc->get_vcc_transaction: #{e}"
+end
+```
+
+#### Using the get_vcc_transaction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VccTransactionsResponse>, Integer, Hash)> get_vcc_transaction_with_http_info(vcc_id, opts)
+
+```ruby
+begin
+  # Get virtual card transactions
+  data, status_code, headers = api_instance.get_vcc_transaction_with_http_info(vcc_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VccTransactionsResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Vcc->get_vcc_transaction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **vcc_id** | **String** |  |  |
+| **beta** | **Boolean** |  | [optional][default to false] |
+| **end_date** | **Date** | End date | [optional] |
+| **page** | **Integer** | Page number | [optional][default to 1] |
+| **per_page** | **Integer** | Items per page | [optional][default to 50] |
+| **start_date** | **Date** | Start date | [optional] |
+
+### Return type
+
+[**VccTransactionsResponse**](VccTransactionsResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_vcc_transaction_by_id
+
+> <VccTransaction> get_vcc_transaction_by_id(vcc_id, transaction_id)
+
+Get virtual card transaction by ID
+
+Get the requested transaction for the specified VCC
+
+### 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::Vcc.new
+vcc_id = 'vcc_id_example' # String | 
+transaction_id = 'transaction_id_example' # String | 
+
+begin
+  # Get virtual card transaction by ID
+  result = api_instance.get_vcc_transaction_by_id(vcc_id, transaction_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Vcc->get_vcc_transaction_by_id: #{e}"
+end
+```
+
+#### Using the get_vcc_transaction_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VccTransaction>, Integer, Hash)> get_vcc_transaction_by_id_with_http_info(vcc_id, transaction_id)
+
+```ruby
+begin
+  # Get virtual card transaction by ID
+  data, status_code, headers = api_instance.get_vcc_transaction_by_id_with_http_info(vcc_id, transaction_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VccTransaction>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Vcc->get_vcc_transaction_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **vcc_id** | **String** |  |  |
+| **transaction_id** | **String** |  |  |
+
+### Return type
+
+[**VccTransaction**](VccTransaction.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_vccs
+
+> <VccQueryResponse> get_vccs
+
+Get virtual cards
+
+Return the virtual cards
+
+### 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::Vcc.new
+
+begin
+  # Get virtual cards
+  result = api_instance.get_vccs
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Vcc->get_vccs: #{e}"
+end
+```
+
+#### Using the get_vccs_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VccQueryResponse>, Integer, Hash)> get_vccs_with_http_info
+
+```ruby
+begin
+  # Get virtual cards
+  data, status_code, headers = api_instance.get_vccs_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VccQueryResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Vcc->get_vccs_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**VccQueryResponse**](VccQueryResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## post_vcc
+
+> <CreateVccResponse> post_vcc(create_vcc_request)
+
+Create virtual card
+
+Add a new vcc
+
+### 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::Vcc.new
+create_vcc_request = Checkbook::CreateVccRequest.new # CreateVccRequest | 
+
+begin
+  # Create virtual card
+  result = api_instance.post_vcc(create_vcc_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Vcc->post_vcc: #{e}"
+end
+```
+
+#### Using the post_vcc_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateVccResponse>, Integer, Hash)> post_vcc_with_http_info(create_vcc_request)
+
+```ruby
+begin
+  # Create virtual card
+  data, status_code, headers = api_instance.post_vcc_with_http_info(create_vcc_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateVccResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Vcc->post_vcc_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_vcc_request** | [**CreateVccRequest**](CreateVccRequest.md) |  |  |
+
+### Return type
+
+[**CreateVccResponse**](CreateVccResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## put_vcc
+
+> put_vcc(vcc_id, update_vcc_request)
+
+Update virtual card
+
+Update the specified vcc
+
+### 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::Vcc.new
+vcc_id = 'vcc_id_example' # String | 
+update_vcc_request = Checkbook::UpdateVccRequest.new # UpdateVccRequest | 
+
+begin
+  # Update virtual card
+  api_instance.put_vcc(vcc_id, update_vcc_request)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Vcc->put_vcc: #{e}"
+end
+```
+
+#### Using the put_vcc_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_vcc_with_http_info(vcc_id, update_vcc_request)
+
+```ruby
+begin
+  # Update virtual card
+  data, status_code, headers = api_instance.put_vcc_with_http_info(vcc_id, update_vcc_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Vcc->put_vcc_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **vcc_id** | **String** |  |  |
+| **update_vcc_request** | [**UpdateVccRequest**](UpdateVccRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+