order_cloud 0.0.6 → 1.0.43

data/docs/ApprovalRule.md

@@ -1,20 +0,0 @@
-# OrderCloud::ApprovalRule
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**name** | **String** |  | [optional] 
-**description** | **String** |  | [optional] 
-**approving_group_id** | **String** |  | [optional] 
-**rule_expression** | **String** |  | [optional] 
-**scope** | **String** |  | [optional] 
-**scope_time_unit** | **String** |  | [optional] 
-**scope_time_number** | **Integer** |  | [optional] 
-**scope_start_date** | **String** |  | [optional] 
-**expire_after_time_unit** | **String** |  | [optional] 
-**expire_after_number** | **Integer** |  | [optional] 
-**approve_on_expire** | **BOOLEAN** |  | [optional] 
-**xp** | **Object** |  | [optional] 
-
-

data/docs/ApprovalRuleApi.md

@@ -1,342 +0,0 @@
-# OrderCloud::ApprovalRuleApi
-
-All URIs are relative to *https://api.ordercloud.io/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ApprovalRuleApi.md#create) | **POST** /buyers/{buyerID}/approvalrules | 
-[**delete**](ApprovalRuleApi.md#delete) | **DELETE** /buyers/{buyerID}/approvalrules/{approvalRuleID} | 
-[**get**](ApprovalRuleApi.md#get) | **GET** /buyers/{buyerID}/approvalrules/{approvalRuleID} | 
-[**list**](ApprovalRuleApi.md#list) | **GET** /buyers/{buyerID}/approvalrules | 
-[**patch**](ApprovalRuleApi.md#patch) | **PATCH** /buyers/{buyerID}/approvalrules/{approvalRuleID} | 
-[**update**](ApprovalRuleApi.md#update) | **PUT** /buyers/{buyerID}/approvalrules/{approvalRuleID} | 
-
-
-# **create**
-> ApprovalRule create(buyer_id, approval_rule)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::ApprovalRuleApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-approval_rule = OrderCloud::ApprovalRule.new # ApprovalRule | 
-
-
-begin
-  result = api_instance.create(buyer_id, approval_rule)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling ApprovalRuleApi->create: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **approval_rule** | [**ApprovalRule**](ApprovalRule.md)|  | 
-
-### Return type
-
-[**ApprovalRule**](ApprovalRule.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **delete**
-> delete(buyer_id, approval_rule_id)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::ApprovalRuleApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-approval_rule_id = "approval_rule_id_example" # String | ID of the approval rule.
-
-
-begin
-  api_instance.delete(buyer_id, approval_rule_id)
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling ApprovalRuleApi->delete: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **approval_rule_id** | **String**| ID of the approval rule. | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **get**
-> ApprovalRule get(buyer_id, approval_rule_id)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::ApprovalRuleApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-approval_rule_id = "approval_rule_id_example" # String | ID of the approval rule.
-
-
-begin
-  result = api_instance.get(buyer_id, approval_rule_id)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling ApprovalRuleApi->get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **approval_rule_id** | **String**| ID of the approval rule. | 
-
-### Return type
-
-[**ApprovalRule**](ApprovalRule.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **list**
-> ListApprovalRule list(buyer_id, opts)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::ApprovalRuleApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-opts = { 
-  search: "search_example", # String | Word or phrase to search for.
-  search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
-  sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
-  page: 56, # Integer | Page of results to return. Default: 1
-  page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
-  filters: {'key' => "filters_example"} # Hash<String, String> | Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'
-}
-
-begin
-  result = api_instance.list(buyer_id, opts)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling ApprovalRuleApi->list: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **search** | **String**| Word or phrase to search for. | [optional] 
- **search_on** | **String**| Comma-delimited list of fields to search on. | [optional] 
- **sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional] 
- **page** | **Integer**| Page of results to return. Default: 1 | [optional] 
- **page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional] 
- **filters** | [**Hash&lt;String, String&gt;**](String.md)| Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or &#39;xp.???&#39; | [optional] 
-
-### Return type
-
-[**ListApprovalRule**](ListApprovalRule.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **patch**
-> ApprovalRule patch(buyer_id, approval_rule_id, partial_approval_rule)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::ApprovalRuleApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-approval_rule_id = "approval_rule_id_example" # String | ID of the approval rule.
-
-partial_approval_rule = OrderCloud::ApprovalRule.new # ApprovalRule | 
-
-
-begin
-  result = api_instance.patch(buyer_id, approval_rule_id, partial_approval_rule)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling ApprovalRuleApi->patch: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **approval_rule_id** | **String**| ID of the approval rule. | 
- **partial_approval_rule** | [**ApprovalRule**](ApprovalRule.md)|  | 
-
-### Return type
-
-[**ApprovalRule**](ApprovalRule.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **update**
-> ApprovalRule update(buyer_id, approval_rule_id, approval_rule)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::ApprovalRuleApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-approval_rule_id = "approval_rule_id_example" # String | ID of the approval rule.
-
-approval_rule = OrderCloud::ApprovalRule.new # ApprovalRule | 
-
-
-begin
-  result = api_instance.update(buyer_id, approval_rule_id, approval_rule)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling ApprovalRuleApi->update: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **approval_rule_id** | **String**| ID of the approval rule. | 
- **approval_rule** | [**ApprovalRule**](ApprovalRule.md)|  | 
-
-### Return type
-
-[**ApprovalRule**](ApprovalRule.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-

data/docs/BaseSpec.md

@@ -1,15 +0,0 @@
-# OrderCloud::BaseSpec
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**list_order** | **Integer** |  | [optional] 
-**name** | **String** |  | [optional] 
-**default_value** | **String** |  | [optional] 
-**required** | **BOOLEAN** |  | [optional] 
-**allow_open_text** | **BOOLEAN** |  | [optional] 
-**default_option_id** | **String** |  | [optional] 
-**xp** | **Object** |  | [optional] 
-
-

data/docs/Buyer.md

@@ -1,11 +0,0 @@
-# OrderCloud::Buyer
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**name** | **String** |  | [optional] 
-**active** | **BOOLEAN** |  | [optional] 
-**xp** | **Object** |  | [optional] 
-
-

data/docs/BuyerAddress.md

@@ -1,11 +0,0 @@
-# OrderCloud::BuyerAddress
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**shipping** | **BOOLEAN** |  | [optional] 
-**billing** | **BOOLEAN** |  | [optional] 
-**editable** | **BOOLEAN** |  | [optional] 
-
-

data/docs/BuyerApi.md

@@ -1,324 +0,0 @@
-# OrderCloud::BuyerApi
-
-All URIs are relative to *https://api.ordercloud.io/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](BuyerApi.md#create) | **POST** /buyers | 
-[**delete**](BuyerApi.md#delete) | **DELETE** /buyers/{buyerID} | 
-[**get**](BuyerApi.md#get) | **GET** /buyers/{buyerID} | 
-[**list**](BuyerApi.md#list) | **GET** /buyers | 
-[**patch**](BuyerApi.md#patch) | **PATCH** /buyers/{buyerID} | 
-[**update**](BuyerApi.md#update) | **PUT** /buyers/{buyerID} | 
-
-
-# **create**
-> Buyer create(company)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::BuyerApi.new
-
-company = OrderCloud::Buyer.new # Buyer | 
-
-
-begin
-  result = api_instance.create(company)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling BuyerApi->create: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **company** | [**Buyer**](Buyer.md)|  | 
-
-### Return type
-
-[**Buyer**](Buyer.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **delete**
-> delete(buyer_id)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::BuyerApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-
-begin
-  api_instance.delete(buyer_id)
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling BuyerApi->delete: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **get**
-> Buyer get(buyer_id)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::BuyerApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-
-begin
-  result = api_instance.get(buyer_id)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling BuyerApi->get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
-
-### Return type
-
-[**Buyer**](Buyer.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **list**
-> ListBuyer list(opts)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::BuyerApi.new
-
-opts = { 
-  search: "search_example", # String | Word or phrase to search for.
-  search_on: "search_on_example", # String | Comma-delimited list of fields to search on.
-  sort_by: "sort_by_example", # String | Comma-delimited list of fields to sort by.
-  page: 56, # Integer | Page of results to return. Default: 1
-  page_size: 56, # Integer | Number of results to return per page. Default: 20, max: 100.
-  filters: {'key' => "filters_example"} # Hash<String, String> | Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'
-}
-
-begin
-  result = api_instance.list(opts)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling BuyerApi->list: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **search** | **String**| Word or phrase to search for. | [optional] 
- **search_on** | **String**| Comma-delimited list of fields to search on. | [optional] 
- **sort_by** | **String**| Comma-delimited list of fields to sort by. | [optional] 
- **page** | **Integer**| Page of results to return. Default: 1 | [optional] 
- **page_size** | **Integer**| Number of results to return per page. Default: 20, max: 100. | [optional] 
- **filters** | [**Hash&lt;String, String&gt;**](String.md)| Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or &#39;xp.???&#39; | [optional] 
-
-### Return type
-
-[**ListBuyer**](ListBuyer.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **patch**
-> Buyer patch(buyer_id, company)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::BuyerApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-company = OrderCloud::Buyer.new # Buyer | 
-
-
-begin
-  result = api_instance.patch(buyer_id, company)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling BuyerApi->patch: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **company** | [**Buyer**](Buyer.md)|  | 
-
-### Return type
-
-[**Buyer**](Buyer.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **update**
-> Buyer update(buyer_id, company)
-
-
-
-### Example
-```ruby
-# load the gem
-require 'order_cloud'
-# setup authorization
-OrderCloud.configure do |config|
-  # Configure OAuth2 access token for authorization: oauth2
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
-
-api_instance = OrderCloud::BuyerApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-company = OrderCloud::Buyer.new # Buyer | 
-
-
-begin
-  result = api_instance.update(buyer_id, company)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling BuyerApi->update: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **company** | [**Buyer**](Buyer.md)|  | 
-
-### Return type
-
-[**Buyer**](Buyer.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-