beanie 0.2.0 → 0.2.2

data/docs/VatRecord.md

@@ -0,0 +1,8 @@
+# Beanie::VatRecord
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | 
+
+

data/docs/VatRecordApi.md

@@ -0,0 +1,175 @@
+# Beanie::VatRecordApi
+
+All URIs are relative to *https://bean.ie*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_vat_record**](VatRecordApi.md#add_vat_record) | **POST** /vat_records | 
+[**find_vat_record_by_id**](VatRecordApi.md#find_vat_record_by_id) | **GET** /vat_records/{id} | Find VAT record by ID
+[**find_vat_records**](VatRecordApi.md#find_vat_records) | **GET** /vat_records | All vat record
+
+
+# **add_vat_record**
+> VatRecord add_vat_record(vat_records)
+
+
+
+Creates a new vat record in the system
+
+### Example
+```ruby
+# load the gem
+require 'beanie'
+# setup authorization
+Beanie.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = Beanie::VatRecordApi.new
+
+vat_records = Beanie::VatRecordInput.new # VatRecordInput | VAT record to add to the system
+
+
+begin
+  result = api_instance.add_vat_record(vat_records)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling VatRecordApi->add_vat_record: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vat_records** | [**VatRecordInput**](VatRecordInput.md)| VAT record to add to the system | 
+
+### Return type
+
+[**VatRecord**](VatRecord.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_vat_record_by_id**
+> VatRecord find_vat_record_by_id(id)
+
+Find VAT record by ID
+
+Returns a single vat record if the user has access
+
+### Example
+```ruby
+# load the gem
+require 'beanie'
+# setup authorization
+Beanie.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = Beanie::VatRecordApi.new
+
+id = 789 # Integer | ID of vat record to fetch
+
+
+begin
+  #Find VAT record by ID
+  result = api_instance.find_vat_record_by_id(id)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling VatRecordApi->find_vat_record_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of vat record to fetch | 
+
+### Return type
+
+[**VatRecord**](VatRecord.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_vat_records**
+> Array<VatRecord> find_vat_records(opts)
+
+All vat record
+
+Returns all vat record from the system that the user has access to
+
+### Example
+```ruby
+# load the gem
+require 'beanie'
+# setup authorization
+Beanie.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = Beanie::VatRecordApi.new
+
+opts = { 
+  tags: ['tags_example'], # Array<String> | tags to filter by
+  limit: 56 # Integer | Maximum number of results to return
+}
+
+begin
+  #All vat record
+  result = api_instance.find_vat_records(opts)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling VatRecordApi->find_vat_records: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **tags** | [**Array&lt;String&gt;**](String.md)| tags to filter by | [optional] 
+ **limit** | **Integer**| Maximum number of results to return | [optional] 
+
+### Return type
+
+[**Array&lt;VatRecord&gt;**](VatRecord.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/VatRecordInput.md

@@ -0,0 +1,9 @@
+# Beanie::VatRecordInput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | 
+**name** | **String** |  | 
+
+

data/docs/VatRecordsApi.md

@@ -0,0 +1,117 @@
+# Beanie::VatRecordsApi
+
+All URIs are relative to *https://bean.ie*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_vat_record**](VatRecordsApi.md#add_vat_record) | **POST** /vat_records | 
+[**find_vat_record_by_id**](VatRecordsApi.md#find_vat_record_by_id) | **GET** /vat_records/{id} | Find VAT record by ID
+
+
+# **add_vat_record**
+> VatRecord add_vat_record(vat_records)
+
+
+
+Creates a new vat record in the system
+
+### Example
+```ruby
+# load the gem
+require 'beanie'
+# setup authorization
+Beanie.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = Beanie::VatRecordsApi.new
+
+vat_records = Beanie::VatRecordInput.new # VatRecordInput | VAT record to add to the system
+
+
+begin
+  result = api_instance.add_vat_record(vat_records)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling VatRecordsApi->add_vat_record: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vat_records** | [**VatRecordInput**](VatRecordInput.md)| VAT record to add to the system | 
+
+### Return type
+
+[**VatRecord**](VatRecord.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_vat_record_by_id**
+> VatRecord find_vat_record_by_id(id)
+
+Find VAT record by ID
+
+Returns a single vat record if the user has access
+
+### Example
+```ruby
+# load the gem
+require 'beanie'
+# setup authorization
+Beanie.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = Beanie::VatRecordsApi.new
+
+id = 789 # Integer | ID of vat record to fetch
+
+
+begin
+  #Find VAT record by ID
+  result = api_instance.find_vat_record_by_id(id)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling VatRecordsApi->find_vat_record_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of vat record to fetch | 
+
+### Return type
+
+[**VatRecord**](VatRecord.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/VatReturn.md

@@ -0,0 +1,8 @@
+# Beanie::VatReturn
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | 
+
+

data/docs/VatReturnApi.md

@@ -0,0 +1,175 @@
+# Beanie::VatReturnApi
+
+All URIs are relative to *https://bean.ie*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_vat_return**](VatReturnApi.md#add_vat_return) | **POST** /vat_returns | 
+[**find_vat_return_by_id**](VatReturnApi.md#find_vat_return_by_id) | **GET** /vat_returns/{id} | Find VAT return by ID
+[**find_vat_returns**](VatReturnApi.md#find_vat_returns) | **GET** /vat_returns | All vat return
+
+
+# **add_vat_return**
+> VatReturn add_vat_return(vat_returns)
+
+
+
+Creates a new vat return in the system
+
+### Example
+```ruby
+# load the gem
+require 'beanie'
+# setup authorization
+Beanie.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = Beanie::VatReturnApi.new
+
+vat_returns = Beanie::VatReturnInput.new # VatReturnInput | VAT return to add to the system
+
+
+begin
+  result = api_instance.add_vat_return(vat_returns)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling VatReturnApi->add_vat_return: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vat_returns** | [**VatReturnInput**](VatReturnInput.md)| VAT return to add to the system | 
+
+### Return type
+
+[**VatReturn**](VatReturn.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_vat_return_by_id**
+> VatReturn find_vat_return_by_id(id)
+
+Find VAT return by ID
+
+Returns a single vat return if the user has access
+
+### Example
+```ruby
+# load the gem
+require 'beanie'
+# setup authorization
+Beanie.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = Beanie::VatReturnApi.new
+
+id = 789 # Integer | ID of vat return to fetch
+
+
+begin
+  #Find VAT return by ID
+  result = api_instance.find_vat_return_by_id(id)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling VatReturnApi->find_vat_return_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of vat return to fetch | 
+
+### Return type
+
+[**VatReturn**](VatReturn.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_vat_returns**
+> Array<VatReturn> find_vat_returns(opts)
+
+All vat return
+
+Returns all vat return from the system that the user has access to
+
+### Example
+```ruby
+# load the gem
+require 'beanie'
+# setup authorization
+Beanie.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['ApiKey'] = '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['ApiKey'] = 'Bearer'
+end
+
+api_instance = Beanie::VatReturnApi.new
+
+opts = { 
+  tags: ['tags_example'], # Array<String> | tags to filter by
+  limit: 56 # Integer | Maximum number of results to return
+}
+
+begin
+  #All vat return
+  result = api_instance.find_vat_returns(opts)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling VatReturnApi->find_vat_returns: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **tags** | [**Array&lt;String&gt;**](String.md)| tags to filter by | [optional] 
+ **limit** | **Integer**| Maximum number of results to return | [optional] 
+
+### Return type
+
+[**Array&lt;VatReturn&gt;**](VatReturn.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+