@knowledge-stack/ksapi 1.162.0 → 2.4.2

package/src/apis/TrashApi.ts

@@ -23,6 +23,7 @@ import type {
   PartType,
   PathOrder,
   SortDirection,
+  TrashItemDetailResponse,
 } from '../models/index';
 import {
     BulkOperationResponseFromJSON,
@@ -41,6 +42,8 @@ import {
     PathOrderToJSON,
     SortDirectionFromJSON,
     SortDirectionToJSON,
+    TrashItemDetailResponseFromJSON,
+    TrashItemDetailResponseToJSON,
 } from '../models/index';
 
 export interface BulkPermanentlyDeleteTrashRequest {
@@ -51,6 +54,10 @@ export interface BulkRestoreTrashRequest {
     bulkTrashRequest: BulkTrashRequest;
 }
 
+export interface GetTrashItemRequest {
+    pathPartId: string;
+}
+
 export interface ListTrashRequest {
     sortOrder?: PathOrder;
     sortDir?: SortDirection;
@@ -128,6 +135,30 @@ export interface TrashApiInterface {
      */
     bulkRestoreTrash(requestParameters: BulkRestoreTrashRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BulkOperationResponse>;
 
+    /**
+     * Creates request options for getTrashItem without sending the request
+     * @param {string} pathPartId Trashed PathPart ID
+     * @throws {RequiredError}
+     * @memberof TrashApiInterface
+     */
+    getTrashItemRequestOpts(requestParameters: GetTrashItemRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Fetch a single trash root, with a preview URL for DOCUMENT items.
+     * @summary Get Trash Item Handler
+     * @param {string} pathPartId Trashed PathPart ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TrashApiInterface
+     */
+    getTrashItemRaw(requestParameters: GetTrashItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TrashItemDetailResponse>>;
+
+    /**
+     * Fetch a single trash root, with a preview URL for DOCUMENT items.
+     * Get Trash Item Handler
+     */
+    getTrashItem(requestParameters: GetTrashItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TrashItemDetailResponse>;
+
     /**
      * Creates request options for listTrash without sending the request
      * @param {PathOrder} [sortOrder] Sort order (default: LOGICAL &#x3D; deletion recency)
@@ -341,6 +372,61 @@ export class TrashApi extends runtime.BaseAPI implements TrashApiInterface {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getTrashItem without sending the request
+     */
+    async getTrashItemRequestOpts(requestParameters: GetTrashItemRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['pathPartId'] == null) {
+            throw new runtime.RequiredError(
+                'pathPartId',
+                'Required parameter "pathPartId" was null or undefined when calling getTrashItem().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/trash/{path_part_id}`;
+        urlPath = urlPath.replace(`{${"path_part_id"}}`, encodeURIComponent(String(requestParameters['pathPartId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Fetch a single trash root, with a preview URL for DOCUMENT items.
+     * Get Trash Item Handler
+     */
+    async getTrashItemRaw(requestParameters: GetTrashItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TrashItemDetailResponse>> {
+        const requestOptions = await this.getTrashItemRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TrashItemDetailResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Fetch a single trash root, with a preview URL for DOCUMENT items.
+     * Get Trash Item Handler
+     */
+    async getTrashItem(requestParameters: GetTrashItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TrashItemDetailResponse> {
+        const response = await this.getTrashItemRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for listTrash without sending the request
      */

package/src/apis/WorkflowRunsApi.ts

@@ -455,7 +455,7 @@ export interface WorkflowRunsApiInterface {
     workflowRunCallbackRequestOpts(requestParameters: WorkflowRunCallbackOperationRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * Terminal-state write seam for the in-process agent runner.  The gating Temporal activities ``mark_run_completed_activity`` and ``mark_run_failed_activity`` authenticate as the triggering user (via ``assume_user``) and POST here. Only the user who triggered the run (or OWNER/ADMIN) may write its terminal state. The handler is idempotent: a callback against an already-terminal row returns ``already_terminal`` and the activity-level retry treats it as a no-op.
+     * Terminal-state write seam for the in-process agent runner.  The gating Temporal activities ``mark_run_completed_activity`` and ``mark_run_failed_activity`` authenticate as the triggering user (via ``assume_user``) and POST here. Only the user who triggered the run (or OWNER/ADMIN) may write its terminal state. The handler is idempotent: a callback against an already-terminal row returns ``already_terminal`` and the activity-level retry treats it as a no-op.  On the first terminal transition it emails the run\'s triggering user (``run.user_id``) a completion or failure notification. Only already-loaded columns are captured in-session; recipient/language lookups and the send run post-commit and best-effort, so a rolled-back transaction never notifies and a notification failure never fails the callback.
      * @summary Workflow Run Callback Handler
      * @param {string} runId 
      * @param {WorkflowRunCallbackRequest} workflowRunCallbackRequest 
@@ -466,7 +466,7 @@ export interface WorkflowRunsApiInterface {
     workflowRunCallbackRaw(requestParameters: WorkflowRunCallbackOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowCallbackResponse>>;
 
     /**
-     * Terminal-state write seam for the in-process agent runner.  The gating Temporal activities ``mark_run_completed_activity`` and ``mark_run_failed_activity`` authenticate as the triggering user (via ``assume_user``) and POST here. Only the user who triggered the run (or OWNER/ADMIN) may write its terminal state. The handler is idempotent: a callback against an already-terminal row returns ``already_terminal`` and the activity-level retry treats it as a no-op.
+     * Terminal-state write seam for the in-process agent runner.  The gating Temporal activities ``mark_run_completed_activity`` and ``mark_run_failed_activity`` authenticate as the triggering user (via ``assume_user``) and POST here. Only the user who triggered the run (or OWNER/ADMIN) may write its terminal state. The handler is idempotent: a callback against an already-terminal row returns ``already_terminal`` and the activity-level retry treats it as a no-op.  On the first terminal transition it emails the run\'s triggering user (``run.user_id``) a completion or failure notification. Only already-loaded columns are captured in-session; recipient/language lookups and the send run post-commit and best-effort, so a rolled-back transaction never notifies and a notification failure never fails the callback.
      * Workflow Run Callback Handler
      */
     workflowRunCallback(requestParameters: WorkflowRunCallbackOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowCallbackResponse>;
@@ -1217,7 +1217,7 @@ export class WorkflowRunsApi extends runtime.BaseAPI implements WorkflowRunsApiI
     }
 
     /**
-     * Terminal-state write seam for the in-process agent runner.  The gating Temporal activities ``mark_run_completed_activity`` and ``mark_run_failed_activity`` authenticate as the triggering user (via ``assume_user``) and POST here. Only the user who triggered the run (or OWNER/ADMIN) may write its terminal state. The handler is idempotent: a callback against an already-terminal row returns ``already_terminal`` and the activity-level retry treats it as a no-op.
+     * Terminal-state write seam for the in-process agent runner.  The gating Temporal activities ``mark_run_completed_activity`` and ``mark_run_failed_activity`` authenticate as the triggering user (via ``assume_user``) and POST here. Only the user who triggered the run (or OWNER/ADMIN) may write its terminal state. The handler is idempotent: a callback against an already-terminal row returns ``already_terminal`` and the activity-level retry treats it as a no-op.  On the first terminal transition it emails the run\'s triggering user (``run.user_id``) a completion or failure notification. Only already-loaded columns are captured in-session; recipient/language lookups and the send run post-commit and best-effort, so a rolled-back transaction never notifies and a notification failure never fails the callback.
      * Workflow Run Callback Handler
      */
     async workflowRunCallbackRaw(requestParameters: WorkflowRunCallbackOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowCallbackResponse>> {
@@ -1228,7 +1228,7 @@ export class WorkflowRunsApi extends runtime.BaseAPI implements WorkflowRunsApiI
     }
 
     /**
-     * Terminal-state write seam for the in-process agent runner.  The gating Temporal activities ``mark_run_completed_activity`` and ``mark_run_failed_activity`` authenticate as the triggering user (via ``assume_user``) and POST here. Only the user who triggered the run (or OWNER/ADMIN) may write its terminal state. The handler is idempotent: a callback against an already-terminal row returns ``already_terminal`` and the activity-level retry treats it as a no-op.
+     * Terminal-state write seam for the in-process agent runner.  The gating Temporal activities ``mark_run_completed_activity`` and ``mark_run_failed_activity`` authenticate as the triggering user (via ``assume_user``) and POST here. Only the user who triggered the run (or OWNER/ADMIN) may write its terminal state. The handler is idempotent: a callback against an already-terminal row returns ``already_terminal`` and the activity-level retry treats it as a no-op.  On the first terminal transition it emails the run\'s triggering user (``run.user_id``) a completion or failure notification. Only already-loaded columns are captured in-session; recipient/language lookups and the send run post-commit and best-effort, so a rolled-back transaction never notifies and a notification failure never fails the callback.
      * Workflow Run Callback Handler
      */
     async workflowRunCallback(requestParameters: WorkflowRunCallbackOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowCallbackResponse> {

package/src/apis/index.ts

@@ -7,6 +7,7 @@ export * from './ApiConnectionsApi';
 export * from './ApiKeysApi';
 export * from './AuditEventsApi';
 export * from './AuthApi';
+export * from './BillingApi';
 export * from './BulkDeleteApi';
 export * from './BulkDownloadApi';
 export * from './BulkMoveApi';

package/src/models/BillingInterval.ts

@@ -0,0 +1,53 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * 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. 
+ *
+ * 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.
+ */
+
+
+/**
+ * Self-serve billing period length.
+ * @export
+ */
+export const BillingInterval = {
+    Monthly: 'MONTHLY',
+    Annual: 'ANNUAL'
+} as const;
+export type BillingInterval = typeof BillingInterval[keyof typeof BillingInterval];
+
+
+export function instanceOfBillingInterval(value: any): boolean {
+    for (const key in BillingInterval) {
+        if (Object.prototype.hasOwnProperty.call(BillingInterval, key)) {
+            if (BillingInterval[key as keyof typeof BillingInterval] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function BillingIntervalFromJSON(json: any): BillingInterval {
+    return BillingIntervalFromJSONTyped(json, false);
+}
+
+export function BillingIntervalFromJSONTyped(json: any, ignoreDiscriminator: boolean): BillingInterval {
+    return json as BillingInterval;
+}
+
+export function BillingIntervalToJSON(value?: BillingInterval | null): any {
+    return value as any;
+}
+
+export function BillingIntervalToJSONTyped(value: any, ignoreDiscriminator: boolean): BillingInterval {
+    return value as BillingInterval;
+}
+

package/src/models/BillingPaymentResponse.ts

@@ -0,0 +1,168 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * 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. 
+ *
+ * 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.
+ */
+
+import { mapValues } from '../runtime';
+import type { BillingSystem } from './BillingSystem';
+import {
+    BillingSystemFromJSON,
+    BillingSystemFromJSONTyped,
+    BillingSystemToJSON,
+    BillingSystemToJSONTyped,
+} from './BillingSystem';
+
+/**
+ * One confirmed payment, as shown in the tenant's billing history.
+ * 
+ * Backs in-app receipts: CN payments have no provider-hosted invoice
+ * (``invoice_url`` is NULL) — the frontend renders a receipt from
+ * these fields. Stripe payments link the hosted invoice.
+ * @export
+ * @interface BillingPaymentResponse
+ */
+export interface BillingPaymentResponse {
+    /**
+     * Payment id.
+     * @type {string}
+     * @memberof BillingPaymentResponse
+     */
+    id: string;
+    /**
+     * 
+     * @type {BillingSystem}
+     * @memberof BillingPaymentResponse
+     */
+    billingSystem: BillingSystem;
+    /**
+     * Plan purchased.
+     * @type {string}
+     * @memberof BillingPaymentResponse
+     */
+    planId: string;
+    /**
+     * Billing period purchased.
+     * @type {string}
+     * @memberof BillingPaymentResponse
+     */
+    interval: string;
+    /**
+     * Seats purchased.
+     * @type {number}
+     * @memberof BillingPaymentResponse
+     */
+    numSeats: number;
+    /**
+     * Total charged, in the currency's minor unit.
+     * @type {number}
+     * @memberof BillingPaymentResponse
+     */
+    amount: number;
+    /**
+     * USD (cents) or CNY (fen).
+     * @type {string}
+     * @memberof BillingPaymentResponse
+     */
+    currency: string;
+    /**
+     * Provider-hosted invoice/receipt, when available.
+     * @type {string}
+     * @memberof BillingPaymentResponse
+     */
+    invoiceUrl?: string | null;
+    /**
+     * When the payment confirmed.
+     * @type {Date}
+     * @memberof BillingPaymentResponse
+     */
+    createdAt: Date;
+}
+
+
+export const BillingPaymentResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+
+
+/**
+ * Check if a given object implements the BillingPaymentResponse interface.
+ */
+export function instanceOfBillingPaymentResponse(value: object): value is BillingPaymentResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('billingSystem' in value) || value['billingSystem'] === undefined) return false;
+    if (!('planId' in value) || value['planId'] === undefined) return false;
+    if (!('interval' in value) || value['interval'] === undefined) return false;
+    if (!('numSeats' in value) || value['numSeats'] === undefined) return false;
+    if (!('amount' in value) || value['amount'] === undefined) return false;
+    if (!('currency' in value) || value['currency'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function BillingPaymentResponseFromJSON(json: any): BillingPaymentResponse {
+    return BillingPaymentResponseFromJSONTyped(json, false);
+}
+
+export function BillingPaymentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): BillingPaymentResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'billingSystem': BillingSystemFromJSON(json['billing_system']),
+        'planId': json['plan_id'],
+        'interval': json['interval'],
+        'numSeats': json['num_seats'],
+        'amount': json['amount'],
+        'currency': json['currency'],
+        'invoiceUrl': json['invoice_url'] == null ? undefined : json['invoice_url'],
+        'createdAt': (new Date(json['created_at'])),
+    };
+}
+
+export function BillingPaymentResponseToJSON(json: any): BillingPaymentResponse {
+    return BillingPaymentResponseToJSONTyped(json, false);
+}
+
+export function BillingPaymentResponseToJSONTyped(value?: BillingPaymentResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'billing_system': BillingSystemToJSON(value['billingSystem']),
+        'plan_id': value['planId'],
+        'interval': value['interval'],
+        'num_seats': value['numSeats'],
+        'amount': value['amount'],
+        'currency': value['currency'],
+        'invoice_url': value['invoiceUrl'],
+        'created_at': value['createdAt'].toISOString(),
+    };
+}
+

package/src/models/BillingSystem.ts

@@ -0,0 +1,58 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * 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. 
+ *
+ * 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.
+ */
+
+
+/**
+ * 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.
+ * @export
+ */
+export const BillingSystem = {
+    Stripe: 'STRIPE',
+    PingPp: 'PING_PP'
+} as const;
+export type BillingSystem = typeof BillingSystem[keyof typeof BillingSystem];
+
+
+export function instanceOfBillingSystem(value: any): boolean {
+    for (const key in BillingSystem) {
+        if (Object.prototype.hasOwnProperty.call(BillingSystem, key)) {
+            if (BillingSystem[key as keyof typeof BillingSystem] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function BillingSystemFromJSON(json: any): BillingSystem {
+    return BillingSystemFromJSONTyped(json, false);
+}
+
+export function BillingSystemFromJSONTyped(json: any, ignoreDiscriminator: boolean): BillingSystem {
+    return json as BillingSystem;
+}
+
+export function BillingSystemToJSON(value?: BillingSystem | null): any {
+    return value as any;
+}
+
+export function BillingSystemToJSONTyped(value: any, ignoreDiscriminator: boolean): BillingSystem {
+    return value as BillingSystem;
+}
+

package/src/models/ChangeSubscriptionRequest.ts

@@ -13,8 +13,29 @@
  */
 
 import { mapValues } from '../runtime';
+import type { BillingInterval } from './BillingInterval';
+import {
+    BillingIntervalFromJSON,
+    BillingIntervalFromJSONTyped,
+    BillingIntervalToJSON,
+    BillingIntervalToJSONTyped,
+} from './BillingInterval';
+import type { BillingSystem } from './BillingSystem';
+import {
+    BillingSystemFromJSON,
+    BillingSystemFromJSONTyped,
+    BillingSystemToJSON,
+    BillingSystemToJSONTyped,
+} from './BillingSystem';
+
 /**
  * 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).
  * @export
  * @interface ChangeSubscriptionRequest
  */
@@ -31,7 +52,33 @@ export interface ChangeSubscriptionRequest {
      * @memberof ChangeSubscriptionRequest
      */
     numSeats: number;
+    /**
+     * 
+     * @type {BillingInterval}
+     * @memberof ChangeSubscriptionRequest
+     */
+    interval?: BillingInterval;
+    /**
+     * 
+     * @type {BillingSystem}
+     * @memberof ChangeSubscriptionRequest
+     */
+    billingSystem?: BillingSystem;
+    /**
+     * Ping++ payment channel chosen in the UI (e.g. 'alipay_pc_direct', 'wx_pub_qr'). Required when billing_system=PING_PP.
+     * @type {string}
+     * @memberof ChangeSubscriptionRequest
+     */
+    channel?: string | null;
+    /**
+     * Channel-specific Ping++ charge `extra` parameters (success_url, product ids, ... — see the Ping++ charge API for the chosen channel). Passed through verbatim; amounts are always resolved server-side.
+     * @type {{ [key: string]: any; }}
+     * @memberof ChangeSubscriptionRequest
+     */
+    channelExtra?: { [key: string]: any; } | null;
 }
+
+
 export const ChangeSubscriptionRequestPropertyValidationAttributesMap: {
     [property: string]: {
         maxLength?: number,
@@ -75,6 +122,10 @@ export function ChangeSubscriptionRequestFromJSONTyped(json: any, ignoreDiscrimi
         
         'subscriptionId': json['subscription_id'],
         'numSeats': json['num_seats'],
+        'interval': json['interval'] == null ? undefined : BillingIntervalFromJSON(json['interval']),
+        'billingSystem': json['billing_system'] == null ? undefined : BillingSystemFromJSON(json['billing_system']),
+        'channel': json['channel'] == null ? undefined : json['channel'],
+        'channelExtra': json['channel_extra'] == null ? undefined : json['channel_extra'],
     };
 }
 
@@ -91,6 +142,10 @@ export function ChangeSubscriptionRequestToJSONTyped(value?: ChangeSubscriptionR
         
         'subscription_id': value['subscriptionId'],
         'num_seats': value['numSeats'],
+        'interval': BillingIntervalToJSON(value['interval']),
+        'billing_system': BillingSystemToJSON(value['billingSystem']),
+        'channel': value['channel'],
+        'channel_extra': value['channelExtra'],
     };
 }
 

package/src/models/CheckoutAction.ts

@@ -0,0 +1,55 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * 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. 
+ *
+ * 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.
+ */
+
+
+/**
+ * What the client must do next after a subscription-change request.
+ * @export
+ */
+export const CheckoutAction = {
+    Redirect: 'REDIRECT',
+    Credential: 'CREDENTIAL',
+    Scheduled: 'SCHEDULED',
+    Applied: 'APPLIED'
+} as const;
+export type CheckoutAction = typeof CheckoutAction[keyof typeof CheckoutAction];
+
+
+export function instanceOfCheckoutAction(value: any): boolean {
+    for (const key in CheckoutAction) {
+        if (Object.prototype.hasOwnProperty.call(CheckoutAction, key)) {
+            if (CheckoutAction[key as keyof typeof CheckoutAction] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function CheckoutActionFromJSON(json: any): CheckoutAction {
+    return CheckoutActionFromJSONTyped(json, false);
+}
+
+export function CheckoutActionFromJSONTyped(json: any, ignoreDiscriminator: boolean): CheckoutAction {
+    return json as CheckoutAction;
+}
+
+export function CheckoutActionToJSON(value?: CheckoutAction | null): any {
+    return value as any;
+}
+
+export function CheckoutActionToJSONTyped(value: any, ignoreDiscriminator: boolean): CheckoutAction {
+    return value as CheckoutAction;
+}
+