ultracart_rest_api_v2_typescript 3.10.178 → 3.10.180

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.178
+## ultracart_rest_api_v2_typescript@3.10.180
 
 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.178 --save
+npm install ultracart_rest_api_v2_typescript@3.10.180 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.180 | 01/10/2024 | workflow tasks - support for searching by tags |
+| 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 |

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,24 @@ 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}
@@ -41713,6 +41743,12 @@ export interface WorkflowTasksRequest {
      * @memberof WorkflowTasksRequest
      */
     status?: WorkflowTasksRequest.StatusEnum;
+    /**
+     * Tasks that are tagged with the specified tags
+     * @type {Array<string>}
+     * @memberof WorkflowTasksRequest
+     */
+    tags?: Array<string>;
     /**
      * Tasks that are unassigned to a user or group
      * @type {boolean}
@@ -64636,7 +64672,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.
@@ -65547,7 +65583,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.
@@ -65959,7 +65995,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.
@@ -66294,7 +66330,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.
@@ -66669,7 +66705,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,24 @@ 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}
@@ -40830,6 +40860,12 @@ export interface WorkflowTasksRequest {
      * @memberof WorkflowTasksRequest
      */
     status?: WorkflowTasksRequest.StatusEnum;
+    /**
+     * Tasks that are tagged with the specified tags
+     * @type {Array<string>}
+     * @memberof WorkflowTasksRequest
+     */
+    tags?: Array<string>;
     /**
      * Tasks that are unassigned to a user or group
      * @type {boolean}
@@ -50135,7 +50171,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.
@@ -50413,7 +50449,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.
@@ -50691,7 +50727,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.
@@ -50990,7 +51026,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.
@@ -51297,7 +51333,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

@@ -20848,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.
@@ -21724,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.
@@ -22143,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.
@@ -22503,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.178",
+  "version": "3.10.180",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "keywords": [