order_cloud 0.0.1

data/docs/Product.md

@@ -0,0 +1,22 @@
+# OrderCloud::Product
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**quantity_multiplier** | **Integer** |  | [optional] 
+**ship_weight** | **Float** |  | [optional] 
+**active** | **BOOLEAN** |  | [optional] 
+**type** | **String** |  | [optional] 
+**inventory_enabled** | **BOOLEAN** |  | [optional] 
+**inventory_notification_point** | **Integer** |  | [optional] 
+**variant_level_inventory** | **BOOLEAN** |  | [optional] 
+**spec_count** | **Integer** |  | [optional] 
+**xp** | **Object** |  | [optional] 
+**allow_order_exceed_inventory** | **BOOLEAN** |  | [optional] 
+**inventory_visible** | **BOOLEAN** |  | [optional] 
+**variant_count** | **Integer** |  | [optional] 
+
+

data/docs/ProductApi.md

@@ -0,0 +1,1115 @@
+# OrderCloud::ProductApi
+
+All URIs are relative to *https://api.ordercloud.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ProductApi.md#create) | **POST** /products | 
+[**delete**](ProductApi.md#delete) | **DELETE** /products/{productID} | 
+[**delete_assignment**](ProductApi.md#delete_assignment) | **DELETE** /products/{productID}/assignments/{buyerID} | 
+[**generate_variants**](ProductApi.md#generate_variants) | **POST** /products/{productID}/variants/generate | 
+[**get**](ProductApi.md#get) | **GET** /products/{productID} | 
+[**get_inventory**](ProductApi.md#get_inventory) | **GET** /products/{productID}/inventory | 
+[**get_variant**](ProductApi.md#get_variant) | **GET** /products/{productID}/variants/{variantID} | 
+[**get_variant_inventory**](ProductApi.md#get_variant_inventory) | **GET** /products/{productID}/variants/inventory/{variantID} | 
+[**list**](ProductApi.md#list) | **GET** /products | 
+[**list_assignments**](ProductApi.md#list_assignments) | **GET** /products/assignments | 
+[**list_inventory**](ProductApi.md#list_inventory) | **GET** /products/inventory | 
+[**list_variant_inventory**](ProductApi.md#list_variant_inventory) | **GET** /products/{productID}/variants/inventory | 
+[**list_variants**](ProductApi.md#list_variants) | **GET** /products/{productID}/variants | 
+[**patch**](ProductApi.md#patch) | **PATCH** /products/{productID} | 
+[**patch_variant**](ProductApi.md#patch_variant) | **PATCH** /products/{productID}/variants/{variantID} | 
+[**save_assignment**](ProductApi.md#save_assignment) | **POST** /products/assignments | 
+[**update**](ProductApi.md#update) | **PUT** /products/{productID} | 
+[**update_inventory**](ProductApi.md#update_inventory) | **PUT** /products/{productID}/inventory/{inventory} | 
+[**update_variant**](ProductApi.md#update_variant) | **PUT** /products/{productID}/variants/{variantID} | 
+[**update_variant_inventory**](ProductApi.md#update_variant_inventory) | **PUT** /products/{productID}/variants/inventory/{variantID}/{inventory} | 
+
+
+# **create**
+> Product create(product)
+
+
+
+### 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::ProductApi.new
+
+product = OrderCloud::Product.new # Product | 
+
+
+begin
+  result = api_instance.create(product)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product** | [**Product**](Product.md)|  | 
+
+### Return type
+
+[**Product**](Product.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **delete**
+> delete(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::ProductApi.new
+
+product_id = "product_id_example" # String | ID of the product.
+
+
+begin
+  api_instance.delete(product_id)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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
+
+
+
+# **delete_assignment**
+> delete_assignment(buyer_id, product_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::ProductApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+product_id = "product_id_example" # String | ID of the product.
+
+opts = { 
+  user_id: "user_id_example", # String | ID of the user.
+  user_group_id: "user_group_id_example" # String | ID of the user group.
+}
+
+begin
+  api_instance.delete_assignment(buyer_id, product_id, opts)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->delete_assignment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **product_id** | **String**| ID of the product. | 
+ **user_id** | **String**| ID of the user. | [optional] 
+ **user_group_id** | **String**| ID of the user group. | [optional] 
+
+### 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
+
+
+
+# **generate_variants**
+> Product generate_variants(product_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::ProductApi.new
+
+product_id = "product_id_example" # String | ID of the product.
+
+opts = { 
+  overwrite_existing: true # BOOLEAN | Overwrite existing of the product.
+}
+
+begin
+  result = api_instance.generate_variants(product_id, opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->generate_variants: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| ID of the product. | 
+ **overwrite_existing** | **BOOLEAN**| Overwrite existing of the product. | [optional] 
+
+### Return type
+
+[**Product**](Product.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **get**
+> Product get(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::ProductApi.new
+
+product_id = "product_id_example" # String | ID of the product.
+
+
+begin
+  result = api_instance.get(product_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| ID of the product. | 
+
+### Return type
+
+[**Product**](Product.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **get_inventory**
+> Inventory get_inventory(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::ProductApi.new
+
+product_id = "product_id_example" # String | ID of the product.
+
+
+begin
+  result = api_instance.get_inventory(product_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->get_inventory: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| ID of the product. | 
+
+### Return type
+
+[**Inventory**](Inventory.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **get_variant**
+> Variant get_variant(product_id, variant_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::ProductApi.new
+
+product_id = "product_id_example" # String | ID of the product.
+
+variant_id = "variant_id_example" # String | ID of the variant.
+
+
+begin
+  result = api_instance.get_variant(product_id, variant_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->get_variant: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| ID of the product. | 
+ **variant_id** | **String**| ID of the variant. | 
+
+### Return type
+
+[**Variant**](Variant.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **get_variant_inventory**
+> Inventory get_variant_inventory(product_id, variant_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::ProductApi.new
+
+product_id = "product_id_example" # String | ID of the product.
+
+variant_id = "variant_id_example" # String | ID of the variant.
+
+
+begin
+  result = api_instance.get_variant_inventory(product_id, variant_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->get_variant_inventory: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| ID of the product. | 
+ **variant_id** | **String**| ID of the variant. | 
+
+### Return type
+
+[**Inventory**](Inventory.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list**
+> ListProduct 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::ProductApi.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 ProductApi->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
+
+[**ListProduct**](ListProduct.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_assignments**
+> ListProductAssignment 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::ProductApi.new
+
+opts = { 
+  product_id: "product_id_example", # String | ID of the product.
+  buyer_id: "buyer_id_example", # String | ID of the buyer.
+  user_id: "user_id_example", # String | ID of the user.
+  user_group_id: "user_group_id_example", # String | ID of the user group.
+  level: "level_example", # String | Level of the product.
+  price_schedule_id: "price_schedule_id_example", # String | ID of the price schedule.
+  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.
+}
+
+begin
+  result = api_instance.list_assignments(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->list_assignments: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| ID of the product. | [optional] 
+ **buyer_id** | **String**| ID of the buyer. | [optional] 
+ **user_id** | **String**| ID of the user. | [optional] 
+ **user_group_id** | **String**| ID of the user group. | [optional] 
+ **level** | **String**| Level of the product. | [optional] 
+ **price_schedule_id** | **String**| ID of the price schedule. | [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] 
+
+### Return type
+
+[**ListProductAssignment**](ListProductAssignment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_inventory**
+> ListInventory list_inventory(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::ProductApi.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_inventory(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->list_inventory: #{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
+
+[**ListInventory**](ListInventory.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_variant_inventory**
+> ListInventory list_variant_inventory(product_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::ProductApi.new
+
+product_id = "product_id_example" # String | ID of the product.
+
+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_variant_inventory(product_id, opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->list_variant_inventory: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| ID of the product. | 
+ **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
+
+[**ListInventory**](ListInventory.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_variants**
+> ListVariant list_variants(product_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::ProductApi.new
+
+product_id = "product_id_example" # String | ID of the product.
+
+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_variants(product_id, opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->list_variants: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| ID of the product. | 
+ **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
+
+[**ListVariant**](ListVariant.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **patch**
+> patch(product_id, product)
+
+
+
+### 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::ProductApi.new
+
+product_id = "product_id_example" # String | ID of the product.
+
+product = OrderCloud::Product.new # Product | 
+
+
+begin
+  api_instance.patch(product_id, product)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->patch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| ID of the product. | 
+ **product** | [**Product**](Product.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
+
+
+
+# **patch_variant**
+> Variant patch_variant(product_id, variant_id, variant)
+
+
+
+### 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::ProductApi.new
+
+product_id = "product_id_example" # String | ID of the product.
+
+variant_id = "variant_id_example" # String | ID of the variant.
+
+variant = OrderCloud::Variant.new # Variant | 
+
+
+begin
+  result = api_instance.patch_variant(product_id, variant_id, variant)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->patch_variant: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| ID of the product. | 
+ **variant_id** | **String**| ID of the variant. | 
+ **variant** | [**Variant**](Variant.md)|  | 
+
+### Return type
+
+[**Variant**](Variant.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(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::ProductApi.new
+
+product_assignment = OrderCloud::ProductAssignment.new # ProductAssignment | 
+
+
+begin
+  api_instance.save_assignment(product_assignment)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->save_assignment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_assignment** | [**ProductAssignment**](ProductAssignment.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**
+> Product update(product_id, product)
+
+
+
+### 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::ProductApi.new
+
+product_id = "product_id_example" # String | ID of the product.
+
+product = OrderCloud::Product.new # Product | 
+
+
+begin
+  result = api_instance.update(product_id, product)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| ID of the product. | 
+ **product** | [**Product**](Product.md)|  | 
+
+### Return type
+
+[**Product**](Product.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **update_inventory**
+> Inventory update_inventory(product_id, inventory)
+
+
+
+### 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::ProductApi.new
+
+product_id = "product_id_example" # String | ID of the product.
+
+inventory = 56 # Integer | Inventory of the product.
+
+
+begin
+  result = api_instance.update_inventory(product_id, inventory)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->update_inventory: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| ID of the product. | 
+ **inventory** | **Integer**| Inventory of the product. | 
+
+### Return type
+
+[**Inventory**](Inventory.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **update_variant**
+> Variant update_variant(product_id, variant_id, variant)
+
+
+
+### 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::ProductApi.new
+
+product_id = "product_id_example" # String | ID of the product.
+
+variant_id = "variant_id_example" # String | ID of the variant.
+
+variant = OrderCloud::Variant.new # Variant | 
+
+
+begin
+  result = api_instance.update_variant(product_id, variant_id, variant)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->update_variant: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| ID of the product. | 
+ **variant_id** | **String**| ID of the variant. | 
+ **variant** | [**Variant**](Variant.md)|  | 
+
+### Return type
+
+[**Variant**](Variant.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **update_variant_inventory**
+> Inventory update_variant_inventory(product_id, variant_id, inventory)
+
+
+
+### 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::ProductApi.new
+
+product_id = "product_id_example" # String | ID of the product.
+
+variant_id = "variant_id_example" # String | ID of the variant.
+
+inventory = 56 # Integer | Inventory of the product.
+
+
+begin
+  result = api_instance.update_variant_inventory(product_id, variant_id, inventory)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ProductApi->update_variant_inventory: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **product_id** | **String**| ID of the product. | 
+ **variant_id** | **String**| ID of the variant. | 
+ **inventory** | **Integer**| Inventory of the product. | 
+
+### Return type
+
+[**Inventory**](Inventory.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+