beanie 0.2.0 → 0.2.2

data/docs/VatReturnInput.md

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

data/docs/VatReturnsApi.md

@@ -0,0 +1,117 @@
+# Beanie::VatReturnsApi
+
+All URIs are relative to *https://bean.ie*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_vat_return**](VatReturnsApi.md#add_vat_return) | **POST** /vat_returns | 
+[**find_vat_return_by_id**](VatReturnsApi.md#find_vat_return_by_id) | **GET** /vat_returns/{id} | Find VAT return by ID
+
+
+# **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::VatReturnsApi.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 VatReturnsApi->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::VatReturnsApi.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 VatReturnsApi->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
+
+
+

data/docs/WorkCentre.md

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

data/docs/WorkCentreApi.md

@@ -0,0 +1,175 @@
+# Beanie::WorkCentreApi
+
+All URIs are relative to *https://bean.ie*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_work_centre**](WorkCentreApi.md#add_work_centre) | **POST** /work_centres | 
+[**find_work_centre_by_id**](WorkCentreApi.md#find_work_centre_by_id) | **GET** /work_centres/{id} | Find Work centre by ID
+[**find_work_centres**](WorkCentreApi.md#find_work_centres) | **GET** /work_centres | All work centre
+
+
+# **add_work_centre**
+> WorkCentre add_work_centre(work_centres)
+
+
+
+Creates a new work centre 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::WorkCentreApi.new
+
+work_centres = Beanie::WorkCentreInput.new # WorkCentreInput | Work centre to add to the system
+
+
+begin
+  result = api_instance.add_work_centre(work_centres)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling WorkCentreApi->add_work_centre: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **work_centres** | [**WorkCentreInput**](WorkCentreInput.md)| Work centre to add to the system | 
+
+### Return type
+
+[**WorkCentre**](WorkCentre.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_work_centre_by_id**
+> WorkCentre find_work_centre_by_id(id)
+
+Find Work centre by ID
+
+Returns a single work centre 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::WorkCentreApi.new
+
+id = 789 # Integer | ID of work centre to fetch
+
+
+begin
+  #Find Work centre by ID
+  result = api_instance.find_work_centre_by_id(id)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling WorkCentreApi->find_work_centre_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of work centre to fetch | 
+
+### Return type
+
+[**WorkCentre**](WorkCentre.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_work_centres**
+> Array<WorkCentre> find_work_centres(opts)
+
+All work centre
+
+Returns all work centre 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::WorkCentreApi.new
+
+opts = { 
+  tags: ['tags_example'], # Array<String> | tags to filter by
+  limit: 56 # Integer | Maximum number of results to return
+}
+
+begin
+  #All work centre
+  result = api_instance.find_work_centres(opts)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling WorkCentreApi->find_work_centres: #{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;WorkCentre&gt;**](WorkCentre.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/WorkCentreGroup.md

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

data/docs/WorkCentreGroupApi.md

@@ -0,0 +1,175 @@
+# Beanie::WorkCentreGroupApi
+
+All URIs are relative to *https://bean.ie*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_work_centre_group**](WorkCentreGroupApi.md#add_work_centre_group) | **POST** /work_centre_groups | 
+[**find_work_centre_group_by_id**](WorkCentreGroupApi.md#find_work_centre_group_by_id) | **GET** /work_centre_groups/{id} | Find Work centre group by ID
+[**find_work_centre_groups**](WorkCentreGroupApi.md#find_work_centre_groups) | **GET** /work_centre_groups | All work centre group
+
+
+# **add_work_centre_group**
+> WorkCentreGroup add_work_centre_group(work_centre_groups)
+
+
+
+Creates a new work centre group 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::WorkCentreGroupApi.new
+
+work_centre_groups = Beanie::WorkCentreGroupInput.new # WorkCentreGroupInput | Work centre group to add to the system
+
+
+begin
+  result = api_instance.add_work_centre_group(work_centre_groups)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling WorkCentreGroupApi->add_work_centre_group: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **work_centre_groups** | [**WorkCentreGroupInput**](WorkCentreGroupInput.md)| Work centre group to add to the system | 
+
+### Return type
+
+[**WorkCentreGroup**](WorkCentreGroup.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_work_centre_group_by_id**
+> WorkCentreGroup find_work_centre_group_by_id(id)
+
+Find Work centre group by ID
+
+Returns a single work centre group 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::WorkCentreGroupApi.new
+
+id = 789 # Integer | ID of work centre group to fetch
+
+
+begin
+  #Find Work centre group by ID
+  result = api_instance.find_work_centre_group_by_id(id)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling WorkCentreGroupApi->find_work_centre_group_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of work centre group to fetch | 
+
+### Return type
+
+[**WorkCentreGroup**](WorkCentreGroup.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_work_centre_groups**
+> Array<WorkCentreGroup> find_work_centre_groups(opts)
+
+All work centre group
+
+Returns all work centre group 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::WorkCentreGroupApi.new
+
+opts = { 
+  tags: ['tags_example'], # Array<String> | tags to filter by
+  limit: 56 # Integer | Maximum number of results to return
+}
+
+begin
+  #All work centre group
+  result = api_instance.find_work_centre_groups(opts)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling WorkCentreGroupApi->find_work_centre_groups: #{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;WorkCentreGroup&gt;**](WorkCentreGroup.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+