order_cloud 0.0.1

data/docs/OrderApproval.md

@@ -0,0 +1,16 @@
+# OrderCloud::OrderApproval
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**approval_rule_id** | **String** |  | [optional] 
+**approving_group_id** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+**date_created** | **String** |  | [optional] 
+**date_completed** | **String** |  | [optional] 
+**approver_id** | **String** |  | [optional] 
+**approver_user_name** | **String** |  | [optional] 
+**approver_email** | **String** |  | [optional] 
+**comments** | **String** |  | [optional] 
+
+

data/docs/OrderPromotion.md

@@ -0,0 +1,8 @@
+# OrderCloud::OrderPromotion
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** |  | [optional] 
+
+

data/docs/PasswordReset.md

@@ -0,0 +1,10 @@
+# OrderCloud::PasswordReset
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** |  | [optional] 
+**username** | **String** |  | [optional] 
+**password** | **String** |  | [optional] 
+
+

data/docs/PasswordResetApi.md

@@ -0,0 +1,109 @@
+# OrderCloud::PasswordResetApi
+
+All URIs are relative to *https://api.ordercloud.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**reset_password**](PasswordResetApi.md#reset_password) | **PUT** /password/reset/{verificationCode} | 
+[**send_verification_code**](PasswordResetApi.md#send_verification_code) | **POST** /password/reset | 
+
+
+# **reset_password**
+> reset_password(verification_code, password_reset)
+
+
+
+### 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::PasswordResetApi.new
+
+verification_code = "verification_code_example" # String | Verification code of the forgotten password.
+
+password_reset = OrderCloud::PasswordReset.new # PasswordReset | 
+
+
+begin
+  api_instance.reset_password(verification_code, password_reset)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PasswordResetApi->reset_password: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **verification_code** | **String**| Verification code of the forgotten password. | 
+ **password_reset** | [**PasswordReset**](PasswordReset.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
+
+
+
+# **send_verification_code**
+> send_verification_code(password_reset_request)
+
+
+
+### 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::PasswordResetApi.new
+
+password_reset_request = OrderCloud::PasswordResetRequest.new # PasswordResetRequest | 
+
+
+begin
+  api_instance.send_verification_code(password_reset_request)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PasswordResetApi->send_verification_code: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **password_reset_request** | [**PasswordResetRequest**](PasswordResetRequest.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/PasswordResetRequest.md

@@ -0,0 +1,11 @@
+# OrderCloud::PasswordResetRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**username** | **String** |  | [optional] 
+**url** | **String** |  | [optional] 
+
+

data/docs/Payment.md

@@ -0,0 +1,16 @@
+# OrderCloud::Payment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+**date_created** | **String** |  | [optional] 
+**credit_card_id** | **String** |  | [optional] 
+**spending_account_id** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**amount** | **Float** |  | [optional] 
+**xp** | **Object** |  | [optional] 
+**transactions** | [**Array<PaymentTransaction>**](PaymentTransaction.md) |  | [optional] 
+
+

data/docs/PaymentApi.md

@@ -0,0 +1,601 @@
+# OrderCloud::PaymentApi
+
+All URIs are relative to *https://api.ordercloud.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](PaymentApi.md#create) | **POST** /buyers/{buyerID}/orders/{orderID}/payments | 
+[**create_transaction**](PaymentApi.md#create_transaction) | **POST** /buyers/{buyerID}/orders/{orderID}/payments/{paymentID}/transactions | 
+[**delete**](PaymentApi.md#delete) | **DELETE** /buyers/{buyerID}/orders/{orderID}/payments/{paymentID} | 
+[**delete_transaction**](PaymentApi.md#delete_transaction) | **DELETE** /buyers/{buyerID}/orders/{orderID}/payments/{paymentID}/transactions/{transactionID} | 
+[**get**](PaymentApi.md#get) | **GET** /buyers/{buyerID}/orders/{orderID}/payments/{paymentID} | 
+[**list**](PaymentApi.md#list) | **GET** /buyers/{buyerID}/orders/{orderID}/payments | 
+[**patch**](PaymentApi.md#patch) | **PATCH** /buyers/{buyerID}/orders/{orderID}/payments/{paymentID} | 
+[**patch_transaction**](PaymentApi.md#patch_transaction) | **PATCH** /buyers/{buyerID}/orders/{orderID}/payments/{paymentID}/transactions/{transactionID} | 
+[**update**](PaymentApi.md#update) | **PUT** /buyers/{buyerID}/orders/{orderID}/payments/{paymentID} | 
+[**update_transaction**](PaymentApi.md#update_transaction) | **PUT** /buyers/{buyerID}/orders/{orderID}/payments/{paymentID}/transactions/{transactionID} | 
+
+
+# **create**
+> Payment create(buyer_id, order_id, payment)
+
+
+
+### 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::PaymentApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+order_id = "order_id_example" # String | ID of the order.
+
+payment = OrderCloud::Payment.new # Payment | 
+
+
+begin
+  result = api_instance.create(buyer_id, order_id, payment)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PaymentApi->create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **order_id** | **String**| ID of the order. | 
+ **payment** | [**Payment**](Payment.md)|  | 
+
+### Return type
+
+[**Payment**](Payment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **create_transaction**
+> Payment create_transaction(buyer_id, order_id, payment_id, transaction)
+
+
+
+### 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::PaymentApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+order_id = "order_id_example" # String | ID of the order.
+
+payment_id = "payment_id_example" # String | ID of the payment.
+
+transaction = OrderCloud::PaymentTransaction.new # PaymentTransaction | 
+
+
+begin
+  result = api_instance.create_transaction(buyer_id, order_id, payment_id, transaction)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PaymentApi->create_transaction: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **order_id** | **String**| ID of the order. | 
+ **payment_id** | **String**| ID of the payment. | 
+ **transaction** | [**PaymentTransaction**](PaymentTransaction.md)|  | 
+
+### Return type
+
+[**Payment**](Payment.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, order_id, payment_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::PaymentApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+order_id = "order_id_example" # String | ID of the order.
+
+payment_id = "payment_id_example" # String | ID of the payment.
+
+
+begin
+  api_instance.delete(buyer_id, order_id, payment_id)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PaymentApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **order_id** | **String**| ID of the order. | 
+ **payment_id** | **String**| ID of the payment. | 
+
+### 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_transaction**
+> delete_transaction(buyer_id, order_id, payment_id, transaction_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::PaymentApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+order_id = "order_id_example" # String | ID of the order.
+
+payment_id = "payment_id_example" # String | ID of the payment.
+
+transaction_id = "transaction_id_example" # String | ID of the transaction.
+
+
+begin
+  api_instance.delete_transaction(buyer_id, order_id, payment_id, transaction_id)
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PaymentApi->delete_transaction: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **order_id** | **String**| ID of the order. | 
+ **payment_id** | **String**| ID of the payment. | 
+ **transaction_id** | **String**| ID of the transaction. | 
+
+### 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**
+> Payment get(buyer_id, order_id, payment_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::PaymentApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+order_id = "order_id_example" # String | ID of the order.
+
+payment_id = "payment_id_example" # String | ID of the payment.
+
+
+begin
+  result = api_instance.get(buyer_id, order_id, payment_id)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PaymentApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **order_id** | **String**| ID of the order. | 
+ **payment_id** | **String**| ID of the payment. | 
+
+### Return type
+
+[**Payment**](Payment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **list**
+> ListPayment list(buyer_id, 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::PaymentApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+order_id = "order_id_example" # String | ID of the order.
+
+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(buyer_id, order_id, opts)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PaymentApi->list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **order_id** | **String**| ID of the order. | 
+ **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
+
+[**ListPayment**](ListPayment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **patch**
+> Payment patch(buyer_id, order_id, payment_id, partial_payment)
+
+
+
+### 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::PaymentApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+order_id = "order_id_example" # String | ID of the order.
+
+payment_id = "payment_id_example" # String | ID of the payment.
+
+partial_payment = OrderCloud::Payment.new # Payment | 
+
+
+begin
+  result = api_instance.patch(buyer_id, order_id, payment_id, partial_payment)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PaymentApi->patch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **order_id** | **String**| ID of the order. | 
+ **payment_id** | **String**| ID of the payment. | 
+ **partial_payment** | [**Payment**](Payment.md)|  | 
+
+### Return type
+
+[**Payment**](Payment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **patch_transaction**
+> Payment patch_transaction(buyer_id, order_id, payment_id, transaction_id, partial_transaction)
+
+
+
+### 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::PaymentApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+order_id = "order_id_example" # String | ID of the order.
+
+payment_id = "payment_id_example" # String | ID of the payment.
+
+transaction_id = "transaction_id_example" # String | ID of the transaction.
+
+partial_transaction = OrderCloud::PaymentTransaction.new # PaymentTransaction | 
+
+
+begin
+  result = api_instance.patch_transaction(buyer_id, order_id, payment_id, transaction_id, partial_transaction)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PaymentApi->patch_transaction: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **order_id** | **String**| ID of the order. | 
+ **payment_id** | **String**| ID of the payment. | 
+ **transaction_id** | **String**| ID of the transaction. | 
+ **partial_transaction** | [**PaymentTransaction**](PaymentTransaction.md)|  | 
+
+### Return type
+
+[**Payment**](Payment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **update**
+> Payment update(buyer_id, order_id, payment_id, payment)
+
+
+
+### 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::PaymentApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+order_id = "order_id_example" # String | ID of the order.
+
+payment_id = "payment_id_example" # String | ID of the payment.
+
+payment = OrderCloud::Payment.new # Payment | 
+
+
+begin
+  result = api_instance.update(buyer_id, order_id, payment_id, payment)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PaymentApi->update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **order_id** | **String**| ID of the order. | 
+ **payment_id** | **String**| ID of the payment. | 
+ **payment** | [**Payment**](Payment.md)|  | 
+
+### Return type
+
+[**Payment**](Payment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+
+# **update_transaction**
+> Payment update_transaction(buyer_id, order_id, payment_id, transaction_id, transaction)
+
+
+
+### 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::PaymentApi.new
+
+buyer_id = "buyer_id_example" # String | ID of the buyer.
+
+order_id = "order_id_example" # String | ID of the order.
+
+payment_id = "payment_id_example" # String | ID of the payment.
+
+transaction_id = "transaction_id_example" # String | ID of the transaction.
+
+transaction = OrderCloud::PaymentTransaction.new # PaymentTransaction | 
+
+
+begin
+  result = api_instance.update_transaction(buyer_id, order_id, payment_id, transaction_id, transaction)
+  p result
+rescue OrderCloud::ApiError => e
+  puts "Exception when calling PaymentApi->update_transaction: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **buyer_id** | **String**| ID of the buyer. | 
+ **order_id** | **String**| ID of the order. | 
+ **payment_id** | **String**| ID of the payment. | 
+ **transaction_id** | **String**| ID of the transaction. | 
+ **transaction** | [**PaymentTransaction**](PaymentTransaction.md)|  | 
+
+### Return type
+
+[**Payment**](Payment.md)
+
+### Authorization
+
+[oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/plain; charset=utf-8
+ - **Accept**: application/json
+
+
+