order_cloud 0.0.6 → 1.0.43

data/docs/PromotionAssignment.md

@@ -1,11 +0,0 @@
-# OrderCloud::PromotionAssignment
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**promotion_id** | **String** |  | [optional] 
-**buyer_id** | **String** |  | [optional] 
-**user_id** | **String** |  | [optional] 
-**user_group_id** | **String** |  | [optional] 
-
-

data/docs/SecurityProfile.md

@@ -1,11 +0,0 @@
-# OrderCloud::SecurityProfile
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**is_dev_profile** | **BOOLEAN** |  | [optional] 
-**name** | **String** |  | [optional] 
-**roles** | **Array<String>** |  | [optional] 
-
-

data/docs/SecurityProfileApi.md

@@ -1,290 +0,0 @@
-# OrderCloud::SecurityProfileApi
-
-All URIs are relative to *https://api.ordercloud.io/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**delete_assignment**](SecurityProfileApi.md#delete_assignment) | **DELETE** /securityprofiles/{securityProfileID}/assignments | 
-[**get**](SecurityProfileApi.md#get) | **GET** /securityprofiles/{securityProfileID} | 
-[**list**](SecurityProfileApi.md#list) | **GET** /securityprofiles | 
-[**list_assignments**](SecurityProfileApi.md#list_assignments) | **GET** /securityprofiles/assignments | 
-[**save_assignment**](SecurityProfileApi.md#save_assignment) | **POST** /securityprofiles/assignments | 
-
-
-# **delete_assignment**
-> delete_assignment(buyer_id, security_profile_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::SecurityProfileApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-security_profile_id = "security_profile_id_example" # String | ID of the security profile.
-
-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, security_profile_id, opts)
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling SecurityProfileApi->delete_assignment: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **security_profile_id** | **String**| ID of the security profile. | 
- **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**
-> SecurityProfile get(security_profile_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::SecurityProfileApi.new
-
-security_profile_id = "security_profile_id_example" # String | ID of the security profile.
-
-
-begin
-  result = api_instance.get(security_profile_id)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling SecurityProfileApi->get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **security_profile_id** | **String**| ID of the security profile. | 
-
-### Return type
-
-[**SecurityProfile**](SecurityProfile.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **list**
-> ListSecurityProfile 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::SecurityProfileApi.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 SecurityProfileApi->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
-
-[**ListSecurityProfile**](ListSecurityProfile.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **list_assignments**
-> ListSecurityProfileAssignment list_assignments(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::SecurityProfileApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-opts = { 
-  security_profile_id: "security_profile_id_example", # String | ID of the security profile.
-  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 security profile.
-  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(buyer_id, opts)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling SecurityProfileApi->list_assignments: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **security_profile_id** | **String**| ID of the security profile. | [optional] 
- **user_id** | **String**| ID of the user. | [optional] 
- **user_group_id** | **String**| ID of the user group. | [optional] 
- **level** | **String**| Level of the security profile. | [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
-
-[**ListSecurityProfileAssignment**](ListSecurityProfileAssignment.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::SecurityProfileApi.new
-
-assignment = OrderCloud::SecurityProfileAssignment.new # SecurityProfileAssignment | 
-
-
-begin
-  api_instance.save_assignment(assignment)
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling SecurityProfileApi->save_assignment: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **assignment** | [**SecurityProfileAssignment**](SecurityProfileAssignment.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
-
-
-

data/docs/SecurityProfileAssignment.md

@@ -1,11 +0,0 @@
-# OrderCloud::SecurityProfileAssignment
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**security_profile_id** | **String** |  | [optional] 
-**buyer_id** | **String** |  | [optional] 
-**user_id** | **String** |  | [optional] 
-**user_group_id** | **String** |  | [optional] 
-
-

data/docs/Shipment.md

@@ -1,14 +0,0 @@
-# OrderCloud::Shipment
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**shipper** | **String** |  | [optional] 
-**date_shipped** | **String** |  | [optional] 
-**tracking_number** | **String** |  | [optional] 
-**cost** | **Float** |  | [optional] 
-**items** | [**Array<ShipmentItem>**](ShipmentItem.md) |  | [optional] 
-**xp** | **Object** |  | [optional] 
-
-

data/docs/ShipmentApi.md

@@ -1,459 +0,0 @@
-# OrderCloud::ShipmentApi
-
-All URIs are relative to *https://api.ordercloud.io/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ShipmentApi.md#create) | **POST** /buyers/{buyerID}/shipments | 
-[**delete**](ShipmentApi.md#delete) | **DELETE** /buyers/{buyerID}/shipments/{shipmentID} | 
-[**delete_item**](ShipmentApi.md#delete_item) | **DELETE** /buyers/{buyerID}/shipments/{shipmentID}/items/{orderID}/{lineItemID} | 
-[**get**](ShipmentApi.md#get) | **GET** /buyers/{buyerID}/shipments/{shipmentID} | 
-[**list**](ShipmentApi.md#list) | **GET** /buyers/{buyerID}/shipments | 
-[**patch**](ShipmentApi.md#patch) | **PATCH** /buyers/{buyerID}/shipments/{shipmentID} | 
-[**save_item**](ShipmentApi.md#save_item) | **POST** /buyers/{buyerID}/shipments/{shipmentID}/items | 
-[**update**](ShipmentApi.md#update) | **PUT** /buyers/{buyerID}/shipments/{shipmentID} | 
-
-
-# **create**
-> Shipment create(buyer_id, shipment)
-
-
-
-### 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::ShipmentApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-shipment = OrderCloud::Shipment.new # Shipment | 
-
-
-begin
-  result = api_instance.create(buyer_id, shipment)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling ShipmentApi->create: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **shipment** | [**Shipment**](Shipment.md)|  | 
-
-### Return type
-
-[**Shipment**](Shipment.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, shipment_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::ShipmentApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-shipment_id = "shipment_id_example" # String | ID of the shipment.
-
-
-begin
-  api_instance.delete(buyer_id, shipment_id)
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling ShipmentApi->delete: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **shipment_id** | **String**| ID of the shipment. | 
-
-### 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_item**
-> Shipment delete_item(buyer_id, shipment_id, 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::ShipmentApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-shipment_id = "shipment_id_example" # String | ID of the shipment.
-
-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.delete_item(buyer_id, shipment_id, order_id, line_item_id)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling ShipmentApi->delete_item: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **shipment_id** | **String**| ID of the shipment. | 
- **order_id** | **String**| ID of the order. | 
- **line_item_id** | **String**| ID of the line item. | 
-
-### Return type
-
-[**Shipment**](Shipment.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **get**
-> Shipment get(buyer_id, shipment_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::ShipmentApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-shipment_id = "shipment_id_example" # String | ID of the shipment.
-
-
-begin
-  result = api_instance.get(buyer_id, shipment_id)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling ShipmentApi->get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **shipment_id** | **String**| ID of the shipment. | 
-
-### Return type
-
-[**Shipment**](Shipment.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **list**
-> ListShipment 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::ShipmentApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-opts = { 
-  order_id: "order_id_example", # String | ID of the order.
-  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(buyer_id, opts)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling ShipmentApi->list: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **order_id** | **String**| ID of the order. | [optional] 
- **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
-
-[**ListShipment**](ListShipment.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **patch**
-> Shipment patch(buyer_id, shipment_id, shipment)
-
-
-
-### 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::ShipmentApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-shipment_id = "shipment_id_example" # String | ID of the shipment.
-
-shipment = OrderCloud::Shipment.new # Shipment | 
-
-
-begin
-  result = api_instance.patch(buyer_id, shipment_id, shipment)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling ShipmentApi->patch: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **shipment_id** | **String**| ID of the shipment. | 
- **shipment** | [**Shipment**](Shipment.md)|  | 
-
-### Return type
-
-[**Shipment**](Shipment.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **save_item**
-> Shipment save_item(buyer_id, shipment_id, 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::ShipmentApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-shipment_id = "shipment_id_example" # String | ID of the shipment.
-
-item = OrderCloud::ShipmentItem.new # ShipmentItem | 
-
-
-begin
-  result = api_instance.save_item(buyer_id, shipment_id, item)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling ShipmentApi->save_item: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **shipment_id** | **String**| ID of the shipment. | 
- **item** | [**ShipmentItem**](ShipmentItem.md)|  | 
-
-### Return type
-
-[**Shipment**](Shipment.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **update**
-> Shipment update(buyer_id, shipment_id, shipment)
-
-
-
-### 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::ShipmentApi.new
-
-buyer_id = "buyer_id_example" # String | ID of the buyer.
-
-shipment_id = "shipment_id_example" # String | ID of the shipment.
-
-shipment = OrderCloud::Shipment.new # Shipment | 
-
-
-begin
-  result = api_instance.update(buyer_id, shipment_id, shipment)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling ShipmentApi->update: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **buyer_id** | **String**| ID of the buyer. | 
- **shipment_id** | **String**| ID of the shipment. | 
- **shipment** | [**Shipment**](Shipment.md)|  | 
-
-### Return type
-
-[**Shipment**](Shipment.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-