@knowledge-stack/ksapi 1.162.0 → 2.4.2

package/docs/BillingSystem.md

@@ -0,0 +1,33 @@
+
+# BillingSystem
+
+External payment platform a subscription or payment is linked to.  ``STRIPE`` serves North America; ``PING_PP`` (Ping++, a mainland-China payment aggregator fronting Alipay + WeChat Pay) serves China. Rows with no external billing linkage (free / admin-issued / synthetic fall-back subscriptions) carry NULL instead of a value.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { BillingSystem } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies BillingSystem
+
+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 BillingSystem
+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/ChangeSubscriptionRequest.md

@@ -1,7 +1,7 @@
 
 # ChangeSubscriptionRequest
 
-Body for ``POST /v1/tenants/{tenant_id}/subscriptions``.
+Body for ``POST /v1/tenants/{tenant_id}/subscriptions``.  For a priced plan, ``interval`` and ``billing_system`` are required (``channel`` too for Ping++); the response carries the provider checkout to complete. For the free plan they are ignored — the downgrade is applied immediately (unbilled tenants) or scheduled for period end (billed tenants).
 
 ## Properties
 
@@ -9,6 +9,10 @@ Name | Type
 ------------ | -------------
 `subscriptionId` | string
 `numSeats` | number
+`interval` | [BillingInterval](BillingInterval.md)
+`billingSystem` | [BillingSystem](BillingSystem.md)
+`channel` | string
+`channelExtra` | { [key: string]: any; }
 
 ## Example
 
@@ -19,6 +23,10 @@ import type { ChangeSubscriptionRequest } from '@knowledge-stack/ksapi'
 const example = {
   "subscriptionId": null,
   "numSeats": null,
+  "interval": null,
+  "billingSystem": null,
+  "channel": null,
+  "channelExtra": null,
 } satisfies ChangeSubscriptionRequest
 
 console.log(example)

package/docs/CheckoutAction.md

@@ -0,0 +1,33 @@
+
+# CheckoutAction
+
+What the client must do next after a subscription-change request.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { CheckoutAction } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies CheckoutAction
+
+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 CheckoutAction
+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/CheckoutResponse.md

@@ -0,0 +1,41 @@
+
+# CheckoutResponse
+
+Result of ``POST /v1/tenants/{tenant_id}/subscriptions``.  ``REDIRECT`` → send the browser to ``url`` (Stripe Checkout). ``CREDENTIAL`` → feed ``credential`` to the Ping++ JS SDK to invoke the chosen channel. ``SCHEDULED`` → nothing to pay; the current billed subscription will not renew and expires at period end. ``APPLIED`` → the change is already in effect (free-plan downgrade of an unbilled tenant, or a no-op request).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`action` | [CheckoutAction](CheckoutAction.md)
+`billingSystem` | [BillingSystem](BillingSystem.md)
+`url` | string
+`credential` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { CheckoutResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "action": null,
+  "billingSystem": null,
+  "url": null,
+  "credential": null,
+} satisfies CheckoutResponse
+
+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 CheckoutResponse
+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

