@vanillabp/bc-official-gui-client 0.0.3

package/dist/models/UserTask.d.ts

@@ -0,0 +1,206 @@
+import { UiUriType } from './UiUriType.js';
+
+/**
+ * gui
+ * Official GUI API
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * 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 UserTask
+ */
+interface UserTask {
+    /**
+     * user task id
+     * @type {string}
+     * @memberof UserTask
+     */
+    id: string;
+    /**
+     * revision of the usertask record
+     * @type {number}
+     * @memberof UserTask
+     */
+    version?: number;
+    /**
+     * The user who triggered the update. Null if the update is done by the system.
+     * @type {string}
+     * @memberof UserTask
+     */
+    initiator?: string;
+    /**
+     * The time the task was created
+     * @type {Date}
+     * @memberof UserTask
+     */
+    createdAt: Date;
+    /**
+     * The time the task was updated
+     * @type {Date}
+     * @memberof UserTask
+     */
+    updatedAt: Date;
+    /**
+     * The time the task was ended
+     * @type {Date}
+     * @memberof UserTask
+     */
+    endedAt?: Date;
+    /**
+     * The workflow module of this usertask
+     * @type {string}
+     * @memberof UserTask
+     */
+    workflowModuleId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserTask
+     */
+    comment?: string;
+    /**
+     * BPMN process ID
+     * @type {string}
+     * @memberof UserTask
+     */
+    bpmnProcessId: string;
+    /**
+     * Version of the BPMN process
+     * @type {string}
+     * @memberof UserTask
+     */
+    bpmnProcessVersion?: string;
+    /**
+     * BPMN process title
+     * @type {{ [key: string]: string; }}
+     * @memberof UserTask
+     */
+    workflowTitle?: {
+        [key: string]: string;
+    };
+    /**
+     * The unique key of the workflow
+     * @type {string}
+     * @memberof UserTask
+     */
+    workflowId?: string;
+    /**
+     * The natural ID of the workflow (e.g. order-id)
+     * @type {string}
+     * @memberof UserTask
+     */
+    businessId?: string;
+    /**
+     * The rendered title of the user-task (may contain specific data)
+     * @type {{ [key: string]: string; }}
+     * @memberof UserTask
+     */
+    title: {
+        [key: string]: string;
+    };
+    /**
+     * The BPMN user task's ID
+     * @type {string}
+     * @memberof UserTask
+     */
+    bpmnTaskId?: string;
+    /**
+     * The task's formkey
+     * @type {string}
+     * @memberof UserTask
+     */
+    taskDefinition: string;
+    /**
+     * The generic title of the user-task (must not contain specific data)
+     * @type {{ [key: string]: string; }}
+     * @memberof UserTask
+     */
+    taskDefinitionTitle?: {
+        [key: string]: string;
+    };
+    /**
+     * An URI as an entrypoint URI for UI components. Maybe a technical URL (e.g. for WEBPACK) or an URL targeting a human readable form (e.g. EXTERNAL)
+     * @type {string}
+     * @memberof UserTask
+     */
+    uiUri: string;
+    /**
+     *
+     * @type {UiUriType}
+     * @memberof UserTask
+     */
+    uiUriType: UiUriType;
+    /**
+     * An URI pointing to the workflow-module's own API (maybe used by user-task forms)
+     * @type {string}
+     * @memberof UserTask
+     */
+    workflowModuleUri: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserTask
+     */
+    assignee?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof UserTask
+     */
+    candidateUsers?: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof UserTask
+     */
+    candidateGroups?: Array<string>;
+    /**
+     *
+     * @type {Date}
+     * @memberof UserTask
+     */
+    dueDate?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof UserTask
+     */
+    followUpDate?: Date;
+    /**
+     * Properties for individual searches
+     * @type {{ [key: string]: any; }}
+     * @memberof UserTask
+     */
+    details?: {
+        [key: string]: any;
+    };
+    /**
+     * List of words for fulltext searching details
+     * @type {string}
+     * @memberof UserTask
+     */
+    detailsFulltextSearch?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof UserTask
+     */
+    read?: Date;
+}
+/**
+ * Check if a given object implements the UserTask interface.
+ */
+declare function instanceOfUserTask(value: object): boolean;
+declare function UserTaskFromJSON(json: any): UserTask;
+declare function UserTaskFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserTask;
+declare function UserTaskToJSON(value?: UserTask | null): any;
+
+export { UserTask, UserTaskFromJSON, UserTaskFromJSONTyped, UserTaskToJSON, instanceOfUserTask };

