order_cloud 0.0.6 → 1.0.43

data/docs/PaymentTransaction.md

@@ -1,15 +0,0 @@
-# OrderCloud::PaymentTransaction
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**type** | **String** |  | [optional] 
-**date_executed** | **String** |  | [optional] 
-**amount** | **Float** |  | [optional] 
-**succeeded** | **BOOLEAN** |  | [optional] 
-**result_code** | **String** |  | [optional] 
-**result_message** | **String** |  | [optional] 
-**xp** | **Object** |  | [optional] 
-
-

data/docs/PingResponse.md

@@ -1,8 +0,0 @@
-# OrderCloud::PingResponse
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message** | **String** |  | [optional] 
-
-

data/docs/PriceBreak.md

@@ -1,9 +0,0 @@
-# OrderCloud::PriceBreak
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**quantity** | **Integer** |  | [optional] 
-**price** | **Float** |  | [optional] 
-
-

data/docs/PriceSchedule.md

@@ -1,18 +0,0 @@
-# OrderCloud::PriceSchedule
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**name** | **String** |  | [optional] 
-**apply_tax** | **BOOLEAN** |  | [optional] 
-**apply_shipping** | **BOOLEAN** |  | [optional] 
-**min_quantity** | **Integer** |  | [optional] 
-**max_quantity** | **Integer** |  | [optional] 
-**use_cumulative_quantity** | **BOOLEAN** |  | [optional] 
-**restricted_quantity** | **BOOLEAN** |  | [optional] 
-**order_type** | **String** |  | [optional] 
-**price_breaks** | [**Array<PriceBreak>**](PriceBreak.md) |  | [optional] 
-**xp** | **Object** |  | [optional] 
-
-

data/docs/PriceScheduleApi.md

@@ -1,429 +0,0 @@
-# OrderCloud::PriceScheduleApi
-
-All URIs are relative to *https://api.ordercloud.io/v1*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](PriceScheduleApi.md#create) | **POST** /priceschedules | 
-[**delete**](PriceScheduleApi.md#delete) | **DELETE** /priceschedules/{priceScheduleID} | 
-[**delete_price_break**](PriceScheduleApi.md#delete_price_break) | **DELETE** /priceschedules/{priceScheduleID}/PriceBreaks | 
-[**get**](PriceScheduleApi.md#get) | **GET** /priceschedules/{priceScheduleID} | 
-[**list**](PriceScheduleApi.md#list) | **GET** /priceschedules | 
-[**patch**](PriceScheduleApi.md#patch) | **PATCH** /priceschedules/{priceScheduleID} | 
-[**save_price_break**](PriceScheduleApi.md#save_price_break) | **POST** /priceschedules/{priceScheduleID}/PriceBreaks | 
-[**update**](PriceScheduleApi.md#update) | **PUT** /priceschedules/{priceScheduleID} | 
-
-
-# **create**
-> PriceSchedule create(price_schedule)
-
-
-
-### 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::PriceScheduleApi.new
-
-price_schedule = OrderCloud::PriceSchedule.new # PriceSchedule | 
-
-
-begin
-  result = api_instance.create(price_schedule)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling PriceScheduleApi->create: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **price_schedule** | [**PriceSchedule**](PriceSchedule.md)|  | 
-
-### Return type
-
-[**PriceSchedule**](PriceSchedule.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **delete**
-> delete(price_schedule_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::PriceScheduleApi.new
-
-price_schedule_id = "price_schedule_id_example" # String | ID of the price schedule.
-
-
-begin
-  api_instance.delete(price_schedule_id)
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling PriceScheduleApi->delete: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **price_schedule_id** | **String**| ID of the price schedule. | 
-
-### 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_price_break**
-> delete_price_break(price_schedule_id, quantity)
-
-
-
-### 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::PriceScheduleApi.new
-
-price_schedule_id = "price_schedule_id_example" # String | ID of the price schedule.
-
-quantity = 56 # Integer | Quantity of the price schedule.
-
-
-begin
-  api_instance.delete_price_break(price_schedule_id, quantity)
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling PriceScheduleApi->delete_price_break: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **price_schedule_id** | **String**| ID of the price schedule. | 
- **quantity** | **Integer**| Quantity of the price schedule. | 
-
-### 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**
-> PriceSchedule get(price_schedule_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::PriceScheduleApi.new
-
-price_schedule_id = "price_schedule_id_example" # String | ID of the price schedule.
-
-
-begin
-  result = api_instance.get(price_schedule_id)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling PriceScheduleApi->get: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **price_schedule_id** | **String**| ID of the price schedule. | 
-
-### Return type
-
-[**PriceSchedule**](PriceSchedule.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **list**
-> ListPriceSchedule 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::PriceScheduleApi.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 PriceScheduleApi->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
-
-[**ListPriceSchedule**](ListPriceSchedule.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **patch**
-> PriceSchedule patch(price_schedule_id, price_schedule)
-
-
-
-### 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::PriceScheduleApi.new
-
-price_schedule_id = "price_schedule_id_example" # String | ID of the price schedule.
-
-price_schedule = OrderCloud::PriceSchedule.new # PriceSchedule | 
-
-
-begin
-  result = api_instance.patch(price_schedule_id, price_schedule)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling PriceScheduleApi->patch: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **price_schedule_id** | **String**| ID of the price schedule. | 
- **price_schedule** | [**PriceSchedule**](PriceSchedule.md)|  | 
-
-### Return type
-
-[**PriceSchedule**](PriceSchedule.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **save_price_break**
-> PriceSchedule save_price_break(price_schedule_id, price_break)
-
-
-
-### 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::PriceScheduleApi.new
-
-price_schedule_id = "price_schedule_id_example" # String | ID of the price schedule.
-
-price_break = OrderCloud::PriceBreak.new # PriceBreak | 
-
-
-begin
-  result = api_instance.save_price_break(price_schedule_id, price_break)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling PriceScheduleApi->save_price_break: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **price_schedule_id** | **String**| ID of the price schedule. | 
- **price_break** | [**PriceBreak**](PriceBreak.md)|  | 
-
-### Return type
-
-[**PriceSchedule**](PriceSchedule.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-
-# **update**
-> PriceSchedule update(price_schedule_id, price_schedule)
-
-
-
-### 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::PriceScheduleApi.new
-
-price_schedule_id = "price_schedule_id_example" # String | ID of the price schedule.
-
-price_schedule = OrderCloud::PriceSchedule.new # PriceSchedule | 
-
-
-begin
-  result = api_instance.update(price_schedule_id, price_schedule)
-  p result
-rescue OrderCloud::ApiError => e
-  puts "Exception when calling PriceScheduleApi->update: #{e}"
-end
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **price_schedule_id** | **String**| ID of the price schedule. | 
- **price_schedule** | [**PriceSchedule**](PriceSchedule.md)|  | 
-
-### Return type
-
-[**PriceSchedule**](PriceSchedule.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, text/plain; charset=utf-8
- - **Accept**: application/json
-
-
-