beanie 0.2.0 → 0.2.2

data/docs/StockItemInput.md

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

data/docs/StockItemsApi.md

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

data/docs/StockLocation.md

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

data/docs/StockLocationApi.md

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

data/docs/StockLocationInput.md

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

data/docs/StockLocationsApi.md

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

data/docs/StockSupplier.md

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