@knowledge-stack/ksapi 1.162.0 → 2.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +20 -2
- package/README.md +13 -3
- package/dist/apis/BillingApi.d.ts +70 -0
- package/dist/apis/BillingApi.js +120 -0
- package/dist/apis/DocumentVersionsApi.d.ts +8 -8
- package/dist/apis/DocumentVersionsApi.js +4 -4
- package/dist/apis/DocumentsApi.d.ts +4 -4
- package/dist/apis/DocumentsApi.js +2 -2
- package/dist/apis/SubscriptionsApi.d.ts +17 -20
- package/dist/apis/SubscriptionsApi.js +6 -9
- package/dist/apis/TenantsApi.d.ts +4 -4
- package/dist/apis/TenantsApi.js +2 -2
- package/dist/apis/TrashApi.d.ts +39 -1
- package/dist/apis/TrashApi.js +48 -0
- package/dist/apis/WorkflowRunsApi.d.ts +4 -4
- package/dist/apis/WorkflowRunsApi.js +2 -2
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/BillingApi.d.ts +70 -0
- package/dist/esm/apis/BillingApi.js +83 -0
- package/dist/esm/apis/DocumentVersionsApi.d.ts +8 -8
- package/dist/esm/apis/DocumentVersionsApi.js +4 -4
- package/dist/esm/apis/DocumentsApi.d.ts +4 -4
- package/dist/esm/apis/DocumentsApi.js +2 -2
- package/dist/esm/apis/SubscriptionsApi.d.ts +17 -20
- package/dist/esm/apis/SubscriptionsApi.js +7 -10
- package/dist/esm/apis/TenantsApi.d.ts +4 -4
- package/dist/esm/apis/TenantsApi.js +2 -2
- package/dist/esm/apis/TrashApi.d.ts +39 -1
- package/dist/esm/apis/TrashApi.js +49 -1
- package/dist/esm/apis/WorkflowRunsApi.d.ts +4 -4
- package/dist/esm/apis/WorkflowRunsApi.js +2 -2
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/BillingInterval.d.ts +25 -0
- package/dist/esm/models/BillingInterval.js +43 -0
- package/dist/esm/models/BillingPaymentResponse.d.ts +100 -0
- package/dist/esm/models/BillingPaymentResponse.js +75 -0
- package/dist/esm/models/BillingSystem.d.ts +30 -0
- package/dist/esm/models/BillingSystem.js +48 -0
- package/dist/esm/models/ChangeSubscriptionRequest.d.ts +34 -0
- package/dist/esm/models/ChangeSubscriptionRequest.js +10 -0
- package/dist/esm/models/CheckoutAction.d.ts +27 -0
- package/dist/esm/models/CheckoutAction.js +45 -0
- package/dist/esm/models/CheckoutResponse.d.ts +76 -0
- package/dist/esm/models/{SubmitSubscriptionResponse.js → CheckoutResponse.js} +20 -20
- package/dist/esm/models/CreateWorkflowDefinitionRequest.d.ts +19 -0
- package/dist/esm/models/CreateWorkflowDefinitionRequest.js +10 -0
- package/dist/esm/models/IdpConfig.d.ts +6 -0
- package/dist/esm/models/IdpConfig.js +10 -1
- package/dist/esm/models/PaginatedResponseBillingPaymentResponse.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseBillingPaymentResponse.js +70 -0
- package/dist/esm/models/ScheduleCadence.d.ts +32 -0
- package/dist/esm/models/ScheduleCadence.js +50 -0
- package/dist/esm/models/SubscriptionPlanResponse.d.ts +24 -0
- package/dist/esm/models/SubscriptionPlanResponse.js +8 -0
- package/dist/esm/models/{SubmitSubscriptionResponse.d.ts → TenantSubscriptionResponse.d.ts} +49 -38
- package/dist/esm/models/TenantSubscriptionResponse.js +67 -0
- package/dist/esm/models/TrashItemDetailResponse.d.ts +110 -0
- package/dist/esm/models/TrashItemDetailResponse.js +81 -0
- package/dist/esm/models/TrashItemResponse.d.ts +7 -0
- package/dist/esm/models/TrashItemResponse.js +3 -0
- package/dist/esm/models/UpdateWorkflowDefinitionRequest.d.ts +19 -0
- package/dist/esm/models/UpdateWorkflowDefinitionRequest.js +10 -0
- package/dist/esm/models/WorkflowDefinitionResponse.d.ts +19 -0
- package/dist/esm/models/WorkflowDefinitionResponse.js +7 -0
- package/dist/esm/models/index.d.ts +9 -1
- package/dist/esm/models/index.js +9 -1
- package/dist/models/BillingInterval.d.ts +25 -0
- package/dist/models/BillingInterval.js +51 -0
- package/dist/models/BillingPaymentResponse.d.ts +100 -0
- package/dist/models/BillingPaymentResponse.js +83 -0
- package/dist/models/BillingSystem.d.ts +30 -0
- package/dist/models/BillingSystem.js +56 -0
- package/dist/models/ChangeSubscriptionRequest.d.ts +34 -0
- package/dist/models/ChangeSubscriptionRequest.js +10 -0
- package/dist/models/CheckoutAction.d.ts +27 -0
- package/dist/models/CheckoutAction.js +53 -0
- package/dist/models/CheckoutResponse.d.ts +76 -0
- package/dist/models/{SubmitSubscriptionResponse.js → CheckoutResponse.js} +26 -26
- package/dist/models/CreateWorkflowDefinitionRequest.d.ts +19 -0
- package/dist/models/CreateWorkflowDefinitionRequest.js +10 -0
- package/dist/models/IdpConfig.d.ts +6 -0
- package/dist/models/IdpConfig.js +10 -1
- package/dist/models/PaginatedResponseBillingPaymentResponse.d.ts +66 -0
- package/dist/models/PaginatedResponseBillingPaymentResponse.js +78 -0
- package/dist/models/ScheduleCadence.d.ts +32 -0
- package/dist/models/ScheduleCadence.js +58 -0
- package/dist/models/SubscriptionPlanResponse.d.ts +24 -0
- package/dist/models/SubscriptionPlanResponse.js +8 -0
- package/dist/models/{SubmitSubscriptionResponse.d.ts → TenantSubscriptionResponse.d.ts} +49 -38
- package/dist/models/TenantSubscriptionResponse.js +75 -0
- package/dist/models/TrashItemDetailResponse.d.ts +110 -0
- package/dist/models/TrashItemDetailResponse.js +89 -0
- package/dist/models/TrashItemResponse.d.ts +7 -0
- package/dist/models/TrashItemResponse.js +3 -0
- package/dist/models/UpdateWorkflowDefinitionRequest.d.ts +19 -0
- package/dist/models/UpdateWorkflowDefinitionRequest.js +10 -0
- package/dist/models/WorkflowDefinitionResponse.d.ts +19 -0
- package/dist/models/WorkflowDefinitionResponse.js +7 -0
- package/dist/models/index.d.ts +9 -1
- package/dist/models/index.js +9 -1
- package/docs/BillingApi.md +90 -0
- package/docs/BillingInterval.md +33 -0
- package/docs/BillingPaymentResponse.md +51 -0
- package/docs/BillingSystem.md +33 -0
- package/docs/ChangeSubscriptionRequest.md +9 -1
- package/docs/CheckoutAction.md +33 -0
- package/docs/CheckoutResponse.md +41 -0
- package/docs/CreateWorkflowDefinitionRequest.md +6 -0
- package/docs/DocumentVersionsApi.md +2 -2
- package/docs/DocumentsApi.md +1 -1
- package/docs/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR.md +6 -0
- package/docs/IdpConfig.md +2 -0
- package/docs/PaginatedResponseBillingPaymentResponse.md +40 -0
- package/docs/ScheduleCadence.md +33 -0
- package/docs/SubscriptionPlanResponse.md +8 -0
- package/docs/SubscriptionsApi.md +7 -10
- package/docs/TenantSubscriptionResponse.md +47 -0
- package/docs/TenantsApi.md +1 -1
- package/docs/TrashApi.md +76 -0
- package/docs/TrashItemDetailResponse.md +55 -0
- package/docs/TrashItemResponse.md +2 -0
- package/docs/UpdateWorkflowDefinitionRequest.md +6 -0
- package/docs/WorkflowDefinitionResponse.md +6 -0
- package/docs/WorkflowRunsApi.md +1 -1
- package/package.json +1 -1
- package/src/apis/BillingApi.ts +142 -0
- package/src/apis/DocumentVersionsApi.ts +8 -8
- package/src/apis/DocumentsApi.ts +4 -4
- package/src/apis/SubscriptionsApi.ts +24 -31
- package/src/apis/TenantsApi.ts +4 -4
- package/src/apis/TrashApi.ts +86 -0
- package/src/apis/WorkflowRunsApi.ts +4 -4
- package/src/apis/index.ts +1 -0
- package/src/models/BillingInterval.ts +53 -0
- package/src/models/BillingPaymentResponse.ts +168 -0
- package/src/models/BillingSystem.ts +58 -0
- package/src/models/ChangeSubscriptionRequest.ts +55 -0
- package/src/models/CheckoutAction.ts +55 -0
- package/src/models/{SubmitSubscriptionResponse.ts → CheckoutResponse.ts} +61 -47
- package/src/models/CreateWorkflowDefinitionRequest.ts +37 -0
- package/src/models/IdpConfig.ts +14 -0
- package/src/models/PaginatedResponseBillingPaymentResponse.ts +130 -0
- package/src/models/ScheduleCadence.ts +60 -0
- package/src/models/SubscriptionPlanResponse.ts +32 -0
- package/src/models/TenantSubscriptionResponse.ts +159 -0
- package/src/models/TrashItemDetailResponse.ts +194 -0
- package/src/models/TrashItemResponse.ts +15 -0
- package/src/models/UpdateWorkflowDefinitionRequest.ts +37 -0
- package/src/models/WorkflowDefinitionResponse.ts +31 -0
- package/src/models/index.ts +9 -1
- package/docs/SubmitSubscriptionResponse.md +0 -39
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Knowledge Stack API
|
|
5
|
+
* Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { BillingIntervalFromJSON, BillingIntervalToJSON, } from './BillingInterval';
|
|
15
|
+
import { BillingSystemFromJSON, BillingSystemToJSON, } from './BillingSystem';
|
|
16
|
+
import { SubscriptionPlanResponseFromJSON, SubscriptionPlanResponseToJSON, } from './SubscriptionPlanResponse';
|
|
17
|
+
export const TenantSubscriptionResponsePropertyValidationAttributesMap = {};
|
|
18
|
+
/**
|
|
19
|
+
* Check if a given object implements the TenantSubscriptionResponse interface.
|
|
20
|
+
*/
|
|
21
|
+
export function instanceOfTenantSubscriptionResponse(value) {
|
|
22
|
+
if (!('plan' in value) || value['plan'] === undefined)
|
|
23
|
+
return false;
|
|
24
|
+
if (!('numSeats' in value) || value['numSeats'] === undefined)
|
|
25
|
+
return false;
|
|
26
|
+
if (!('startDate' in value) || value['startDate'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('endDate' in value) || value['endDate'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
if (!('willRenew' in value) || value['willRenew'] === undefined)
|
|
31
|
+
return false;
|
|
32
|
+
return true;
|
|
33
|
+
}
|
|
34
|
+
export function TenantSubscriptionResponseFromJSON(json) {
|
|
35
|
+
return TenantSubscriptionResponseFromJSONTyped(json, false);
|
|
36
|
+
}
|
|
37
|
+
export function TenantSubscriptionResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
38
|
+
if (json == null) {
|
|
39
|
+
return json;
|
|
40
|
+
}
|
|
41
|
+
return {
|
|
42
|
+
'plan': SubscriptionPlanResponseFromJSON(json['plan']),
|
|
43
|
+
'numSeats': json['num_seats'],
|
|
44
|
+
'startDate': (new Date(json['start_date'])),
|
|
45
|
+
'endDate': (new Date(json['end_date'])),
|
|
46
|
+
'billingSystem': json['billing_system'] == null ? undefined : BillingSystemFromJSON(json['billing_system']),
|
|
47
|
+
'interval': json['interval'] == null ? undefined : BillingIntervalFromJSON(json['interval']),
|
|
48
|
+
'willRenew': json['will_renew'],
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
export function TenantSubscriptionResponseToJSON(json) {
|
|
52
|
+
return TenantSubscriptionResponseToJSONTyped(json, false);
|
|
53
|
+
}
|
|
54
|
+
export function TenantSubscriptionResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
55
|
+
if (value == null) {
|
|
56
|
+
return value;
|
|
57
|
+
}
|
|
58
|
+
return {
|
|
59
|
+
'plan': SubscriptionPlanResponseToJSON(value['plan']),
|
|
60
|
+
'num_seats': value['numSeats'],
|
|
61
|
+
'start_date': value['startDate'].toISOString(),
|
|
62
|
+
'end_date': value['endDate'].toISOString(),
|
|
63
|
+
'billing_system': BillingSystemToJSON(value['billingSystem']),
|
|
64
|
+
'interval': BillingIntervalToJSON(value['interval']),
|
|
65
|
+
'will_renew': value['willRenew'],
|
|
66
|
+
};
|
|
67
|
+
}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Knowledge Stack API
|
|
3
|
+
* Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { PartType } from './PartType';
|
|
13
|
+
import type { DocumentType } from './DocumentType';
|
|
14
|
+
import type { UserInfo } from './UserInfo';
|
|
15
|
+
/**
|
|
16
|
+
* A single trash item plus a preview link for DOCUMENT items.
|
|
17
|
+
* @export
|
|
18
|
+
* @interface TrashItemDetailResponse
|
|
19
|
+
*/
|
|
20
|
+
export interface TrashItemDetailResponse {
|
|
21
|
+
/**
|
|
22
|
+
* PathPart ID
|
|
23
|
+
* @type {string}
|
|
24
|
+
* @memberof TrashItemDetailResponse
|
|
25
|
+
*/
|
|
26
|
+
pathPartId: string;
|
|
27
|
+
/**
|
|
28
|
+
* Underlying PDO ID
|
|
29
|
+
* @type {string}
|
|
30
|
+
* @memberof TrashItemDetailResponse
|
|
31
|
+
*/
|
|
32
|
+
metadataObjId: string;
|
|
33
|
+
/**
|
|
34
|
+
*
|
|
35
|
+
* @type {PartType}
|
|
36
|
+
* @memberof TrashItemDetailResponse
|
|
37
|
+
*/
|
|
38
|
+
partType: PartType;
|
|
39
|
+
/**
|
|
40
|
+
* Display name
|
|
41
|
+
* @type {string}
|
|
42
|
+
* @memberof TrashItemDetailResponse
|
|
43
|
+
*/
|
|
44
|
+
name: string;
|
|
45
|
+
/**
|
|
46
|
+
* Parent PathPart ID
|
|
47
|
+
* @type {string}
|
|
48
|
+
* @memberof TrashItemDetailResponse
|
|
49
|
+
*/
|
|
50
|
+
parentPathPartId: string | null;
|
|
51
|
+
/**
|
|
52
|
+
* Original materialized path
|
|
53
|
+
* @type {string}
|
|
54
|
+
* @memberof TrashItemDetailResponse
|
|
55
|
+
*/
|
|
56
|
+
materializedPath: string;
|
|
57
|
+
/**
|
|
58
|
+
* When the item was moved to trash
|
|
59
|
+
* @type {Date}
|
|
60
|
+
* @memberof TrashItemDetailResponse
|
|
61
|
+
*/
|
|
62
|
+
deletedAt: Date;
|
|
63
|
+
/**
|
|
64
|
+
* User that moved it to trash
|
|
65
|
+
* @type {string}
|
|
66
|
+
* @memberof TrashItemDetailResponse
|
|
67
|
+
*/
|
|
68
|
+
deletedBy: string | null;
|
|
69
|
+
/**
|
|
70
|
+
*
|
|
71
|
+
* @type {DocumentType}
|
|
72
|
+
* @memberof TrashItemDetailResponse
|
|
73
|
+
*/
|
|
74
|
+
documentType?: DocumentType;
|
|
75
|
+
/**
|
|
76
|
+
* Current owner (creator) of the item, or null if unowned.
|
|
77
|
+
* @type {UserInfo}
|
|
78
|
+
* @memberof TrashItemDetailResponse
|
|
79
|
+
*/
|
|
80
|
+
owner?: UserInfo | null;
|
|
81
|
+
/**
|
|
82
|
+
* Presigned URL (6-hour validity) to the document's source blob for preview; null for folders and other non-document items.
|
|
83
|
+
* @type {string}
|
|
84
|
+
* @memberof TrashItemDetailResponse
|
|
85
|
+
*/
|
|
86
|
+
assetS3Url?: string | null;
|
|
87
|
+
}
|
|
88
|
+
export declare const TrashItemDetailResponsePropertyValidationAttributesMap: {
|
|
89
|
+
[property: string]: {
|
|
90
|
+
maxLength?: number;
|
|
91
|
+
minLength?: number;
|
|
92
|
+
pattern?: string;
|
|
93
|
+
maximum?: number;
|
|
94
|
+
exclusiveMaximum?: boolean;
|
|
95
|
+
minimum?: number;
|
|
96
|
+
exclusiveMinimum?: boolean;
|
|
97
|
+
multipleOf?: number;
|
|
98
|
+
maxItems?: number;
|
|
99
|
+
minItems?: number;
|
|
100
|
+
uniqueItems?: boolean;
|
|
101
|
+
};
|
|
102
|
+
};
|
|
103
|
+
/**
|
|
104
|
+
* Check if a given object implements the TrashItemDetailResponse interface.
|
|
105
|
+
*/
|
|
106
|
+
export declare function instanceOfTrashItemDetailResponse(value: object): value is TrashItemDetailResponse;
|
|
107
|
+
export declare function TrashItemDetailResponseFromJSON(json: any): TrashItemDetailResponse;
|
|
108
|
+
export declare function TrashItemDetailResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TrashItemDetailResponse;
|
|
109
|
+
export declare function TrashItemDetailResponseToJSON(json: any): TrashItemDetailResponse;
|
|
110
|
+
export declare function TrashItemDetailResponseToJSONTyped(value?: TrashItemDetailResponse | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Knowledge Stack API
|
|
5
|
+
* Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { PartTypeFromJSON, PartTypeToJSON, } from './PartType';
|
|
15
|
+
import { DocumentTypeFromJSON, DocumentTypeToJSON, } from './DocumentType';
|
|
16
|
+
import { UserInfoFromJSON, UserInfoToJSON, } from './UserInfo';
|
|
17
|
+
export const TrashItemDetailResponsePropertyValidationAttributesMap = {};
|
|
18
|
+
/**
|
|
19
|
+
* Check if a given object implements the TrashItemDetailResponse interface.
|
|
20
|
+
*/
|
|
21
|
+
export function instanceOfTrashItemDetailResponse(value) {
|
|
22
|
+
if (!('pathPartId' in value) || value['pathPartId'] === undefined)
|
|
23
|
+
return false;
|
|
24
|
+
if (!('metadataObjId' in value) || value['metadataObjId'] === undefined)
|
|
25
|
+
return false;
|
|
26
|
+
if (!('partType' in value) || value['partType'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('name' in value) || value['name'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
if (!('parentPathPartId' in value) || value['parentPathPartId'] === undefined)
|
|
31
|
+
return false;
|
|
32
|
+
if (!('materializedPath' in value) || value['materializedPath'] === undefined)
|
|
33
|
+
return false;
|
|
34
|
+
if (!('deletedAt' in value) || value['deletedAt'] === undefined)
|
|
35
|
+
return false;
|
|
36
|
+
if (!('deletedBy' in value) || value['deletedBy'] === undefined)
|
|
37
|
+
return false;
|
|
38
|
+
return true;
|
|
39
|
+
}
|
|
40
|
+
export function TrashItemDetailResponseFromJSON(json) {
|
|
41
|
+
return TrashItemDetailResponseFromJSONTyped(json, false);
|
|
42
|
+
}
|
|
43
|
+
export function TrashItemDetailResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
44
|
+
if (json == null) {
|
|
45
|
+
return json;
|
|
46
|
+
}
|
|
47
|
+
return {
|
|
48
|
+
'pathPartId': json['path_part_id'],
|
|
49
|
+
'metadataObjId': json['metadata_obj_id'],
|
|
50
|
+
'partType': PartTypeFromJSON(json['part_type']),
|
|
51
|
+
'name': json['name'],
|
|
52
|
+
'parentPathPartId': json['parent_path_part_id'],
|
|
53
|
+
'materializedPath': json['materialized_path'],
|
|
54
|
+
'deletedAt': (new Date(json['deleted_at'])),
|
|
55
|
+
'deletedBy': json['deleted_by'],
|
|
56
|
+
'documentType': json['document_type'] == null ? undefined : DocumentTypeFromJSON(json['document_type']),
|
|
57
|
+
'owner': json['owner'] == null ? undefined : UserInfoFromJSON(json['owner']),
|
|
58
|
+
'assetS3Url': json['asset_s3_url'] == null ? undefined : json['asset_s3_url'],
|
|
59
|
+
};
|
|
60
|
+
}
|
|
61
|
+
export function TrashItemDetailResponseToJSON(json) {
|
|
62
|
+
return TrashItemDetailResponseToJSONTyped(json, false);
|
|
63
|
+
}
|
|
64
|
+
export function TrashItemDetailResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
65
|
+
if (value == null) {
|
|
66
|
+
return value;
|
|
67
|
+
}
|
|
68
|
+
return {
|
|
69
|
+
'path_part_id': value['pathPartId'],
|
|
70
|
+
'metadata_obj_id': value['metadataObjId'],
|
|
71
|
+
'part_type': PartTypeToJSON(value['partType']),
|
|
72
|
+
'name': value['name'],
|
|
73
|
+
'parent_path_part_id': value['parentPathPartId'],
|
|
74
|
+
'materialized_path': value['materializedPath'],
|
|
75
|
+
'deleted_at': value['deletedAt'].toISOString(),
|
|
76
|
+
'deleted_by': value['deletedBy'],
|
|
77
|
+
'document_type': DocumentTypeToJSON(value['documentType']),
|
|
78
|
+
'owner': UserInfoToJSON(value['owner']),
|
|
79
|
+
'asset_s3_url': value['assetS3Url'],
|
|
80
|
+
};
|
|
81
|
+
}
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { PartType } from './PartType';
|
|
13
|
+
import type { DocumentType } from './DocumentType';
|
|
13
14
|
import type { UserInfo } from './UserInfo';
|
|
14
15
|
/**
|
|
15
16
|
* A top-level item currently in trash.
|
|
@@ -65,6 +66,12 @@ export interface TrashItemResponse {
|
|
|
65
66
|
* @memberof TrashItemResponse
|
|
66
67
|
*/
|
|
67
68
|
deletedBy: string | null;
|
|
69
|
+
/**
|
|
70
|
+
*
|
|
71
|
+
* @type {DocumentType}
|
|
72
|
+
* @memberof TrashItemResponse
|
|
73
|
+
*/
|
|
74
|
+
documentType?: DocumentType;
|
|
68
75
|
/**
|
|
69
76
|
* Current owner (creator) of the item, or null if unowned.
|
|
70
77
|
* @type {UserInfo}
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
14
|
import { PartTypeFromJSON, PartTypeToJSON, } from './PartType';
|
|
15
|
+
import { DocumentTypeFromJSON, DocumentTypeToJSON, } from './DocumentType';
|
|
15
16
|
import { UserInfoFromJSON, UserInfoToJSON, } from './UserInfo';
|
|
16
17
|
export const TrashItemResponsePropertyValidationAttributesMap = {};
|
|
17
18
|
/**
|
|
@@ -52,6 +53,7 @@ export function TrashItemResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
52
53
|
'materializedPath': json['materialized_path'],
|
|
53
54
|
'deletedAt': (new Date(json['deleted_at'])),
|
|
54
55
|
'deletedBy': json['deleted_by'],
|
|
56
|
+
'documentType': json['document_type'] == null ? undefined : DocumentTypeFromJSON(json['document_type']),
|
|
55
57
|
'owner': json['owner'] == null ? undefined : UserInfoFromJSON(json['owner']),
|
|
56
58
|
};
|
|
57
59
|
}
|
|
@@ -71,6 +73,7 @@ export function TrashItemResponseToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
71
73
|
'materialized_path': value['materializedPath'],
|
|
72
74
|
'deleted_at': value['deletedAt'].toISOString(),
|
|
73
75
|
'deleted_by': value['deletedBy'],
|
|
76
|
+
'document_type': DocumentTypeToJSON(value['documentType']),
|
|
74
77
|
'owner': UserInfoToJSON(value['owner']),
|
|
75
78
|
};
|
|
76
79
|
}
|
|
@@ -9,12 +9,31 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { ScheduleCadence } from './ScheduleCadence';
|
|
12
13
|
/**
|
|
13
14
|
* Full replacement (PUT semantics).
|
|
14
15
|
* @export
|
|
15
16
|
* @interface UpdateWorkflowDefinitionRequest
|
|
16
17
|
*/
|
|
17
18
|
export interface UpdateWorkflowDefinitionRequest {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {ScheduleCadence}
|
|
22
|
+
* @memberof UpdateWorkflowDefinitionRequest
|
|
23
|
+
*/
|
|
24
|
+
scheduleCadence?: ScheduleCadence;
|
|
25
|
+
/**
|
|
26
|
+
* First occurrence. Read in ``schedule_timezone``, so its local wall time, weekday and day of month drive the recurrence. A MONTHLY schedule must land on or before the 28th: Temporal silently skips months that are too short.
|
|
27
|
+
* @type {Date}
|
|
28
|
+
* @memberof UpdateWorkflowDefinitionRequest
|
|
29
|
+
*/
|
|
30
|
+
scheduleStartAt?: Date | null;
|
|
31
|
+
/**
|
|
32
|
+
* IANA zone the schedule fires in, e.g. ``Asia/Shanghai``. Optional: omit it to inherit the tenant timezone. Only set it to fire in a different zone than the tenant's. Must be an IANA name, not an ISO offset — an offset stops meaning the same wall clock across DST.
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof UpdateWorkflowDefinitionRequest
|
|
35
|
+
*/
|
|
36
|
+
scheduleTimezone?: string | null;
|
|
18
37
|
/**
|
|
19
38
|
*
|
|
20
39
|
* @type {string}
|
|
@@ -11,7 +11,11 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
+
import { ScheduleCadenceFromJSON, ScheduleCadenceToJSON, } from './ScheduleCadence';
|
|
14
15
|
export const UpdateWorkflowDefinitionRequestPropertyValidationAttributesMap = {
|
|
16
|
+
scheduleTimezone: {
|
|
17
|
+
maxLength: 64,
|
|
18
|
+
},
|
|
15
19
|
name: {
|
|
16
20
|
maxLength: 255,
|
|
17
21
|
},
|
|
@@ -50,6 +54,9 @@ export function UpdateWorkflowDefinitionRequestFromJSONTyped(json, ignoreDiscrim
|
|
|
50
54
|
return json;
|
|
51
55
|
}
|
|
52
56
|
return {
|
|
57
|
+
'scheduleCadence': json['schedule_cadence'] == null ? undefined : ScheduleCadenceFromJSON(json['schedule_cadence']),
|
|
58
|
+
'scheduleStartAt': json['schedule_start_at'] == null ? undefined : (new Date(json['schedule_start_at'])),
|
|
59
|
+
'scheduleTimezone': json['schedule_timezone'] == null ? undefined : json['schedule_timezone'],
|
|
53
60
|
'name': json['name'],
|
|
54
61
|
'description': json['description'] == null ? undefined : json['description'],
|
|
55
62
|
'maxRunDurationSeconds': json['max_run_duration_seconds'] == null ? undefined : json['max_run_duration_seconds'],
|
|
@@ -69,6 +76,9 @@ export function UpdateWorkflowDefinitionRequestToJSONTyped(value, ignoreDiscrimi
|
|
|
69
76
|
return value;
|
|
70
77
|
}
|
|
71
78
|
return {
|
|
79
|
+
'schedule_cadence': ScheduleCadenceToJSON(value['scheduleCadence']),
|
|
80
|
+
'schedule_start_at': value['scheduleStartAt'] == null ? value['scheduleStartAt'] : value['scheduleStartAt'].toISOString(),
|
|
81
|
+
'schedule_timezone': value['scheduleTimezone'],
|
|
72
82
|
'name': value['name'],
|
|
73
83
|
'description': value['description'],
|
|
74
84
|
'max_run_duration_seconds': value['maxRunDurationSeconds'],
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { ItemPermissions } from './ItemPermissions';
|
|
13
|
+
import type { ScheduleCadence } from './ScheduleCadence';
|
|
13
14
|
import type { LastRunSummary } from './LastRunSummary';
|
|
14
15
|
import type { PathPartApprovalState } from './PathPartApprovalState';
|
|
15
16
|
import type { UserInfo } from './UserInfo';
|
|
@@ -151,6 +152,24 @@ export interface WorkflowDefinitionResponse {
|
|
|
151
152
|
* @memberof WorkflowDefinitionResponse
|
|
152
153
|
*/
|
|
153
154
|
owner?: UserInfo | null;
|
|
155
|
+
/**
|
|
156
|
+
*
|
|
157
|
+
* @type {ScheduleCadence}
|
|
158
|
+
* @memberof WorkflowDefinitionResponse
|
|
159
|
+
*/
|
|
160
|
+
scheduleCadence?: ScheduleCadence;
|
|
161
|
+
/**
|
|
162
|
+
* First occurrence, read in ``schedule_timezone``.
|
|
163
|
+
* @type {Date}
|
|
164
|
+
* @memberof WorkflowDefinitionResponse
|
|
165
|
+
*/
|
|
166
|
+
scheduleStartAt?: Date | null;
|
|
167
|
+
/**
|
|
168
|
+
* IANA zone the schedule fires in, e.g. ``Asia/Shanghai``. Resolved at arm time: the tenant timezone unless the caller overrode it. Null only when unscheduled.
|
|
169
|
+
* @type {string}
|
|
170
|
+
* @memberof WorkflowDefinitionResponse
|
|
171
|
+
*/
|
|
172
|
+
scheduleTimezone?: string | null;
|
|
154
173
|
/**
|
|
155
174
|
*
|
|
156
175
|
* @type {Date}
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
14
|
import { ItemPermissionsFromJSON, ItemPermissionsToJSON, } from './ItemPermissions';
|
|
15
|
+
import { ScheduleCadenceFromJSON, ScheduleCadenceToJSON, } from './ScheduleCadence';
|
|
15
16
|
import { LastRunSummaryFromJSON, LastRunSummaryToJSON, } from './LastRunSummary';
|
|
16
17
|
import { PathPartApprovalStateFromJSON, PathPartApprovalStateToJSON, } from './PathPartApprovalState';
|
|
17
18
|
import { UserInfoFromJSON, UserInfoToJSON, } from './UserInfo';
|
|
@@ -89,6 +90,9 @@ export function WorkflowDefinitionResponseFromJSONTyped(json, ignoreDiscriminato
|
|
|
89
90
|
'pendingApprovalCount': json['pending_approval_count'] == null ? undefined : json['pending_approval_count'],
|
|
90
91
|
'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
|
|
91
92
|
'owner': json['owner'] == null ? undefined : UserInfoFromJSON(json['owner']),
|
|
93
|
+
'scheduleCadence': json['schedule_cadence'] == null ? undefined : ScheduleCadenceFromJSON(json['schedule_cadence']),
|
|
94
|
+
'scheduleStartAt': json['schedule_start_at'] == null ? undefined : (new Date(json['schedule_start_at'])),
|
|
95
|
+
'scheduleTimezone': json['schedule_timezone'] == null ? undefined : json['schedule_timezone'],
|
|
92
96
|
'createdAt': (new Date(json['created_at'])),
|
|
93
97
|
'updatedAt': (new Date(json['updated_at'])),
|
|
94
98
|
'permissions': json['permissions'] == null ? undefined : ItemPermissionsFromJSON(json['permissions']),
|
|
@@ -123,6 +127,9 @@ export function WorkflowDefinitionResponseToJSONTyped(value, ignoreDiscriminator
|
|
|
123
127
|
'pending_approval_count': value['pendingApprovalCount'],
|
|
124
128
|
'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
|
|
125
129
|
'owner': UserInfoToJSON(value['owner']),
|
|
130
|
+
'schedule_cadence': ScheduleCadenceToJSON(value['scheduleCadence']),
|
|
131
|
+
'schedule_start_at': value['scheduleStartAt'] == null ? value['scheduleStartAt'] : value['scheduleStartAt'].toISOString(),
|
|
132
|
+
'schedule_timezone': value['scheduleTimezone'],
|
|
126
133
|
'created_at': value['createdAt'].toISOString(),
|
|
127
134
|
'updated_at': value['updatedAt'].toISOString(),
|
|
128
135
|
'permissions': ItemPermissionsToJSON(value['permissions']),
|
|
@@ -14,6 +14,9 @@ export * from './AppendMemoryChunkRequest';
|
|
|
14
14
|
export * from './Args';
|
|
15
15
|
export * from './AskRequest';
|
|
16
16
|
export * from './AskResponse';
|
|
17
|
+
export * from './BillingInterval';
|
|
18
|
+
export * from './BillingPaymentResponse';
|
|
19
|
+
export * from './BillingSystem';
|
|
17
20
|
export * from './BlockChangeType';
|
|
18
21
|
export * from './BlockKind';
|
|
19
22
|
export * from './BrandingLogoType';
|
|
@@ -41,6 +44,8 @@ export * from './CellDiff';
|
|
|
41
44
|
export * from './ChangeClass';
|
|
42
45
|
export * from './ChangePhoneNumberRequest';
|
|
43
46
|
export * from './ChangeSubscriptionRequest';
|
|
47
|
+
export * from './CheckoutAction';
|
|
48
|
+
export * from './CheckoutResponse';
|
|
44
49
|
export * from './CheckpointDetails';
|
|
45
50
|
export * from './ChunkBulkResponse';
|
|
46
51
|
export * from './ChunkContentItem';
|
|
@@ -194,6 +199,7 @@ export * from './OnboardingCompanyRequest';
|
|
|
194
199
|
export * from './OnboardingProfileRequest';
|
|
195
200
|
export * from './PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat';
|
|
196
201
|
export * from './PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator';
|
|
202
|
+
export * from './PaginatedResponseBillingPaymentResponse';
|
|
197
203
|
export * from './PaginatedResponseDocumentResponse';
|
|
198
204
|
export * from './PaginatedResponseDocumentVersionResponse';
|
|
199
205
|
export * from './PaginatedResponseEventResponse';
|
|
@@ -253,6 +259,7 @@ export * from './RunFolder';
|
|
|
253
259
|
export * from './RunFolderRef';
|
|
254
260
|
export * from './RunTimeseriesResponse';
|
|
255
261
|
export * from './SSOInitiateResponse';
|
|
262
|
+
export * from './ScheduleCadence';
|
|
256
263
|
export * from './ScoredChunkResponse';
|
|
257
264
|
export * from './SearchSkillsRequest';
|
|
258
265
|
export * from './SearchSkillsResponse';
|
|
@@ -285,7 +292,6 @@ export * from './StructuredChange';
|
|
|
285
292
|
export * from './StructuredChangeType';
|
|
286
293
|
export * from './StructuredDiff';
|
|
287
294
|
export * from './SubmitFeedbackRequest';
|
|
288
|
-
export * from './SubmitSubscriptionResponse';
|
|
289
295
|
export * from './SubscriptionPlanResponse';
|
|
290
296
|
export * from './SubtreeChunkGroup';
|
|
291
297
|
export * from './SubtreeChunksResponse';
|
|
@@ -302,6 +308,7 @@ export * from './TenantQuotaStateResponse';
|
|
|
302
308
|
export * from './TenantResponse';
|
|
303
309
|
export * from './TenantSettingsResponse';
|
|
304
310
|
export * from './TenantSettingsUpdate';
|
|
311
|
+
export * from './TenantSubscriptionResponse';
|
|
305
312
|
export * from './TenantUserEditRequest';
|
|
306
313
|
export * from './TenantUserOrder';
|
|
307
314
|
export * from './TenantUserResponse';
|
|
@@ -323,6 +330,7 @@ export * from './ToolPart';
|
|
|
323
330
|
export * from './ToolStatus';
|
|
324
331
|
export * from './TransferOwnerRequest';
|
|
325
332
|
export * from './TransferOwnerResponse';
|
|
333
|
+
export * from './TrashItemDetailResponse';
|
|
326
334
|
export * from './TrashItemResponse';
|
|
327
335
|
export * from './UpdateApiConnectionRequest';
|
|
328
336
|
export * from './UpdateChunkContentRequest';
|
package/dist/esm/models/index.js
CHANGED
|
@@ -16,6 +16,9 @@ export * from './AppendMemoryChunkRequest';
|
|
|
16
16
|
export * from './Args';
|
|
17
17
|
export * from './AskRequest';
|
|
18
18
|
export * from './AskResponse';
|
|
19
|
+
export * from './BillingInterval';
|
|
20
|
+
export * from './BillingPaymentResponse';
|
|
21
|
+
export * from './BillingSystem';
|
|
19
22
|
export * from './BlockChangeType';
|
|
20
23
|
export * from './BlockKind';
|
|
21
24
|
export * from './BrandingLogoType';
|
|
@@ -43,6 +46,8 @@ export * from './CellDiff';
|
|
|
43
46
|
export * from './ChangeClass';
|
|
44
47
|
export * from './ChangePhoneNumberRequest';
|
|
45
48
|
export * from './ChangeSubscriptionRequest';
|
|
49
|
+
export * from './CheckoutAction';
|
|
50
|
+
export * from './CheckoutResponse';
|
|
46
51
|
export * from './CheckpointDetails';
|
|
47
52
|
export * from './ChunkBulkResponse';
|
|
48
53
|
export * from './ChunkContentItem';
|
|
@@ -196,6 +201,7 @@ export * from './OnboardingCompanyRequest';
|
|
|
196
201
|
export * from './OnboardingProfileRequest';
|
|
197
202
|
export * from './PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDat';
|
|
198
203
|
export * from './PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator';
|
|
204
|
+
export * from './PaginatedResponseBillingPaymentResponse';
|
|
199
205
|
export * from './PaginatedResponseDocumentResponse';
|
|
200
206
|
export * from './PaginatedResponseDocumentVersionResponse';
|
|
201
207
|
export * from './PaginatedResponseEventResponse';
|
|
@@ -255,6 +261,7 @@ export * from './RunFolder';
|
|
|
255
261
|
export * from './RunFolderRef';
|
|
256
262
|
export * from './RunTimeseriesResponse';
|
|
257
263
|
export * from './SSOInitiateResponse';
|
|
264
|
+
export * from './ScheduleCadence';
|
|
258
265
|
export * from './ScoredChunkResponse';
|
|
259
266
|
export * from './SearchSkillsRequest';
|
|
260
267
|
export * from './SearchSkillsResponse';
|
|
@@ -287,7 +294,6 @@ export * from './StructuredChange';
|
|
|
287
294
|
export * from './StructuredChangeType';
|
|
288
295
|
export * from './StructuredDiff';
|
|
289
296
|
export * from './SubmitFeedbackRequest';
|
|
290
|
-
export * from './SubmitSubscriptionResponse';
|
|
291
297
|
export * from './SubscriptionPlanResponse';
|
|
292
298
|
export * from './SubtreeChunkGroup';
|
|
293
299
|
export * from './SubtreeChunksResponse';
|
|
@@ -304,6 +310,7 @@ export * from './TenantQuotaStateResponse';
|
|
|
304
310
|
export * from './TenantResponse';
|
|
305
311
|
export * from './TenantSettingsResponse';
|
|
306
312
|
export * from './TenantSettingsUpdate';
|
|
313
|
+
export * from './TenantSubscriptionResponse';
|
|
307
314
|
export * from './TenantUserEditRequest';
|
|
308
315
|
export * from './TenantUserOrder';
|
|
309
316
|
export * from './TenantUserResponse';
|
|
@@ -325,6 +332,7 @@ export * from './ToolPart';
|
|
|
325
332
|
export * from './ToolStatus';
|
|
326
333
|
export * from './TransferOwnerRequest';
|
|
327
334
|
export * from './TransferOwnerResponse';
|
|
335
|
+
export * from './TrashItemDetailResponse';
|
|
328
336
|
export * from './TrashItemResponse';
|
|
329
337
|
export * from './UpdateApiConnectionRequest';
|
|
330
338
|
export * from './UpdateChunkContentRequest';
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Knowledge Stack API
|
|
3
|
+
* Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Self-serve billing period length.
|
|
14
|
+
* @export
|
|
15
|
+
*/
|
|
16
|
+
export declare const BillingInterval: {
|
|
17
|
+
readonly Monthly: 'MONTHLY';
|
|
18
|
+
readonly Annual: 'ANNUAL';
|
|
19
|
+
};
|
|
20
|
+
export type BillingInterval = typeof BillingInterval[keyof typeof BillingInterval];
|
|
21
|
+
export declare function instanceOfBillingInterval(value: any): boolean;
|
|
22
|
+
export declare function BillingIntervalFromJSON(json: any): BillingInterval;
|
|
23
|
+
export declare function BillingIntervalFromJSONTyped(json: any, ignoreDiscriminator: boolean): BillingInterval;
|
|
24
|
+
export declare function BillingIntervalToJSON(value?: BillingInterval | null): any;
|
|
25
|
+
export declare function BillingIntervalToJSONTyped(value: any, ignoreDiscriminator: boolean): BillingInterval;
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Knowledge Stack API
|
|
6
|
+
* Knowledge Stack backend API for authentication and knowledge management. ## Integrating (RPA / machine clients) **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only. **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user\'s live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients. **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`; poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is terminal (anything other than `pending`/`processing`). The `Location` response header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes and returns the answer inline. Use a generous HTTP timeout. **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`. **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema\'s `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support. **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.1.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.BillingInterval = void 0;
|
|
17
|
+
exports.instanceOfBillingInterval = instanceOfBillingInterval;
|
|
18
|
+
exports.BillingIntervalFromJSON = BillingIntervalFromJSON;
|
|
19
|
+
exports.BillingIntervalFromJSONTyped = BillingIntervalFromJSONTyped;
|
|
20
|
+
exports.BillingIntervalToJSON = BillingIntervalToJSON;
|
|
21
|
+
exports.BillingIntervalToJSONTyped = BillingIntervalToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* Self-serve billing period length.
|
|
24
|
+
* @export
|
|
25
|
+
*/
|
|
26
|
+
exports.BillingInterval = {
|
|
27
|
+
Monthly: 'MONTHLY',
|
|
28
|
+
Annual: 'ANNUAL'
|
|
29
|
+
};
|
|
30
|
+
function instanceOfBillingInterval(value) {
|
|
31
|
+
for (const key in exports.BillingInterval) {
|
|
32
|
+
if (Object.prototype.hasOwnProperty.call(exports.BillingInterval, key)) {
|
|
33
|
+
if (exports.BillingInterval[key] === value) {
|
|
34
|
+
return true;
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
return false;
|
|
39
|
+
}
|
|
40
|
+
function BillingIntervalFromJSON(json) {
|
|
41
|
+
return BillingIntervalFromJSONTyped(json, false);
|
|
42
|
+
}
|
|
43
|
+
function BillingIntervalFromJSONTyped(json, ignoreDiscriminator) {
|
|
44
|
+
return json;
|
|
45
|
+
}
|
|
46
|
+
function BillingIntervalToJSON(value) {
|
|
47
|
+
return value;
|
|
48
|
+
}
|
|
49
|
+
function BillingIntervalToJSONTyped(value, ignoreDiscriminator) {
|
|
50
|
+
return value;
|
|
51
|
+
}
|