ultracart_api 3.11.14 → 3.11.16

data/docs/OrderApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**adjust_order_total**](OrderApi.md#adjust_order_total) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total
+[**block_refund_on_order**](OrderApi.md#block_refund_on_order) | **GET** /order/orders/{order_id}/refund_block | Set a refund block on an order
 [**cancel_order**](OrderApi.md#cancel_order) | **POST** /order/orders/{order_id}/cancel | Cancel an order
 [**delete_order**](OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
 [**duplicate_order**](OrderApi.md#duplicate_order) | **POST** /order/orders/{order_id}/duplicate | Duplicate an order
@@ -25,10 +26,10 @@ Method | HTTP request | Description
 [**is_refundable_order**](OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded
 [**process_payment**](OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
 [**refund_order**](OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
-[**refund_order_completely**](OrderApi.md#refund_order_completely) | **PUT** /order/orders/{order_id}/refund_completely | Refund an order completely
 [**replacement**](OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
 [**resend_receipt**](OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt
 [**resend_shipment_confirmation**](OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
+[**unblock_refund_on_order**](OrderApi.md#unblock_refund_on_order) | **GET** /order/orders/{order_id}/refund_unblock | Remove a refund block on an order
 [**update_accounts_receivable_retry_config**](OrderApi.md#update_accounts_receivable_retry_config) | **POST** /order/accountsReceivableRetryConfig | Update A/R Retry Configuration
 [**update_order**](OrderApi.md#update_order) | **PUT** /order/orders/{order_id} | Update an order
 [**validate_order**](OrderApi.md#validate_order) | **POST** /order/validate | Validate
@@ -87,6 +88,59 @@ Name | Type | Description  | Notes
 
 
 
+# **block_refund_on_order**
+> block_refund_on_order(order_id, opts)
+
+Set a refund block on an order
+
+Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
+
+
+order_id = 'order_id_example' # String | The order id to block a refund on.
+
+opts = { 
+  block_reason: 'block_reason_example' # String | Block reason code (optional)
+}
+
+begin
+  #Set a refund block on an order
+  api_instance.block_refund_on_order(order_id, opts)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling OrderApi->block_refund_on_order: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_id** | **String**| The order id to block a refund on. | 
+ **block_reason** | **String**| Block reason code (optional) | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **cancel_order**
 > BaseResponse cancel_order(order_id, opts)
 
@@ -1211,12 +1265,12 @@ Name | Type | Description  | Notes
 
 
 
-# **refund_order_completely**
-> OrderResponse refund_order_completely(order_id, opts)
+# **replacement**
+> OrderReplacementResponse replacement(order_id, replacement)
 
-Refund an order completely
+Replacement order
 
-Perform a refund operation on an order and then update the order if successful. 
+Create a replacement order based upon a previous order 
 
 ### Example
 ```ruby
@@ -1228,26 +1282,17 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
 api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
 
 
-order_id = 'order_id_example' # String | The order id to refund.
+order_id = 'order_id_example' # String | The order id to generate a replacement for.
+
+replacement = UltracartClient::OrderReplacement.new # OrderReplacement | Replacement order details
 
-opts = { 
-  reject_after_refund: false, # BOOLEAN | Reject order after refund
-  skip_customer_notification: false, # BOOLEAN | Skip customer email notification
-  auto_order_cancel: false, # BOOLEAN | Cancel associated auto orders
-  manual_refund: false, # BOOLEAN | Consider a manual refund done externally
-  reverse_affiliate_transactions: true, # BOOLEAN | Reverse affiliate transactions
-  issue_store_credit: false, # BOOLEAN | Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
-  auto_order_cancel_reason: 'auto_order_cancel_reason_example', # String | Reason for auto orders cancellation
-  refund_reason: 'refund_reason_example', # String | Reason for refund
-  reject_reason: 'reject_reason_example' # String | Reason for reject
-}
 
 begin
-  #Refund an order completely
-  result = api_instance.refund_order_completely(order_id, opts)
+  #Replacement order
+  result = api_instance.replacement(order_id, replacement)
   p result
 rescue UltracartClient::ApiError => e
-  puts "Exception when calling OrderApi->refund_order_completely: #{e}"
+  puts "Exception when calling OrderApi->replacement: #{e}"
 end
 ```
 
@@ -1255,20 +1300,12 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **order_id** | **String**| The order id to refund. | 
- **reject_after_refund** | **BOOLEAN**| Reject order after refund | [optional] [default to false]
- **skip_customer_notification** | **BOOLEAN**| Skip customer email notification | [optional] [default to false]
- **auto_order_cancel** | **BOOLEAN**| Cancel associated auto orders | [optional] [default to false]
- **manual_refund** | **BOOLEAN**| Consider a manual refund done externally | [optional] [default to false]
- **reverse_affiliate_transactions** | **BOOLEAN**| Reverse affiliate transactions | [optional] [default to true]
- **issue_store_credit** | **BOOLEAN**| Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account | [optional] [default to false]
- **auto_order_cancel_reason** | **String**| Reason for auto orders cancellation | [optional] 
- **refund_reason** | **String**| Reason for refund | [optional] 
- **reject_reason** | **String**| Reason for reject | [optional] 
+ **order_id** | **String**| The order id to generate a replacement for. | 
+ **replacement** | [**OrderReplacement**](OrderReplacement.md)| Replacement order details | 
 
 ### Return type
 
-[**OrderResponse**](OrderResponse.md)
+[**OrderReplacementResponse**](OrderReplacementResponse.md)
 
 ### Authorization
 
@@ -1276,17 +1313,17 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json; charset=UTF-8
+ - **Content-Type**: application/json
  - **Accept**: application/json
 
 
 
-# **replacement**
-> OrderReplacementResponse replacement(order_id, replacement)
+# **resend_receipt**
+> BaseResponse resend_receipt(order_id)
 
-Replacement order
+Resend receipt
 
-Create a replacement order based upon a previous order 
+Resend the receipt for an order on the UltraCart account. 
 
 ### Example
 ```ruby
@@ -1298,17 +1335,15 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
 api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
 
 
-order_id = 'order_id_example' # String | The order id to generate a replacement for.
-
-replacement = UltracartClient::OrderReplacement.new # OrderReplacement | Replacement order details
+order_id = 'order_id_example' # String | The order id to resend the receipt for.
 
 
 begin
-  #Replacement order
-  result = api_instance.replacement(order_id, replacement)
+  #Resend receipt
+  result = api_instance.resend_receipt(order_id)
   p result
 rescue UltracartClient::ApiError => e
-  puts "Exception when calling OrderApi->replacement: #{e}"
+  puts "Exception when calling OrderApi->resend_receipt: #{e}"
 end
 ```
 
@@ -1316,12 +1351,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **order_id** | **String**| The order id to generate a replacement for. | 
- **replacement** | [**OrderReplacement**](OrderReplacement.md)| Replacement order details | 
+ **order_id** | **String**| The order id to resend the receipt for. | 
 
 ### Return type
 
-[**OrderReplacementResponse**](OrderReplacementResponse.md)
+[**BaseResponse**](BaseResponse.md)
 
 ### Authorization
 
@@ -1334,12 +1368,12 @@ Name | Type | Description  | Notes
 
 
 
-# **resend_receipt**
-> BaseResponse resend_receipt(order_id)
+# **resend_shipment_confirmation**
+> BaseResponse resend_shipment_confirmation(order_id)
 
-Resend receipt
+Resend shipment confirmation
 
-Resend the receipt for an order on the UltraCart account. 
+Resend shipment confirmation for an order on the UltraCart account. 
 
 ### Example
 ```ruby
@@ -1351,15 +1385,15 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
 api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
 
 
-order_id = 'order_id_example' # String | The order id to resend the receipt for.
+order_id = 'order_id_example' # String | The order id to resend the shipment notification for.
 
 
 begin
-  #Resend receipt
-  result = api_instance.resend_receipt(order_id)
+  #Resend shipment confirmation
+  result = api_instance.resend_shipment_confirmation(order_id)
   p result
 rescue UltracartClient::ApiError => e
-  puts "Exception when calling OrderApi->resend_receipt: #{e}"
+  puts "Exception when calling OrderApi->resend_shipment_confirmation: #{e}"
 end
 ```
 
@@ -1367,7 +1401,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **order_id** | **String**| The order id to resend the receipt for. | 
+ **order_id** | **String**| The order id to resend the shipment notification for. | 
 
 ### Return type
 
@@ -1384,12 +1418,12 @@ Name | Type | Description  | Notes
 
 
 
-# **resend_shipment_confirmation**
-> BaseResponse resend_shipment_confirmation(order_id)
+# **unblock_refund_on_order**
+> unblock_refund_on_order(order_id)
 
-Resend shipment confirmation
+Remove a refund block on an order
 
-Resend shipment confirmation for an order on the UltraCart account. 
+Removes a refund block on an order to prevent a user from performing a refund. 
 
 ### Example
 ```ruby
@@ -1401,15 +1435,14 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
 api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
 
 
-order_id = 'order_id_example' # String | The order id to resend the shipment notification for.
+order_id = 'order_id_example' # String | The order id to unblock a refund on.
 
 
 begin
-  #Resend shipment confirmation
-  result = api_instance.resend_shipment_confirmation(order_id)
-  p result
+  #Remove a refund block on an order
+  api_instance.unblock_refund_on_order(order_id)
 rescue UltracartClient::ApiError => e
-  puts "Exception when calling OrderApi->resend_shipment_confirmation: #{e}"
+  puts "Exception when calling OrderApi->unblock_refund_on_order: #{e}"
 end
 ```
 
@@ -1417,11 +1450,11 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **order_id** | **String**| The order id to resend the shipment notification for. | 
+ **order_id** | **String**| The order id to unblock a refund on. | 
 
 ### Return type
 
-[**BaseResponse**](BaseResponse.md)
+nil (empty response body)
 
 ### Authorization
 

data/docs/WebhookApi.md

@@ -186,14 +186,6 @@ api_instance = UltracartClient::WebhookApi.new_using_api_key(simple_key, false,
 webhook_oid = 56 # Integer | The webhook oid to retrieve log summaries for.
 
 opts = { 
-  request_id: 'request_id_example', # String | 
-  begin_date: 'begin_date_example', # String | 
-  end_date: 'end_date_example', # String | 
-  status: 'status_example', # String | 
-  event: 'event_example', # String | 
-  order_id: 'order_id_example', # String | 
-  request: 'request_example', # String | 
-  duration: 56, # Integer | 
   _limit: 100, # Integer | The maximum number of records to return on this one API call.
   _offset: 0, # Integer | Pagination of the record set.  Offset is a zero based index.
   _since: '_since_example' # String | Fetch log summaries that have been delivered since this date/time.
@@ -213,14 +205,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **webhook_oid** | **Integer**| The webhook oid to retrieve log summaries for. | 
- **request_id** | **String**|  | [optional] 
- **begin_date** | **String**|  | [optional] 
- **end_date** | **String**|  | [optional] 
- **status** | **String**|  | [optional] 
- **event** | **String**|  | [optional] 
- **order_id** | **String**|  | [optional] 
- **request** | **String**|  | [optional] 
- **duration** | **Integer**|  | [optional] 
  **_limit** | **Integer**| The maximum number of records to return on this one API call. | [optional] [default to 100]
  **_offset** | **Integer**| Pagination of the record set.  Offset is a zero based index. | [optional] [default to 0]
  **_since** | **String**| Fetch log summaries that have been delivered since this date/time. | [optional]