beanie 0.2.0 → 0.2.2

data/docs/ProductsApi.md

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

data/docs/PurchaseInvoice.md

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

data/docs/PurchaseInvoiceApi.md

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

data/docs/PurchaseInvoiceInput.md

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

data/docs/PurchaseInvoicesApi.md

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

data/docs/PurchaseOrder.md

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

data/docs/PurchaseOrderApi.md

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