beanie 0.2.0 → 0.2.2

data/docs/DocumentInput.md

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

data/docs/DocumentsApi.md

@@ -0,0 +1,117 @@
+# Beanie::DocumentsApi
+
+All URIs are relative to *https://bean.ie*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_document**](DocumentsApi.md#add_document) | **POST** /documents | 
+[**find_document_by_id**](DocumentsApi.md#find_document_by_id) | **GET** /documents/{id} | Find Document by ID
+
+
+# **add_document**
+> Document add_document(documents)
+
+
+
+Creates a new document 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::DocumentsApi.new
+
+documents = Beanie::DocumentInput.new # DocumentInput | Document to add to the system
+
+
+begin
+  result = api_instance.add_document(documents)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling DocumentsApi->add_document: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **documents** | [**DocumentInput**](DocumentInput.md)| Document to add to the system | 
+
+### Return type
+
+[**Document**](Document.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_document_by_id**
+> Document find_document_by_id(id)
+
+Find Document by ID
+
+Returns a single document 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::DocumentsApi.new
+
+id = 789 # Integer | ID of document to fetch
+
+
+begin
+  #Find Document by ID
+  result = api_instance.find_document_by_id(id)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling DocumentsApi->find_document_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of document to fetch | 
+
+### Return type
+
+[**Document**](Document.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/FixedAsset.md

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

data/docs/FixedAssetApi.md

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

data/docs/FixedAssetInput.md

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

data/docs/FixedAssetsApi.md

@@ -0,0 +1,117 @@
+# Beanie::FixedAssetsApi
+
+All URIs are relative to *https://bean.ie*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_fixed_asset**](FixedAssetsApi.md#add_fixed_asset) | **POST** /fixed_assets | 
+[**find_fixed_asset_by_id**](FixedAssetsApi.md#find_fixed_asset_by_id) | **GET** /fixed_assets/{id} | Find Fixed asset by ID
+
+
+# **add_fixed_asset**
+> FixedAsset add_fixed_asset(fixed_assets)
+
+
+
+Creates a new fixed asset 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::FixedAssetsApi.new
+
+fixed_assets = Beanie::FixedAssetInput.new # FixedAssetInput | Fixed asset to add to the system
+
+
+begin
+  result = api_instance.add_fixed_asset(fixed_assets)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling FixedAssetsApi->add_fixed_asset: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **fixed_assets** | [**FixedAssetInput**](FixedAssetInput.md)| Fixed asset to add to the system | 
+
+### Return type
+
+[**FixedAsset**](FixedAsset.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_fixed_asset_by_id**
+> FixedAsset find_fixed_asset_by_id(id)
+
+Find Fixed asset by ID
+
+Returns a single fixed asset 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::FixedAssetsApi.new
+
+id = 789 # Integer | ID of fixed asset to fetch
+
+
+begin
+  #Find Fixed asset by ID
+  result = api_instance.find_fixed_asset_by_id(id)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling FixedAssetsApi->find_fixed_asset_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| ID of fixed asset to fetch | 
+
+### Return type
+
+[**FixedAsset**](FixedAsset.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Journal.md

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