ultracart_rest_api_v2_typescript 3.10.118 → 3.10.119

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.118
+## ultracart_rest_api_v2_typescript@3.10.119
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@3.10.118 --save
+npm install ultracart_rest_api_v2_typescript@3.10.119 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.119 | 02/20/2023 | refund reasons |
 | 3.10.118 | 02/17/2023 | convo api - smsUnsubscribeConversation method |
 | 3.10.117 | 02/15/2023 | added auto order sorting by next_shipment_dts |
 | 3.10.116 | 02/10/2023 | convo - add storefront_host_name to search request |

package/api.ts

@@ -28309,12 +28309,24 @@ export interface Order {
      * @memberof Order
      */
     refund_dts?: string;
+    /**
+     * Refund reason code.  This can only be written during a refund operation otherwise this field is read only.
+     * @type {string}
+     * @memberof Order
+     */
+    refund_reason?: string;
     /**
      * If the order was rejected, the date/time that the rejection occurred
      * @type {string}
      * @memberof Order
      */
     reject_dts?: string;
+    /**
+     * Reject reason code.  This can only be written during a reject operation otherwise this field is read only.
+     * @type {string}
+     * @memberof Order
+     */
+    reject_reason?: string;
     /**
      * 
      * @type {OrderSalesforce}
@@ -29877,6 +29889,18 @@ export interface OrderItem {
      * @memberof OrderItem
      */
     quickbooks_class?: string;
+    /**
+     * Refund reason code.  This can only be written during a refund operation otherwise this field is read only.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    refund_reason?: string;
+    /**
+     * Return reason code.  This can only be written during a refund operation otherwise this field is read only.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    return_reason?: string;
     /**
      * True if this item ships in a separate box
      * @type {boolean}
@@ -31241,6 +31265,32 @@ export interface OrderQuote {
     quoted_dts?: string;
 }
 
+/**
+ * 
+ * @export
+ * @interface OrderReason
+ */
+export interface OrderReason {
+    /**
+     * Default reason
+     * @type {boolean}
+     * @memberof OrderReason
+     */
+    default_reason?: boolean;
+    /**
+     * Reason description.  This is the friendly description of the reason that should be displayed to the user.
+     * @type {string}
+     * @memberof OrderReason
+     */
+    description?: string;
+    /**
+     * Reason value.  This is what should be submitted with a refund operation.
+     * @type {string}
+     * @memberof OrderReason
+     */
+    value?: string;
+}
+
 /**
  * 
  * @export
@@ -31253,12 +31303,48 @@ export interface OrderRefundableResponse {
      * @memberof OrderRefundableResponse
      */
     error?: ModelError;
+    /**
+     * True if the item level refund reason is required
+     * @type {boolean}
+     * @memberof OrderRefundableResponse
+     */
+    item_level_refund_reason_required?: boolean;
+    /**
+     * Reason codes available at the item level.
+     * @type {Array<OrderReason>}
+     * @memberof OrderRefundableResponse
+     */
+    item_level_refund_reasons?: Array<OrderReason>;
+    /**
+     * Return codes available at the item level.
+     * @type {Array<OrderReason>}
+     * @memberof OrderRefundableResponse
+     */
+    item_level_return_reasons?: Array<OrderReason>;
     /**
      * 
      * @type {ResponseMetadata}
      * @memberof OrderRefundableResponse
      */
     metadata?: ResponseMetadata;
+    /**
+     * True if the order level refund reason is required
+     * @type {boolean}
+     * @memberof OrderRefundableResponse
+     */
+    order_level_refund_reason_required?: boolean;
+    /**
+     * Reason codes available at the order level.
+     * @type {Array<OrderReason>}
+     * @memberof OrderRefundableResponse
+     */
+    order_level_refund_reasons?: Array<OrderReason>;
+    /**
+     * Reject codes available at the order level.
+     * @type {Array<OrderReason>}
+     * @memberof OrderRefundableResponse
+     */
+    order_level_reject_reasons?: Array<OrderReason>;
     /**
      * Whether the order is refundable or not.  Null should be interpreted as false.
      * @type {boolean}

package/dist/api.d.ts

@@ -27705,12 +27705,24 @@ export interface Order {
      * @memberof Order
      */
     refund_dts?: string;
+    /**
+     * Refund reason code.  This can only be written during a refund operation otherwise this field is read only.
+     * @type {string}
+     * @memberof Order
+     */
+    refund_reason?: string;
     /**
      * If the order was rejected, the date/time that the rejection occurred
      * @type {string}
      * @memberof Order
      */
     reject_dts?: string;
+    /**
+     * Reject reason code.  This can only be written during a reject operation otherwise this field is read only.
+     * @type {string}
+     * @memberof Order
+     */
+    reject_reason?: string;
     /**
      *
      * @type {OrderSalesforce}
@@ -29248,6 +29260,18 @@ export interface OrderItem {
      * @memberof OrderItem
      */
     quickbooks_class?: string;
+    /**
+     * Refund reason code.  This can only be written during a refund operation otherwise this field is read only.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    refund_reason?: string;
+    /**
+     * Return reason code.  This can only be written during a refund operation otherwise this field is read only.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    return_reason?: string;
     /**
      * True if this item ships in a separate box
      * @type {boolean}
@@ -30580,6 +30604,31 @@ export interface OrderQuote {
      */
     quoted_dts?: string;
 }
+/**
+ *
+ * @export
+ * @interface OrderReason
+ */
+export interface OrderReason {
+    /**
+     * Default reason
+     * @type {boolean}
+     * @memberof OrderReason
+     */
+    default_reason?: boolean;
+    /**
+     * Reason description.  This is the friendly description of the reason that should be displayed to the user.
+     * @type {string}
+     * @memberof OrderReason
+     */
+    description?: string;
+    /**
+     * Reason value.  This is what should be submitted with a refund operation.
+     * @type {string}
+     * @memberof OrderReason
+     */
+    value?: string;
+}
 /**
  *
  * @export
@@ -30592,12 +30641,48 @@ export interface OrderRefundableResponse {
      * @memberof OrderRefundableResponse
      */
     error?: ModelError;
+    /**
+     * True if the item level refund reason is required
+     * @type {boolean}
+     * @memberof OrderRefundableResponse
+     */
+    item_level_refund_reason_required?: boolean;
+    /**
+     * Reason codes available at the item level.
+     * @type {Array<OrderReason>}
+     * @memberof OrderRefundableResponse
+     */
+    item_level_refund_reasons?: Array<OrderReason>;
+    /**
+     * Return codes available at the item level.
+     * @type {Array<OrderReason>}
+     * @memberof OrderRefundableResponse
+     */
+    item_level_return_reasons?: Array<OrderReason>;
     /**
      *
      * @type {ResponseMetadata}
      * @memberof OrderRefundableResponse
      */
     metadata?: ResponseMetadata;
+    /**
+     * True if the order level refund reason is required
+     * @type {boolean}
+     * @memberof OrderRefundableResponse
+     */
+    order_level_refund_reason_required?: boolean;
+    /**
+     * Reason codes available at the order level.
+     * @type {Array<OrderReason>}
+     * @memberof OrderRefundableResponse
+     */
+    order_level_refund_reasons?: Array<OrderReason>;
+    /**
+     * Reject codes available at the order level.
+     * @type {Array<OrderReason>}
+     * @memberof OrderRefundableResponse
+     */
+    order_level_reject_reasons?: Array<OrderReason>;
     /**
      * Whether the order is refundable or not.  Null should be interpreted as false.
      * @type {boolean}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "3.10.118",
+  "version": "3.10.119",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "keywords": [