order_cloud 1.0.45.pre.staging → 1.0.57

data/docs/BuyerCreditCard.md

@@ -0,0 +1,16 @@
+# OrderCloud::BuyerCreditCard
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**editable** | **BOOLEAN** |  | [optional] 
+**token** | **String** |  | [optional] 
+**date_created** | **String** |  | [optional] 
+**card_type** | **String** |  | [optional] 
+**partial_account_number** | **String** |  | [optional] 
+**cardholder_name** | **String** |  | [optional] 
+**expiration_date** | **String** |  | [optional] 
+**xp** | **Object** |  | [optional] 
+
+

data/docs/BuyerProduct.md

@@ -0,0 +1,23 @@
+# OrderCloud::BuyerProduct
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**price_schedule** | [**PriceSchedule**](PriceSchedule.md) |  | [optional] 
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**quantity_multiplier** | **Integer** |  | [optional] 
+**ship_weight** | **Float** |  | [optional] 
+**ship_height** | **Float** |  | [optional] 
+**ship_width** | **Float** |  | [optional] 
+**ship_length** | **Float** |  | [optional] 
+**active** | **BOOLEAN** |  | [optional] 
+**spec_count** | **Integer** |  | [optional] 
+**xp** | **Object** |  | [optional] 
+**variant_count** | **Integer** |  | [optional] 
+**ship_from_address_id** | **String** |  | [optional] 
+**inventory** | [**Inventory**](Inventory.md) |  | [optional] 
+**auto_forward_supplier_id** | **String** |  | [optional] 
+
+

data/docs/BuyerShipment.md

@@ -0,0 +1,19 @@
+# OrderCloud::BuyerShipment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**shipper** | **String** |  | [optional] 
+**date_shipped** | **String** |  | [optional] 
+**date_delivered** | **String** |  | [optional] 
+**tracking_number** | **String** |  | [optional] 
+**cost** | **Float** |  | [optional] 
+**xp** | **Object** |  | [optional] 
+**account** | **String** |  | [optional] 
+**from_address_id** | **String** |  | [optional] 
+**to_address_id** | **String** |  | [optional] 
+**from_address** | [**Address**](Address.md) |  | [optional] 
+**to_address** | [**Address**](Address.md) |  | [optional] 
+
+

data/docs/BuyerSpec.md

@@ -0,0 +1,17 @@
+# OrderCloud::BuyerSpec
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**options** | [**Array<SpecOption>**](SpecOption.md) |  | [optional] 
+**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/Catalog.md

@@ -0,0 +1,13 @@
+# OrderCloud::Catalog
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**active** | **BOOLEAN** |  | [optional] 
+**category_count** | **Integer** |  | [optional] 
+**xp** | **Object** |  | [optional] 
+
+

data/docs/CatalogApi.md

