@knowledge-stack/ksapi 1.162.0 → 2.4.2

package/src/models/{SubmitSubscriptionResponse.ts → CheckoutResponse.ts}

@@ -13,48 +13,62 @@
  */
 
 import { mapValues } from '../runtime';
+import type { CheckoutAction } from './CheckoutAction';
+import {
+    CheckoutActionFromJSON,
+    CheckoutActionFromJSONTyped,
+    CheckoutActionToJSON,
+    CheckoutActionToJSONTyped,
+} from './CheckoutAction';
+import type { BillingSystem } from './BillingSystem';
+import {
+    BillingSystemFromJSON,
+    BillingSystemFromJSONTyped,
+    BillingSystemToJSON,
+    BillingSystemToJSONTyped,
+} from './BillingSystem';
+
 /**
- * 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).
+ * Result of ``POST /v1/tenants/{tenant_id}/subscriptions``.
  * 
- * ``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.
+ * ``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 SubmitSubscriptionResponse
+ * @interface CheckoutResponse
  */
-export interface SubmitSubscriptionResponse {
+export interface CheckoutResponse {
     /**
-     * Always True when the submit returns 202.
-     * @type {boolean}
-     * @memberof SubmitSubscriptionResponse
+     * 
+     * @type {CheckoutAction}
+     * @memberof CheckoutResponse
      */
-    submitted: boolean;
+    action: CheckoutAction;
     /**
-     * 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
+     * 
+     * @type {BillingSystem}
+     * @memberof CheckoutResponse
      */
-    noop: boolean;
+    billingSystem?: BillingSystem;
     /**
-     * Idempotency key forwarded to Stripe — sourced from the ``Idempotency-Key`` request header or a server-generated uuid4 when absent.
+     * Stripe Checkout URL (action=REDIRECT).
      * @type {string}
-     * @memberof SubmitSubscriptionResponse
+     * @memberof CheckoutResponse
      */
-    idempotencyKey: string;
+    url?: string | null;
+    /**
+     * Ping++ charge credential (action=CREDENTIAL).
+     * @type {{ [key: string]: any; }}
+     * @memberof CheckoutResponse
+     */
+    credential?: { [key: string]: any; } | null;
 }
-export const SubmitSubscriptionResponsePropertyValidationAttributesMap: {
+
+
+export const CheckoutResponsePropertyValidationAttributesMap: {
     [property: string]: {
         maxLength?: number,
         minLength?: number,
@@ -73,45 +87,45 @@ export const SubmitSubscriptionResponsePropertyValidationAttributesMap: {
 
 
 /**
- * Check if a given object implements the SubmitSubscriptionResponse interface.
+ * Check if a given object implements the CheckoutResponse interface.
  */
-export function instanceOfSubmitSubscriptionResponse(value: object): value is SubmitSubscriptionResponse {
-    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) return false;
+export function instanceOfCheckoutResponse(value: object): value is CheckoutResponse {
+    if (!('action' in value) || value['action'] === undefined) return false;
     return true;
 }
 
-export function SubmitSubscriptionResponseFromJSON(json: any): SubmitSubscriptionResponse {
-    return SubmitSubscriptionResponseFromJSONTyped(json, false);
+export function CheckoutResponseFromJSON(json: any): CheckoutResponse {
+    return CheckoutResponseFromJSONTyped(json, false);
 }
 
-export function SubmitSubscriptionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubmitSubscriptionResponse {
+export function CheckoutResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CheckoutResponse {
     if (json == null) {
         return json;
     }
     return {
         
-        'submitted': json['submitted'],
-        'noop': json['noop'],
-        'idempotencyKey': json['idempotency_key'],
+        'action': CheckoutActionFromJSON(json['action']),
+        'billingSystem': json['billing_system'] == null ? undefined : BillingSystemFromJSON(json['billing_system']),
+        'url': json['url'] == null ? undefined : json['url'],
+        'credential': json['credential'] == null ? undefined : json['credential'],
     };
 }
 
-export function SubmitSubscriptionResponseToJSON(json: any): SubmitSubscriptionResponse {
-    return SubmitSubscriptionResponseToJSONTyped(json, false);
+export function CheckoutResponseToJSON(json: any): CheckoutResponse {
+    return CheckoutResponseToJSONTyped(json, false);
 }
 
-export function SubmitSubscriptionResponseToJSONTyped(value?: SubmitSubscriptionResponse | null, ignoreDiscriminator: boolean = false): any {
+export function CheckoutResponseToJSONTyped(value?: CheckoutResponse | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
 
     return {
         
-        'submitted': value['submitted'],
-        'noop': value['noop'],
-        'idempotency_key': value['idempotencyKey'],
+        'action': CheckoutActionToJSON(value['action']),
+        'billing_system': BillingSystemToJSON(value['billingSystem']),
+        'url': value['url'],
+        'credential': value['credential'],
     };
 }
 

package/src/models/CreateWorkflowDefinitionRequest.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { ScheduleCadence } from './ScheduleCadence';
+import {
+    ScheduleCadenceFromJSON,
+    ScheduleCadenceFromJSONTyped,
+    ScheduleCadenceToJSON,
+    ScheduleCadenceToJSONTyped,
+} from './ScheduleCadence';
+
 /**
  * Create a new workflow definition.
  * 
@@ -23,6 +31,24 @@ import { mapValues } from '../runtime';
  * @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}
@@ -78,6 +104,8 @@ export interface CreateWorkflowDefinitionRequest {
      */
     commonFilePathPartIds?: Array<string>;
 }
+
+
 export const CreateWorkflowDefinitionRequestPropertyValidationAttributesMap: {
     [property: string]: {
         maxLength?: number,
@@ -93,6 +121,9 @@ export const CreateWorkflowDefinitionRequestPropertyValidationAttributesMap: {
         uniqueItems?: boolean
     }
 } = {
+    scheduleTimezone: {
+        maxLength: 64,
+    },
     name: {
         maxLength: 255,
     },
@@ -133,6 +164,9 @@ export function CreateWorkflowDefinitionRequestFromJSONTyped(json: any, ignoreDi
     }
     return {
         
+        'scheduleCadence': json['schedule_cadence'] == null ? undefined : 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'],
@@ -156,6 +190,9 @@ export function CreateWorkflowDefinitionRequestToJSONTyped(value?: CreateWorkflo
 
     return {
         
+        'schedule_cadence': 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/src/models/IdpConfig.ts

@@ -43,6 +43,12 @@ export interface IdpConfig {
      * @memberof IdpConfig
      */
     _configuration: { [key: string]: any; };
+    /**
+     * Crontab string for directory sync
+     * @type {string}
+     * @memberof IdpConfig
+     */
+    syncCrontab?: string | null;
 }
 
 
@@ -61,6 +67,12 @@ export const IdpConfigPropertyValidationAttributesMap: {
         uniqueItems?: boolean
     }
 } = {
+    _configuration: {
+        minItems: 1,
+    },
+    syncCrontab: {
+        minLength: 9,
+    },
 }
 
 
@@ -85,6 +97,7 @@ export function IdpConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         
         'provider': SupportedIdPFromJSON(json['provider']),
         '_configuration': json['configuration'],
+        'syncCrontab': json['sync_crontab'] == null ? undefined : json['sync_crontab'],
     };
 }
 
@@ -101,6 +114,7 @@ export function IdpConfigToJSONTyped(value?: IdpConfig | null, ignoreDiscriminat
         
         'provider': SupportedIdPToJSON(value['provider']),
         'configuration': value['_configuration'],
+        'sync_crontab': value['syncCrontab'],
     };
 }
 

package/src/models/PaginatedResponseBillingPaymentResponse.ts

@@ -0,0 +1,130 @@
+/* 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 { BillingPaymentResponse } from './BillingPaymentResponse';
+import {
+    BillingPaymentResponseFromJSON,
+    BillingPaymentResponseFromJSONTyped,
+    BillingPaymentResponseToJSON,
+    BillingPaymentResponseToJSONTyped,
+} 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 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
+    }
+} = {
+    total: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+    limit: {
+        minimum: 1,
+        exclusiveMinimum: false,
+    },
+    offset: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+}
+
+
+/**
+ * Check if a given object implements the PaginatedResponseBillingPaymentResponse interface.
+ */
+export function instanceOfPaginatedResponseBillingPaymentResponse(value: object): value is PaginatedResponseBillingPaymentResponse {
+    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;
+}
+
+export function PaginatedResponseBillingPaymentResponseFromJSON(json: any): PaginatedResponseBillingPaymentResponse {
+    return PaginatedResponseBillingPaymentResponseFromJSONTyped(json, false);
+}
+
+export function PaginatedResponseBillingPaymentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedResponseBillingPaymentResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(BillingPaymentResponseFromJSON)),
+        'total': json['total'],
+        'limit': json['limit'],
+        'offset': json['offset'],
+    };
+}
+
+export function PaginatedResponseBillingPaymentResponseToJSON(json: any): PaginatedResponseBillingPaymentResponse {
+    return PaginatedResponseBillingPaymentResponseToJSONTyped(json, false);
+}
+
+export function PaginatedResponseBillingPaymentResponseToJSONTyped(value?: PaginatedResponseBillingPaymentResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(BillingPaymentResponseToJSON)),
+        'total': value['total'],
+        'limit': value['limit'],
+        'offset': value['offset'],
+    };
+}
+

package/src/models/ScheduleCadence.ts

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

package/src/models/SubscriptionPlanResponse.ts

@@ -73,6 +73,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}
@@ -139,6 +163,10 @@ export function SubscriptionPlanResponseFromJSONTyped(json: any, ignoreDiscrimin
         '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'])),
     };
@@ -163,6 +191,10 @@ export function SubscriptionPlanResponseToJSONTyped(value?: SubscriptionPlanResp
         '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(),
     };