package/dist/models/UserTask.js

@@ -0,0 +1,102 @@
+import "../chunk-4TPCCB4K.js";
+import { exists } from "../runtime.js";
+import {
+  UiUriTypeFromJSON,
+  UiUriTypeToJSON
+} from "./UiUriType.js";
+function instanceOfUserTask(value) {
+  let isInstance = true;
+  isInstance = isInstance && "id" in value;
+  isInstance = isInstance && "createdAt" in value;
+  isInstance = isInstance && "updatedAt" in value;
+  isInstance = isInstance && "workflowModuleId" in value;
+  isInstance = isInstance && "bpmnProcessId" in value;
+  isInstance = isInstance && "title" in value;
+  isInstance = isInstance && "taskDefinition" in value;
+  isInstance = isInstance && "uiUri" in value;
+  isInstance = isInstance && "uiUriType" in value;
+  isInstance = isInstance && "workflowModuleUri" in value;
+  return isInstance;
+}
+function UserTaskFromJSON(json) {
+  return UserTaskFromJSONTyped(json, false);
+}
+function UserTaskFromJSONTyped(json, ignoreDiscriminator) {
+  if (json === void 0 || json === null) {
+    return json;
+  }
+  return {
+    "id": json["id"],
+    "version": !exists(json, "version") ? void 0 : json["version"],
+    "initiator": !exists(json, "initiator") ? void 0 : json["initiator"],
+    "createdAt": new Date(json["createdAt"]),
+    "updatedAt": new Date(json["updatedAt"]),
+    "endedAt": !exists(json, "endedAt") ? void 0 : new Date(json["endedAt"]),
+    "workflowModuleId": json["workflowModuleId"],
+    "comment": !exists(json, "comment") ? void 0 : json["comment"],
+    "bpmnProcessId": json["bpmnProcessId"],
+    "bpmnProcessVersion": !exists(json, "bpmnProcessVersion") ? void 0 : json["bpmnProcessVersion"],
+    "workflowTitle": !exists(json, "workflowTitle") ? void 0 : json["workflowTitle"],
+    "workflowId": !exists(json, "workflowId") ? void 0 : json["workflowId"],
+    "businessId": !exists(json, "businessId") ? void 0 : json["businessId"],
+    "title": json["title"],
+    "bpmnTaskId": !exists(json, "bpmnTaskId") ? void 0 : json["bpmnTaskId"],
+    "taskDefinition": json["taskDefinition"],
+    "taskDefinitionTitle": !exists(json, "taskDefinitionTitle") ? void 0 : json["taskDefinitionTitle"],
+    "uiUri": json["uiUri"],
+    "uiUriType": UiUriTypeFromJSON(json["uiUriType"]),
+    "workflowModuleUri": json["workflowModuleUri"],
+    "assignee": !exists(json, "assignee") ? void 0 : json["assignee"],
+    "candidateUsers": !exists(json, "candidateUsers") ? void 0 : json["candidateUsers"],
+    "candidateGroups": !exists(json, "candidateGroups") ? void 0 : json["candidateGroups"],
+    "dueDate": !exists(json, "dueDate") ? void 0 : new Date(json["dueDate"]),
+    "followUpDate": !exists(json, "followUpDate") ? void 0 : new Date(json["followUpDate"]),
+    "details": !exists(json, "details") ? void 0 : json["details"],
+    "detailsFulltextSearch": !exists(json, "detailsFulltextSearch") ? void 0 : json["detailsFulltextSearch"],
+    "read": !exists(json, "read") ? void 0 : new Date(json["read"])
+  };
+}
+function UserTaskToJSON(value) {
+  if (value === void 0) {
+    return void 0;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    "id": value.id,
+    "version": value.version,
+    "initiator": value.initiator,
+    "createdAt": value.createdAt.toISOString(),
+    "updatedAt": value.updatedAt.toISOString(),
+    "endedAt": value.endedAt === void 0 ? void 0 : value.endedAt.toISOString(),
+    "workflowModuleId": value.workflowModuleId,
+    "comment": value.comment,
+    "bpmnProcessId": value.bpmnProcessId,
+    "bpmnProcessVersion": value.bpmnProcessVersion,
+    "workflowTitle": value.workflowTitle,
+    "workflowId": value.workflowId,
+    "businessId": value.businessId,
+    "title": value.title,
+    "bpmnTaskId": value.bpmnTaskId,
+    "taskDefinition": value.taskDefinition,
+    "taskDefinitionTitle": value.taskDefinitionTitle,
+    "uiUri": value.uiUri,
+    "uiUriType": UiUriTypeToJSON(value.uiUriType),
+    "workflowModuleUri": value.workflowModuleUri,
+    "assignee": value.assignee,
+    "candidateUsers": value.candidateUsers,
+    "candidateGroups": value.candidateGroups,
+    "dueDate": value.dueDate === void 0 ? void 0 : value.dueDate.toISOString(),
+    "followUpDate": value.followUpDate === void 0 ? void 0 : value.followUpDate.toISOString(),
+    "details": value.details,
+    "detailsFulltextSearch": value.detailsFulltextSearch,
+    "read": value.read === void 0 ? void 0 : value.read.toISOString()
+  };
+}
+export {
+  UserTaskFromJSON,
+  UserTaskFromJSONTyped,
+  UserTaskToJSON,
+  instanceOfUserTask
+};

