beanie 0.2.0 → 0.2.2

data/docs/DeliveryNote.md

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

data/docs/DeliveryNoteApi.md

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

data/docs/DeliveryNoteInput.md

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

data/docs/DeliveryNoteItem.md

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

data/docs/DeliveryNoteItemInput.md

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

data/docs/DeliveryNotesApi.md

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

data/docs/Document.md

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

data/docs/DocumentApi.md

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