@knowledge-stack/ksapi 1.62.2 → 1.64.0

package/dist/models/WorkflowRunSnapshot.js

@@ -0,0 +1,86 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowRunSnapshotPropertyValidationAttributesMap = void 0;
+exports.instanceOfWorkflowRunSnapshot = instanceOfWorkflowRunSnapshot;
+exports.WorkflowRunSnapshotFromJSON = WorkflowRunSnapshotFromJSON;
+exports.WorkflowRunSnapshotFromJSONTyped = WorkflowRunSnapshotFromJSONTyped;
+exports.WorkflowRunSnapshotToJSON = WorkflowRunSnapshotToJSON;
+exports.WorkflowRunSnapshotToJSONTyped = WorkflowRunSnapshotToJSONTyped;
+const ABCDPathSnapshot_1 = require("./ABCDPathSnapshot");
+const WorkflowRunnerType_1 = require("./WorkflowRunnerType");
+/**
+ * Check if a given object implements the WorkflowRunSnapshot interface.
+ */
+function instanceOfWorkflowRunSnapshot(value) {
+    if (!('workflowDefinitionId' in value) || value['workflowDefinitionId'] === undefined)
+        return false;
+    if (!('workflowName' in value) || value['workflowName'] === undefined)
+        return false;
+    if (!('runnerType' in value) || value['runnerType'] === undefined)
+        return false;
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('maxRunDurationSeconds' in value) || value['maxRunDurationSeconds'] === undefined)
+        return false;
+    if (!('sources' in value) || value['sources'] === undefined)
+        return false;
+    if (!('instructions' in value) || value['instructions'] === undefined)
+        return false;
+    if (!('outputs' in value) || value['outputs'] === undefined)
+        return false;
+    if (!('template' in value) || value['template'] === undefined)
+        return false;
+    return true;
+}
+function WorkflowRunSnapshotFromJSON(json) {
+    return WorkflowRunSnapshotFromJSONTyped(json, false);
+}
+function WorkflowRunSnapshotFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'workflowDefinitionId': json['workflow_definition_id'],
+        'workflowName': json['workflow_name'],
+        'runnerType': (0, WorkflowRunnerType_1.WorkflowRunnerTypeFromJSON)(json['runner_type']),
+        'userId': json['user_id'],
+        'maxRunDurationSeconds': json['max_run_duration_seconds'],
+        'sources': (json['sources'].map(ABCDPathSnapshot_1.ABCDPathSnapshotFromJSON)),
+        'instructions': (json['instructions'].map(ABCDPathSnapshot_1.ABCDPathSnapshotFromJSON)),
+        'outputs': (json['outputs'].map(ABCDPathSnapshot_1.ABCDPathSnapshotFromJSON)),
+        'template': (0, ABCDPathSnapshot_1.ABCDPathSnapshotFromJSON)(json['template']),
+    };
+}
+function WorkflowRunSnapshotToJSON(json) {
+    return WorkflowRunSnapshotToJSONTyped(json, false);
+}
+function WorkflowRunSnapshotToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'workflow_definition_id': value['workflowDefinitionId'],
+        'workflow_name': value['workflowName'],
+        'runner_type': (0, WorkflowRunnerType_1.WorkflowRunnerTypeToJSON)(value['runnerType']),
+        'user_id': value['userId'],
+        'max_run_duration_seconds': value['maxRunDurationSeconds'],
+        'sources': (value['sources'].map(ABCDPathSnapshot_1.ABCDPathSnapshotToJSON)),
+        'instructions': (value['instructions'].map(ABCDPathSnapshot_1.ABCDPathSnapshotToJSON)),
+        'outputs': (value['outputs'].map(ABCDPathSnapshot_1.ABCDPathSnapshotToJSON)),
+        'template': (0, ABCDPathSnapshot_1.ABCDPathSnapshotToJSON)(value['template']),
+    };
+}
+exports.WorkflowRunSnapshotPropertyValidationAttributesMap = {};

