@knowledge-stack/ksapi 1.163.0 → 2.4.2

package/dist/models/CreateWorkflowDefinitionRequest.js

@@ -19,7 +19,11 @@ exports.CreateWorkflowDefinitionRequestFromJSON = CreateWorkflowDefinitionReques
 exports.CreateWorkflowDefinitionRequestFromJSONTyped = CreateWorkflowDefinitionRequestFromJSONTyped;
 exports.CreateWorkflowDefinitionRequestToJSON = CreateWorkflowDefinitionRequestToJSON;
 exports.CreateWorkflowDefinitionRequestToJSONTyped = CreateWorkflowDefinitionRequestToJSONTyped;
+const ScheduleCadence_1 = require("./ScheduleCadence");
 exports.CreateWorkflowDefinitionRequestPropertyValidationAttributesMap = {
+    scheduleTimezone: {
+        maxLength: 64,
+    },
     name: {
         maxLength: 255,
     },
@@ -58,6 +62,9 @@ function CreateWorkflowDefinitionRequestFromJSONTyped(json, ignoreDiscriminator)
         return json;
     }
     return {
+        'scheduleCadence': json['schedule_cadence'] == null ? undefined : (0, ScheduleCadence_1.ScheduleCadenceFromJSON)(json['schedule_cadence']),
+        'scheduleStartAt': json['schedule_start_at'] == null ? undefined : (new Date(json['schedule_start_at'])),
+        'scheduleTimezone': json['schedule_timezone'] == null ? undefined : json['schedule_timezone'],
         'name': json['name'],
         'description': json['description'] == null ? undefined : json['description'],
         'maxRunDurationSeconds': json['max_run_duration_seconds'] == null ? undefined : json['max_run_duration_seconds'],
@@ -77,6 +84,9 @@ function CreateWorkflowDefinitionRequestToJSONTyped(value, ignoreDiscriminator =
         return value;
     }
     return {
+        'schedule_cadence': (0, ScheduleCadence_1.ScheduleCadenceToJSON)(value['scheduleCadence']),
+        'schedule_start_at': value['scheduleStartAt'] == null ? value['scheduleStartAt'] : value['scheduleStartAt'].toISOString(),
+        'schedule_timezone': value['scheduleTimezone'],
         'name': value['name'],
         'description': value['description'],
         'max_run_duration_seconds': value['maxRunDurationSeconds'],

package/dist/models/IdpConfig.d.ts

@@ -34,6 +34,12 @@ export interface IdpConfig {
     _configuration: {
         [key: string]: any;
     };
+    /**
+     * Crontab string for directory sync
+     * @type {string}
+     * @memberof IdpConfig
+     */
+    syncCrontab?: string | null;
 }
 export declare const IdpConfigPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/IdpConfig.js

@@ -20,7 +20,14 @@ exports.IdpConfigFromJSONTyped = IdpConfigFromJSONTyped;
 exports.IdpConfigToJSON = IdpConfigToJSON;
 exports.IdpConfigToJSONTyped = IdpConfigToJSONTyped;
 const SupportedIdP_1 = require("./SupportedIdP");
-exports.IdpConfigPropertyValidationAttributesMap = {};
+exports.IdpConfigPropertyValidationAttributesMap = {
+    _configuration: {
+        minItems: 1,
+    },
+    syncCrontab: {
+        minLength: 9,
+    },
+};
 /**
  * Check if a given object implements the IdpConfig interface.
  */
@@ -41,6 +48,7 @@ function IdpConfigFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'provider': (0, SupportedIdP_1.SupportedIdPFromJSON)(json['provider']),
         '_configuration': json['configuration'],
+        'syncCrontab': json['sync_crontab'] == null ? undefined : json['sync_crontab'],
     };
 }
 function IdpConfigToJSON(json) {
@@ -53,5 +61,6 @@ function IdpConfigToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'provider': (0, SupportedIdP_1.SupportedIdPToJSON)(value['provider']),
         'configuration': value['_configuration'],
+        'sync_crontab': value['syncCrontab'],
     };
 }

package/dist/models/PaginatedResponseBillingPaymentResponse.d.ts

