@ptkl/sdk 1.13.0 → 1.15.0

package/dist/v0.10/types/component.d.ts

@@ -10,6 +10,7 @@ type FindParams = {
     dateTo?: string;
     dateField?: string;
     only?: string[];
+    cursor?: string;
     $adv?: FindAdvancedParams;
     $aggregate?: FindAggregateParams[];
 };
@@ -57,17 +58,23 @@ type FindStreamMeta = {
     total_filtered: number;
     total_pages: number;
     page: number;
+    next_cursor?: string;
 };
 /**
  * Callback invoked once with pagination metadata before any records
  */
 type FindStreamMetaCallback = (meta: FindStreamMeta) => void | Promise<void>;
+type FindStreamCursor = {
+    next_cursor?: string;
+};
+type FindStreamCursorCallback = (cursor: FindStreamCursor) => void | Promise<void>;
 /**
  * Chainable find stream result for cursor-based NDJSON pagination
  */
 type FindChainable = {
     onMeta: (callback: FindStreamMetaCallback) => FindChainable;
     onData: (callback: StreamCallback) => FindChainable;
+    onCursor: (callback: FindStreamCursorCallback) => FindChainable;
     onError: (callback: (error: Error) => void) => FindChainable;
     onEnd: (callback: () => void) => FindChainable;
     stream: () => Promise<void>;
@@ -432,6 +439,7 @@ type SetupData = {
     is_public?: boolean;
     icon?: string;
     settings?: Settings;
+    force_override?: boolean;
 };
 type ComponentCreateResponse = ComponentListItem;
-export { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions, ModifyOptions, UpdateOperators, UpdateAggregate, ModelUpdateData, ComponentOptions, ComponentListResponse, ComponentListItem, ComponentLabel, ComponentWorkspace, StreamCallback, StreamHandler, AggregateChainable, FindChainable, FindStreamMeta, FindStreamMetaCallback, UpdateManyOptions, CreateManyOptions, Settings, SettingsField, FieldRoles, FieldConstraints, Context, Preset, PresetContext, Filters, Function, Extension, Policy, FieldAccessConfig, TemplatesDist, SetupData, ComponentCreateResponse, };
+export { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions, ModifyOptions, UpdateOperators, UpdateAggregate, ModelUpdateData, ComponentOptions, ComponentListResponse, ComponentListItem, ComponentLabel, ComponentWorkspace, StreamCallback, StreamHandler, AggregateChainable, FindChainable, FindStreamMeta, FindStreamMetaCallback, FindStreamCursor, FindStreamCursorCallback, UpdateManyOptions, CreateManyOptions, Settings, SettingsField, FieldRoles, FieldConstraints, Context, Preset, PresetContext, Filters, Function, Extension, Policy, FieldAccessConfig, TemplatesDist, SetupData, ComponentCreateResponse, };

package/dist/v0.10/types/integrations.d.ts

@@ -442,3 +442,145 @@ export type OCRExtractResult = {
     results: Record<string, string>;
     errors?: string[];
 };
+export type LibraryExportStatus = 'queued' | 'running' | 'completed' | 'failed' | 'expired';
+export type LibraryExportCreatePayload = {
+    path?: string;
+    format?: 'zip' | 'tar' | 'tar.gz';
+};
+/**
+ * A library export archive record (models.MediaExport)
+ */
+export type LibraryExport = {
+    uuid: string;
+    library_uuid: string;
+    path?: string;
+    format?: string;
+    status: LibraryExportStatus;
+    size_bytes?: number;
+    created_at?: string;
+    updated_at?: string;
+};
+export type LibraryExportListResponse = LibraryExport[];
+/**
+ * Response body for POST library/{uuid}/exports.
+ * `mode` indicates whether the export was queued (async, `export` populated)
+ * or streamed back directly as the response body (synchronous binary download,
+ * in which case the response will not be this JSON shape at all).
+ */
+export type MediaExportCreateResult = {
+    mode: string;
+    export?: LibraryExport;
+};
+/**
+ * Response body for GET library/{uuid}/exports/{export_uuid}
+ */
+export type LibraryExportGetResult = {
+    export: LibraryExport;
+    download_url?: string;
+};
+export type NotificationMode = 'off' | 'inherit' | 'enabled' | 'disabled' | (string & {});
+export type NotificationDeliveryMode = 'digest' | 'immediate' | 'hourly_digest' | 'daily_digest' | (string & {});
+export type NotifyEvent = 'upload' | 'download' | 'share_created' | 'file_deleted' | 'expiration_warning' | 'quota_warning' | 'worm_expiring';
+export type QuotaExceededAction = 'block' | 'delete_oldest' | 'delete_lru';
+export type LibraryPolicyPayload = {
+    ttl_after_last_access_days?: number;
+    ttl_after_last_modified_days?: number;
+    default_expiration_days?: number;
+    allowed_mime_types?: string[];
+    denied_mime_types?: string[];
+    allowed_extensions?: string[];
+    auto_private_after_days?: number;
+    disable_public_access?: boolean;
+    allowed_ip_ranges?: string[];
+    notification_mode?: NotificationMode;
+    notify_events?: NotifyEvent[];
+    notify_roles?: string[];
+    notify_emails?: string[];
+    notify_before_expiration_days?: number[];
+    notify_quota_thresholds?: number[];
+    notification_delivery_mode?: NotificationDeliveryMode;
+    notification_min_interval_minutes?: number;
+    prune_empty_dirs?: boolean;
+    worm_days?: number;
+};
+export type DirPolicyPayload = LibraryPolicyPayload & {
+    quota_bytes?: number;
+    quota_exceeded_action?: QuotaExceededAction;
+};
+export type LibraryPolicy = LibraryPolicyPayload & {
+    library_uuid: string;
+    scope: 'library';
+};
+export type DirPolicy = DirPolicyPayload & {
+    library_uuid: string;
+    scope: 'dir';
+    path: string;
+};
+/**
+ * Recurrence frequency for a per-file notification rule (models.MediaFileNotificationRule)
+ */
+export type NotificationRuleFrequency = 'daily' | 'weekly' | 'monthly' | 'yearly';
+export type NotificationRuleStatus = 'active' | 'paused' | 'cancelled' | 'completed';
+/**
+ * Payload for creating a recurring reminder on a media file
+ * (media-api v3 `library/{uuid}/notification-rules`, mediaFileNotificationRuleRequest).
+ * One of `media_uuid` / `file_key` must identify the target file.
+ */
+export type NotificationRuleCreatePayload = {
+    /** Target file UUID (required unless file_key is provided) */
+    media_uuid?: string;
+    /** Target file key/path (alternative to media_uuid) */
+    file_key?: string;
+    /** Recurrence frequency */
+    frequency: NotificationRuleFrequency;
+    /** First occurrence; must be a future timestamp (RFC3339) */
+    start_at: string;
+    /** Repeat every N frequency units (default: 1) */
+    interval?: number;
+    /** Optional recurrence end timestamp (RFC3339) */
+    end_at?: string;
+    /** Optional cap on number of occurrences */
+    max_occurrences?: number;
+    /** Recipient email for the reminder (only recipient field the server reads) */
+    recipient_email?: string;
+};
+export type NotificationRule = {
+    uuid: string;
+    library_uuid: string;
+    media_uuid: string;
+    file_key?: string;
+    frequency: NotificationRuleFrequency;
+    interval?: number;
+    start_at: string;
+    end_at?: string;
+    max_occurrences?: number;
+    recipient_email?: string;
+    status: NotificationRuleStatus;
+    created_at?: string;
+    updated_at?: string;
+};
+export type NotificationRuleListResponse = NotificationRule[];
+export type FileNotificationStatus = 'scheduled' | 'queued' | 'sent' | 'cancelled';
+export type FileNotificationCreatePayload = {
+    notify_at: string;
+    note: string;
+    /** Only recipient field the server (mediaFileNotificationRequest) reads */
+    recipient_email?: string;
+};
+export type FileNotification = {
+    uuid: string;
+    library_uuid: string;
+    media_uuid: string;
+    file_key?: string;
+    file_name?: string;
+    /** UUID of the notification rule that generated this occurrence, if any */
+    rule_uuid?: string;
+    note: string;
+    notify_at: string;
+    status: FileNotificationStatus;
+    sent_at?: string;
+    queued_at?: string;
+    created_by?: string;
+    recipient_email?: string;
+};
+export type FileNotificationListResponse = FileNotification[];

package/dist/v0.10/types/kortex.d.ts

@@ -273,6 +273,21 @@ type Tier = {
     max_storage_bytes: number;
     max_users: number;
 };
+type KnowledgeBaseSearchPayload = {
+    query: string;
+    agent_uuid: string;
+    top_k?: number;
+};
+type KnowledgeBaseSearchChunk = {
+    text: string;
+    score: number;
+    document_name: string;
+    document_uuid: string;
+    chunk_index: number;
+};
+type KnowledgeBaseSearchResult = {
+    chunks: KnowledgeBaseSearchChunk[];
+};
 type KortexWorkflowMessage = {
     role: string;
     content: string;
@@ -291,4 +306,4 @@ type KortexWorkflowResult = {
     content: string;
     usage: TokenUsage;
 };
-export { PagedResponse, PaginationParams, RAGConfig, LLMSettings, Agent, AgentCreatePayload, AgentUpdatePayload, ChunkingStrategy, KnowledgeBase, KnowledgeBaseCreatePayload, KnowledgeBaseUpdatePayload, Document, Participant, TokenUsage, ToolCall, RAGSource, Message, Conversation, ConversationCreatePayload, ConversationUpdatePayload, ParticipantAddPayload, ToolResultApproval, ToolResultPayload, PageContext, SendMessagePayload, InjectMessagePayload, OCRPayload, OCRResult, UserAccess, UserAccessCreatePayload, UserAccessUpdatePayload, TopUpPayload, UserMonthlyUsage, UserUsageBreakdown, MyAccess, AggregatedUsage, Tier, KortexWorkflowMessage, KortexWorkflowPayload, KortexWorkflowResult, };
+export { PagedResponse, PaginationParams, RAGConfig, LLMSettings, Agent, AgentCreatePayload, AgentUpdatePayload, ChunkingStrategy, KnowledgeBase, KnowledgeBaseCreatePayload, KnowledgeBaseUpdatePayload, Document, Participant, TokenUsage, ToolCall, RAGSource, Message, Conversation, ConversationCreatePayload, ConversationUpdatePayload, ParticipantAddPayload, ToolResultApproval, ToolResultPayload, PageContext, SendMessagePayload, InjectMessagePayload, OCRPayload, OCRResult, UserAccess, UserAccessCreatePayload, UserAccessUpdatePayload, TopUpPayload, UserMonthlyUsage, UserUsageBreakdown, MyAccess, AggregatedUsage, Tier, KnowledgeBaseSearchPayload, KnowledgeBaseSearchChunk, KnowledgeBaseSearchResult, KortexWorkflowMessage, KortexWorkflowPayload, KortexWorkflowResult, };

package/dist/v0.10/types/sandbox.d.ts

@@ -0,0 +1,116 @@
+/** "function" — a stateless FaaS spark; "app" — a long-running spark app. */
+export type SparkType = "function" | "app";
+/** Supported spark language runtimes. */
+export type SparkRuntimeId = "node22" | "node20" | "node18" | "nodejs20" | "nodejs18" | "python311" | "python39" | "go121" | "go119" | "java17" | "java11" | (string & {});
+export interface SparkDist {
+    handler: string;
+    package: string;
+}
+export interface SparkSettings {
+    version: string;
+    dist: SparkDist;
+}
+export interface SparkInfo {
+    status: string;
+    memory: number;
+    env_vars: Record<string, string>;
+    dependencies?: Record<string, string>;
+}
+export interface SparkEnvInfo {
+    dev: SparkInfo;
+    live: SparkInfo;
+}
+export interface CloudRunEnv {
+    service_name: string;
+    service_url: string;
+    region: string;
+    project_id: string;
+    revision: string;
+    image_uri: string;
+    build_id: string;
+    build_status: string;
+    build_start_time: number;
+    build_duration_seconds: number;
+    created_at: number;
+    updated_at: number;
+}
+export interface SparkCloudRunInfo {
+    dev: CloudRunEnv;
+    live: CloudRunEnv;
+}
+export interface Spark {
+    uuid: string;
+    project_uuid: string;
+    name: string;
+    type: SparkType;
+    runtime: SparkRuntimeId;
+    code?: string;
+    dev_version: string;
+    public_version: string;
+    settings: SparkSettings[];
+    info: SparkEnvInfo;
+    cloud_run?: SparkCloudRunInfo;
+    tags: string[];
+}
+/** Payload for `spark().create()`. Memory (Mi) must be one of 128/256/512. */
+export interface CreateSparkPayload {
+    name: string;
+    type?: SparkType;
+    runtime: SparkRuntimeId;
+    memory: number;
+    settings?: SparkSettings[];
+}
+/** Payload for `spark().update()`. Memory (Mi) must be one of 128/256/512/1024. */
+export interface UpdateSparkPayload {
+    memory?: number;
+    settings?: SparkSettings[];
+    info?: Partial<SparkEnvInfo>;
+}
+export type SparkEnv = "dev" | "live";
+export interface SparkLogsParams {
+    env?: SparkEnv;
+    limit?: number;
+    level?: string;
+    since?: string;
+}
+export interface SparkTier {
+    [key: string]: any;
+}
+export type RuntimeStatus = "deploying" | "running" | "failed" | "stopped";
+export interface ResourceSpec {
+    requests_cpu?: string;
+    requests_memory?: string;
+    limits_cpu?: string;
+    limits_memory?: string;
+}
+export interface Runtime {
+    uuid: string;
+    project_uuid: string;
+    name: string;
+    image: string;
+    port: number;
+    status: RuntimeStatus;
+    url: string;
+    resources: ResourceSpec;
+    env_vars: Record<string, string>;
+    created_at: number;
+    updated_at: number;
+    tags: string[];
+}
+export interface CreateRuntimePayload {
+    name: string;
+    image: string;
+    port: number;
+    env_vars?: Record<string, string>;
+    resources?: ResourceSpec;
+    tags?: string[];
+}
+export interface UpdateRuntimePayload {
+    image?: string;
+    env_vars?: Record<string, string>;
+    resources?: ResourceSpec;
+    tags?: string[];
+}
+export interface RuntimeLogsParams {
+    lines?: number;
+}

package/dist/v0.10/types/transactions.d.ts

@@ -0,0 +1,198 @@
+/** ISO-8601 timestamp string as returned by the platform (e.g. "2026-07-17T12:00:00Z"). */
+export type ISODateString = string;
+export interface Subscription {
+    uuid: string;
+    project_uuid: string;
+    period: number;
+    discount: number;
+    renewed_at: ISODateString | null;
+    expires_at: ISODateString | null;
+    payment_provider: string;
+    payment_method: string;
+    is_active: boolean;
+    is_paused: boolean;
+    is_expired: boolean;
+    is_canceled: boolean;
+    is_trial: boolean;
+    trial_period_days: number;
+    is_lifetime: boolean;
+    payment_status: string;
+    ref_no: string;
+    price: number;
+    human_price: number;
+    prorated_human_price?: number;
+    license_code?: string | null;
+    license_product?: unknown;
+    bundle_products?: unknown;
+    product_id: string;
+    license_qty: string;
+    currency: string;
+    option_code: string;
+    usage?: unknown[];
+    created_at: ISODateString;
+    updated_at: ISODateString;
+    [key: string]: unknown;
+}
+/** Payload for `POST subscription/renew` — renews an expired subscription (bundle-aware). */
+export interface RenewSubscriptionPayload {
+    subscription_id: string;
+    /** BCP-47-ish locale, e.g. "en_US". Defaults to "en_US" server-side. */
+    lang?: string;
+    /** ISO 4217 currency code, e.g. "USD". Defaults to "USD" server-side. */
+    currency?: string;
+}
+export interface RenewSubscriptionResult {
+    message: string;
+    invoice: Invoice;
+    checkout_link: string;
+    transaction_id: string;
+    new_expires_at: string;
+    amount: number;
+    bundle_count: number;
+    [key: string]: unknown;
+}
+/** Payload for `POST subscription/cancel`. */
+export interface CancelSubscriptionPayload {
+    subscription_id: string;
+    reason?: string;
+}
+export interface CancelSubscriptionResult {
+    message: string;
+    refund_issued: boolean;
+    subscription?: Subscription;
+    refund_transaction_id?: string;
+    [key: string]: unknown;
+}
+export type InvoiceStatus = "draft" | "pending" | "paid" | "canceled" | "refunded" | "overdue" | "void";
+export interface InvoiceLineItem {
+    description: string;
+    quantity: number;
+    unit_price: number;
+    amount: number;
+    product_id?: string;
+    option_code?: string;
+    [key: string]: unknown;
+}
+export interface Invoice {
+    uuid: string;
+    project_uuid: string;
+    subscription_uuids?: string[];
+    ref_no: string;
+    invoice_number: string;
+    status: InvoiceStatus;
+    period_start: ISODateString | null;
+    period_end: ISODateString | null;
+    due_date: ISODateString | null;
+    paid_at: ISODateString | null;
+    subtotal: number;
+    tax_amount: number;
+    tax_rate: number;
+    discount: number;
+    total: number;
+    amount_paid: number;
+    amount_due: number;
+    currency: string;
+    payment_provider: string;
+    payment_method: string;
+    transaction_id: string;
+    payment_reference: string;
+    external_reference?: string;
+    billing_name?: string;
+    billing_company?: string;
+    billing_address?: string;
+    billing_city?: string;
+    billing_zipcode?: string;
+    billing_country?: string;
+    billing_state?: string;
+    billing_email?: string;
+    billing_vat_number?: string;
+    description: string;
+    notes?: string;
+    line_items?: InvoiceLineItem[];
+    metadata?: Record<string, unknown>;
+    created_at: ISODateString;
+    updated_at: ISODateString;
+    [key: string]: unknown;
+}
+export interface BalanceResult {
+    balance_usd: number;
+    balance_display: number;
+    exchange_rate: number;
+    currency: string;
+    topup_bonus?: number;
+    [key: string]: unknown;
+}
+/** Payload for `POST billing/topup`. */
+export interface TopUpPayload {
+    /** Purchase amount in USD cents (e.g. 1000 = $10.00). */
+    amount_cents: number;
+    /** ISO 4217 currency code. Defaults to "USD" server-side. */
+    currency?: string;
+}
+export interface TopUpResult {
+    checkout_url: string;
+    ref_no: string;
+    [key: string]: unknown;
+}
+export interface CreditsHistoryQuery {
+    /** Max rows to return (server default 50, capped at 200). */
+    limit?: number;
+    offset?: number;
+    /** Filter by entry type (e.g. "deduction" | "topup"). */
+    type?: string;
+    year?: number;
+    month?: number;
+}
+export interface CreditsHistoryItem {
+    id: string;
+    type: string;
+    amount_usd: number;
+    amount_display: number;
+    currency: string;
+    amount_micro_cents: number;
+    product_id?: string;
+    option_code?: string;
+    created_at: string;
+    event_count: number;
+    [key: string]: unknown;
+}
+export interface CreditsHistoryResult {
+    items: CreditsHistoryItem[];
+    total: number;
+    limit: number;
+    offset: number;
+    currency: string;
+    [key: string]: unknown;
+}
+/** Per-usage-domain pricing entries (usage-based pricing table), keyed by option code. */
+export interface UsagePriceEntry {
+    price: number;
+    precision: number;
+    min_infra_cost?: number;
+    [key: string]: unknown;
+}
+/** Response of `GET prices/{currency}` — server-computed pricing table for the given currency. */
+export type SubscriptionPrices = Record<string, unknown>;
+export type BillingMode = "credits" | "hybrid" | "invoice";
+export interface BillingModeEntry {
+    option_code: string;
+    mode: BillingMode;
+    [key: string]: unknown;
+}
+export interface GetBillingModesResult {
+    usage_billing_modes: BillingModeEntry[];
+    platform_defaults: Record<string, unknown>;
+    allowed_modes: Record<string, BillingMode[]>;
+    [key: string]: unknown;
+}
+/** Payload for `PUT billing/billing-modes` — overrides the billing mode for one usage option code. */
+export interface UpdateBillingModePayload {
+    option_code: string;
+    mode: BillingMode;
+}
+export interface UpdateBillingModeResult {
+    status: boolean;
+    option_code: string;
+    mode: BillingMode;
+    [key: string]: unknown;
+}

package/dist/v0.10/types/users.d.ts

@@ -65,3 +65,13 @@ export interface Permission {
     action: string;
     role_uuid: string;
 }
+/**
+ * Resolved RBAC permission set for a user on the current project.
+ * Matches the dashboard `models.Permissions` response shape returned by
+ * `GET /v1/user/role/permissions` and `GET /v1/user/role/principal-permissions`.
+ */
+export interface Permissions {
+    is_admin: boolean;
+    roles: string[];
+    permissions: string[];
+}

package/dist/v0.10/types/workflow.d.ts

@@ -45,4 +45,107 @@ type WorkflowUpdatePayload = {
     settings?: WorkflowSettings[];
 };
 type WorkflowListResponse = WorkflowModel[];
-export { WorkflowNode, WorkflowNodeConnection, WorkflowSettings, WorkflowModel, WorkflowCreatePayload, WorkflowUpdatePayload, WorkflowListResponse, };
+type WorkflowInstallPayload = {
+    name: string;
+    project_uuid?: string;
+    dev_version?: string;
+    public_version?: string;
+    integrator?: string;
+    settings: WorkflowSettings;
+};
+type WorkflowHistoryQuery = {
+    limit?: number;
+    offset?: number;
+    status?: string;
+    ref?: string;
+    type?: string;
+    workflow_name?: string;
+    context_uuid?: string;
+    date_from?: string;
+};
+type WorkflowHistoryEntry = {
+    execution_uuid: string;
+    project_uuid: string;
+    status: string;
+    ref?: string;
+    type?: string;
+    context_uuid?: string;
+    start_time: string;
+    duration?: number;
+    [key: string]: any;
+};
+type WorkflowHistoryGroup = {
+    context_uuid: string;
+    executions: WorkflowHistoryEntry[];
+};
+type WorkflowHistoryListResponse = {
+    data: WorkflowHistoryGroup[];
+    total: number;
+    limit: number;
+    offset: number;
+};
+type WorkflowStatsQuery = {
+    days?: number;
+};
+type WorkflowStats = {
+    period_days: number;
+    total_executions: number;
+    overall_avg_duration: number;
+    status_counts: Record<string, number>;
+    avg_durations: Record<string, number>;
+    daily_counts?: Record<string, any>[];
+    [key: string]: any;
+};
+type WorkflowRunningQuery = {
+    limit?: number;
+    offset?: number;
+    status?: string;
+    type?: string;
+    ref?: string;
+    workflow_name?: string;
+    context_uuid?: string;
+};
+type WorkflowRunningExecution = {
+    execution_uuid: string;
+    project_uuid: string;
+    workflow_name: string;
+    type: string;
+    ref: string;
+    context_uuid: string;
+    status: string;
+    start_time: string;
+    duration: number;
+    env?: string;
+    input_data?: any;
+    execution_nodes?: any;
+    current_node_id?: number;
+    [key: string]: any;
+};
+type WorkflowRunningListResponse = {
+    data: WorkflowRunningExecution[];
+    total: number;
+    limit: number;
+    offset: number;
+};
+type WorkflowControlResponse = {
+    status: boolean;
+};
+type WorkflowRestartOptions = {
+    clearState?: boolean;
+};
+type WorkflowRestartResponse = {
+    status: boolean;
+    execution_uuid: string;
+};
+type WorkflowNodeControlOptions = {
+    iterationIdx?: number;
+    parentNodeId?: number;
+};
+type WorkflowError = {
+    _id: string;
+    projectuuid?: string;
+    last_occurence?: string;
+    [key: string]: any;
+};
+type WorkflowErrorListResponse = WorkflowError[];
+export { WorkflowNode, WorkflowNodeConnection, WorkflowSettings, WorkflowModel, WorkflowCreatePayload, WorkflowUpdatePayload, WorkflowListResponse, WorkflowInstallPayload, WorkflowHistoryQuery, WorkflowHistoryEntry, WorkflowHistoryGroup, WorkflowHistoryListResponse, WorkflowStatsQuery, WorkflowStats, WorkflowRunningQuery, WorkflowRunningExecution, WorkflowRunningListResponse, WorkflowControlResponse, WorkflowRestartOptions, WorkflowRestartResponse, WorkflowNodeControlOptions, WorkflowError, WorkflowErrorListResponse, };

package/dist/v0.9/api/users.d.ts

@@ -1,5 +1,5 @@
 import PlatformBaseClient from "./platformBaseClient";
-import { UserClaims, UserModel, Role, CreateRoleRequest, EditRoleRequest, RoleModel, Permission } from "../types/users";
+import { UserClaims, UserModel, Role, CreateRoleRequest, EditRoleRequest, RoleModel, Permission, Permissions } from "../types/users";
 import { AxiosResponse } from "axios";
 export default class Users extends PlatformBaseClient {
     auth(username: string, password: string, project: string): Promise<AxiosResponse<any>>;
@@ -28,9 +28,28 @@ export default class Users extends PlatformBaseClient {
      */
     editProfile(data: any): Promise<AxiosResponse<any>>;
     /**
-     * Get user permissions
+     * Get the current token's permissions.
+     *
+     * Returns the resolved permission set carried by the calling token. For a
+     * forge actor token this is the scoped intersection minted at launch time —
+     * see `getPrincipalPermissions()` for the underlying user's full set.
      */
-    getPermissions(): Promise<AxiosResponse<Permission[]>>;
+    getPermissions(): Promise<AxiosResponse<Permissions>>;
+    /**
+     * Get the FULL permissions of the user the current token is acting on behalf
+     * of (the "principal").
+     *
+     * When a forge app runs under an actor token, `getPermissions()` returns only
+     * the token's scoped permissions — the intersection of the app's declared
+     * runtime permissions and the user's permissions. This instead returns the
+     * complete permission set of the underlying user, so the app can check what
+     * that user is actually allowed to do, independent of what the app itself was
+     * granted. The token scope is unchanged: this exposes knowledge, not capability.
+     *
+     * For a normal user session (no actor token) it returns the caller's own
+     * permissions, identical to `getPermissions()`'s scope.
+     */
+    getPrincipalPermissions(): Promise<AxiosResponse<Permissions>>;
     /**
      * Get list of available permissions
      */