beanie 0.2.0 → 0.2.2

data/docs/SalesInvoiceInput.md

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

data/docs/SalesInvoiceItem.md

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

data/docs/SalesInvoiceItemInput.md

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

data/docs/SalesInvoicesApi.md

@@ -0,0 +1,117 @@
+# Beanie::SalesInvoicesApi
+
+All URIs are relative to *https://bean.ie*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_sales_invoice**](SalesInvoicesApi.md#add_sales_invoice) | **POST** /sales_invoices | 
+[**find_sales_invoice_by_id**](SalesInvoicesApi.md#find_sales_invoice_by_id) | **GET** /sales_invoices/{id} | Find Sales invoice by ID
+
+
+# **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::SalesInvoicesApi.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 SalesInvoicesApi->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::SalesInvoicesApi.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 SalesInvoicesApi->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
+
+
+

data/docs/SalesOrder.md

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

data/docs/SalesOrderApi.md

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

data/docs/SalesOrderInput.md

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

data/docs/SalesOrderItem.md

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

data/docs/SalesOrderItemInput.md

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

data/docs/SalesOrdersApi.md

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