package/dist/models/UserTaskEvent.d.ts

@@ -0,0 +1,45 @@
+/**
+ * gui
+ * Official GUI API
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * 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 UserTaskEvent
+ */
+interface UserTaskEvent {
+    /**
+     *
+     * @type {string}
+     * @memberof UserTaskEvent
+     */
+    type: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserTaskEvent
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserTaskEvent
+     */
+    id: string;
+}
+/**
+ * Check if a given object implements the UserTaskEvent interface.
+ */
+declare function instanceOfUserTaskEvent(value: object): boolean;
+declare function UserTaskEventFromJSON(json: any): UserTaskEvent;
+declare function UserTaskEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserTaskEvent;
+declare function UserTaskEventToJSON(value?: UserTaskEvent | null): any;
+
+export { UserTaskEvent, UserTaskEventFromJSON, UserTaskEventFromJSONTyped, UserTaskEventToJSON, instanceOfUserTaskEvent };

package/dist/models/UserTaskEvent.js

@@ -0,0 +1,40 @@
+import "../chunk-4TPCCB4K.js";
+function instanceOfUserTaskEvent(value) {
+  let isInstance = true;
+  isInstance = isInstance && "type" in value;
+  isInstance = isInstance && "name" in value;
+  isInstance = isInstance && "id" in value;
+  return isInstance;
+}
+function UserTaskEventFromJSON(json) {
+  return UserTaskEventFromJSONTyped(json, false);
+}
+function UserTaskEventFromJSONTyped(json, ignoreDiscriminator) {
+  if (json === void 0 || json === null) {
+    return json;
+  }
+  return {
+    "type": json["type"],
+    "name": json["name"],
+    "id": json["id"]
+  };
+}
+function UserTaskEventToJSON(value) {
+  if (value === void 0) {
+    return void 0;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    "type": value.type,
+    "name": value.name,
+    "id": value.id
+  };
+}
+export {
+  UserTaskEventFromJSON,
+  UserTaskEventFromJSONTyped,
+  UserTaskEventToJSON,
+  instanceOfUserTaskEvent
+};

package/dist/models/UserTaskIds.d.ts