@@ -0,0 +1,640 @@
+# OrderCloud::CatalogApi
+
+All URIs are relative to *https://api.ordercloud.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](CatalogApi.md#create) | **POST** /catalogs | 
+[**delete**](CatalogApi.md#delete) | **DELETE** /catalogs/{catalogID} | 
+[**delete_assignment**](CatalogApi.md#delete_assignment) | **DELETE** /catalogs/{catalogID}/assignments | 
+[**delete_product_assignment**](CatalogApi.md#delete_product_assignment) | **DELETE** /catalogs/{catalogID}/productassignments/{productID} | 
+[**get**](CatalogApi.md#get) | **GET** /catalogs/{catalogID} | 
+[**list**](CatalogApi.md#list) | **GET** /catalogs | 
+[**list_assignments**](CatalogApi.md#list_assignments) | **GET** /catalogs/assignments | 
+[**list_product_assignments**](CatalogApi.md#list_product_assignments) | **GET** /catalogs/productassignments | 
+[**patch**](CatalogApi.md#patch) | **PATCH** /catalogs/{catalogID} | 
+[**save_assignment**](CatalogApi.md#save_assignment) | **POST** /catalogs/assignments | 
+[**save_product_assignment**](CatalogApi.md#save_product_assignment) | **POST** /catalogs/productassignments | 
+[**update**](CatalogApi.md#update) | **PUT** /catalogs/{catalogID} | 
+
+
+# **create**
+> Catalog create(catalog)
+
+
+
+### 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::CatalogApi.new
+
+catalog = OrderCloud::Catalog.new # Catalog | 
+
+
+begin
+  result = api_instance.create(catalog)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling CatalogApi->create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **catalog** | [**Catalog**](Catalog.md)|  | 
+
+### Return type
+
+[**Catalog**](Catalog.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **delete**
+> delete(catalog_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::CatalogApi.new
+
+catalog_id = "catalog_id_example" # String | ID of the catalog.
+
+
+begin
+  api_instance.delete(catalog_id)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling CatalogApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **catalog_id** | **String**| ID of the catalog. | 
+
+### 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
+
+
+
+# **delete_assignment**
+> delete_assignment(catalog_id, 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::CatalogApi.new
+
+catalog_id = "catalog_id_example" # String | ID of the catalog.
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+
+begin
+  api_instance.delete_assignment(catalog_id, buyer_id)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling CatalogApi->delete_assignment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **catalog_id** | **String**| ID of the catalog. | 
+ **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
+
+
+
+# **delete_product_assignment**
+> delete_product_assignment(catalog_id, product_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::CatalogApi.new
+
+catalog_id = "catalog_id_example" # String | ID of the catalog.
+
+product_id = "product_id_example" # String | ID of the product.
+
+
+begin
+  api_instance.delete_product_assignment(catalog_id, product_id)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling CatalogApi->delete_product_assignment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **catalog_id** | **String**| ID of the catalog. | 
+ **product_id** | **String**| ID of the product. | 
+
+### 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**
+> Catalog get(catalog_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::CatalogApi.new
+
+catalog_id = "catalog_id_example" # String | ID of the catalog.
+
+
+begin
+  result = api_instance.get(catalog_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling CatalogApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **catalog_id** | **String**| ID of the catalog. | 
+
+### Return type
+
+[**Catalog**](Catalog.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list**
+> ListCatalog 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::CatalogApi.new
+
+opts = { 
+  search: "search_example", # String | Search of the catalog.
+  search_on: ["search_on_example"], # Array<String> | Search on of the catalog.
+  sort_by: ["sort_by_example"], # Array<String> | Sort by of the catalog.
+  page: 56, # Integer | Page of the catalog.
+  page_size: 56, # Integer | Page size of the catalog.
+  filters: {'key' => "filters_example"} # Hash<String, String> | Filters of the catalog.
+}
+
+begin
+  result = api_instance.list(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling CatalogApi->list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **search** | **String**| Search of the catalog. | [optional] 
+ **search_on** | [**Array&lt;String&gt;**](String.md)| Search on of the catalog. | [optional] 
+ **sort_by** | [**Array&lt;String&gt;**](String.md)| Sort by of the catalog. | [optional] 
+ **page** | **Integer**| Page of the catalog. | [optional] 
+ **page_size** | **Integer**| Page size of the catalog. | [optional] 
+ **filters** | [**Hash&lt;String, String&gt;**](String.md)| Filters of the catalog. | [optional] 
+
+### Return type
+
+[**ListCatalog**](ListCatalog.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_assignments**
+> ListCatalogAssignment list_assignments(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::CatalogApi.new
+
+opts = { 
+  catalog_id: "catalog_id_example", # String | ID of the catalog.
+  buyer_id: "buyer_id_example", # String | ID of the buyer.
+  page: 56, # Integer | Page of the catalog.
+  page_size: 56 # Integer | Page size of the catalog.
+}
+
+begin
+  result = api_instance.list_assignments(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling CatalogApi->list_assignments: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **catalog_id** | **String**| ID of the catalog. | [optional] 
+ **buyer_id** | **String**| ID of the buyer. | [optional] 
+ **page** | **Integer**| Page of the catalog. | [optional] 
+ **page_size** | **Integer**| Page size of the catalog. | [optional] 
+
+### Return type
+
+[**ListCatalogAssignment**](ListCatalogAssignment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_product_assignments**
+> ListProductCatalogAssignment list_product_assignments(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::CatalogApi.new
+
+opts = { 
+  catalog_id: "catalog_id_example", # String | ID of the catalog.
+  product_id: "product_id_example", # String | ID of the product.
+  page: 56, # Integer | Page of the catalog.
+  page_size: 56 # Integer | Page size of the catalog.
+}
+
+begin
+  result = api_instance.list_product_assignments(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling CatalogApi->list_product_assignments: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **catalog_id** | **String**| ID of the catalog. | [optional] 
+ **product_id** | **String**| ID of the product. | [optional] 
+ **page** | **Integer**| Page of the catalog. | [optional] 
+ **page_size** | **Integer**| Page size of the catalog. | [optional] 
+
+### Return type
+
+[**ListProductCatalogAssignment**](ListProductCatalogAssignment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **patch**
+> Catalog patch(catalog_id, partial_catalog)
+
+
+
+### 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::CatalogApi.new
+
+catalog_id = "catalog_id_example" # String | ID of the catalog.
+
+partial_catalog = OrderCloud::Catalog.new # Catalog | 
+
+
+begin
+  result = api_instance.patch(catalog_id, partial_catalog)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling CatalogApi->patch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **catalog_id** | **String**| ID of the catalog. | 
+ **partial_catalog** | [**Catalog**](Catalog.md)|  | 
+
+### Return type
+
+[**Catalog**](Catalog.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **save_assignment**
+> save_assignment(assignment)
+
+
+
+### 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::CatalogApi.new
+
+assignment = OrderCloud::CatalogAssignment.new # CatalogAssignment | 
+
+
+begin
+  api_instance.save_assignment(assignment)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling CatalogApi->save_assignment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **assignment** | [**CatalogAssignment**](CatalogAssignment.md)|  | 
+
+### 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
+
+
+
+# **save_product_assignment**
+> save_product_assignment(product_assignment)
+
+
+
+### 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::CatalogApi.new
+
+product_assignment = OrderCloud::ProductCatalogAssignment.new # ProductCatalogAssignment | 
+
+
+begin
+  api_instance.save_product_assignment(product_assignment)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling CatalogApi->save_product_assignment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_assignment** | [**ProductCatalogAssignment**](ProductCatalogAssignment.md)|  | 
+
+### 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
+
+
+
+# **update**
+> Catalog update(catalog_id, catalog)
+
+
+
+### 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::CatalogApi.new
+
+catalog_id = "catalog_id_example" # String | ID of the catalog.
+
+catalog = OrderCloud::Catalog.new # Catalog | 
+
+
+begin
+  result = api_instance.update(catalog_id, catalog)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling CatalogApi->update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **catalog_id** | **String**| ID of the catalog. | 
+ **catalog** | [**Catalog**](Catalog.md)|  | 
+
+### Return type
+
+[**Catalog**](Catalog.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+