@@ -0,0 +1,66 @@
+/**
+ * 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 { BillingPaymentResponse } from './BillingPaymentResponse';
+/**
+ *
+ * @export
+ * @interface PaginatedResponseBillingPaymentResponse
+ */
+export interface PaginatedResponseBillingPaymentResponse {
+    /**
+     * List of items
+     * @type {Array<BillingPaymentResponse>}
+     * @memberof PaginatedResponseBillingPaymentResponse
+     */
+    items: Array<BillingPaymentResponse>;
+    /**
+     * Total number of items
+     * @type {number}
+     * @memberof PaginatedResponseBillingPaymentResponse
+     */
+    total: number;
+    /**
+     * Number of items per page
+     * @type {number}
+     * @memberof PaginatedResponseBillingPaymentResponse
+     */
+    limit: number;
+    /**
+     * Number of items to skip
+     * @type {number}
+     * @memberof PaginatedResponseBillingPaymentResponse
+     */
+    offset: number;
+}
+export declare const PaginatedResponseBillingPaymentResponsePropertyValidationAttributesMap: {
+    [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 PaginatedResponseBillingPaymentResponse interface.
+ */
+export declare function instanceOfPaginatedResponseBillingPaymentResponse(value: object): value is PaginatedResponseBillingPaymentResponse;
+export declare function PaginatedResponseBillingPaymentResponseFromJSON(json: any): PaginatedResponseBillingPaymentResponse;
+export declare function PaginatedResponseBillingPaymentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedResponseBillingPaymentResponse;
+export declare function PaginatedResponseBillingPaymentResponseToJSON(json: any): PaginatedResponseBillingPaymentResponse;
+export declare function PaginatedResponseBillingPaymentResponseToJSONTyped(value?: PaginatedResponseBillingPaymentResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PaginatedResponseBillingPaymentResponse.js

@@ -0,0 +1,78 @@
+"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.PaginatedResponseBillingPaymentResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfPaginatedResponseBillingPaymentResponse = instanceOfPaginatedResponseBillingPaymentResponse;
+exports.PaginatedResponseBillingPaymentResponseFromJSON = PaginatedResponseBillingPaymentResponseFromJSON;
+exports.PaginatedResponseBillingPaymentResponseFromJSONTyped = PaginatedResponseBillingPaymentResponseFromJSONTyped;
+exports.PaginatedResponseBillingPaymentResponseToJSON = PaginatedResponseBillingPaymentResponseToJSON;
+exports.PaginatedResponseBillingPaymentResponseToJSONTyped = PaginatedResponseBillingPaymentResponseToJSONTyped;
+const BillingPaymentResponse_1 = require("./BillingPaymentResponse");
+exports.PaginatedResponseBillingPaymentResponsePropertyValidationAttributesMap = {
+    total: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+    limit: {
+        minimum: 1,
+        exclusiveMinimum: false,
+    },
+    offset: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+};
+/**
+ * Check if a given object implements the PaginatedResponseBillingPaymentResponse interface.
+ */
+function instanceOfPaginatedResponseBillingPaymentResponse(value) {
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    if (!('limit' in value) || value['limit'] === undefined)
+        return false;
+    if (!('offset' in value) || value['offset'] === undefined)
+        return false;
+    return true;
+}
+function PaginatedResponseBillingPaymentResponseFromJSON(json) {
+    return PaginatedResponseBillingPaymentResponseFromJSONTyped(json, false);
+}
+function PaginatedResponseBillingPaymentResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'items': (json['items'].map(BillingPaymentResponse_1.BillingPaymentResponseFromJSON)),
+        'total': json['total'],
+        'limit': json['limit'],
+        'offset': json['offset'],
+    };
+}
+function PaginatedResponseBillingPaymentResponseToJSON(json) {
+    return PaginatedResponseBillingPaymentResponseToJSONTyped(json, false);
+}
+function PaginatedResponseBillingPaymentResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'items': (value['items'].map(BillingPaymentResponse_1.BillingPaymentResponseToJSON)),
+        'total': value['total'],
+        'limit': value['limit'],
+        'offset': value['offset'],
+    };
+}

