ultracart_rest_api_v2_typescript 4.0.195 → 4.0.197

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@4.0.195
+## ultracart_rest_api_v2_typescript@4.0.197
 
 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.195 --save
+npm install ultracart_rest_api_v2_typescript@4.0.197 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.197 | 01/10/2024 | workflow tasks - support for searching by tags |
+| 4.0.196 | 01/10/2024 | workflow task - add uuids of related tasks and tags |
 | 4.0.195 | 01/03/2024 | workflow - add task_context field to task obj |
 | 4.0.194 | 12/15/2023 | bug fix on bad docs breaking yaml schema |
 | 4.0.193 | 12/12/2023 | webhook - added event ruler property |

package/dist/apis/OrderApi.d.ts

@@ -479,7 +479,7 @@ export interface OrderApiInterface {
      */
     processPayment(requestParameters: ProcessPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): 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 {string} orderId The order id to refund.
      * @param {Order} order Order to refund
@@ -496,7 +496,7 @@ export interface OrderApiInterface {
      */
     refundOrderRaw(requestParameters: RefundOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
     /**
-     * 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.
      * Refund an order
      */
     refundOrder(requestParameters: RefundOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
@@ -793,12 +793,12 @@ export declare class OrderApi extends runtime.BaseAPI implements OrderApiInterfa
      */
     processPayment(requestParameters: ProcessPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): 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.
      * Refund an order
      */
     refundOrderRaw(requestParameters: RefundOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
     /**
-     * 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.
      * Refund an order
      */
     refundOrder(requestParameters: RefundOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;

package/dist/apis/OrderApi.js

@@ -1403,7 +1403,7 @@ var OrderApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * 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.
      * Refund an order
      */
     OrderApi.prototype.refundOrderRaw = function (requestParameters, initOverrides) {
@@ -1470,7 +1470,7 @@ var OrderApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * 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.
      * Refund an order
      */
     OrderApi.prototype.refundOrder = function (requestParameters, initOverrides) {

package/dist/models/CartSummary.d.ts

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

package/dist/models/CartSummary.js

@@ -30,6 +30,8 @@ function CartSummaryFromJSONTyped(json, ignoreDiscriminator) {
         'arbitrary_tax_rate': !(0, runtime_1.exists)(json, 'arbitrary_tax_rate') ? undefined : (0, Currency_1.CurrencyFromJSON)(json['arbitrary_tax_rate']),
         'arbitrary_taxable_subtotal': !(0, runtime_1.exists)(json, 'arbitrary_taxable_subtotal') ? undefined : (0, Currency_1.CurrencyFromJSON)(json['arbitrary_taxable_subtotal']),
         'health_benefit_card_amount': !(0, runtime_1.exists)(json, 'health_benefit_card_amount') ? undefined : (0, Currency_1.CurrencyFromJSON)(json['health_benefit_card_amount']),
+        'health_benefit_card_balance': !(0, runtime_1.exists)(json, 'health_benefit_card_balance') ? undefined : (0, Currency_1.CurrencyFromJSON)(json['health_benefit_card_balance']),
+        'health_benefit_card_requirements': !(0, runtime_1.exists)(json, 'health_benefit_card_requirements') ? undefined : json['health_benefit_card_requirements'],
         'internal_gift_certificate_amount': !(0, runtime_1.exists)(json, 'internal_gift_certificate_amount') ? undefined : (0, Currency_1.CurrencyFromJSON)(json['internal_gift_certificate_amount']),
         'shipping_handling': !(0, runtime_1.exists)(json, 'shipping_handling') ? undefined : (0, Currency_1.CurrencyFromJSON)(json['shipping_handling']),
         'shipping_handling_discount': !(0, runtime_1.exists)(json, 'shipping_handling_discount') ? undefined : (0, Currency_1.CurrencyFromJSON)(json['shipping_handling_discount']),
@@ -59,6 +61,8 @@ function CartSummaryToJSON(value) {
         'arbitrary_tax_rate': (0, Currency_1.CurrencyToJSON)(value.arbitrary_tax_rate),
         'arbitrary_taxable_subtotal': (0, Currency_1.CurrencyToJSON)(value.arbitrary_taxable_subtotal),
         'health_benefit_card_amount': (0, Currency_1.CurrencyToJSON)(value.health_benefit_card_amount),
+        'health_benefit_card_balance': (0, Currency_1.CurrencyToJSON)(value.health_benefit_card_balance),
+        'health_benefit_card_requirements': value.health_benefit_card_requirements,
         'internal_gift_certificate_amount': (0, Currency_1.CurrencyToJSON)(value.internal_gift_certificate_amount),
         'shipping_handling': (0, Currency_1.CurrencyToJSON)(value.shipping_handling),
         'shipping_handling_discount': (0, Currency_1.CurrencyToJSON)(value.shipping_handling_discount),

package/dist/models/WorkflowTask.d.ts

@@ -67,6 +67,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}
@@ -127,12 +133,24 @@ export interface WorkflowTask {
      * @memberof WorkflowTask
      */
     priority?: WorkflowTaskPriorityEnum;
+    /**
+     * Related Workflow Task UUID
+     * @type {string}
+     * @memberof WorkflowTask
+     */
+    related_workflow_task_uuid?: string;
     /**
      * Status of the workflow task
      * @type {string}
      * @memberof WorkflowTask
      */
     status?: WorkflowTaskStatusEnum;
+    /**
+     * Tags
+     * @type {Array<string>}
+     * @memberof WorkflowTask
+     */
+    tags?: Array<string>;
     /**
      * User friendly string of the task context
      * @type {string}

package/dist/models/WorkflowTask.js

@@ -64,6 +64,7 @@ function WorkflowTaskFromJSONTyped(json, ignoreDiscriminator) {
         'created_by': !(0, runtime_1.exists)(json, 'created_by') ? undefined : (0, WorkflowUser_1.WorkflowUserFromJSON)(json['created_by']),
         'created_dts': !(0, runtime_1.exists)(json, 'created_dts') ? undefined : json['created_dts'],
         'delay_until_dts': !(0, runtime_1.exists)(json, 'delay_until_dts') ? undefined : json['delay_until_dts'],
+        'dependant_workflow_task_uuid': !(0, runtime_1.exists)(json, 'dependant_workflow_task_uuid') ? undefined : json['dependant_workflow_task_uuid'],
         'due_dts': !(0, runtime_1.exists)(json, 'due_dts') ? undefined : json['due_dts'],
         'histories': !(0, runtime_1.exists)(json, 'histories') ? undefined : (json['histories'].map(WorkflowTaskHistory_1.WorkflowTaskHistoryFromJSON)),
         'last_update_dts': !(0, runtime_1.exists)(json, 'last_update_dts') ? undefined : json['last_update_dts'],
@@ -74,7 +75,9 @@ function WorkflowTaskFromJSONTyped(json, ignoreDiscriminator) {
         'object_type': !(0, runtime_1.exists)(json, 'object_type') ? undefined : json['object_type'],
         'object_url': !(0, runtime_1.exists)(json, 'object_url') ? undefined : json['object_url'],
         'priority': !(0, runtime_1.exists)(json, 'priority') ? undefined : json['priority'],
+        'related_workflow_task_uuid': !(0, runtime_1.exists)(json, 'related_workflow_task_uuid') ? undefined : json['related_workflow_task_uuid'],
         'status': !(0, runtime_1.exists)(json, 'status') ? undefined : json['status'],
+        'tags': !(0, runtime_1.exists)(json, 'tags') ? undefined : json['tags'],
         'task_context': !(0, runtime_1.exists)(json, 'task_context') ? undefined : json['task_context'],
         'task_details': !(0, runtime_1.exists)(json, 'task_details') ? undefined : json['task_details'],
         'task_name': !(0, runtime_1.exists)(json, 'task_name') ? undefined : json['task_name'],
@@ -98,6 +101,7 @@ function WorkflowTaskToJSON(value) {
         'created_by': (0, WorkflowUser_1.WorkflowUserToJSON)(value.created_by),
         'created_dts': value.created_dts,
         'delay_until_dts': value.delay_until_dts,
+        'dependant_workflow_task_uuid': value.dependant_workflow_task_uuid,
         'due_dts': value.due_dts,
         'histories': value.histories === undefined ? undefined : (value.histories.map(WorkflowTaskHistory_1.WorkflowTaskHistoryToJSON)),
         'last_update_dts': value.last_update_dts,
@@ -108,7 +112,9 @@ function WorkflowTaskToJSON(value) {
         'object_type': value.object_type,
         'object_url': value.object_url,
         'priority': value.priority,
+        'related_workflow_task_uuid': value.related_workflow_task_uuid,
         'status': value.status,
+        'tags': value.tags,
         'task_context': value.task_context,
         'task_details': value.task_details,
         'task_name': value.task_name,

package/dist/models/WorkflowTasksRequest.d.ts

@@ -112,6 +112,12 @@ export interface WorkflowTasksRequest {
      * @memberof WorkflowTasksRequest
      */
     status?: WorkflowTasksRequestStatusEnum;
+    /**
+     * 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}

package/dist/models/WorkflowTasksRequest.js

@@ -68,6 +68,7 @@ function WorkflowTasksRequestFromJSONTyped(json, ignoreDiscriminator) {
         'object_type': !(0, runtime_1.exists)(json, 'object_type') ? undefined : json['object_type'],
         'priority': !(0, runtime_1.exists)(json, 'priority') ? undefined : json['priority'],
         'status': !(0, runtime_1.exists)(json, 'status') ? undefined : json['status'],
+        'tags': !(0, runtime_1.exists)(json, 'tags') ? undefined : json['tags'],
         'unassigned': !(0, runtime_1.exists)(json, 'unassigned') ? undefined : json['unassigned'],
     };
 }
@@ -96,6 +97,7 @@ function WorkflowTasksRequestToJSON(value) {
         'object_type': value.object_type,
         'priority': value.priority,
         'status': value.status,
+        'tags': value.tags,
         'unassigned': value.unassigned,
     };
 }

package/package.json

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

package/src/apis/OrderApi.ts

@@ -623,7 +623,7 @@ export interface OrderApiInterface {
     processPayment(requestParameters: ProcessPaymentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): 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 {string} orderId The order id to refund.
      * @param {Order} order Order to refund
@@ -641,7 +641,7 @@ export interface OrderApiInterface {
     refundOrderRaw(requestParameters: RefundOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>>;
 
     /**
-     * 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. 
      * Refund an order
      */
     refundOrder(requestParameters: RefundOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse>;
@@ -1770,7 +1770,7 @@ export class OrderApi extends runtime.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. 
      * Refund an order
      */
     async refundOrderRaw(requestParameters: RefundOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderResponse>> {
@@ -1837,7 +1837,7 @@ export class OrderApi extends runtime.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. 
      * Refund an order
      */
     async refundOrder(requestParameters: RefundOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderResponse> {

package/src/models/CartSummary.ts

@@ -56,6 +56,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}
@@ -151,6 +163,8 @@ export function CartSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean
         'arbitrary_tax_rate': !exists(json, 'arbitrary_tax_rate') ? undefined : CurrencyFromJSON(json['arbitrary_tax_rate']),
         'arbitrary_taxable_subtotal': !exists(json, 'arbitrary_taxable_subtotal') ? undefined : CurrencyFromJSON(json['arbitrary_taxable_subtotal']),
         'health_benefit_card_amount': !exists(json, 'health_benefit_card_amount') ? undefined : CurrencyFromJSON(json['health_benefit_card_amount']),
+        'health_benefit_card_balance': !exists(json, 'health_benefit_card_balance') ? undefined : CurrencyFromJSON(json['health_benefit_card_balance']),
+        'health_benefit_card_requirements': !exists(json, 'health_benefit_card_requirements') ? undefined : json['health_benefit_card_requirements'],
         'internal_gift_certificate_amount': !exists(json, 'internal_gift_certificate_amount') ? undefined : CurrencyFromJSON(json['internal_gift_certificate_amount']),
         'shipping_handling': !exists(json, 'shipping_handling') ? undefined : CurrencyFromJSON(json['shipping_handling']),
         'shipping_handling_discount': !exists(json, 'shipping_handling_discount') ? undefined : CurrencyFromJSON(json['shipping_handling_discount']),
@@ -181,6 +195,8 @@ export function CartSummaryToJSON(value?: CartSummary | null): any {
         'arbitrary_tax_rate': CurrencyToJSON(value.arbitrary_tax_rate),
         'arbitrary_taxable_subtotal': CurrencyToJSON(value.arbitrary_taxable_subtotal),
         'health_benefit_card_amount': CurrencyToJSON(value.health_benefit_card_amount),
+        'health_benefit_card_balance': CurrencyToJSON(value.health_benefit_card_balance),
+        'health_benefit_card_requirements': value.health_benefit_card_requirements,
         'internal_gift_certificate_amount': CurrencyToJSON(value.internal_gift_certificate_amount),
         'shipping_handling': CurrencyToJSON(value.shipping_handling),
         'shipping_handling_discount': CurrencyToJSON(value.shipping_handling_discount),

package/src/models/WorkflowTask.ts

@@ -92,6 +92,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}
@@ -152,12 +158,24 @@ export interface WorkflowTask {
      * @memberof WorkflowTask
      */
     priority?: WorkflowTaskPriorityEnum;
+    /**
+     * Related Workflow Task UUID
+     * @type {string}
+     * @memberof WorkflowTask
+     */
+    related_workflow_task_uuid?: string;
     /**
      * Status of the workflow task
      * @type {string}
      * @memberof WorkflowTask
      */
     status?: WorkflowTaskStatusEnum;
+    /**
+     * Tags
+     * @type {Array<string>}
+     * @memberof WorkflowTask
+     */
+    tags?: Array<string>;
     /**
      * User friendly string of the task context
      * @type {string}
@@ -238,6 +256,7 @@ export function WorkflowTaskFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'created_by': !exists(json, 'created_by') ? undefined : WorkflowUserFromJSON(json['created_by']),
         'created_dts': !exists(json, 'created_dts') ? undefined : json['created_dts'],
         'delay_until_dts': !exists(json, 'delay_until_dts') ? undefined : json['delay_until_dts'],
+        'dependant_workflow_task_uuid': !exists(json, 'dependant_workflow_task_uuid') ? undefined : json['dependant_workflow_task_uuid'],
         'due_dts': !exists(json, 'due_dts') ? undefined : json['due_dts'],
         'histories': !exists(json, 'histories') ? undefined : ((json['histories'] as Array<any>).map(WorkflowTaskHistoryFromJSON)),
         'last_update_dts': !exists(json, 'last_update_dts') ? undefined : json['last_update_dts'],
@@ -248,7 +267,9 @@ export function WorkflowTaskFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'object_type': !exists(json, 'object_type') ? undefined : json['object_type'],
         'object_url': !exists(json, 'object_url') ? undefined : json['object_url'],
         'priority': !exists(json, 'priority') ? undefined : json['priority'],
+        'related_workflow_task_uuid': !exists(json, 'related_workflow_task_uuid') ? undefined : json['related_workflow_task_uuid'],
         'status': !exists(json, 'status') ? undefined : json['status'],
+        'tags': !exists(json, 'tags') ? undefined : json['tags'],
         'task_context': !exists(json, 'task_context') ? undefined : json['task_context'],
         'task_details': !exists(json, 'task_details') ? undefined : json['task_details'],
         'task_name': !exists(json, 'task_name') ? undefined : json['task_name'],
@@ -273,6 +294,7 @@ export function WorkflowTaskToJSON(value?: WorkflowTask | null): any {
         'created_by': WorkflowUserToJSON(value.created_by),
         'created_dts': value.created_dts,
         'delay_until_dts': value.delay_until_dts,
+        'dependant_workflow_task_uuid': value.dependant_workflow_task_uuid,
         'due_dts': value.due_dts,
         'histories': value.histories === undefined ? undefined : ((value.histories as Array<any>).map(WorkflowTaskHistoryToJSON)),
         'last_update_dts': value.last_update_dts,
@@ -283,7 +305,9 @@ export function WorkflowTaskToJSON(value?: WorkflowTask | null): any {
         'object_type': value.object_type,
         'object_url': value.object_url,
         'priority': value.priority,
+        'related_workflow_task_uuid': value.related_workflow_task_uuid,
         'status': value.status,
+        'tags': value.tags,
         'task_context': value.task_context,
         'task_details': value.task_details,
         'task_name': value.task_name,

package/src/models/WorkflowTasksRequest.ts

@@ -122,6 +122,12 @@ export interface WorkflowTasksRequest {
      * @memberof WorkflowTasksRequest
      */
     status?: WorkflowTasksRequestStatusEnum;
+    /**
+     * 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}
@@ -191,6 +197,7 @@ export function WorkflowTasksRequestFromJSONTyped(json: any, ignoreDiscriminator
         'object_type': !exists(json, 'object_type') ? undefined : json['object_type'],
         'priority': !exists(json, 'priority') ? undefined : json['priority'],
         'status': !exists(json, 'status') ? undefined : json['status'],
+        'tags': !exists(json, 'tags') ? undefined : json['tags'],
         'unassigned': !exists(json, 'unassigned') ? undefined : json['unassigned'],
     };
 }
@@ -220,6 +227,7 @@ export function WorkflowTasksRequestToJSON(value?: WorkflowTasksRequest | null):
         'object_type': value.object_type,
         'priority': value.priority,
         'status': value.status,
+        'tags': value.tags,
         'unassigned': value.unassigned,
     };
 }