package/dist/models/WorkflowRunStatus.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.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.
+ */
+/**
+ * Lifecycle status of a workflow run.
+ * @export
+ */
+export declare const WorkflowRunStatus: {
+    readonly Pending: "PENDING";
+    readonly Running: "RUNNING";
+    readonly Completed: "COMPLETED";
+    readonly Failed: "FAILED";
+};
+export type WorkflowRunStatus = typeof WorkflowRunStatus[keyof typeof WorkflowRunStatus];
+export declare function instanceOfWorkflowRunStatus(value: any): boolean;
+export declare function WorkflowRunStatusFromJSON(json: any): WorkflowRunStatus;
+export declare function WorkflowRunStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowRunStatus;
+export declare function WorkflowRunStatusToJSON(value?: WorkflowRunStatus | null): any;
+export declare function WorkflowRunStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): WorkflowRunStatus;

package/dist/models/WorkflowRunStatus.js

@@ -0,0 +1,53 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowRunStatus = void 0;
+exports.instanceOfWorkflowRunStatus = instanceOfWorkflowRunStatus;
+exports.WorkflowRunStatusFromJSON = WorkflowRunStatusFromJSON;
+exports.WorkflowRunStatusFromJSONTyped = WorkflowRunStatusFromJSONTyped;
+exports.WorkflowRunStatusToJSON = WorkflowRunStatusToJSON;
+exports.WorkflowRunStatusToJSONTyped = WorkflowRunStatusToJSONTyped;
+/**
+ * Lifecycle status of a workflow run.
+ * @export
+ */
+exports.WorkflowRunStatus = {
+    Pending: 'PENDING',
+    Running: 'RUNNING',
+    Completed: 'COMPLETED',
+    Failed: 'FAILED'
+};
+function instanceOfWorkflowRunStatus(value) {
+    for (const key in exports.WorkflowRunStatus) {
+        if (Object.prototype.hasOwnProperty.call(exports.WorkflowRunStatus, key)) {
+            if (exports.WorkflowRunStatus[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function WorkflowRunStatusFromJSON(json) {
+    return WorkflowRunStatusFromJSONTyped(json, false);
+}
+function WorkflowRunStatusFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function WorkflowRunStatusToJSON(value) {
+    return value;
+}
+function WorkflowRunStatusToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/WorkflowRunnerType.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.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.
+ */
+/**
+ * Runner that executes the workflow.
+ * @export
+ */
+export declare const WorkflowRunnerType: {
+    readonly SelfHosted: "SELF_HOSTED";
+};
+export type WorkflowRunnerType = typeof WorkflowRunnerType[keyof typeof WorkflowRunnerType];
+export declare function instanceOfWorkflowRunnerType(value: any): boolean;
+export declare function WorkflowRunnerTypeFromJSON(json: any): WorkflowRunnerType;
+export declare function WorkflowRunnerTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowRunnerType;
+export declare function WorkflowRunnerTypeToJSON(value?: WorkflowRunnerType | null): any;
+export declare function WorkflowRunnerTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): WorkflowRunnerType;

package/dist/models/WorkflowRunnerType.js

@@ -0,0 +1,50 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowRunnerType = void 0;
+exports.instanceOfWorkflowRunnerType = instanceOfWorkflowRunnerType;
+exports.WorkflowRunnerTypeFromJSON = WorkflowRunnerTypeFromJSON;
+exports.WorkflowRunnerTypeFromJSONTyped = WorkflowRunnerTypeFromJSONTyped;
+exports.WorkflowRunnerTypeToJSON = WorkflowRunnerTypeToJSON;
+exports.WorkflowRunnerTypeToJSONTyped = WorkflowRunnerTypeToJSONTyped;
+/**
+ * Runner that executes the workflow.
+ * @export
+ */
+exports.WorkflowRunnerType = {
+    SelfHosted: 'SELF_HOSTED'
+};
+function instanceOfWorkflowRunnerType(value) {
+    for (const key in exports.WorkflowRunnerType) {
+        if (Object.prototype.hasOwnProperty.call(exports.WorkflowRunnerType, key)) {
+            if (exports.WorkflowRunnerType[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function WorkflowRunnerTypeFromJSON(json) {
+    return WorkflowRunnerTypeFromJSONTyped(json, false);
+}
+function WorkflowRunnerTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function WorkflowRunnerTypeToJSON(value) {
+    return value;
+}
+function WorkflowRunnerTypeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/index.d.ts

@@ -1,3 +1,4 @@
+export * from './ABCDPathSnapshot';
 export * from './AcceptInviteResponse';
 export * from './AddMemberRequest';
 export * from './AncestryResponse';
@@ -33,6 +34,7 @@ export * from './CreateTagRequest';
 export * from './CreateTenantRequest';
 export * from './CreateThreadMessageRequest';
 export * from './CreateThreadRequest';
+export * from './CreateWorkflowDefinitionRequest';
 export * from './DissolveSectionResponse';
 export * from './DocumentOrigin';
 export * from './DocumentResponse';
@@ -48,6 +50,10 @@ export * from './EmailVerificationRequest';
 export * from './EnrichedCitation';
 export * from './EnrichedThreadMessageContent';
 export * from './FeaturesResponse';
+export * from './FeedbackEventResponse';
+export * from './FeedbackRating';
+export * from './FeedbackReason';
+export * from './FeedbackTargetType';
 export * from './FolderAction';
 export * from './FolderActionResponse';
 export * from './FolderResponse';
@@ -64,6 +70,7 @@ export * from './IngestionMode';
 export * from './InviteResponse';
 export * from './InviteStatus';
 export * from './InviteUserRequest';
+export * from './InvokeWorkflowRequest';
 export * from './LineageEdgeResponse';
 export * from './LineageGraphResponse';
 export * from './LineageNodeResponse';
@@ -76,6 +83,7 @@ export * from './PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDi
 export * from './PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator';
 export * from './PaginatedResponseDocumentResponse';
 export * from './PaginatedResponseDocumentVersionResponse';
+export * from './PaginatedResponseFeedbackEventResponse';
 export * from './PaginatedResponseFolderResponse';
 export * from './PaginatedResponseGroupPermissionResponse';
 export * from './PaginatedResponseGroupResponse';
@@ -88,6 +96,8 @@ export * from './PaginatedResponseTenantResponse';
 export * from './PaginatedResponseTenantUserResponse';
 export * from './PaginatedResponseThreadMessageResponse';
 export * from './PaginatedResponseThreadResponse';
+export * from './PaginatedResponseWorkflowDefinitionResponse';
+export * from './PaginatedResponseWorkflowRunResponse';
 export * from './PaginatedResponseWorkflowSummaryResponse';
 export * from './PartType';
 export * from './PasswordResetRequest';
@@ -115,10 +125,13 @@ export * from './SectionContentItem';
 export * from './SectionContentItemOrChunkContentItem';
 export * from './SectionResponse';
 export * from './SectionSystemMetadata';
+export * from './SelfHostedRunnerConfig';
+export * from './SelfHostedRunnerConfigResponse';
 export * from './SignInRequest';
 export * from './StepInput';
 export * from './StepKind';
 export * from './StepOutput';
+export * from './SubmitFeedbackRequest';
 export * from './SubtreeChunkGroup';
 export * from './SubtreeChunksResponse';
 export * from './SupportedLanguage';
@@ -148,12 +161,20 @@ export * from './UpdateTagRequest';
 export * from './UpdateTenantRequest';
 export * from './UpdateThreadRequest';
 export * from './UpdateUserRequest';
+export * from './UpdateWorkflowDefinitionRequest';
 export * from './UserMessageRequest';
 export * from './UserMessageResponse';
 export * from './UserResponse';
 export * from './ValidationError';
 export * from './VersionChunkIdsResponse';
 export * from './WorkflowActionResponse';
+export * from './WorkflowCallbackResponse';
 export * from './WorkflowCancelResponse';
+export * from './WorkflowDefinitionResponse';
 export * from './WorkflowDetailResponse';
+export * from './WorkflowRunCallbackRequest';
+export * from './WorkflowRunResponse';
+export * from './WorkflowRunSnapshot';
+export * from './WorkflowRunStatus';
+export * from './WorkflowRunnerType';
 export * from './WorkflowSummaryResponse';

package/dist/models/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 /* tslint:disable */
 /* eslint-disable */
+__exportStar(require("./ABCDPathSnapshot"), exports);
 __exportStar(require("./AcceptInviteResponse"), exports);
 __exportStar(require("./AddMemberRequest"), exports);
 __exportStar(require("./AncestryResponse"), exports);
@@ -51,6 +52,7 @@ __exportStar(require("./CreateTagRequest"), exports);
 __exportStar(require("./CreateTenantRequest"), exports);
 __exportStar(require("./CreateThreadMessageRequest"), exports);
 __exportStar(require("./CreateThreadRequest"), exports);
+__exportStar(require("./CreateWorkflowDefinitionRequest"), exports);
 __exportStar(require("./DissolveSectionResponse"), exports);
 __exportStar(require("./DocumentOrigin"), exports);
 __exportStar(require("./DocumentResponse"), exports);
@@ -66,6 +68,10 @@ __exportStar(require("./EmailVerificationRequest"), exports);
 __exportStar(require("./EnrichedCitation"), exports);
 __exportStar(require("./EnrichedThreadMessageContent"), exports);
 __exportStar(require("./FeaturesResponse"), exports);
+__exportStar(require("./FeedbackEventResponse"), exports);
+__exportStar(require("./FeedbackRating"), exports);
+__exportStar(require("./FeedbackReason"), exports);
+__exportStar(require("./FeedbackTargetType"), exports);
 __exportStar(require("./FolderAction"), exports);
 __exportStar(require("./FolderActionResponse"), exports);
 __exportStar(require("./FolderResponse"), exports);
@@ -82,6 +88,7 @@ __exportStar(require("./IngestionMode"), exports);
 __exportStar(require("./InviteResponse"), exports);
 __exportStar(require("./InviteStatus"), exports);
 __exportStar(require("./InviteUserRequest"), exports);
+__exportStar(require("./InvokeWorkflowRequest"), exports);
 __exportStar(require("./LineageEdgeResponse"), exports);
 __exportStar(require("./LineageGraphResponse"), exports);
 __exportStar(require("./LineageNodeResponse"), exports);
@@ -94,6 +101,7 @@ __exportStar(require("./PaginatedResponseAnnotatedUnionFolderResponseDocumentRes
 __exportStar(require("./PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator"), exports);
 __exportStar(require("./PaginatedResponseDocumentResponse"), exports);
 __exportStar(require("./PaginatedResponseDocumentVersionResponse"), exports);
+__exportStar(require("./PaginatedResponseFeedbackEventResponse"), exports);
 __exportStar(require("./PaginatedResponseFolderResponse"), exports);
 __exportStar(require("./PaginatedResponseGroupPermissionResponse"), exports);
 __exportStar(require("./PaginatedResponseGroupResponse"), exports);
@@ -106,6 +114,8 @@ __exportStar(require("./PaginatedResponseTenantResponse"), exports);
 __exportStar(require("./PaginatedResponseTenantUserResponse"), exports);
 __exportStar(require("./PaginatedResponseThreadMessageResponse"), exports);
 __exportStar(require("./PaginatedResponseThreadResponse"), exports);
+__exportStar(require("./PaginatedResponseWorkflowDefinitionResponse"), exports);
+__exportStar(require("./PaginatedResponseWorkflowRunResponse"), exports);
 __exportStar(require("./PaginatedResponseWorkflowSummaryResponse"), exports);
 __exportStar(require("./PartType"), exports);
 __exportStar(require("./PasswordResetRequest"), exports);
@@ -133,10 +143,13 @@ __exportStar(require("./SectionContentItem"), exports);
 __exportStar(require("./SectionContentItemOrChunkContentItem"), exports);
 __exportStar(require("./SectionResponse"), exports);
 __exportStar(require("./SectionSystemMetadata"), exports);
+__exportStar(require("./SelfHostedRunnerConfig"), exports);
+__exportStar(require("./SelfHostedRunnerConfigResponse"), exports);
 __exportStar(require("./SignInRequest"), exports);
 __exportStar(require("./StepInput"), exports);
 __exportStar(require("./StepKind"), exports);
 __exportStar(require("./StepOutput"), exports);
+__exportStar(require("./SubmitFeedbackRequest"), exports);
 __exportStar(require("./SubtreeChunkGroup"), exports);
 __exportStar(require("./SubtreeChunksResponse"), exports);
 __exportStar(require("./SupportedLanguage"), exports);
@@ -166,12 +179,20 @@ __exportStar(require("./UpdateTagRequest"), exports);
 __exportStar(require("./UpdateTenantRequest"), exports);
 __exportStar(require("./UpdateThreadRequest"), exports);
 __exportStar(require("./UpdateUserRequest"), exports);
+__exportStar(require("./UpdateWorkflowDefinitionRequest"), exports);
 __exportStar(require("./UserMessageRequest"), exports);
 __exportStar(require("./UserMessageResponse"), exports);
 __exportStar(require("./UserResponse"), exports);
 __exportStar(require("./ValidationError"), exports);
 __exportStar(require("./VersionChunkIdsResponse"), exports);
 __exportStar(require("./WorkflowActionResponse"), exports);
+__exportStar(require("./WorkflowCallbackResponse"), exports);
 __exportStar(require("./WorkflowCancelResponse"), exports);
+__exportStar(require("./WorkflowDefinitionResponse"), exports);
 __exportStar(require("./WorkflowDetailResponse"), exports);
+__exportStar(require("./WorkflowRunCallbackRequest"), exports);
+__exportStar(require("./WorkflowRunResponse"), exports);
+__exportStar(require("./WorkflowRunSnapshot"), exports);
+__exportStar(require("./WorkflowRunStatus"), exports);
+__exportStar(require("./WorkflowRunnerType"), exports);
 __exportStar(require("./WorkflowSummaryResponse"), exports);

package/docs/ABCDPathSnapshot.md

@@ -0,0 +1,39 @@
+
+# ABCDPathSnapshot
+
+Snapshot of a single ABCD path reference at trigger time.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pathPartId` | string
+`materializedPath` | string
+`partType` | [PartType](PartType.md)
+
+## Example
+
+```typescript
+import type { ABCDPathSnapshot } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pathPartId": null,
+  "materializedPath": null,
+  "partType": null,
+} satisfies ABCDPathSnapshot
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ABCDPathSnapshot
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CreateWorkflowDefinitionRequest.md

@@ -0,0 +1,51 @@
+
+# CreateWorkflowDefinitionRequest
+
+Create a new workflow definition.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+`runnerType` | [WorkflowRunnerType](WorkflowRunnerType.md)
+`runnerConfig` | [SelfHostedRunnerConfig](SelfHostedRunnerConfig.md)
+`maxRunDurationSeconds` | number
+`sourcePathPartIds` | Array<string>
+`instructionPathPartIds` | Array<string>
+`outputPathPartIds` | Array<string>
+`templatePathPartId` | string
+
+## Example
+
+```typescript
+import type { CreateWorkflowDefinitionRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+  "runnerType": null,
+  "runnerConfig": null,
+  "maxRunDurationSeconds": null,
+  "sourcePathPartIds": null,
+  "instructionPathPartIds": null,
+  "outputPathPartIds": null,
+  "templatePathPartId": null,
+} satisfies CreateWorkflowDefinitionRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CreateWorkflowDefinitionRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+