package/dist/models/ScheduleCadence.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ * 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.
+ * @export
+ */
+export declare const ScheduleCadence: {
+    readonly Daily: 'DAILY';
+    readonly Weekly: 'WEEKLY';
+    readonly Monthly: 'MONTHLY';
+};
+export type ScheduleCadence = typeof ScheduleCadence[keyof typeof ScheduleCadence];
+export declare function instanceOfScheduleCadence(value: any): boolean;
+export declare function ScheduleCadenceFromJSON(json: any): ScheduleCadence;
+export declare function ScheduleCadenceFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScheduleCadence;
+export declare function ScheduleCadenceToJSON(value?: ScheduleCadence | null): any;
+export declare function ScheduleCadenceToJSONTyped(value: any, ignoreDiscriminator: boolean): ScheduleCadence;

package/dist/models/ScheduleCadence.js

@@ -0,0 +1,58 @@
+"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.ScheduleCadence = void 0;
+exports.instanceOfScheduleCadence = instanceOfScheduleCadence;
+exports.ScheduleCadenceFromJSON = ScheduleCadenceFromJSON;
+exports.ScheduleCadenceFromJSONTyped = ScheduleCadenceFromJSONTyped;
+exports.ScheduleCadenceToJSON = ScheduleCadenceToJSON;
+exports.ScheduleCadenceToJSONTyped = ScheduleCadenceToJSONTyped;
+/**
+ * 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.
+ * @export
+ */
+exports.ScheduleCadence = {
+    Daily: 'DAILY',
+    Weekly: 'WEEKLY',
+    Monthly: 'MONTHLY'
+};
+function instanceOfScheduleCadence(value) {
+    for (const key in exports.ScheduleCadence) {
+        if (Object.prototype.hasOwnProperty.call(exports.ScheduleCadence, key)) {
+            if (exports.ScheduleCadence[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function ScheduleCadenceFromJSON(json) {
+    return ScheduleCadenceFromJSONTyped(json, false);
+}
+function ScheduleCadenceFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function ScheduleCadenceToJSON(value) {
+    return value;
+}
+function ScheduleCadenceToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/SubscriptionPlanResponse.d.ts

@@ -69,6 +69,30 @@ export interface SubscriptionPlanResponse {
      * @memberof SubscriptionPlanResponse
      */
     _public: boolean;
+    /**
+     * Per-seat monthly price in USD cents (Stripe / NA). NULL = not self-serve purchasable in this currency/interval.
+     * @type {number}
+     * @memberof SubscriptionPlanResponse
+     */
+    priceMonthlyUsdCents?: number | null;
+    /**
+     * Per-seat annual price in USD cents (Stripe / NA).
+     * @type {number}
+     * @memberof SubscriptionPlanResponse
+     */
+    priceAnnualUsdCents?: number | null;
+    /**
+     * Per-seat monthly price in CNY fen (Ping++ / CN).
+     * @type {number}
+     * @memberof SubscriptionPlanResponse
+     */
+    priceMonthlyCnyFen?: number | null;
+    /**
+     * Per-seat annual price in CNY fen (Ping++ / CN).
+     * @type {number}
+     * @memberof SubscriptionPlanResponse
+     */
+    priceAnnualCnyFen?: number | null;
     /**
      * Plan creation timestamp.
      * @type {Date}

package/dist/models/SubscriptionPlanResponse.js

@@ -62,6 +62,10 @@ function SubscriptionPlanResponseFromJSONTyped(json, ignoreDiscriminator) {
         'mediaMinutes': json['media_minutes'],
         'maxSeats': json['max_seats'],
         '_public': json['public'],
+        'priceMonthlyUsdCents': json['price_monthly_usd_cents'] == null ? undefined : json['price_monthly_usd_cents'],
+        'priceAnnualUsdCents': json['price_annual_usd_cents'] == null ? undefined : json['price_annual_usd_cents'],
+        'priceMonthlyCnyFen': json['price_monthly_cny_fen'] == null ? undefined : json['price_monthly_cny_fen'],
+        'priceAnnualCnyFen': json['price_annual_cny_fen'] == null ? undefined : json['price_annual_cny_fen'],
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
     };
@@ -82,6 +86,10 @@ function SubscriptionPlanResponseToJSONTyped(value, ignoreDiscriminator = false)
         'media_minutes': value['mediaMinutes'],
         'max_seats': value['maxSeats'],
         'public': value['_public'],
+        'price_monthly_usd_cents': value['priceMonthlyUsdCents'],
+        'price_annual_usd_cents': value['priceAnnualUsdCents'],
+        'price_monthly_cny_fen': value['priceMonthlyCnyFen'],
+        'price_annual_cny_fen': value['priceAnnualCnyFen'],
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
     };

package/dist/models/{SubmitSubscriptionResponse.d.ts → TenantSubscriptionResponse.d.ts}

@@ -9,48 +9,59 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { BillingInterval } from './BillingInterval';
+import type { BillingSystem } from './BillingSystem';
+import type { SubscriptionPlanResponse } from './SubscriptionPlanResponse';
 /**
- * Result envelope for the subscription-change submit endpoint.
- *
- * The endpoint returns immediately after the (mock-)Stripe charge is
- * submitted; the actual plan/seat write happens later in the Stripe
- * subscription webhook. ``submitted=True`` always when the route
- * succeeds (errors raise via the global handler).
- *
- * ``noop=True`` indicates the tenant is already at the requested
- * ``(plan, num_seats)`` — no Stripe call was issued, no webhook will
- * arrive, and the user's account is unchanged. Symmetric with
- * ``StripeWebhookAck.replayed`` so client UIs can render "already
- * on this plan" rather than spinning a "waiting for webhook"
- * indicator forever.
- *
- * ``idempotency_key`` echoes the value forwarded to Stripe — clients
- * can store it to correlate the eventual webhook receipt with the
- * original request, and re-send it verbatim on retries.
+ * The tenant's current subscription: plan body + period state.
  * @export
- * @interface SubmitSubscriptionResponse
+ * @interface TenantSubscriptionResponse
  */
-export interface SubmitSubscriptionResponse {
+export interface TenantSubscriptionResponse {
     /**
-     * Always True when the submit returns 202.
-     * @type {boolean}
-     * @memberof SubmitSubscriptionResponse
+     *
+     * @type {SubscriptionPlanResponse}
+     * @memberof TenantSubscriptionResponse
      */
-    submitted: boolean;
+    plan: SubscriptionPlanResponse;
     /**
-     * True when the tenant was already at the target ``(plan, num_seats)`` — no Stripe call was made and no webhook will arrive.
-     * @type {boolean}
-     * @memberof SubmitSubscriptionResponse
+     * Seats in force for this period.
+     * @type {number}
+     * @memberof TenantSubscriptionResponse
+     */
+    numSeats: number;
+    /**
+     * Inclusive period start.
+     * @type {Date}
+     * @memberof TenantSubscriptionResponse
      */
-    noop: boolean;
+    startDate: Date;
     /**
-     * Idempotency key forwarded to Stripe — sourced from the ``Idempotency-Key`` request header or a server-generated uuid4 when absent.
-     * @type {string}
-     * @memberof SubmitSubscriptionResponse
+     * Exclusive period end. Unbilled subscriptions carry a 100-year horizon; billed ones the paid-through date.
+     * @type {Date}
+     * @memberof TenantSubscriptionResponse
+     */
+    endDate: Date;
+    /**
+     *
+     * @type {BillingSystem}
+     * @memberof TenantSubscriptionResponse
+     */
+    billingSystem?: BillingSystem;
+    /**
+     *
+     * @type {BillingInterval}
+     * @memberof TenantSubscriptionResponse
+     */
+    interval?: BillingInterval;
+    /**
+     * True when the subscription auto-renews at period end (a Stripe subscription with no cancellation scheduled). False for Ping++ prepay (renewal = buying again), unbilled subscriptions, and Stripe periods with a scheduled cancellation.
+     * @type {boolean}
+     * @memberof TenantSubscriptionResponse
      */
-    idempotencyKey: string;
+    willRenew: boolean;
 }
-export declare const SubmitSubscriptionResponsePropertyValidationAttributesMap: {
+export declare const TenantSubscriptionResponsePropertyValidationAttributesMap: {
     [property: string]: {
         maxLength?: number;
         minLength?: number;
@@ -66,10 +77,10 @@ export declare const SubmitSubscriptionResponsePropertyValidationAttributesMap:
     };
 };
 /**
- * Check if a given object implements the SubmitSubscriptionResponse interface.
+ * Check if a given object implements the TenantSubscriptionResponse interface.
  */
-export declare function instanceOfSubmitSubscriptionResponse(value: object): value is SubmitSubscriptionResponse;
-export declare function SubmitSubscriptionResponseFromJSON(json: any): SubmitSubscriptionResponse;
-export declare function SubmitSubscriptionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubmitSubscriptionResponse;
-export declare function SubmitSubscriptionResponseToJSON(json: any): SubmitSubscriptionResponse;
-export declare function SubmitSubscriptionResponseToJSONTyped(value?: SubmitSubscriptionResponse | null, ignoreDiscriminator?: boolean): any;
+export declare function instanceOfTenantSubscriptionResponse(value: object): value is TenantSubscriptionResponse;
+export declare function TenantSubscriptionResponseFromJSON(json: any): TenantSubscriptionResponse;
+export declare function TenantSubscriptionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TenantSubscriptionResponse;
+export declare function TenantSubscriptionResponseToJSON(json: any): TenantSubscriptionResponse;
+export declare function TenantSubscriptionResponseToJSONTyped(value?: TenantSubscriptionResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/TenantSubscriptionResponse.js

@@ -0,0 +1,75 @@
+"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.TenantSubscriptionResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfTenantSubscriptionResponse = instanceOfTenantSubscriptionResponse;
+exports.TenantSubscriptionResponseFromJSON = TenantSubscriptionResponseFromJSON;
+exports.TenantSubscriptionResponseFromJSONTyped = TenantSubscriptionResponseFromJSONTyped;
+exports.TenantSubscriptionResponseToJSON = TenantSubscriptionResponseToJSON;
+exports.TenantSubscriptionResponseToJSONTyped = TenantSubscriptionResponseToJSONTyped;
+const BillingInterval_1 = require("./BillingInterval");
+const BillingSystem_1 = require("./BillingSystem");
+const SubscriptionPlanResponse_1 = require("./SubscriptionPlanResponse");
+exports.TenantSubscriptionResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the TenantSubscriptionResponse interface.
+ */
+function instanceOfTenantSubscriptionResponse(value) {
+    if (!('plan' in value) || value['plan'] === undefined)
+        return false;
+    if (!('numSeats' in value) || value['numSeats'] === undefined)
+        return false;
+    if (!('startDate' in value) || value['startDate'] === undefined)
+        return false;
+    if (!('endDate' in value) || value['endDate'] === undefined)
+        return false;
+    if (!('willRenew' in value) || value['willRenew'] === undefined)
+        return false;
+    return true;
+}
+function TenantSubscriptionResponseFromJSON(json) {
+    return TenantSubscriptionResponseFromJSONTyped(json, false);
+}
+function TenantSubscriptionResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'plan': (0, SubscriptionPlanResponse_1.SubscriptionPlanResponseFromJSON)(json['plan']),
+        'numSeats': json['num_seats'],
+        'startDate': (new Date(json['start_date'])),
+        'endDate': (new Date(json['end_date'])),
+        'billingSystem': json['billing_system'] == null ? undefined : (0, BillingSystem_1.BillingSystemFromJSON)(json['billing_system']),
+        'interval': json['interval'] == null ? undefined : (0, BillingInterval_1.BillingIntervalFromJSON)(json['interval']),
+        'willRenew': json['will_renew'],
+    };
+}
+function TenantSubscriptionResponseToJSON(json) {
+    return TenantSubscriptionResponseToJSONTyped(json, false);
+}
+function TenantSubscriptionResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'plan': (0, SubscriptionPlanResponse_1.SubscriptionPlanResponseToJSON)(value['plan']),
+        'num_seats': value['numSeats'],
+        'start_date': value['startDate'].toISOString(),
+        'end_date': value['endDate'].toISOString(),
+        'billing_system': (0, BillingSystem_1.BillingSystemToJSON)(value['billingSystem']),
+        'interval': (0, BillingInterval_1.BillingIntervalToJSON)(value['interval']),
+        'will_renew': value['willRenew'],
+    };
+}