beanie 0.2.0 → 0.2.2

data/docs/JournalApi.md

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

data/docs/JournalInput.md

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

data/docs/JournalItem.md

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

data/docs/JournalItemInput.md

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

data/docs/JournalsApi.md

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

data/docs/NominalAccount.md

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

data/docs/NominalAccountApi.md

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