beanie 0.2.0 → 0.2.2

data/docs/CustomerAddressInput.md

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

data/docs/CustomerAddressesApi.md

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

data/docs/CustomerApi.md

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

data/docs/CustomerInput.md

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

data/docs/CustomerLedger.md

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

data/docs/CustomerLedgerInput.md

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

data/docs/CustomerNote.md

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

data/docs/CustomerNoteInput.md

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

data/docs/CustomersApi.md

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