order_cloud 1.0.45.pre.staging → 1.0.57

data/docs/ProductAssignment.md

@@ -0,0 +1,11 @@
+# OrderCloud::ProductAssignment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**product_id** | **String** |  | [optional] 
+**buyer_id** | **String** |  | [optional] 
+**user_group_id** | **String** |  | [optional] 
+**price_schedule_id** | **String** |  | [optional] 
+
+

data/docs/ProductBase.md

@@ -0,0 +1,22 @@
+# OrderCloud::ProductBase
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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/ProductCatalogAssignment.md

@@ -0,0 +1,9 @@
+# OrderCloud::ProductCatalogAssignment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**catalog_id** | **String** |  | [optional] 
+**product_id** | **String** |  | [optional] 
+
+

data/docs/Promotion.md

@@ -0,0 +1,21 @@
+# OrderCloud::Promotion
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**code** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**redemption_limit** | **Integer** |  | [optional] 
+**redemption_limit_per_user** | **Integer** |  | [optional] 
+**redemption_count** | **Integer** |  | [optional] 
+**description** | **String** |  | [optional] 
+**fine_print** | **String** |  | [optional] 
+**start_date** | **String** |  | [optional] 
+**expiration_date** | **String** |  | [optional] 
+**eligible_expression** | **String** |  | [optional] 
+**value_expression** | **String** |  | [optional] 
+**can_combine** | **BOOLEAN** |  | [optional] 
+**xp** | **Object** |  | [optional] 
+
+

data/docs/PromotionApi.md

@@ -0,0 +1,494 @@
+# OrderCloud::PromotionApi
+
+All URIs are relative to *https://api.ordercloud.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](PromotionApi.md#create) | **POST** /promotions | 
+[**delete**](PromotionApi.md#delete) | **DELETE** /promotions/{promotionID} | 
+[**delete_assignment**](PromotionApi.md#delete_assignment) | **DELETE** /promotions/{promotionID}/assignments | 
+[**get**](PromotionApi.md#get) | **GET** /promotions/{promotionID} | 
+[**list**](PromotionApi.md#list) | **GET** /promotions | 
+[**list_assignments**](PromotionApi.md#list_assignments) | **GET** /promotions/assignments | 
+[**patch**](PromotionApi.md#patch) | **PATCH** /promotions/{promotionID} | 
+[**save_assignment**](PromotionApi.md#save_assignment) | **POST** /promotions/assignments | 
+[**update**](PromotionApi.md#update) | **PUT** /promotions/{promotionID} | 
+
+
+# **create**
+> Promotion create(promo)
+
+
+
+### 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::PromotionApi.new
+
+promo = OrderCloud::Promotion.new # Promotion | 
+
+
+begin
+  result = api_instance.create(promo)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PromotionApi->create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **promo** | [**Promotion**](Promotion.md)|  | 
+
+### Return type
+
+[**Promotion**](Promotion.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **delete**
+> delete(promotion_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::PromotionApi.new
+
+promotion_id = "promotion_id_example" # String | ID of the promotion.
+
+
+begin
+  api_instance.delete(promotion_id)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PromotionApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **promotion_id** | **String**| ID of the promotion. | 
+
+### 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(promotion_id, 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::PromotionApi.new
+
+promotion_id = "promotion_id_example" # String | ID of the promotion.
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+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(promotion_id, buyer_id, opts)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PromotionApi->delete_assignment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **promotion_id** | **String**| ID of the promotion. | 
+ **buyer_id** | **String**| ID of the buyer. | 
+ **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
+
+
+
+# **get**
+> Promotion get(promotion_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::PromotionApi.new
+
+promotion_id = "promotion_id_example" # String | ID of the promotion.
+
+
+begin
+  result = api_instance.get(promotion_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PromotionApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **promotion_id** | **String**| ID of the promotion. | 
+
+### Return type
+
+[**Promotion**](Promotion.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list**
+> ListPromotion 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::PromotionApi.new
+
+opts = { 
+  search: "search_example", # String | Search of the promotion.
+  search_on: ["search_on_example"], # Array<String> | Search on of the promotion.
+  sort_by: ["sort_by_example"], # Array<String> | Sort by of the promotion.
+  page: 56, # Integer | Page of the promotion.
+  page_size: 56, # Integer | Page size of the promotion.
+  filters: {'key' => "filters_example"} # Hash<String, String> | Filters of the promotion.
+}
+
+begin
+  result = api_instance.list(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PromotionApi->list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **search** | **String**| Search of the promotion. | [optional] 
+ **search_on** | [**Array&lt;String&gt;**](String.md)| Search on of the promotion. | [optional] 
+ **sort_by** | [**Array&lt;String&gt;**](String.md)| Sort by of the promotion. | [optional] 
+ **page** | **Integer**| Page of the promotion. | [optional] 
+ **page_size** | **Integer**| Page size of the promotion. | [optional] 
+ **filters** | [**Hash&lt;String, String&gt;**](String.md)| Filters of the promotion. | [optional] 
+
+### Return type
+
+[**ListPromotion**](ListPromotion.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list_assignments**
+> ListPromotionAssignment 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::PromotionApi.new
+
+opts = { 
+  buyer_id: "buyer_id_example", # String | ID of the buyer.
+  promotion_id: "promotion_id_example", # String | ID of the promotion.
+  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 promotion.
+  page: 56, # Integer | Page of the promotion.
+  page_size: 56 # Integer | Page size of the promotion.
+}
+
+begin
+  result = api_instance.list_assignments(opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PromotionApi->list_assignments: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | [optional] 
+ **promotion_id** | **String**| ID of the promotion. | [optional] 
+ **user_id** | **String**| ID of the user. | [optional] 
+ **user_group_id** | **String**| ID of the user group. | [optional] 
+ **level** | **String**| Level of the promotion. | [optional] 
+ **page** | **Integer**| Page of the promotion. | [optional] 
+ **page_size** | **Integer**| Page size of the promotion. | [optional] 
+
+### Return type
+
+[**ListPromotionAssignment**](ListPromotionAssignment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **patch**
+> Promotion patch(promotion_id, partial_promotion)
+
+
+
+### 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::PromotionApi.new
+
+promotion_id = "promotion_id_example" # String | ID of the promotion.
+
+partial_promotion = OrderCloud::Promotion.new # Promotion | 
+
+
+begin
+  result = api_instance.patch(promotion_id, partial_promotion)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PromotionApi->patch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **promotion_id** | **String**| ID of the promotion. | 
+ **partial_promotion** | [**Promotion**](Promotion.md)|  | 
+
+### Return type
+
+[**Promotion**](Promotion.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::PromotionApi.new
+
+assignment = OrderCloud::PromotionAssignment.new # PromotionAssignment | 
+
+
+begin
+  api_instance.save_assignment(assignment)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PromotionApi->save_assignment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **assignment** | [**PromotionAssignment**](PromotionAssignment.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**
+> Promotion update(promotion_id, promo)
+
+
+
+### 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::PromotionApi.new
+
+promotion_id = "promotion_id_example" # String | ID of the promotion.
+
+promo = OrderCloud::Promotion.new # Promotion | 
+
+
+begin
+  result = api_instance.update(promotion_id, promo)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PromotionApi->update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **promotion_id** | **String**| ID of the promotion. | 
+ **promo** | [**Promotion**](Promotion.md)|  | 
+
+### Return type
+
+[**Promotion**](Promotion.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+