beanie 0.2.0 → 0.2.2

data/docs/ProductApi.md

@@ -0,0 +1,175 @@
+# Beanie::ProductApi
+
+All URIs are relative to *https://bean.ie*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_product**](ProductApi.md#add_product) | **POST** /products | 
+[**find_product_by_id**](ProductApi.md#find_product_by_id) | **GET** /products/{id} | Find Product by ID
+[**find_products**](ProductApi.md#find_products) | **GET** /products | All product
+
+
+# **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::ProductApi.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 ProductApi->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::ProductApi.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 ProductApi->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
+
+
+
+# **find_products**
+> Array<Product> find_products(opts)
+
+All product
+
+Returns all product 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::ProductApi.new
+
+opts = { 
+  tags: ['tags_example'], # Array<String> | tags to filter by
+  limit: 56 # Integer | Maximum number of results to return
+}
+
+begin
+  #All product
+  result = api_instance.find_products(opts)
+  p result
+rescue Beanie::ApiError => e
+  puts "Exception when calling ProductApi->find_products: #{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;Product&gt;**](Product.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/ProductCategoriesApi.md

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

data/docs/ProductCategory.md

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

data/docs/ProductCategoryApi.md

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