@@ -0,0 +1,33 @@
+/**
+ * gui
+ * Official GUI API
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * 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 UserTaskIds
+ */
+interface UserTaskIds {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof UserTaskIds
+     */
+    userTaskIds?: Array<string>;
+}
+/**
+ * Check if a given object implements the UserTaskIds interface.
+ */
+declare function instanceOfUserTaskIds(value: object): boolean;
+declare function UserTaskIdsFromJSON(json: any): UserTaskIds;
+declare function UserTaskIdsFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserTaskIds;
+declare function UserTaskIdsToJSON(value?: UserTaskIds | null): any;
+
+export { UserTaskIds, UserTaskIdsFromJSON, UserTaskIdsFromJSONTyped, UserTaskIdsToJSON, instanceOfUserTaskIds };

package/dist/models/UserTaskIds.js

@@ -0,0 +1,34 @@
+import "../chunk-4TPCCB4K.js";
+import { exists } from "../runtime.js";
+function instanceOfUserTaskIds(value) {
+  let isInstance = true;
+  return isInstance;
+}
+function UserTaskIdsFromJSON(json) {
+  return UserTaskIdsFromJSONTyped(json, false);
+}
+function UserTaskIdsFromJSONTyped(json, ignoreDiscriminator) {
+  if (json === void 0 || json === null) {
+    return json;
+  }
+  return {
+    "userTaskIds": !exists(json, "userTaskIds") ? void 0 : json["userTaskIds"]
+  };
+}
+function UserTaskIdsToJSON(value) {
+  if (value === void 0) {
+    return void 0;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    "userTaskIds": value.userTaskIds
+  };
+}
+export {
+  UserTaskIdsFromJSON,
+  UserTaskIdsFromJSONTyped,
+  UserTaskIdsToJSON,
+  instanceOfUserTaskIds
+};

package/dist/models/UserTaskRetrieveMode.d.ts

@@ -0,0 +1,28 @@
+/**
+ * gui
+ * Official GUI API
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ */
+declare const UserTaskRetrieveMode: {
+    readonly All: "All";
+    readonly OpenTasks: "OpenTasks";
+    readonly OpenTasksWithoutFollowup: "OpenTasksWithoutFollowup";
+    readonly OpenTasksWithFollowup: "OpenTasksWithFollowup";
+    readonly ClosedTasksOnly: "ClosedTasksOnly";
+};
+declare type UserTaskRetrieveMode = typeof UserTaskRetrieveMode[keyof typeof UserTaskRetrieveMode];
+declare function UserTaskRetrieveModeFromJSON(json: any): UserTaskRetrieveMode;
+declare function UserTaskRetrieveModeFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserTaskRetrieveMode;
+declare function UserTaskRetrieveModeToJSON(value?: UserTaskRetrieveMode | null): any;
+
+export { UserTaskRetrieveMode, UserTaskRetrieveModeFromJSON, UserTaskRetrieveModeFromJSONTyped, UserTaskRetrieveModeToJSON };

package/dist/models/UserTaskRetrieveMode.js

@@ -0,0 +1,23 @@
+import "../chunk-4TPCCB4K.js";
+const UserTaskRetrieveMode = {
+  All: "All",
+  OpenTasks: "OpenTasks",
+  OpenTasksWithoutFollowup: "OpenTasksWithoutFollowup",
+  OpenTasksWithFollowup: "OpenTasksWithFollowup",
+  ClosedTasksOnly: "ClosedTasksOnly"
+};
+function UserTaskRetrieveModeFromJSON(json) {
+  return UserTaskRetrieveModeFromJSONTyped(json, false);
+}
+function UserTaskRetrieveModeFromJSONTyped(json, ignoreDiscriminator) {
+  return json;
+}
+function UserTaskRetrieveModeToJSON(value) {
+  return value;
+}
+export {
+  UserTaskRetrieveMode,
+  UserTaskRetrieveModeFromJSON,
+  UserTaskRetrieveModeFromJSONTyped,
+  UserTaskRetrieveModeToJSON
+};

package/dist/models/UserTasks.d.ts

