beanie 0.2.0 → 0.2.2

data/docs/StockSupplierApi.md

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

data/docs/StockSupplierInput.md

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

data/docs/StockSuppliersApi.md

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

data/docs/Supplier.md

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

data/docs/SupplierAddress.md

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

data/docs/SupplierAddressApi.md

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