beanie 0.2.0 → 0.2.2

data/docs/BillablesApi.md

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

data/docs/BomItem.md

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

data/docs/BomItemInput.md

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

data/docs/CompaniesApi.md

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

data/docs/Company.md

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

data/docs/CompanyApi.md

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

data/docs/Customer.md

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

data/docs/CustomerAddress.md

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

data/docs/CustomerAddressApi.md

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