beanie 0.2.0 → 0.2.2

data/docs/PurchaseOrderInput.md

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

data/docs/PurchaseOrderItem.md

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

data/docs/PurchaseOrderItemInput.md

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

data/docs/PurchaseOrdersApi.md

@@ -0,0 +1,117 @@
+# Beanie::PurchaseOrdersApi
+
+All URIs are relative to *https://bean.ie*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_purchase_order**](PurchaseOrdersApi.md#add_purchase_order) | **POST** /purchase_orders | 
+[**find_purchase_order_by_id**](PurchaseOrdersApi.md#find_purchase_order_by_id) | **GET** /purchase_orders/{id} | Find Purchase order by ID
+
+
+# **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::PurchaseOrdersApi.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 PurchaseOrdersApi->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::PurchaseOrdersApi.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 PurchaseOrdersApi->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
+
+
+

data/docs/ReceivedGoods.md

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

data/docs/ReceivedGoodsApi.md

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

data/docs/ReceivedGoodsInput.md

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

data/docs/SalesInvoice.md

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

data/docs/SalesInvoiceApi.md

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