order_cloud 1.0.45.pre.staging → 1.0.57

data/docs/ApprovalRule.md

@@ -0,0 +1,13 @@
+# 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] 
+**xp** | **Object** |  | [optional] 
+
+

data/docs/ApprovalRuleApi.md

@@ -0,0 +1,342 @@
+# 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 | Search of the approval rule.
+  search_on: ["search_on_example"], # Array<String> | Search on of the approval rule.
+  sort_by: ["sort_by_example"], # Array<String> | Sort by of the approval rule.
+  page: 56, # Integer | Page of the approval rule.
+  page_size: 56, # Integer | Page size of the approval rule.
+  filters: {'key' => "filters_example"} # Hash<String, String> | Filters of the approval rule.
+}
+
+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**| Search of the approval rule. | [optional] 
+ **search_on** | [**Array&lt;String&gt;**](String.md)| Search on of the approval rule. | [optional] 
+ **sort_by** | [**Array&lt;String&gt;**](String.md)| Sort by of the approval rule. | [optional] 
+ **page** | **Integer**| Page of the approval rule. | [optional] 
+ **page_size** | **Integer**| Page size of the approval rule. | [optional] 
+ **filters** | [**Hash&lt;String, String&gt;**](String.md)| Filters of the approval rule. | [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

@@ -0,0 +1,16 @@
+# 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] 
+**defines_variant** | **BOOLEAN** |  | [optional] 
+**xp** | **Object** |  | [optional] 
+
+

data/docs/Buyer.md

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

data/docs/BuyerAddress.md

@@ -0,0 +1,23 @@
+# OrderCloud::BuyerAddress
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**shipping** | **BOOLEAN** |  | [optional] 
+**billing** | **BOOLEAN** |  | [optional] 
+**editable** | **BOOLEAN** |  | [optional] 
+**company_name** | **String** |  | [optional] 
+**first_name** | **String** |  | [optional] 
+**last_name** | **String** |  | [optional] 
+**street1** | **String** |  | [optional] 
+**street2** | **String** |  | [optional] 
+**city** | **String** |  | [optional] 
+**state** | **String** |  | [optional] 
+**zip** | **String** |  | [optional] 
+**country** | **String** |  | [optional] 
+**phone** | **String** |  | [optional] 
+**address_name** | **String** |  | [optional] 
+**xp** | **Object** |  | [optional] 
+
+

data/docs/BuyerApi.md

@@ -0,0 +1,324 @@
+# 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 | Search of the buyer.
+  search_on: ["search_on_example"], # Array<String> | Search on of the buyer.
+  sort_by: ["sort_by_example"], # Array<String> | Sort by of the buyer.
+  page: 56, # Integer | Page of the buyer.
+  page_size: 56, # Integer | Page size of the buyer.
+  filters: {'key' => "filters_example"} # Hash<String, String> | Filters of the buyer.
+}
+
+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**| Search of the buyer. | [optional] 
+ **search_on** | [**Array&lt;String&gt;**](String.md)| Search on of the buyer. | [optional] 
+ **sort_by** | [**Array&lt;String&gt;**](String.md)| Sort by of the buyer. | [optional] 
+ **page** | **Integer**| Page of the buyer. | [optional] 
+ **page_size** | **Integer**| Page size of the buyer. | [optional] 
+ **filters** | [**Hash&lt;String, String&gt;**](String.md)| Filters of the buyer. | [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
+
+
+