beanie 0.2.0 → 0.2.2

data/docs/AddressBlockInput.md

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

data/docs/AddressBlocksApi.md

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

data/docs/BankAccount.md

@@ -3,10 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** |  | 
 **name** | **String** |  | 
 **bank_name** | **String** |  | 
-**currency** | **String** |  | 
+**currency_code** | **String** |  | 
 **swift** | **String** |  | 
 **iban** | **String** |  | 
 **address1** | **String** |  | [optional] 
@@ -15,10 +14,11 @@ Name | Type | Description | Notes
 **city** | **String** |  | [optional] 
 **state_county** | **String** |  | [optional] 
 **zip_postcode** | **String** |  | [optional] 
-**country** | **String** |  | [optional] 
+**country_name** | **String** |  | 
 **contact_name** | **String** |  | [optional] 
 **phone** | **String** |  | [optional] 
 **email** | **String** |  | [optional] 
 **website** | **String** |  | [optional] 
+**id** | **Integer** |  | [optional] 
 
 

data/docs/BankAccountApi.md

@@ -20,6 +20,13 @@ Creates a new bank account in the system
 ```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::BankAccountApi.new
 
@@ -46,7 +53,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -66,6 +73,13 @@ Returns a single bank account if the user has access
 ```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::BankAccountApi.new
 
@@ -93,7 +107,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 
@@ -113,6 +127,13 @@ Returns all bank accounts from the system that the user has access to
 ```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::BankAccountApi.new
 
@@ -143,7 +164,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[api_key](../README.md#api_key)
 
 ### HTTP request headers
 

data/docs/BankAccountInput.md

@@ -3,10 +3,9 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** |  | 
 **name** | **String** |  | 
 **bank_name** | **String** |  | 
-**currency** | **String** |  | 
+**currency_code** | **String** |  | 
 **swift** | **String** |  | 
 **iban** | **String** |  | 
 **address1** | **String** |  | [optional] 
@@ -15,7 +14,7 @@ Name | Type | Description | Notes
 **city** | **String** |  | [optional] 
 **state_county** | **String** |  | [optional] 
 **zip_postcode** | **String** |  | [optional] 
-**country** | **String** |  | [optional] 
+**country_name** | **String** |  | 
 **contact_name** | **String** |  | [optional] 
 **phone** | **String** |  | [optional] 
 **email** | **String** |  | [optional] 

data/docs/BankStatement.md

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

data/docs/BankStatementApi.md

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

data/docs/BankStatementData.md

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

data/docs/BankStatementDataInput.md

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