@@ -7,6 +7,9 @@ Create a new workflow definition.  Inputs are per-run (see ``POST /workflow-defi
 
 Name | Type
 ------------ | -------------
+`scheduleCadence` | [ScheduleCadence](ScheduleCadence.md)
+`scheduleStartAt` | Date
+`scheduleTimezone` | string
 `name` | string
 `description` | string
 `maxRunDurationSeconds` | number
@@ -24,6 +27,9 @@ import type { CreateWorkflowDefinitionRequest } from '@knowledge-stack/ksapi'
 
 // TODO: Update the object below with actual values
 const example = {
+  "scheduleCadence": null,
+  "scheduleStartAt": null,
+  "scheduleTimezone": null,
   "name": null,
   "description": null,
   "maxRunDurationSeconds": null,

package/docs/DocumentVersionsApi.md

@@ -177,7 +177,7 @@ example().catch(console.error);
 
 Create Document Version Handler
 
-Create a new version for a document.  The version number is automatically incremented from the highest existing version.
+Create a new version for a document.  Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").  The version number is automatically incremented from the highest existing version.
 
 ### Example
 
@@ -252,7 +252,7 @@ example().catch(console.error);
 
 Delete Document Version Handler
 
-Delete a document version by its ID.  Cannot delete the active version of a document.
+Delete a document version by its ID.  Requires an active document checkout held by the caller on the **parent document** (the version itself carries no lock). Acquire one via ``POST /v1/documents/{id}/checkout`` first; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").  Cannot delete the active version of a document.
 
 ### Example
 

package/docs/DocumentsApi.md

@@ -736,7 +736,7 @@ example().catch(console.error);
 
 Ingest Document Version Handler
 
-Upload a new file for an existing document, creating a new version and triggering ingestion.  Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated.  Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
+Upload a new file for an existing document, creating a new version and triggering ingestion.  Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\").  Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated.  Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
 
 ### Example
 

package/docs/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaR.md

@@ -38,6 +38,9 @@ Name | Type
 `copyCount` | number
 `lastRun` | [LastRunSummary](LastRunSummary.md)
 `pendingApprovalCount` | number
+`scheduleCadence` | [ScheduleCadence](ScheduleCadence.md)
+`scheduleStartAt` | Date
+`scheduleTimezone` | string
 `workflowDefinitionId` | string
 `triggeredBy` | [UserInfo](UserInfo.md)
 `executionState` | [WorkflowExecutionState](WorkflowExecutionState.md)
@@ -110,6 +113,9 @@ const example = {
   "copyCount": null,
   "lastRun": null,
   "pendingApprovalCount": null,
+  "scheduleCadence": null,
+  "scheduleStartAt": null,
+  "scheduleTimezone": null,
   "workflowDefinitionId": null,
   "triggeredBy": null,
   "executionState": null,

package/docs/IdpConfig.md

@@ -9,6 +9,7 @@ Name | Type
 ------------ | -------------
 `provider` | [SupportedIdP](SupportedIdP.md)
 `_configuration` | { [key: string]: any; }
+`syncCrontab` | string
 
 ## Example
 
@@ -19,6 +20,7 @@ import type { IdpConfig } from '@knowledge-stack/ksapi'
 const example = {
   "provider": null,
   "_configuration": null,
+  "syncCrontab": null,
 } satisfies IdpConfig
 
 console.log(example)

package/docs/PaginatedResponseBillingPaymentResponse.md

@@ -0,0 +1,40 @@
+
+# PaginatedResponseBillingPaymentResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<BillingPaymentResponse>](BillingPaymentResponse.md)
+`total` | number
+`limit` | number
+`offset` | number
+
+## Example
+
+```typescript
+import type { PaginatedResponseBillingPaymentResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "total": null,
+  "limit": null,
+  "offset": null,
+} satisfies PaginatedResponseBillingPaymentResponse
+
+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 PaginatedResponseBillingPaymentResponse
+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/ScheduleCadence.md

@@ -0,0 +1,33 @@
+
+# ScheduleCadence
+
+How often a workflow definition runs itself.  The cadence names the recurrence; the time of day, weekday and day of month all come from the definition\'s ``schedule_start_at``, so an illegal combination (a daily cadence carrying a weekday, say) cannot be expressed. ``None`` on the definition means manual-only — the state every definition is in today.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ScheduleCadence } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ScheduleCadence
+
+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 ScheduleCadence
+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/SubscriptionPlanResponse.md

@@ -15,6 +15,10 @@ Name | Type
 `mediaMinutes` | number
 `maxSeats` | number
 `_public` | boolean
+`priceMonthlyUsdCents` | number
+`priceAnnualUsdCents` | number
+`priceMonthlyCnyFen` | number
+`priceAnnualCnyFen` | number
 `createdAt` | Date
 `updatedAt` | Date
 
@@ -33,6 +37,10 @@ const example = {
   "mediaMinutes": null,
   "maxSeats": null,
   "_public": null,
+  "priceMonthlyUsdCents": null,
+  "priceAnnualUsdCents": null,
+  "priceMonthlyCnyFen": null,
+  "priceAnnualCnyFen": null,
   "createdAt": null,
   "updatedAt": null,
 } satisfies SubscriptionPlanResponse

package/docs/SubscriptionsApi.md

@@ -11,11 +11,11 @@ All URIs are relative to *http://localhost:8000*
 
 ## changeTenantSubscription
 
-> SubmitSubscriptionResponse changeTenantSubscription(tenantId, changeSubscriptionRequest, idempotencyKey)
+> CheckoutResponse changeTenantSubscription(tenantId, changeSubscriptionRequest)
 
 Change Tenant Subscription Handler
 
-Submit a subscription change (mock-Stripe).  OWNER-only on the target tenant. Validates the request (tenant + plan exist, ``num_seats`` within bounds), submits the (mock-)Stripe subscription update, and returns 202. The plan/seat write is NOT applied here — that happens in ``POST /webhooks/stripe/subscription`` after Stripe confirms the change.  Async two-hop workflow per ``docs/billing_additional_limits.md`` §\"Async payment workflow\": the dev environment exercises the same submit/webhook split as production will when the real Stripe SDK replaces the log-line stub in ``notify_billing``.  Optional ``Idempotency-Key`` request header is forwarded to Stripe verbatim (clients that retry the same logical operation MUST send the same value across attempts; Stripe collapses duplicates server- side). Absent the header, the server generates a fresh ``uuid4()`` per call and emits a warning — but only when a Stripe call is actually about to fire (i.e. the validation passed AND the change is not a no-op). Warning before validation would false-positive on every 4xx and on every redundant submit.  **Header value lands in structured logs.** The header value is forwarded into the ``stripe.update_subscription`` log event\'s ``idempotency_key`` field (and into the eventual real Stripe call). Use opaque random IDs (e.g. ``uuid4()``); do NOT pass user identifiers, tokens, or other sensitive material as the ``Idempotency-Key`` header.
+Start a subscription change (OWNER only).  Priced plan → validates the request, creates a provider checkout (Stripe Checkout redirect / Ping++ charge credential), and returns it — nothing is written until the provider\'s webhook confirms payment. Free plan → applied immediately for unbilled tenants, or scheduled for period end when a billed subscription is active (Stripe: ``cancel_at_period_end``; Ping++ prepay simply isn\'t renewed). Re-picking the current plan/seats while a Stripe cancellation is scheduled resumes the renewal. Deployments with no payment provider configured return 501 for priced checkouts (billing is optional — local-first).
 
 ### Example
 
@@ -41,8 +41,6 @@ async function example() {
     tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // ChangeSubscriptionRequest
     changeSubscriptionRequest: ...,
-    // string (optional)
-    idempotencyKey: idempotencyKey_example,
   } satisfies ChangeTenantSubscriptionRequest;
 
   try {
@@ -64,11 +62,10 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **tenantId** | `string` |  | [Defaults to `undefined`] |
 | **changeSubscriptionRequest** | [ChangeSubscriptionRequest](ChangeSubscriptionRequest.md) |  | |
-| **idempotencyKey** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
-[**SubmitSubscriptionResponse**](SubmitSubscriptionResponse.md)
+[**CheckoutResponse**](CheckoutResponse.md)
 
 ### Authorization
 
@@ -83,7 +80,7 @@ example().catch(console.error);
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **202** | Successful Response |  -  |
+| **200** | Successful Response |  -  |
 | **422** | Validation Error |  -  |
 | **0** | Error response. |  -  |
 
@@ -92,11 +89,11 @@ example().catch(console.error);
 
 ## getTenantSubscription
 
-> SubscriptionPlanResponse getTenantSubscription(tenantId)
+> TenantSubscriptionResponse getTenantSubscription(tenantId)
 
 Get Tenant Subscription Handler
 
-Read the tenant\'s current subscription plan, including private tiers.  Any active member of the tenant can read. This is the only path that surfaces private (custom enterprise) plans to non-admin users — ``GET /public/subscriptions`` filters them out, but tenants on a private plan still need to see their own caps. Returns the full plan body (id, name, caps, max_seats, public flag, timestamps).  Returns 404 when the user is not a member of the tenant — same response shape as a non-existent tenant so we don\'t leak existence to outsiders.
+Read the tenant\'s current subscription: plan body + period state.  Any active member of the tenant can read. This is the only path that surfaces private (custom enterprise) plans to non-admin users — ``GET /public/subscriptions`` filters them out, but tenants on a private plan still need to see their own caps. The period fields let the FE render renewal/expiry state (billed subscriptions carry the paid-through date; unbilled ones a 100-year horizon), and ``will_renew`` distinguishes an auto-renewing Stripe subscription from one whose cancellation is scheduled (or a prepay/unbilled period that simply runs out).  Returns 404 when the user is not a member of the tenant — same response shape as a non-existent tenant so we don\'t leak existence to outsiders.
 
 ### Example
 
@@ -143,7 +140,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**SubscriptionPlanResponse**](SubscriptionPlanResponse.md)
+[**TenantSubscriptionResponse**](TenantSubscriptionResponse.md)
 
 ### Authorization
 

package/docs/TenantSubscriptionResponse.md

@@ -0,0 +1,47 @@
+
+# TenantSubscriptionResponse
+
+The tenant\'s current subscription: plan body + period state.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`plan` | [SubscriptionPlanResponse](SubscriptionPlanResponse.md)
+`numSeats` | number
+`startDate` | Date
+`endDate` | Date
+`billingSystem` | [BillingSystem](BillingSystem.md)
+`interval` | [BillingInterval](BillingInterval.md)
+`willRenew` | boolean
+
+## Example
+
+```typescript
+import type { TenantSubscriptionResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "plan": null,
+  "numSeats": null,
+  "startDate": null,
+  "endDate": null,
+  "billingSystem": null,
+  "interval": null,
+  "willRenew": null,
+} satisfies TenantSubscriptionResponse
+
+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 TenantSubscriptionResponse
+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/TenantsApi.md

@@ -181,7 +181,7 @@ example().catch(console.error);
 
 Delete Tenant
 
-Delete a tenant.  Requires OWNER role in the tenant. Deletes the tenant\'s LiteLLM team/keys and S3 bucket after the DB transaction commits.
+Delete a tenant.  Requires OWNER role in the tenant. Refused (409) while a provider-billed subscription is live — deleting the tenant would not stop Stripe/Ping++ from charging for it; the OWNER must downgrade to free (or let the prepay period expire) first. Deletes the tenant\'s LiteLLM team/keys and S3 bucket after the DB transaction commits.
 
 ### Example
 

package/docs/TrashApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *http://localhost:8000*
 |------------- | ------------- | -------------|
 | [**bulkPermanentlyDeleteTrash**](TrashApi.md#bulkpermanentlydeletetrash) | **POST** /v1/trash/bulk-delete | Bulk Permanently Delete Trash Handler |
 | [**bulkRestoreTrash**](TrashApi.md#bulkrestoretrash) | **POST** /v1/trash/bulk-restore | Bulk Restore Trash Handler |
+| [**getTrashItem**](TrashApi.md#gettrashitem) | **GET** /v1/trash/{path_part_id} | Get Trash Item Handler |
 | [**listTrash**](TrashApi.md#listtrash) | **GET** /v1/trash | List Trash Handler |
 | [**permanentlyDeleteTrashItem**](TrashApi.md#permanentlydeletetrashitem) | **DELETE** /v1/trash/{path_part_id} | Permanently Delete Trash Item Handler |
 | [**restoreTrashItem**](TrashApi.md#restoretrashitem) | **POST** /v1/trash/{path_part_id}/restore | Restore Trash Item Handler |
@@ -162,6 +163,81 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getTrashItem
+
+> TrashItemDetailResponse getTrashItem(pathPartId)
+
+Get Trash Item Handler
+
+Fetch a single trash root, with a preview URL for DOCUMENT items.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TrashApi,
+} from '@knowledge-stack/ksapi';
+import type { GetTrashItemRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new TrashApi(config);
+
+  const body = {
+    // string | Trashed PathPart ID
+    pathPartId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetTrashItemRequest;
+
+  try {
+    const data = await api.getTrashItem(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pathPartId** | `string` | Trashed PathPart ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**TrashItemDetailResponse**](TrashItemDetailResponse.md)
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+| **0** | Error response. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## listTrash
 
 > PaginatedResponseTrashItemResponse listTrash(sortOrder, sortDir, deletedBy, partType, ownerId, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)

package/docs/TrashItemDetailResponse.md

@@ -0,0 +1,55 @@
+
+# TrashItemDetailResponse
+
+A single trash item plus a preview link for DOCUMENT items.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pathPartId` | string
+`metadataObjId` | string
+`partType` | [PartType](PartType.md)
+`name` | string
+`parentPathPartId` | string
+`materializedPath` | string
+`deletedAt` | Date
+`deletedBy` | string
+`documentType` | [DocumentType](DocumentType.md)
+`owner` | [UserInfo](UserInfo.md)
+`assetS3Url` | string
+
+## Example
+
+```typescript
+import type { TrashItemDetailResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pathPartId": null,
+  "metadataObjId": null,
+  "partType": null,
+  "name": null,
+  "parentPathPartId": null,
+  "materializedPath": null,
+  "deletedAt": null,
+  "deletedBy": null,
+  "documentType": null,
+  "owner": null,
+  "assetS3Url": null,
+} satisfies TrashItemDetailResponse
+
+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 TrashItemDetailResponse
+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/TrashItemResponse.md

@@ -15,6 +15,7 @@ Name | Type
 `materializedPath` | string
 `deletedAt` | Date
 `deletedBy` | string
+`documentType` | [DocumentType](DocumentType.md)
 `owner` | [UserInfo](UserInfo.md)
 
 ## Example
@@ -32,6 +33,7 @@ const example = {
   "materializedPath": null,
   "deletedAt": null,
   "deletedBy": null,
+  "documentType": null,
   "owner": null,
 } satisfies TrashItemResponse
 

package/docs/UpdateWorkflowDefinitionRequest.md

@@ -7,6 +7,9 @@ Full replacement (PUT semantics).
 
 Name | Type
 ------------ | -------------
+`scheduleCadence` | [ScheduleCadence](ScheduleCadence.md)
+`scheduleStartAt` | Date
+`scheduleTimezone` | string
 `name` | string
 `description` | string
 `maxRunDurationSeconds` | number
@@ -24,6 +27,9 @@ import type { UpdateWorkflowDefinitionRequest } from '@knowledge-stack/ksapi'
 
 // TODO: Update the object below with actual values
 const example = {
+  "scheduleCadence": null,
+  "scheduleStartAt": null,
+  "scheduleTimezone": null,
   "name": null,
   "description": null,
   "maxRunDurationSeconds": null,

package/docs/WorkflowDefinitionResponse.md

@@ -28,6 +28,9 @@ Name | Type
 `pendingApprovalCount` | number
 `approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
 `owner` | [UserInfo](UserInfo.md)
+`scheduleCadence` | [ScheduleCadence](ScheduleCadence.md)
+`scheduleStartAt` | Date
+`scheduleTimezone` | string
 `createdAt` | Date
 `updatedAt` | Date
 `permissions` | [ItemPermissions](ItemPermissions.md)
@@ -60,6 +63,9 @@ const example = {
   "pendingApprovalCount": null,
   "approvalState": null,
   "owner": null,
+  "scheduleCadence": null,
+  "scheduleStartAt": null,
+  "scheduleTimezone": null,
   "createdAt": null,
   "updatedAt": null,
   "permissions": null,