ultracart_rest_api_v2_typescript 4.0.135 → 4.0.137

package/.openapi-generator/FILES

@@ -615,6 +615,7 @@ src/models/OrderProperty.ts
 src/models/OrderQuery.ts
 src/models/OrderQueryBatch.ts
 src/models/OrderQuote.ts
+src/models/OrderReason.ts
 src/models/OrderRefundableResponse.ts
 src/models/OrderReplacement.ts
 src/models/OrderReplacementItem.ts

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.135
+## ultracart_rest_api_v2_typescript@4.0.137
 
 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@4.0.135 --save
+npm install ultracart_rest_api_v2_typescript@4.0.137 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.137 | 02/22/2023 | convo - customer initiated flag on engagement |
+| 4.0.136 | 02/20/2023 | refund reasons |
 | 4.0.135 | 02/17/2023 | convo api - smsUnsubscribeConversation method |
 | 4.0.134 | 02/15/2023 | added auto order sorting by next_shipment_dts |
 | 4.0.133 | 02/10/2023 | convo - add storefront_host_name to search request |

package/dist/models/ConversationEngagement.d.ts

@@ -34,6 +34,12 @@ export interface ConversationEngagement {
      * @memberof ConversationEngagement
      */
     customer_greeting?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ConversationEngagement
+     */
+    customer_initiated?: boolean;
     /**
      *
      * @type {Array<number>}

package/dist/models/ConversationEngagement.js

@@ -36,6 +36,7 @@ function ConversationEngagementFromJSONTyped(json, ignoreDiscriminator) {
         'active': !(0, runtime_1.exists)(json, 'active') ? undefined : json['active'],
         'conversation_engagement_oid': !(0, runtime_1.exists)(json, 'conversation_engagement_oid') ? undefined : json['conversation_engagement_oid'],
         'customer_greeting': !(0, runtime_1.exists)(json, 'customer_greeting') ? undefined : json['customer_greeting'],
+        'customer_initiated': !(0, runtime_1.exists)(json, 'customer_initiated') ? undefined : json['customer_initiated'],
         'department_oids': !(0, runtime_1.exists)(json, 'department_oids') ? undefined : json['department_oids'],
         'engagement_name': !(0, runtime_1.exists)(json, 'engagement_name') ? undefined : json['engagement_name'],
         'equation': !(0, runtime_1.exists)(json, 'equation') ? undefined : (0, ConversationEngagementEquation_1.ConversationEngagementEquationFromJSON)(json['equation']),
@@ -55,6 +56,7 @@ function ConversationEngagementToJSON(value) {
         'active': value.active,
         'conversation_engagement_oid': value.conversation_engagement_oid,
         'customer_greeting': value.customer_greeting,
+        'customer_initiated': value.customer_initiated,
         'department_oids': value.department_oids,
         'engagement_name': value.engagement_name,
         'equation': (0, ConversationEngagementEquation_1.ConversationEngagementEquationToJSON)(value.equation),

package/dist/models/Order.d.ts

@@ -216,12 +216,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}

package/dist/models/Order.js

@@ -97,7 +97,9 @@ function OrderFromJSONTyped(json, ignoreDiscriminator) {
         'properties': !(0, runtime_1.exists)(json, 'properties') ? undefined : (json['properties'].map(OrderProperty_1.OrderPropertyFromJSON)),
         'quote': !(0, runtime_1.exists)(json, 'quote') ? undefined : (0, OrderQuote_1.OrderQuoteFromJSON)(json['quote']),
         'refund_dts': !(0, runtime_1.exists)(json, 'refund_dts') ? undefined : json['refund_dts'],
+        'refund_reason': !(0, runtime_1.exists)(json, 'refund_reason') ? undefined : json['refund_reason'],
         'reject_dts': !(0, runtime_1.exists)(json, 'reject_dts') ? undefined : json['reject_dts'],
+        'reject_reason': !(0, runtime_1.exists)(json, 'reject_reason') ? undefined : json['reject_reason'],
         'salesforce': !(0, runtime_1.exists)(json, 'salesforce') ? undefined : (0, OrderSalesforce_1.OrderSalesforceFromJSON)(json['salesforce']),
         'shipping': !(0, runtime_1.exists)(json, 'shipping') ? undefined : (0, OrderShipping_1.OrderShippingFromJSON)(json['shipping']),
         'summary': !(0, runtime_1.exists)(json, 'summary') ? undefined : (0, OrderSummary_1.OrderSummaryFromJSON)(json['summary']),
@@ -144,7 +146,9 @@ function OrderToJSON(value) {
         'properties': value.properties === undefined ? undefined : (value.properties.map(OrderProperty_1.OrderPropertyToJSON)),
         'quote': (0, OrderQuote_1.OrderQuoteToJSON)(value.quote),
         'refund_dts': value.refund_dts,
+        'refund_reason': value.refund_reason,
         'reject_dts': value.reject_dts,
+        'reject_reason': value.reject_reason,
         'salesforce': (0, OrderSalesforce_1.OrderSalesforceToJSON)(value.salesforce),
         'shipping': (0, OrderShipping_1.OrderShippingToJSON)(value.shipping),
         'summary': (0, OrderSummary_1.OrderSummaryToJSON)(value.summary),

package/dist/models/OrderItem.d.ts

@@ -280,6 +280,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}

package/dist/models/OrderItem.js

@@ -83,6 +83,8 @@ function OrderItemFromJSONTyped(json, ignoreDiscriminator) {
         'quantity': !(0, runtime_1.exists)(json, 'quantity') ? undefined : json['quantity'],
         'quantity_refunded': !(0, runtime_1.exists)(json, 'quantity_refunded') ? undefined : json['quantity_refunded'],
         'quickbooks_class': !(0, runtime_1.exists)(json, 'quickbooks_class') ? undefined : json['quickbooks_class'],
+        'refund_reason': !(0, runtime_1.exists)(json, 'refund_reason') ? undefined : json['refund_reason'],
+        'return_reason': !(0, runtime_1.exists)(json, 'return_reason') ? undefined : json['return_reason'],
         'ship_separately': !(0, runtime_1.exists)(json, 'ship_separately') ? undefined : json['ship_separately'],
         'shipped_by_user': !(0, runtime_1.exists)(json, 'shipped_by_user') ? undefined : json['shipped_by_user'],
         'shipped_dts': !(0, runtime_1.exists)(json, 'shipped_dts') ? undefined : json['shipped_dts'],
@@ -153,6 +155,8 @@ function OrderItemToJSON(value) {
         'quantity': value.quantity,
         'quantity_refunded': value.quantity_refunded,
         'quickbooks_class': value.quickbooks_class,
+        'refund_reason': value.refund_reason,
+        'return_reason': value.return_reason,
         'ship_separately': value.ship_separately,
         'shipped_by_user': value.shipped_by_user,
         'shipped_dts': value.shipped_dts,

package/dist/models/OrderReason.d.ts

@@ -0,0 +1,39 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @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 declare function OrderReasonFromJSON(json: any): OrderReason;
+export declare function OrderReasonFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderReason;
+export declare function OrderReasonToJSON(value?: OrderReason | null): any;

package/dist/models/OrderReason.js

@@ -0,0 +1,46 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderReasonToJSON = exports.OrderReasonFromJSONTyped = exports.OrderReasonFromJSON = void 0;
+var runtime_1 = require("../runtime");
+function OrderReasonFromJSON(json) {
+    return OrderReasonFromJSONTyped(json, false);
+}
+exports.OrderReasonFromJSON = OrderReasonFromJSON;
+function OrderReasonFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'default_reason': !(0, runtime_1.exists)(json, 'default_reason') ? undefined : json['default_reason'],
+        'description': !(0, runtime_1.exists)(json, 'description') ? undefined : json['description'],
+        'value': !(0, runtime_1.exists)(json, 'value') ? undefined : json['value'],
+    };
+}
+exports.OrderReasonFromJSONTyped = OrderReasonFromJSONTyped;
+function OrderReasonToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'default_reason': value.default_reason,
+        'description': value.description,
+        'value': value.value,
+    };
+}
+exports.OrderReasonToJSON = OrderReasonToJSON;

package/dist/models/OrderRefundableResponse.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import { ModelError } from './ModelError';
+import { OrderReason } from './OrderReason';
 import { ResponseMetadata } from './ResponseMetadata';
 import { Warning } from './Warning';
 /**
@@ -24,12 +25,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/models/OrderRefundableResponse.js

@@ -16,6 +16,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OrderRefundableResponseToJSON = exports.OrderRefundableResponseFromJSONTyped = exports.OrderRefundableResponseFromJSON = void 0;
 var runtime_1 = require("../runtime");
 var ModelError_1 = require("./ModelError");
+var OrderReason_1 = require("./OrderReason");
 var ResponseMetadata_1 = require("./ResponseMetadata");
 var Warning_1 = require("./Warning");
 function OrderRefundableResponseFromJSON(json) {
@@ -28,7 +29,13 @@ function OrderRefundableResponseFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
+        'item_level_refund_reason_required': !(0, runtime_1.exists)(json, 'item_level_refund_reason_required') ? undefined : json['item_level_refund_reason_required'],
+        'item_level_refund_reasons': !(0, runtime_1.exists)(json, 'item_level_refund_reasons') ? undefined : (json['item_level_refund_reasons'].map(OrderReason_1.OrderReasonFromJSON)),
+        'item_level_return_reasons': !(0, runtime_1.exists)(json, 'item_level_return_reasons') ? undefined : (json['item_level_return_reasons'].map(OrderReason_1.OrderReasonFromJSON)),
         'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
+        'order_level_refund_reason_required': !(0, runtime_1.exists)(json, 'order_level_refund_reason_required') ? undefined : json['order_level_refund_reason_required'],
+        'order_level_refund_reasons': !(0, runtime_1.exists)(json, 'order_level_refund_reasons') ? undefined : (json['order_level_refund_reasons'].map(OrderReason_1.OrderReasonFromJSON)),
+        'order_level_reject_reasons': !(0, runtime_1.exists)(json, 'order_level_reject_reasons') ? undefined : (json['order_level_reject_reasons'].map(OrderReason_1.OrderReasonFromJSON)),
         'refundable': !(0, runtime_1.exists)(json, 'refundable') ? undefined : json['refundable'],
         'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
         'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
@@ -44,7 +51,13 @@ function OrderRefundableResponseToJSON(value) {
     }
     return {
         'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
+        'item_level_refund_reason_required': value.item_level_refund_reason_required,
+        'item_level_refund_reasons': value.item_level_refund_reasons === undefined ? undefined : (value.item_level_refund_reasons.map(OrderReason_1.OrderReasonToJSON)),
+        'item_level_return_reasons': value.item_level_return_reasons === undefined ? undefined : (value.item_level_return_reasons.map(OrderReason_1.OrderReasonToJSON)),
         'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
+        'order_level_refund_reason_required': value.order_level_refund_reason_required,
+        'order_level_refund_reasons': value.order_level_refund_reasons === undefined ? undefined : (value.order_level_refund_reasons.map(OrderReason_1.OrderReasonToJSON)),
+        'order_level_reject_reasons': value.order_level_reject_reasons === undefined ? undefined : (value.order_level_reject_reasons.map(OrderReason_1.OrderReasonToJSON)),
         'refundable': value.refundable,
         'success': value.success,
         'warning': (0, Warning_1.WarningToJSON)(value.warning),

package/dist/models/index.d.ts

@@ -590,6 +590,7 @@ export * from './OrderProperty';
 export * from './OrderQuery';
 export * from './OrderQueryBatch';
 export * from './OrderQuote';
+export * from './OrderReason';
 export * from './OrderRefundableResponse';
 export * from './OrderReplacement';
 export * from './OrderReplacementItem';

package/dist/models/index.js

@@ -608,6 +608,7 @@ __exportStar(require("./OrderProperty"), exports);
 __exportStar(require("./OrderQuery"), exports);
 __exportStar(require("./OrderQueryBatch"), exports);
 __exportStar(require("./OrderQuote"), exports);
+__exportStar(require("./OrderReason"), exports);
 __exportStar(require("./OrderRefundableResponse"), exports);
 __exportStar(require("./OrderReplacement"), exports);
 __exportStar(require("./OrderReplacementItem"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.0.135",
+  "version": "4.0.137",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/models/ConversationEngagement.ts

@@ -44,6 +44,12 @@ export interface ConversationEngagement {
      * @memberof ConversationEngagement
      */
     customer_greeting?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ConversationEngagement
+     */
+    customer_initiated?: boolean;
     /**
      * 
      * @type {Array<number>}
@@ -101,6 +107,7 @@ export function ConversationEngagementFromJSONTyped(json: any, ignoreDiscriminat
         'active': !exists(json, 'active') ? undefined : json['active'],
         'conversation_engagement_oid': !exists(json, 'conversation_engagement_oid') ? undefined : json['conversation_engagement_oid'],
         'customer_greeting': !exists(json, 'customer_greeting') ? undefined : json['customer_greeting'],
+        'customer_initiated': !exists(json, 'customer_initiated') ? undefined : json['customer_initiated'],
         'department_oids': !exists(json, 'department_oids') ? undefined : json['department_oids'],
         'engagement_name': !exists(json, 'engagement_name') ? undefined : json['engagement_name'],
         'equation': !exists(json, 'equation') ? undefined : ConversationEngagementEquationFromJSON(json['equation']),
@@ -121,6 +128,7 @@ export function ConversationEngagementToJSON(value?: ConversationEngagement | nu
         'active': value.active,
         'conversation_engagement_oid': value.conversation_engagement_oid,
         'customer_greeting': value.customer_greeting,
+        'customer_initiated': value.customer_initiated,
         'department_oids': value.department_oids,
         'engagement_name': value.engagement_name,
         'equation': ConversationEngagementEquationToJSON(value.equation),

package/src/models/Order.ts

@@ -356,12 +356,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}
@@ -460,7 +472,9 @@ export function OrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): Ord
         'properties': !exists(json, 'properties') ? undefined : ((json['properties'] as Array<any>).map(OrderPropertyFromJSON)),
         'quote': !exists(json, 'quote') ? undefined : OrderQuoteFromJSON(json['quote']),
         'refund_dts': !exists(json, 'refund_dts') ? undefined : json['refund_dts'],
+        'refund_reason': !exists(json, 'refund_reason') ? undefined : json['refund_reason'],
         'reject_dts': !exists(json, 'reject_dts') ? undefined : json['reject_dts'],
+        'reject_reason': !exists(json, 'reject_reason') ? undefined : json['reject_reason'],
         'salesforce': !exists(json, 'salesforce') ? undefined : OrderSalesforceFromJSON(json['salesforce']),
         'shipping': !exists(json, 'shipping') ? undefined : OrderShippingFromJSON(json['shipping']),
         'summary': !exists(json, 'summary') ? undefined : OrderSummaryFromJSON(json['summary']),
@@ -508,7 +522,9 @@ export function OrderToJSON(value?: Order | null): any {
         'properties': value.properties === undefined ? undefined : ((value.properties as Array<any>).map(OrderPropertyToJSON)),
         'quote': OrderQuoteToJSON(value.quote),
         'refund_dts': value.refund_dts,
+        'refund_reason': value.refund_reason,
         'reject_dts': value.reject_dts,
+        'reject_reason': value.reject_reason,
         'salesforce': OrderSalesforceToJSON(value.salesforce),
         'shipping': OrderShippingToJSON(value.shipping),
         'summary': OrderSummaryToJSON(value.summary),

package/src/models/OrderItem.ts

@@ -320,6 +320,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}
@@ -484,6 +496,8 @@ export function OrderItemFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'quantity': !exists(json, 'quantity') ? undefined : json['quantity'],
         'quantity_refunded': !exists(json, 'quantity_refunded') ? undefined : json['quantity_refunded'],
         'quickbooks_class': !exists(json, 'quickbooks_class') ? undefined : json['quickbooks_class'],
+        'refund_reason': !exists(json, 'refund_reason') ? undefined : json['refund_reason'],
+        'return_reason': !exists(json, 'return_reason') ? undefined : json['return_reason'],
         'ship_separately': !exists(json, 'ship_separately') ? undefined : json['ship_separately'],
         'shipped_by_user': !exists(json, 'shipped_by_user') ? undefined : json['shipped_by_user'],
         'shipped_dts': !exists(json, 'shipped_dts') ? undefined : json['shipped_dts'],
@@ -555,6 +569,8 @@ export function OrderItemToJSON(value?: OrderItem | null): any {
         'quantity': value.quantity,
         'quantity_refunded': value.quantity_refunded,
         'quickbooks_class': value.quickbooks_class,
+        'refund_reason': value.refund_reason,
+        'return_reason': value.return_reason,
         'ship_separately': value.ship_separately,
         'shipped_by_user': value.shipped_by_user,
         'shipped_dts': value.shipped_dts,

package/src/models/OrderReason.ts

@@ -0,0 +1,72 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @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 function OrderReasonFromJSON(json: any): OrderReason {
+    return OrderReasonFromJSONTyped(json, false);
+}
+
+export function OrderReasonFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderReason {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'default_reason': !exists(json, 'default_reason') ? undefined : json['default_reason'],
+        'description': !exists(json, 'description') ? undefined : json['description'],
+        'value': !exists(json, 'value') ? undefined : json['value'],
+    };
+}
+
+export function OrderReasonToJSON(value?: OrderReason | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'default_reason': value.default_reason,
+        'description': value.description,
+        'value': value.value,
+    };
+}
+

package/src/models/OrderRefundableResponse.ts

@@ -19,6 +19,12 @@ import {
     ModelErrorFromJSONTyped,
     ModelErrorToJSON,
 } from './ModelError';
+import {
+    OrderReason,
+    OrderReasonFromJSON,
+    OrderReasonFromJSONTyped,
+    OrderReasonToJSON,
+} from './OrderReason';
 import {
     ResponseMetadata,
     ResponseMetadataFromJSON,
@@ -44,12 +50,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}
@@ -81,7 +123,13 @@ export function OrderRefundableResponseFromJSONTyped(json: any, ignoreDiscrimina
     return {
         
         'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
+        'item_level_refund_reason_required': !exists(json, 'item_level_refund_reason_required') ? undefined : json['item_level_refund_reason_required'],
+        'item_level_refund_reasons': !exists(json, 'item_level_refund_reasons') ? undefined : ((json['item_level_refund_reasons'] as Array<any>).map(OrderReasonFromJSON)),
+        'item_level_return_reasons': !exists(json, 'item_level_return_reasons') ? undefined : ((json['item_level_return_reasons'] as Array<any>).map(OrderReasonFromJSON)),
         'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
+        'order_level_refund_reason_required': !exists(json, 'order_level_refund_reason_required') ? undefined : json['order_level_refund_reason_required'],
+        'order_level_refund_reasons': !exists(json, 'order_level_refund_reasons') ? undefined : ((json['order_level_refund_reasons'] as Array<any>).map(OrderReasonFromJSON)),
+        'order_level_reject_reasons': !exists(json, 'order_level_reject_reasons') ? undefined : ((json['order_level_reject_reasons'] as Array<any>).map(OrderReasonFromJSON)),
         'refundable': !exists(json, 'refundable') ? undefined : json['refundable'],
         'success': !exists(json, 'success') ? undefined : json['success'],
         'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
@@ -98,7 +146,13 @@ export function OrderRefundableResponseToJSON(value?: OrderRefundableResponse |
     return {
         
         'error': ModelErrorToJSON(value.error),
+        'item_level_refund_reason_required': value.item_level_refund_reason_required,
+        'item_level_refund_reasons': value.item_level_refund_reasons === undefined ? undefined : ((value.item_level_refund_reasons as Array<any>).map(OrderReasonToJSON)),
+        'item_level_return_reasons': value.item_level_return_reasons === undefined ? undefined : ((value.item_level_return_reasons as Array<any>).map(OrderReasonToJSON)),
         'metadata': ResponseMetadataToJSON(value.metadata),
+        'order_level_refund_reason_required': value.order_level_refund_reason_required,
+        'order_level_refund_reasons': value.order_level_refund_reasons === undefined ? undefined : ((value.order_level_refund_reasons as Array<any>).map(OrderReasonToJSON)),
+        'order_level_reject_reasons': value.order_level_reject_reasons === undefined ? undefined : ((value.order_level_reject_reasons as Array<any>).map(OrderReasonToJSON)),
         'refundable': value.refundable,
         'success': value.success,
         'warning': WarningToJSON(value.warning),

package/src/models/index.ts

@@ -592,6 +592,7 @@ export * from './OrderProperty';
 export * from './OrderQuery';
 export * from './OrderQueryBatch';
 export * from './OrderQuote';
+export * from './OrderReason';
 export * from './OrderRefundableResponse';
 export * from './OrderReplacement';
 export * from './OrderReplacementItem';