order_cloud 1.0.45.pre.staging → 1.0.57

data/docs/CreditCardAssignment.md

@@ -0,0 +1,10 @@
+# OrderCloud::CreditCardAssignment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**credit_card_id** | **String** |  | [optional] 
+**user_id** | **String** |  | [optional] 
+**user_group_id** | **String** |  | [optional] 
+
+

data/docs/ImpersonateTokenRequest.md

@@ -0,0 +1,9 @@
+# OrderCloud::ImpersonateTokenRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** |  | [optional] 
+**roles** | **Array<String>** |  | [optional] 
+
+

data/docs/ImpersonationConfig.md

@@ -0,0 +1,16 @@
+# OrderCloud::ImpersonationConfig
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**impersonation_buyer_id** | **String** |  | [optional] 
+**impersonation_group_id** | **String** |  | [optional] 
+**impersonation_user_id** | **String** |  | [optional] 
+**buyer_id** | **String** |  | [optional] 
+**group_id** | **String** |  | [optional] 
+**user_id** | **String** |  | [optional] 
+**security_profile_id** | **String** |  | [optional] 
+**client_id** | **String** |  | [optional] 
+
+

data/docs/ImpersonationConfigApi.md

@@ -0,0 +1,324 @@
+# OrderCloud::ImpersonationConfigApi
+
+All URIs are relative to *https://api.ordercloud.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ImpersonationConfigApi.md#create) | **POST** /impersonationconfig | 
+[**delete**](ImpersonationConfigApi.md#delete) | **DELETE** /impersonationconfig/{impersonationConfigID} | 
+[**get**](ImpersonationConfigApi.md#get) | **GET** /impersonationconfig/{impersonationConfigID} | 
+[**list**](ImpersonationConfigApi.md#list) | **GET** /impersonationconfig | 
+[**patch**](ImpersonationConfigApi.md#patch) | **PATCH** /impersonationconfig/{impersonationConfigID} | 
+[**update**](ImpersonationConfigApi.md#update) | **PUT** /impersonationconfig/{impersonationConfigID} | 
+
+
+# **create**
+> ImpersonationConfig create(impersonation_config)
+
+
+
+### 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::ImpersonationConfigApi.new
+
+impersonation_config = OrderCloud::ImpersonationConfig.new # ImpersonationConfig | 
+
+
+begin
+  result = api_instance.create(impersonation_config)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ImpersonationConfigApi->create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **impersonation_config** | [**ImpersonationConfig**](ImpersonationConfig.md)|  | 
+
+### Return type
+
+[**ImpersonationConfig**](ImpersonationConfig.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **delete**
+> delete(impersonation_config_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::ImpersonationConfigApi.new
+
+impersonation_config_id = "impersonation_config_id_example" # String | ID of the impersonation config.
+
+
+begin
+  api_instance.delete(impersonation_config_id)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ImpersonationConfigApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **impersonation_config_id** | **String**| ID of the impersonation config. | 
+
+### 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**
+> ImpersonationConfig get(impersonation_config_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::ImpersonationConfigApi.new
+
+impersonation_config_id = "impersonation_config_id_example" # String | ID of the impersonation config.
+
+
+begin
+  result = api_instance.get(impersonation_config_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ImpersonationConfigApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **impersonation_config_id** | **String**| ID of the impersonation config. | 
+
+### Return type
+
+[**ImpersonationConfig**](ImpersonationConfig.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list**
+> ListImpersonationConfig 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::ImpersonationConfigApi.new
+
+opts = { 
+  search: "search_example", # String | Search of the impersonation config.
+  search_on: ["search_on_example"], # Array<String> | Search on of the impersonation config.
+  sort_by: ["sort_by_example"], # Array<String> | Sort by of the impersonation config.
+  page: 56, # Integer | Page of the impersonation config.
+  page_size: 56, # Integer | Page size of the impersonation config.
+  filters: {'key' => "filters_example"} # Hash<String, String> | Filters of the impersonation config.
+}
+
+begin
+  result = api_instance.list(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ImpersonationConfigApi->list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **search** | **String**| Search of the impersonation config. | [optional] 
+ **search_on** | [**Array&lt;String&gt;**](String.md)| Search on of the impersonation config. | [optional] 
+ **sort_by** | [**Array&lt;String&gt;**](String.md)| Sort by of the impersonation config. | [optional] 
+ **page** | **Integer**| Page of the impersonation config. | [optional] 
+ **page_size** | **Integer**| Page size of the impersonation config. | [optional] 
+ **filters** | [**Hash&lt;String, String&gt;**](String.md)| Filters of the impersonation config. | [optional] 
+
+### Return type
+
+[**ListImpersonationConfig**](ListImpersonationConfig.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **patch**
+> ImpersonationConfig patch(impersonation_config_id, impersonation_config)
+
+
+
+### 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::ImpersonationConfigApi.new
+
+impersonation_config_id = "impersonation_config_id_example" # String | ID of the impersonation config.
+
+impersonation_config = OrderCloud::ImpersonationConfig.new # ImpersonationConfig | 
+
+
+begin
+  result = api_instance.patch(impersonation_config_id, impersonation_config)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ImpersonationConfigApi->patch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **impersonation_config_id** | **String**| ID of the impersonation config. | 
+ **impersonation_config** | [**ImpersonationConfig**](ImpersonationConfig.md)|  | 
+
+### Return type
+
+[**ImpersonationConfig**](ImpersonationConfig.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **update**
+> ImpersonationConfig update(impersonation_config_id, impersonation_config)
+
+
+
+### 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::ImpersonationConfigApi.new
+
+impersonation_config_id = "impersonation_config_id_example" # String | ID of the impersonation config.
+
+impersonation_config = OrderCloud::ImpersonationConfig.new # ImpersonationConfig | 
+
+
+begin
+  result = api_instance.update(impersonation_config_id, impersonation_config)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling ImpersonationConfigApi->update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **impersonation_config_id** | **String**| ID of the impersonation config. | 
+ **impersonation_config** | [**ImpersonationConfig**](ImpersonationConfig.md)|  | 
+
+### Return type
+
+[**ImpersonationConfig**](ImpersonationConfig.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+

data/docs/Inventory.md

@@ -0,0 +1,13 @@
+# OrderCloud::Inventory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **BOOLEAN** |  | [optional] 
+**notification_point** | **Integer** |  | [optional] 
+**variant_level_tracking** | **BOOLEAN** |  | [optional] 
+**order_can_exceed** | **BOOLEAN** |  | [optional] 
+**quantity_available** | **Integer** |  | [optional] 
+**last_updated** | **String** |  | [optional] 
+
+

data/docs/LineItem.md

@@ -0,0 +1,24 @@
+# OrderCloud::LineItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**product_id** | **String** |  | [optional] 
+**quantity** | **Integer** |  | [optional] 
+**date_added** | **String** |  | [optional] 
+**quantity_shipped** | **Integer** |  | [optional] 
+**unit_price** | **Float** |  | [optional] 
+**line_total** | **Float** |  | [optional] 
+**cost_center** | **String** |  | [optional] 
+**date_needed** | **String** |  | [optional] 
+**shipping_account** | **String** |  | [optional] 
+**shipping_address_id** | **String** |  | [optional] 
+**ship_from_address_id** | **String** |  | [optional] 
+**product** | [**LineItemProduct**](LineItemProduct.md) |  | [optional] 
+**shipping_address** | [**Address**](Address.md) |  | [optional] 
+**ship_from_address** | [**Address**](Address.md) |  | [optional] 
+**specs** | [**Array<LineItemSpec>**](LineItemSpec.md) |  | [optional] 
+**xp** | **Object** |  | [optional] 
+
+

data/docs/LineItemApi.md

@@ -0,0 +1,478 @@
+# OrderCloud::LineItemApi
+
+All URIs are relative to *https://api.ordercloud.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](LineItemApi.md#create) | **POST** /orders/{direction}/{orderID}/lineitems | 
+[**delete**](LineItemApi.md#delete) | **DELETE** /orders/{direction}/{orderID}/lineitems/{lineItemID} | 
+[**get**](LineItemApi.md#get) | **GET** /orders/{direction}/{orderID}/lineitems/{lineItemID} | 
+[**list**](LineItemApi.md#list) | **GET** /orders/{direction}/{orderID}/lineitems | 
+[**patch**](LineItemApi.md#patch) | **PATCH** /orders/{direction}/{orderID}/lineitems/{lineItemID} | 
+[**patch_shipping_address**](LineItemApi.md#patch_shipping_address) | **PATCH** /orders/{direction}/{orderID}/lineitems/{lineItemID}/shipto | 
+[**set_shipping_address**](LineItemApi.md#set_shipping_address) | **PUT** /orders/{direction}/{orderID}/lineitems/{lineItemID}/shipto | 
+[**update**](LineItemApi.md#update) | **PUT** /orders/{direction}/{orderID}/lineitems/{lineItemID} | 
+
+
+# **create**
+> LineItem create(direction, order_id, line_item)
+
+
+
+### 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::LineItemApi.new
+
+direction = "direction_example" # String | Direction of the line item. Possible values: Incoming, Outgoing.
+
+order_id = "order_id_example" # String | ID of the order.
+
+line_item = OrderCloud::LineItem.new # LineItem | 
+
+
+begin
+  result = api_instance.create(direction, order_id, line_item)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling LineItemApi->create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **direction** | **String**| Direction of the line item. Possible values: Incoming, Outgoing. | 
+ **order_id** | **String**| ID of the order. | 
+ **line_item** | [**LineItem**](LineItem.md)|  | 
+
+### Return type
+
+[**LineItem**](LineItem.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **delete**
+> delete(direction, order_id, line_item_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::LineItemApi.new
+
+direction = "direction_example" # String | Direction of the line item. Possible values: Incoming, Outgoing.
+
+order_id = "order_id_example" # String | ID of the order.
+
+line_item_id = "line_item_id_example" # String | ID of the line item.
+
+
+begin
+  api_instance.delete(direction, order_id, line_item_id)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling LineItemApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **direction** | **String**| Direction of the line item. Possible values: Incoming, Outgoing. | 
+ **order_id** | **String**| ID of the order. | 
+ **line_item_id** | **String**| ID of the line item. | 
+
+### 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**
+> LineItem get(direction, order_id, line_item_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::LineItemApi.new
+
+direction = "direction_example" # String | Direction of the line item. Possible values: Incoming, Outgoing.
+
+order_id = "order_id_example" # String | ID of the order.
+
+line_item_id = "line_item_id_example" # String | ID of the line item.
+
+
+begin
+  result = api_instance.get(direction, order_id, line_item_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling LineItemApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **direction** | **String**| Direction of the line item. Possible values: Incoming, Outgoing. | 
+ **order_id** | **String**| ID of the order. | 
+ **line_item_id** | **String**| ID of the line item. | 
+
+### Return type
+
+[**LineItem**](LineItem.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list**
+> ListLineItem list(direction, order_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::LineItemApi.new
+
+direction = "direction_example" # String | Direction of the line item. Possible values: Incoming, Outgoing.
+
+order_id = "order_id_example" # String | ID of the order.
+
+opts = { 
+  search: "search_example", # String | Search of the line item.
+  search_on: ["search_on_example"], # Array<String> | Search on of the line item.
+  sort_by: ["sort_by_example"], # Array<String> | Sort by of the line item.
+  page: 56, # Integer | Page of the line item.
+  page_size: 56, # Integer | Page size of the line item.
+  filters: {'key' => "filters_example"} # Hash<String, String> | Filters of the line item.
+}
+
+begin
+  result = api_instance.list(direction, order_id, opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling LineItemApi->list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **direction** | **String**| Direction of the line item. Possible values: Incoming, Outgoing. | 
+ **order_id** | **String**| ID of the order. | 
+ **search** | **String**| Search of the line item. | [optional] 
+ **search_on** | [**Array&lt;String&gt;**](String.md)| Search on of the line item. | [optional] 
+ **sort_by** | [**Array&lt;String&gt;**](String.md)| Sort by of the line item. | [optional] 
+ **page** | **Integer**| Page of the line item. | [optional] 
+ **page_size** | **Integer**| Page size of the line item. | [optional] 
+ **filters** | [**Hash&lt;String, String&gt;**](String.md)| Filters of the line item. | [optional] 
+
+### Return type
+
+[**ListLineItem**](ListLineItem.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **patch**
+> LineItem patch(direction, order_id, line_item_id, partial_line_item)
+
+
+
+### 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::LineItemApi.new
+
+direction = "direction_example" # String | Direction of the line item. Possible values: Incoming, Outgoing.
+
+order_id = "order_id_example" # String | ID of the order.
+
+line_item_id = "line_item_id_example" # String | ID of the line item.
+
+partial_line_item = OrderCloud::LineItem.new # LineItem | 
+
+
+begin
+  result = api_instance.patch(direction, order_id, line_item_id, partial_line_item)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling LineItemApi->patch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **direction** | **String**| Direction of the line item. Possible values: Incoming, Outgoing. | 
+ **order_id** | **String**| ID of the order. | 
+ **line_item_id** | **String**| ID of the line item. | 
+ **partial_line_item** | [**LineItem**](LineItem.md)|  | 
+
+### Return type
+
+[**LineItem**](LineItem.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **patch_shipping_address**
+> LineItem patch_shipping_address(direction, order_id, line_item_id, partial_address)
+
+
+
+### 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::LineItemApi.new
+
+direction = "direction_example" # String | Direction of the line item. Possible values: Incoming, Outgoing.
+
+order_id = "order_id_example" # String | ID of the order.
+
+line_item_id = "line_item_id_example" # String | ID of the line item.
+
+partial_address = OrderCloud::Address.new # Address | 
+
+
+begin
+  result = api_instance.patch_shipping_address(direction, order_id, line_item_id, partial_address)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling LineItemApi->patch_shipping_address: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **direction** | **String**| Direction of the line item. Possible values: Incoming, Outgoing. | 
+ **order_id** | **String**| ID of the order. | 
+ **line_item_id** | **String**| ID of the line item. | 
+ **partial_address** | [**Address**](Address.md)|  | 
+
+### Return type
+
+[**LineItem**](LineItem.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **set_shipping_address**
+> LineItem set_shipping_address(direction, order_id, line_item_id, address)
+
+
+
+### 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::LineItemApi.new
+
+direction = "direction_example" # String | Direction of the line item. Possible values: Incoming, Outgoing.
+
+order_id = "order_id_example" # String | ID of the order.
+
+line_item_id = "line_item_id_example" # String | ID of the line item.
+
+address = OrderCloud::Address.new # Address | 
+
+
+begin
+  result = api_instance.set_shipping_address(direction, order_id, line_item_id, address)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling LineItemApi->set_shipping_address: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **direction** | **String**| Direction of the line item. Possible values: Incoming, Outgoing. | 
+ **order_id** | **String**| ID of the order. | 
+ **line_item_id** | **String**| ID of the line item. | 
+ **address** | [**Address**](Address.md)|  | 
+
+### Return type
+
+[**LineItem**](LineItem.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **update**
+> LineItem update(direction, order_id, line_item_id, line_item)
+
+
+
+### 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::LineItemApi.new
+
+direction = "direction_example" # String | Direction of the line item. Possible values: Incoming, Outgoing.
+
+order_id = "order_id_example" # String | ID of the order.
+
+line_item_id = "line_item_id_example" # String | ID of the line item.
+
+line_item = OrderCloud::LineItem.new # LineItem | 
+
+
+begin
+  result = api_instance.update(direction, order_id, line_item_id, line_item)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling LineItemApi->update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **direction** | **String**| Direction of the line item. Possible values: Incoming, Outgoing. | 
+ **order_id** | **String**| ID of the order. | 
+ **line_item_id** | **String**| ID of the line item. | 
+ **line_item** | [**LineItem**](LineItem.md)|  | 
+
+### Return type
+
+[**LineItem**](LineItem.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+