bruce-models 7.1.114 → 7.1.116

package/dist/types/workflow/workflow-item.d.ts

@@ -3,6 +3,25 @@ import { BruceApi } from "../api/bruce-api";
 type WorkflowItemId = number | string;
 type WorkflowSettingId = number | string;
 export declare namespace WorkflowItem {
+    /** Sort fields supported by workflow/itemsquery. */
+    enum EOrderBy {
+        ID = "ID",
+        ENTITY_ID = "EntityID",
+        CREATED = "Created",
+        UPDATED = "Updated",
+        DUE_DATE = "DueDate",
+        CREATED_BY_USER_ID = "CreatedByUserID",
+        ITEM_TYPE_ID = "ItemTypeID",
+        ITEM_STATUS_ID = "ItemStatusID",
+        QUEUE_ID = "QueueID",
+        WORKFLOW_SCHEDULE_ID = "WorkflowScheduleID",
+        PRIORITY = "Priority",
+        PARENT_ITEM_ID = "ParentItemID",
+        DESCRIPTION = "Description",
+        UI_SLIDE_ID = "UISlideID",
+        THUMBNAIL_CLIENT_FILE_ID = "ThumbnailClientFileID",
+        RANDOM = "RANDOM"
+    }
     interface IItem {
         ID?: number;
         "Entity.ID"?: string;
@@ -14,7 +33,9 @@ export declare namespace WorkflowItem {
         "ItemStatus.ID"?: number;
         "Queue.ID"?: number;
         "Workflow.Schedule.ID"?: number | null;
+        /** Optional signed int32 priority. Send null to clear; omit to preserve on update. */
         Priority?: number | null;
+        /** Optional int64 parent Workflow Item ID. Send null to detach; omit to preserve on update. */
         "Parent.Item.ID"?: number | null;
         Description?: string;
         "UI.Slide.ID"?: string;
@@ -33,7 +54,7 @@ export declare namespace WorkflowItem {
         api?: BruceApi.Api;
         pageSize?: number;
         pageIndex?: number;
-        orderBy?: string;
+        orderBy?: EOrderBy | string;
         sortOrder?: Api.ESortOrderStr | "ASC" | "DESC" | string;
         statusEnd?: boolean;
         assignedToMe?: boolean;
@@ -41,8 +62,10 @@ export declare namespace WorkflowItem {
         queueId?: WorkflowSettingId | WorkflowSettingId[];
         scheduleId?: WorkflowSettingId | WorkflowSettingId[];
         workflowScheduleId?: WorkflowSettingId | WorkflowSettingId[];
+        /** Match one or more integer priorities, including zero and negative values. */
         priority?: number | number[];
-        parentItemId?: WorkflowSettingId | WorkflowSettingId[];
+        /** Match direct children of one or more parent Workflow Items. */
+        parentItemId?: WorkflowItemId | WorkflowItemId[];
         statusId?: WorkflowSettingId | WorkflowSettingId[];
         createdByUserId?: string | string[];
         dueDate?: string | string[];
@@ -111,6 +134,7 @@ export declare namespace WorkflowItem {
      * Parent Entity Type and Ontology breakdowns are returned only when expanded.
      */
     function GetStatistics(params?: IStatisticsParams): Promise<IStatisticsResponse>;
+    /** Creates an item, including its optional Priority and Parent.Item.ID. */
     function Create(params: {
         api?: BruceApi.Api;
         workflowItemTypeId?: WorkflowSettingId;
@@ -121,6 +145,10 @@ export declare namespace WorkflowItem {
         workflowItem: IItem;
         entity?: any;
     }>;
+    /**
+     * Saves item changes. Omitted fields are preserved; null clears Priority or Parent.Item.ID.
+     * The API validates that the parent exists and that its parent chain is not circular.
+     */
     function Update(params: {
         api?: BruceApi.Api;
         workflowItem: IItem;
@@ -128,6 +156,27 @@ export declare namespace WorkflowItem {
     }): Promise<{
         workflowItem: IItem;
     }>;
+    /** Updates only the priority of an existing item. Pass null to clear it. */
+    function UpdatePriority(params: {
+        api?: BruceApi.Api;
+        workflowItemId: WorkflowItemId;
+        priority: number | null;
+        req?: Api.IReqParams;
+    }): Promise<{
+        workflowItem: IItem;
+    }>;
+    /**
+     * Updates only the parent of an existing item. Pass null to detach it.
+     * The API validates parent existence and rejects circular parent chains.
+     */
+    function UpdateParent(params: {
+        api?: BruceApi.Api;
+        workflowItemId: WorkflowItemId;
+        parentItemId: number | null;
+        req?: Api.IReqParams;
+    }): Promise<{
+        workflowItem: IItem;
+    }>;
     function Delete(params: {
         api?: BruceApi.Api;
         workflowItemId: WorkflowItemId;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bruce-models",
-    "version": "7.1.114",
+    "version": "7.1.116",
     "description": "",
     "keywords": [],
     "main": "dist/bruce-models.umd.js",