ultracart_rest_api_v2_typescript 3.10.177 → 3.10.179

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.177
+## ultracart_rest_api_v2_typescript@3.10.179
 
 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.177 --save
+npm install ultracart_rest_api_v2_typescript@3.10.179 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.179 | 01/10/2024 | workflow task - add uuids of related tasks and tags |
+| 3.10.178 | 01/03/2024 | workflow - add task_context field to task obj |
 | 3.10.177 | 12/15/2023 | bug fix on bad docs breaking yaml schema |
 | 3.10.176 | 12/12/2023 | webhook - added event ruler property |
 | 3.10.175 | 11/21/2023 | coupons - addl support on tiered amount/percent off items |

package/api.ts

@@ -5107,6 +5107,18 @@ export interface CartSummary {
      * @memberof CartSummary
      */
     health_benefit_card_amount?: Currency;
+    /**
+     * 
+     * @type {Currency}
+     * @memberof CartSummary
+     */
+    health_benefit_card_balance?: Currency;
+    /**
+     * Health benefit card requirements
+     * @type {string}
+     * @memberof CartSummary
+     */
+    health_benefit_card_requirements?: string;
     /**
      * 
      * @type {Currency}
@@ -41411,6 +41423,12 @@ export interface WorkflowTask {
      * @memberof WorkflowTask
      */
     delay_until_dts?: string;
+    /**
+     * Dependant Workflow Task UUID (must be completed before this task can be completed)
+     * @type {string}
+     * @memberof WorkflowTask
+     */
+    dependant_workflow_task_uuid?: string;
     /**
      * Date/time that the workflow task is due
      * @type {string}
@@ -41471,12 +41489,30 @@ export interface WorkflowTask {
      * @memberof WorkflowTask
      */
     priority?: WorkflowTask.PriorityEnum;
+    /**
+     * Related Workflow Task UUID
+     * @type {string}
+     * @memberof WorkflowTask
+     */
+    related_workflow_task_uuid?: string;
     /**
      * Status of the workflow task
      * @type {string}
      * @memberof WorkflowTask
      */
     status?: WorkflowTask.StatusEnum;
+    /**
+     * Tags
+     * @type {Array<string>}
+     * @memberof WorkflowTask
+     */
+    tags?: Array<string>;
+    /**
+     * User friendly string of the task context
+     * @type {string}
+     * @memberof WorkflowTask
+     */
+    task_context?: string;
     /**
      * Task Details
      * @type {string}
@@ -41510,7 +41546,8 @@ export namespace WorkflowTask {
         Order = <any> 'order',
         AutoOrder = <any> 'auto order',
         Item = <any> 'item',
-        CustomerProfile = <any> 'customer profile'
+        CustomerProfile = <any> 'customer profile',
+        Storefront = <any> 'storefront'
     }
     /**
      * @export
@@ -41775,6 +41812,12 @@ export interface WorkflowTasksResponse {
      * @memberof WorkflowTasksResponse
      */
     success?: boolean;
+    /**
+     * User friendly string of the task context if querying for a specific object type/id
+     * @type {string}
+     * @memberof WorkflowTasksResponse
+     */
+    task_context?: string;
     /**
      * tasks
      * @type {Array<WorkflowTask>}
@@ -64623,7 +64666,7 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
             };
         },
         /**
-         * Perform a refund operation on an order and then update the order if successful 
+         * Perform a refund operation on an order and then update the order if successful.  All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded.  UltraCart will calculate the actual amount to refund based upon the prior refunds. 
          * @summary Refund an order
          * @param {Order} order Order to refund
          * @param {string} order_id The order id to refund.
@@ -65534,7 +65577,7 @@ export const OrderApiFp = function(configuration?: Configuration) {
             };
         },
         /**
-         * Perform a refund operation on an order and then update the order if successful 
+         * Perform a refund operation on an order and then update the order if successful.  All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded.  UltraCart will calculate the actual amount to refund based upon the prior refunds. 
          * @summary Refund an order
          * @param {Order} order Order to refund
          * @param {string} order_id The order id to refund.
@@ -65946,7 +65989,7 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
             return OrderApiFp(configuration).processPayment(order_id, process_payment_request, options)(fetch, basePath);
         },
         /**
-         * Perform a refund operation on an order and then update the order if successful 
+         * Perform a refund operation on an order and then update the order if successful.  All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded.  UltraCart will calculate the actual amount to refund based upon the prior refunds. 
          * @summary Refund an order
          * @param {Order} order Order to refund
          * @param {string} order_id The order id to refund.
@@ -66281,7 +66324,7 @@ export interface OrderApiInterface {
     processPayment(order_id: string, process_payment_request: OrderProcessPaymentRequest, options?: any): Promise<OrderProcessPaymentResponse>;
 
     /**
-     * Perform a refund operation on an order and then update the order if successful 
+     * Perform a refund operation on an order and then update the order if successful.  All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded.  UltraCart will calculate the actual amount to refund based upon the prior refunds. 
      * @summary Refund an order
      * @param {Order} order Order to refund
      * @param {string} order_id The order id to refund.
@@ -66656,7 +66699,7 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
     }
 
     /**
-     * Perform a refund operation on an order and then update the order if successful 
+     * Perform a refund operation on an order and then update the order if successful.  All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded.  UltraCart will calculate the actual amount to refund based upon the prior refunds. 
      * @summary Refund an order
      * @param {Order} order Order to refund
      * @param {string} order_id The order id to refund.

package/dist/api.d.ts

@@ -4983,6 +4983,18 @@ export interface CartSummary {
      * @memberof CartSummary
      */
     health_benefit_card_amount?: Currency;
+    /**
+     *
+     * @type {Currency}
+     * @memberof CartSummary
+     */
+    health_benefit_card_balance?: Currency;
+    /**
+     * Health benefit card requirements
+     * @type {string}
+     * @memberof CartSummary
+     */
+    health_benefit_card_requirements?: string;
     /**
      *
      * @type {Currency}
@@ -40532,6 +40544,12 @@ export interface WorkflowTask {
      * @memberof WorkflowTask
      */
     delay_until_dts?: string;
+    /**
+     * Dependant Workflow Task UUID (must be completed before this task can be completed)
+     * @type {string}
+     * @memberof WorkflowTask
+     */
+    dependant_workflow_task_uuid?: string;
     /**
      * Date/time that the workflow task is due
      * @type {string}
@@ -40592,12 +40610,30 @@ export interface WorkflowTask {
      * @memberof WorkflowTask
      */
     priority?: WorkflowTask.PriorityEnum;
+    /**
+     * Related Workflow Task UUID
+     * @type {string}
+     * @memberof WorkflowTask
+     */
+    related_workflow_task_uuid?: string;
     /**
      * Status of the workflow task
      * @type {string}
      * @memberof WorkflowTask
      */
     status?: WorkflowTask.StatusEnum;
+    /**
+     * Tags
+     * @type {Array<string>}
+     * @memberof WorkflowTask
+     */
+    tags?: Array<string>;
+    /**
+     * User friendly string of the task context
+     * @type {string}
+     * @memberof WorkflowTask
+     */
+    task_context?: string;
     /**
      * Task Details
      * @type {string}
@@ -40630,7 +40666,8 @@ export declare namespace WorkflowTask {
         Order,
         AutoOrder,
         Item,
-        CustomerProfile
+        CustomerProfile,
+        Storefront
     }
     /**
      * @export
@@ -40890,6 +40927,12 @@ export interface WorkflowTasksResponse {
      * @memberof WorkflowTasksResponse
      */
     success?: boolean;
+    /**
+     * User friendly string of the task context if querying for a specific object type/id
+     * @type {string}
+     * @memberof WorkflowTasksResponse
+     */
+    task_context?: string;
     /**
      * tasks
      * @type {Array<WorkflowTask>}
@@ -50122,7 +50165,7 @@ export declare const OrderApiFetchParamCreator: (configuration?: Configuration)
      */
     processPayment(order_id: string, process_payment_request: OrderProcessPaymentRequest, options?: any): FetchArgs;
     /**
-     * Perform a refund operation on an order and then update the order if successful
+     * Perform a refund operation on an order and then update the order if successful.  All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded.  UltraCart will calculate the actual amount to refund based upon the prior refunds.
      * @summary Refund an order
      * @param {Order} order Order to refund
      * @param {string} order_id The order id to refund.
@@ -50400,7 +50443,7 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
      */
     processPayment(order_id: string, process_payment_request: OrderProcessPaymentRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderProcessPaymentResponse>;
     /**
-     * Perform a refund operation on an order and then update the order if successful
+     * Perform a refund operation on an order and then update the order if successful.  All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded.  UltraCart will calculate the actual amount to refund based upon the prior refunds.
      * @summary Refund an order
      * @param {Order} order Order to refund
      * @param {string} order_id The order id to refund.
@@ -50678,7 +50721,7 @@ export declare const OrderApiFactory: (configuration?: Configuration, fetch?: Fe
      */
     processPayment(order_id: string, process_payment_request: OrderProcessPaymentRequest, options?: any): Promise<OrderProcessPaymentResponse>;
     /**
-     * Perform a refund operation on an order and then update the order if successful
+     * Perform a refund operation on an order and then update the order if successful.  All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded.  UltraCart will calculate the actual amount to refund based upon the prior refunds.
      * @summary Refund an order
      * @param {Order} order Order to refund
      * @param {string} order_id The order id to refund.
@@ -50977,7 +51020,7 @@ export interface OrderApiInterface {
      */
     processPayment(order_id: string, process_payment_request: OrderProcessPaymentRequest, options?: any): Promise<OrderProcessPaymentResponse>;
     /**
-     * Perform a refund operation on an order and then update the order if successful
+     * Perform a refund operation on an order and then update the order if successful.  All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded.  UltraCart will calculate the actual amount to refund based upon the prior refunds.
      * @summary Refund an order
      * @param {Order} order Order to refund
      * @param {string} order_id The order id to refund.
@@ -51284,7 +51327,7 @@ export declare class OrderApi extends BaseAPI implements OrderApiInterface {
      */
     processPayment(order_id: string, process_payment_request: OrderProcessPaymentRequest, options?: any): Promise<OrderProcessPaymentResponse>;
     /**
-     * Perform a refund operation on an order and then update the order if successful
+     * Perform a refund operation on an order and then update the order if successful.  All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded.  UltraCart will calculate the actual amount to refund based upon the prior refunds.
      * @summary Refund an order
      * @param {Order} order Order to refund
      * @param {string} order_id The order id to refund.

package/dist/api.js

@@ -1592,6 +1592,7 @@ var WorkflowTask;
         ObjectTypeEnum[ObjectTypeEnum["AutoOrder"] = 'auto order'] = "AutoOrder";
         ObjectTypeEnum[ObjectTypeEnum["Item"] = 'item'] = "Item";
         ObjectTypeEnum[ObjectTypeEnum["CustomerProfile"] = 'customer profile'] = "CustomerProfile";
+        ObjectTypeEnum[ObjectTypeEnum["Storefront"] = 'storefront'] = "Storefront";
     })(ObjectTypeEnum = WorkflowTask.ObjectTypeEnum || (WorkflowTask.ObjectTypeEnum = {}));
     /**
      * @export
@@ -20847,7 +20848,7 @@ var OrderApiFetchParamCreator = function (configuration) {
             };
         },
         /**
-         * Perform a refund operation on an order and then update the order if successful
+         * Perform a refund operation on an order and then update the order if successful.  All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded.  UltraCart will calculate the actual amount to refund based upon the prior refunds.
          * @summary Refund an order
          * @param {Order} order Order to refund
          * @param {string} order_id The order id to refund.
@@ -21723,7 +21724,7 @@ var OrderApiFp = function (configuration) {
             };
         },
         /**
-         * Perform a refund operation on an order and then update the order if successful
+         * Perform a refund operation on an order and then update the order if successful.  All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded.  UltraCart will calculate the actual amount to refund based upon the prior refunds.
          * @summary Refund an order
          * @param {Order} order Order to refund
          * @param {string} order_id The order id to refund.
@@ -22142,7 +22143,7 @@ var OrderApiFactory = function (configuration, fetch, basePath) {
             return (0, exports.OrderApiFp)(configuration).processPayment(order_id, process_payment_request, options)(fetch, basePath);
         },
         /**
-         * Perform a refund operation on an order and then update the order if successful
+         * Perform a refund operation on an order and then update the order if successful.  All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded.  UltraCart will calculate the actual amount to refund based upon the prior refunds.
          * @summary Refund an order
          * @param {Order} order Order to refund
          * @param {string} order_id The order id to refund.
@@ -22502,7 +22503,7 @@ var OrderApi = /** @class */ (function (_super) {
         return (0, exports.OrderApiFp)(this.configuration).processPayment(order_id, process_payment_request, options)(this.fetch, this.basePath);
     };
     /**
-     * Perform a refund operation on an order and then update the order if successful
+     * Perform a refund operation on an order and then update the order if successful.  All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded.  UltraCart will calculate the actual amount to refund based upon the prior refunds.
      * @summary Refund an order
      * @param {Order} order Order to refund
      * @param {string} order_id The order id to refund.

package/package.json

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