@knowledge-stack/ksapi 1.163.0 → 2.4.2

package/dist/models/BillingPaymentResponse.d.ts

@@ -0,0 +1,100 @@
+/**
+ * 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 type { BillingSystem } 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 declare 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 declare function instanceOfBillingPaymentResponse(value: object): value is BillingPaymentResponse;
+export declare function BillingPaymentResponseFromJSON(json: any): BillingPaymentResponse;
+export declare function BillingPaymentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): BillingPaymentResponse;
+export declare function BillingPaymentResponseToJSON(json: any): BillingPaymentResponse;
+export declare function BillingPaymentResponseToJSONTyped(value?: BillingPaymentResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/BillingPaymentResponse.js

@@ -0,0 +1,83 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillingPaymentResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfBillingPaymentResponse = instanceOfBillingPaymentResponse;
+exports.BillingPaymentResponseFromJSON = BillingPaymentResponseFromJSON;
+exports.BillingPaymentResponseFromJSONTyped = BillingPaymentResponseFromJSONTyped;
+exports.BillingPaymentResponseToJSON = BillingPaymentResponseToJSON;
+exports.BillingPaymentResponseToJSONTyped = BillingPaymentResponseToJSONTyped;
+const BillingSystem_1 = require("./BillingSystem");
+exports.BillingPaymentResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the BillingPaymentResponse interface.
+ */
+function instanceOfBillingPaymentResponse(value) {
+    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;
+}
+function BillingPaymentResponseFromJSON(json) {
+    return BillingPaymentResponseFromJSONTyped(json, false);
+}
+function BillingPaymentResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'billingSystem': (0, BillingSystem_1.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'])),
+    };
+}
+function BillingPaymentResponseToJSON(json) {
+    return BillingPaymentResponseToJSONTyped(json, false);
+}
+function BillingPaymentResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'billing_system': (0, BillingSystem_1.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/dist/models/BillingSystem.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 declare const BillingSystem: {
+    readonly Stripe: 'STRIPE';
+    readonly PingPp: 'PING_PP';
+};
+export type BillingSystem = typeof BillingSystem[keyof typeof BillingSystem];
+export declare function instanceOfBillingSystem(value: any): boolean;
+export declare function BillingSystemFromJSON(json: any): BillingSystem;
+export declare function BillingSystemFromJSONTyped(json: any, ignoreDiscriminator: boolean): BillingSystem;
+export declare function BillingSystemToJSON(value?: BillingSystem | null): any;
+export declare function BillingSystemToJSONTyped(value: any, ignoreDiscriminator: boolean): BillingSystem;

package/dist/models/BillingSystem.js

@@ -0,0 +1,56 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillingSystem = void 0;
+exports.instanceOfBillingSystem = instanceOfBillingSystem;
+exports.BillingSystemFromJSON = BillingSystemFromJSON;
+exports.BillingSystemFromJSONTyped = BillingSystemFromJSONTyped;
+exports.BillingSystemToJSON = BillingSystemToJSON;
+exports.BillingSystemToJSONTyped = BillingSystemToJSONTyped;
+/**
+ * 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
+ */
+exports.BillingSystem = {
+    Stripe: 'STRIPE',
+    PingPp: 'PING_PP'
+};
+function instanceOfBillingSystem(value) {
+    for (const key in exports.BillingSystem) {
+        if (Object.prototype.hasOwnProperty.call(exports.BillingSystem, key)) {
+            if (exports.BillingSystem[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function BillingSystemFromJSON(json) {
+    return BillingSystemFromJSONTyped(json, false);
+}
+function BillingSystemFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function BillingSystemToJSON(value) {
+    return value;
+}
+function BillingSystemToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/ChangeSubscriptionRequest.d.ts

@@ -9,8 +9,16 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { BillingInterval } from './BillingInterval';
+import type { BillingSystem } 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
  */
@@ -27,6 +35,32 @@ 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 declare const ChangeSubscriptionRequestPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/ChangeSubscriptionRequest.js

@@ -19,6 +19,8 @@ exports.ChangeSubscriptionRequestFromJSON = ChangeSubscriptionRequestFromJSON;
 exports.ChangeSubscriptionRequestFromJSONTyped = ChangeSubscriptionRequestFromJSONTyped;
 exports.ChangeSubscriptionRequestToJSON = ChangeSubscriptionRequestToJSON;
 exports.ChangeSubscriptionRequestToJSONTyped = ChangeSubscriptionRequestToJSONTyped;
+const BillingInterval_1 = require("./BillingInterval");
+const BillingSystem_1 = require("./BillingSystem");
 exports.ChangeSubscriptionRequestPropertyValidationAttributesMap = {
     numSeats: {
         minimum: 1,
@@ -45,6 +47,10 @@ function ChangeSubscriptionRequestFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'subscriptionId': json['subscription_id'],
         'numSeats': json['num_seats'],
+        'interval': json['interval'] == null ? undefined : (0, BillingInterval_1.BillingIntervalFromJSON)(json['interval']),
+        'billingSystem': json['billing_system'] == null ? undefined : (0, BillingSystem_1.BillingSystemFromJSON)(json['billing_system']),
+        'channel': json['channel'] == null ? undefined : json['channel'],
+        'channelExtra': json['channel_extra'] == null ? undefined : json['channel_extra'],
     };
 }
 function ChangeSubscriptionRequestToJSON(json) {
@@ -57,5 +63,9 @@ function ChangeSubscriptionRequestToJSONTyped(value, ignoreDiscriminator = false
     return {
         'subscription_id': value['subscriptionId'],
         'num_seats': value['numSeats'],
+        'interval': (0, BillingInterval_1.BillingIntervalToJSON)(value['interval']),
+        'billing_system': (0, BillingSystem_1.BillingSystemToJSON)(value['billingSystem']),
+        'channel': value['channel'],
+        'channel_extra': value['channelExtra'],
     };
 }

package/dist/models/CheckoutAction.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 declare const CheckoutAction: {
+    readonly Redirect: 'REDIRECT';
+    readonly Credential: 'CREDENTIAL';
+    readonly Scheduled: 'SCHEDULED';
+    readonly Applied: 'APPLIED';
+};
+export type CheckoutAction = typeof CheckoutAction[keyof typeof CheckoutAction];
+export declare function instanceOfCheckoutAction(value: any): boolean;
+export declare function CheckoutActionFromJSON(json: any): CheckoutAction;
+export declare function CheckoutActionFromJSONTyped(json: any, ignoreDiscriminator: boolean): CheckoutAction;
+export declare function CheckoutActionToJSON(value?: CheckoutAction | null): any;
+export declare function CheckoutActionToJSONTyped(value: any, ignoreDiscriminator: boolean): CheckoutAction;

package/dist/models/CheckoutAction.js

@@ -0,0 +1,53 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckoutAction = void 0;
+exports.instanceOfCheckoutAction = instanceOfCheckoutAction;
+exports.CheckoutActionFromJSON = CheckoutActionFromJSON;
+exports.CheckoutActionFromJSONTyped = CheckoutActionFromJSONTyped;
+exports.CheckoutActionToJSON = CheckoutActionToJSON;
+exports.CheckoutActionToJSONTyped = CheckoutActionToJSONTyped;
+/**
+ * What the client must do next after a subscription-change request.
+ * @export
+ */
+exports.CheckoutAction = {
+    Redirect: 'REDIRECT',
+    Credential: 'CREDENTIAL',
+    Scheduled: 'SCHEDULED',
+    Applied: 'APPLIED'
+};
+function instanceOfCheckoutAction(value) {
+    for (const key in exports.CheckoutAction) {
+        if (Object.prototype.hasOwnProperty.call(exports.CheckoutAction, key)) {
+            if (exports.CheckoutAction[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function CheckoutActionFromJSON(json) {
+    return CheckoutActionFromJSONTyped(json, false);
+}
+function CheckoutActionFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function CheckoutActionToJSON(value) {
+    return value;
+}
+function CheckoutActionToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/CheckoutResponse.d.ts

@@ -0,0 +1,76 @@
+/**
+ * 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 type { CheckoutAction } from './CheckoutAction';
+import type { BillingSystem } from './BillingSystem';
+/**
+ * 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).
+ * @export
+ * @interface CheckoutResponse
+ */
+export interface CheckoutResponse {
+    /**
+     *
+     * @type {CheckoutAction}
+     * @memberof CheckoutResponse
+     */
+    action: CheckoutAction;
+    /**
+     *
+     * @type {BillingSystem}
+     * @memberof CheckoutResponse
+     */
+    billingSystem?: BillingSystem;
+    /**
+     * Stripe Checkout URL (action=REDIRECT).
+     * @type {string}
+     * @memberof CheckoutResponse
+     */
+    url?: string | null;
+    /**
+     * Ping++ charge credential (action=CREDENTIAL).
+     * @type {{ [key: string]: any; }}
+     * @memberof CheckoutResponse
+     */
+    credential?: {
+        [key: string]: any;
+    } | null;
+}
+export declare const CheckoutResponsePropertyValidationAttributesMap: {
+    [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 CheckoutResponse interface.
+ */
+export declare function instanceOfCheckoutResponse(value: object): value is CheckoutResponse;
+export declare function CheckoutResponseFromJSON(json: any): CheckoutResponse;
+export declare function CheckoutResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CheckoutResponse;
+export declare function CheckoutResponseToJSON(json: any): CheckoutResponse;
+export declare function CheckoutResponseToJSONTyped(value?: CheckoutResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/{SubmitSubscriptionResponse.js → CheckoutResponse.js}

@@ -13,48 +13,48 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SubmitSubscriptionResponsePropertyValidationAttributesMap = void 0;
-exports.instanceOfSubmitSubscriptionResponse = instanceOfSubmitSubscriptionResponse;
-exports.SubmitSubscriptionResponseFromJSON = SubmitSubscriptionResponseFromJSON;
-exports.SubmitSubscriptionResponseFromJSONTyped = SubmitSubscriptionResponseFromJSONTyped;
-exports.SubmitSubscriptionResponseToJSON = SubmitSubscriptionResponseToJSON;
-exports.SubmitSubscriptionResponseToJSONTyped = SubmitSubscriptionResponseToJSONTyped;
-exports.SubmitSubscriptionResponsePropertyValidationAttributesMap = {};
+exports.CheckoutResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfCheckoutResponse = instanceOfCheckoutResponse;
+exports.CheckoutResponseFromJSON = CheckoutResponseFromJSON;
+exports.CheckoutResponseFromJSONTyped = CheckoutResponseFromJSONTyped;
+exports.CheckoutResponseToJSON = CheckoutResponseToJSON;
+exports.CheckoutResponseToJSONTyped = CheckoutResponseToJSONTyped;
+const CheckoutAction_1 = require("./CheckoutAction");
+const BillingSystem_1 = require("./BillingSystem");
+exports.CheckoutResponsePropertyValidationAttributesMap = {};
 /**
- * Check if a given object implements the SubmitSubscriptionResponse interface.
+ * Check if a given object implements the CheckoutResponse interface.
  */
-function instanceOfSubmitSubscriptionResponse(value) {
-    if (!('submitted' in value) || value['submitted'] === undefined)
-        return false;
-    if (!('noop' in value) || value['noop'] === undefined)
-        return false;
-    if (!('idempotencyKey' in value) || value['idempotencyKey'] === undefined)
+function instanceOfCheckoutResponse(value) {
+    if (!('action' in value) || value['action'] === undefined)
         return false;
     return true;
 }
-function SubmitSubscriptionResponseFromJSON(json) {
-    return SubmitSubscriptionResponseFromJSONTyped(json, false);
+function CheckoutResponseFromJSON(json) {
+    return CheckoutResponseFromJSONTyped(json, false);
 }
-function SubmitSubscriptionResponseFromJSONTyped(json, ignoreDiscriminator) {
+function CheckoutResponseFromJSONTyped(json, ignoreDiscriminator) {
     if (json == null) {
         return json;
     }
     return {
-        'submitted': json['submitted'],
-        'noop': json['noop'],
-        'idempotencyKey': json['idempotency_key'],
+        'action': (0, CheckoutAction_1.CheckoutActionFromJSON)(json['action']),
+        'billingSystem': json['billing_system'] == null ? undefined : (0, BillingSystem_1.BillingSystemFromJSON)(json['billing_system']),
+        'url': json['url'] == null ? undefined : json['url'],
+        'credential': json['credential'] == null ? undefined : json['credential'],
     };
 }
-function SubmitSubscriptionResponseToJSON(json) {
-    return SubmitSubscriptionResponseToJSONTyped(json, false);
+function CheckoutResponseToJSON(json) {
+    return CheckoutResponseToJSONTyped(json, false);
 }
-function SubmitSubscriptionResponseToJSONTyped(value, ignoreDiscriminator = false) {
+function CheckoutResponseToJSONTyped(value, ignoreDiscriminator = false) {
     if (value == null) {
         return value;
     }
     return {
-        'submitted': value['submitted'],
-        'noop': value['noop'],
-        'idempotency_key': value['idempotencyKey'],
+        'action': (0, CheckoutAction_1.CheckoutActionToJSON)(value['action']),
+        'billing_system': (0, BillingSystem_1.BillingSystemToJSON)(value['billingSystem']),
+        'url': value['url'],
+        'credential': value['credential'],
     };
 }

package/dist/models/CreateWorkflowDefinitionRequest.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { ScheduleCadence } from './ScheduleCadence';
 /**
  * Create a new workflow definition.
  *
@@ -19,6 +20,24 @@
  * @interface CreateWorkflowDefinitionRequest
  */
 export interface CreateWorkflowDefinitionRequest {
+    /**
+     *
+     * @type {ScheduleCadence}
+     * @memberof CreateWorkflowDefinitionRequest
+     */
+    scheduleCadence?: ScheduleCadence;
+    /**
+     * 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.
+     * @type {Date}
+     * @memberof CreateWorkflowDefinitionRequest
+     */
+    scheduleStartAt?: Date | null;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof CreateWorkflowDefinitionRequest
+     */
+    scheduleTimezone?: string | null;
     /**
      *
      * @type {string}