@@ -0,0 +1,50 @@
+import { Page } from './Page.js';
+import { UserTask } from './UserTask.js';
+import './UiUriType.js';
+
+/**
+ * gui
+ * Official GUI API
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * 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 UserTasks
+ */
+interface UserTasks {
+    /**
+     *
+     * @type {Date}
+     * @memberof UserTasks
+     */
+    serverTimestamp: Date;
+    /**
+     *
+     * @type {Page}
+     * @memberof UserTasks
+     */
+    page: Page;
+    /**
+     *
+     * @type {Array<UserTask>}
+     * @memberof UserTasks
+     */
+    userTasks: Array<UserTask>;
+}
+/**
+ * Check if a given object implements the UserTasks interface.
+ */
+declare function instanceOfUserTasks(value: object): boolean;
+declare function UserTasksFromJSON(json: any): UserTasks;
+declare function UserTasksFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserTasks;
+declare function UserTasksToJSON(value?: UserTasks | null): any;
+
+export { UserTasks, UserTasksFromJSON, UserTasksFromJSONTyped, UserTasksToJSON, instanceOfUserTasks };

package/dist/models/UserTasks.js

@@ -0,0 +1,48 @@
+import "../chunk-4TPCCB4K.js";
+import {
+  PageFromJSON,
+  PageToJSON
+} from "./Page.js";
+import {
+  UserTaskFromJSON,
+  UserTaskToJSON
+} from "./UserTask.js";
+function instanceOfUserTasks(value) {
+  let isInstance = true;
+  isInstance = isInstance && "serverTimestamp" in value;
+  isInstance = isInstance && "page" in value;
+  isInstance = isInstance && "userTasks" in value;
+  return isInstance;
+}
+function UserTasksFromJSON(json) {
+  return UserTasksFromJSONTyped(json, false);
+}
+function UserTasksFromJSONTyped(json, ignoreDiscriminator) {
+  if (json === void 0 || json === null) {
+    return json;
+  }
+  return {
+    "serverTimestamp": new Date(json["serverTimestamp"]),
+    "page": PageFromJSON(json["page"]),
+    "userTasks": json["userTasks"].map(UserTaskFromJSON)
+  };
+}
+function UserTasksToJSON(value) {
+  if (value === void 0) {
+    return void 0;
+  }
+  if (value === null) {
+    return null;
+  }
+  return {
+    "serverTimestamp": value.serverTimestamp.toISOString(),
+    "page": PageToJSON(value.page),
+    "userTasks": value.userTasks.map(UserTaskToJSON)
+  };
+}
+export {
+  UserTasksFromJSON,
+  UserTasksFromJSONTyped,
+  UserTasksToJSON,
+  instanceOfUserTasks
+};

package/dist/models/UserTasksRequest.d.ts

@@ -0,0 +1,66 @@
+import { UserTaskRetrieveMode } from './UserTaskRetrieveMode.js';
+
+/**
+ * gui
+ * Official GUI API
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * 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 UserTasksRequest
+ */
+interface UserTasksRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof UserTasksRequest
+     */
+    pageNumber?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof UserTasksRequest
+     */
+    pageSize?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof UserTasksRequest
+     */
+    query?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UserTasksRequest
+     */
+    sort?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserTasksRequest
+     */
+    sortAscending?: boolean;
+    /**
+     *
+     * @type {UserTaskRetrieveMode}
+     * @memberof UserTasksRequest
+     */
+    mode?: UserTaskRetrieveMode;
+}
+/**
+ * Check if a given object implements the UserTasksRequest interface.
+ */
+declare function instanceOfUserTasksRequest(value: object): boolean;
+declare function UserTasksRequestFromJSON(json: any): UserTasksRequest;
+declare function UserTasksRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserTasksRequest;
+declare function UserTasksRequestToJSON(value?: UserTasksRequest | null): any;
+
+export { UserTasksRequest, UserTasksRequestFromJSON, UserTasksRequestFromJSONTyped, UserTasksRequestToJSON, instanceOfUserTasksRequest };