@ptkl/sdk 1.13.0 → 1.15.0

package/dist/index.0.9.js

@@ -582,11 +582,32 @@ var ProtokolSDK09 = (function (exports, axios) {
         }
         // Permissions & Roles
         /**
-         * 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.
          */
         async getPermissions() {
             return await this.client.get("/v1/user/role/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.
+         */
+        async getPrincipalPermissions() {
+            return await this.client.get("/v1/user/role/principal-permissions");
+        }
         /**
          * Get list of available permissions
          */

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ptkl/sdk",
-  "version": "1.13.0",
+  "version": "1.15.0",
   "scripts": {
     "build": "rollup -c",
     "build:monaco": "npm run build && node scripts/generate-monaco-types.cjs",

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

@@ -1,4 +1,4 @@
-import { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions, ModifyOptions, StreamHandler, AggregateChainable, FindChainable, FindStreamMeta, FindStreamMetaCallback, ComponentOptions, UpdateManyOptions, CreateManyOptions, Extension, Policy } from "../types/component";
+import { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions, ModifyOptions, StreamHandler, AggregateChainable, FindChainable, FindStreamMeta, FindStreamMetaCallback, FindStreamCursor, FindStreamCursorCallback, ComponentOptions, UpdateManyOptions, CreateManyOptions, Extension, Policy } from "../types/component";
 import PlatformBaseClient from "./platformBaseClient";
 import { AxiosResponse } from "axios";
 import type { ComponentModels, ComponentFunctions } from "../types/functions";
@@ -46,6 +46,7 @@ export default class Component<C extends string = string> extends PlatformBaseCl
         total: number;
         page: number;
         pages: number;
+        next_cursor?: string;
     }>>;
     /**
      * FindOne method to search for a single model
@@ -329,4 +330,4 @@ export default class Component<C extends string = string> extends PlatformBaseCl
      */
     private _streamNDJSONNode;
 }
-export { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions, StreamHandler, AggregateChainable, FindChainable, FindStreamMeta, FindStreamMetaCallback, ComponentOptions, Extension, };
+export { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions, StreamHandler, AggregateChainable, FindChainable, FindStreamMeta, FindStreamMetaCallback, FindStreamCursor, FindStreamCursorCallback, ComponentOptions, Extension, };

package/dist/v0.10/api/forge.d.ts

@@ -8,8 +8,30 @@ export default class Forge extends PlatformBaseClient {
     getVariables(ref: string): Promise<any>;
     updateVariables(ref: string, variables: Record<string, any>): Promise<any>;
     addVariable(ref: string, key: string, value: any): Promise<any>;
-    callService(appUuid: string, serviceName: string, options?: {
-        body?: any;
+    /**
+     * Run a Forge service: `runService(target, body?, { query?, headers? })`.
+     * Mirrors `axios.post(url, data, config)` — the 2nd arg is the request payload.
+     *
+     * `target` is either:
+     *  - a bare service name — runs that service on the CURRENT app; or
+     *  - a service PRN `prn:forge:{ref}:service/{name}` — runs it on ANOTHER app,
+     *    where `ref` is the app's **name** or uuid. A name is resolved by the
+     *    runtime deterministically (marketplace → custom); use the uuid to pin a
+     *    specific app. This is the addressing to use where there's no ambient
+     *    "current app" — e.g. a workflow, which has no per-install uuid to hardcode.
+     *
+     * `body` is sent as the POST body; `options.query` / `options.headers` are optional.
+     *
+     * The current app's uuid (bare-name form) is resolved automatically from the
+     * platform context (FORGE_APP_UUID for public views, forge_app_uuid in
+     * sessionStorage for platform views), so app code never needs its own uuid.
+     *
+     * Resolving the app does NOT grant access. Execution is still authorized against
+     * the caller's permissions — for a `platform`-access service the caller must hold
+     * `service::{name} forge::{appUuid}`; `public`-access services require none. An
+     * app's own runtime token is implicitly granted this for all of its own services.
+     */
+    runService(target: string, body?: any, options?: {
         query?: Record<string, string>;
         headers?: Record<string, string>;
     }): Promise<any>;

package/dist/v0.10/api/index.d.ts

@@ -35,3 +35,5 @@ export { default as VPFR } from './integrations/serbia/minfin/vpfr';
 export { default as Mail } from './integrations/mail';
 export { default as Ecommerce } from './integrations/ecommerce';
 export { default as Timber } from './integrations/timber';
+export { default as Transactions } from './transactions';
+export type { ISODateString as TransactionsISODateString, Subscription as TransactionsSubscription, RenewSubscriptionPayload, RenewSubscriptionResult, CancelSubscriptionPayload, CancelSubscriptionResult, InvoiceStatus as TransactionsInvoiceStatus, InvoiceLineItem as TransactionsInvoiceLineItem, Invoice as TransactionsInvoice, BalanceResult, TopUpPayload as TransactionsTopUpPayload, TopUpResult as TransactionsTopUpResult, CreditsHistoryQuery, CreditsHistoryItem, CreditsHistoryResult, UsagePriceEntry, SubscriptionPrices, BillingMode, BillingModeEntry, GetBillingModesResult, UpdateBillingModePayload, UpdateBillingModeResult, } from '../types/transactions';

package/dist/v0.10/api/integrations/dms.d.ts

@@ -1,6 +1,6 @@
 import IntegrationsBaseClient from "../integrationsBaseClient";
 import { AxiosResponse } from "axios";
-import { PDFFillOptions, DataConversionParams, DataValidationParams, DataInfoParams, DataInfo, DataValidationResult, ConversionOptions, HTML2PDFOptions, PDF2HTMLOptions, MediaUploadPayload, MediaUploadBase64Payload, DocumentListParams, DocumentListResponse, DocumentCreatePayload, DocumentUpdatePayload, DocumentRestorePayload, DocumentCommentPayload, DocumentResponse, DocumentGeneratePayload, DocumentGenerateResponse, DocumentRevisionListResponse, ExtractTextPayload, ExtractTextResult, OCRExtractPayload, OCRExtractResult } from "../../types/integrations";
+import { PDFFillOptions, DataConversionParams, DataValidationParams, DataInfoParams, DataInfo, DataValidationResult, ConversionOptions, HTML2PDFOptions, PDF2HTMLOptions, MediaUploadPayload, MediaUploadBase64Payload, DocumentListParams, DocumentListResponse, DocumentCreatePayload, DocumentUpdatePayload, DocumentRestorePayload, DocumentCommentPayload, DocumentResponse, DocumentGeneratePayload, DocumentGenerateResponse, DocumentRevisionListResponse, ExtractTextPayload, ExtractTextResult, OCRExtractPayload, OCRExtractResult, LibraryExportCreatePayload, LibraryExportListResponse, MediaExportCreateResult, LibraryExportGetResult, LibraryPolicy, LibraryPolicyPayload, DirPolicy, DirPolicyPayload, NotificationRuleCreatePayload, NotificationRule, NotificationRuleListResponse, FileNotificationCreatePayload, FileNotification, FileNotificationListResponse } from "../../types/integrations";
 /**
  * Document Management System (DMS) API client
  *
@@ -510,6 +510,98 @@ export default class DMS extends IntegrationsBaseClient {
      * ```
      */
     ocrExtract(payload: OCRExtractPayload): Promise<AxiosResponse<OCRExtractResult>>;
+    /**
+     * Create a library export archive (a snapshot of the project's library or a directory within it)
+     *
+     * The library is resolved server-side from the project in the auth context —
+     * there is a single library per project.
+     *
+     * @param payload - Optional export scope/format options
+     * @returns `{ mode, export }` when the export is queued asynchronously.
+     *   Depending on server-side sizing, the endpoint may instead stream the
+     *   archive back directly as a binary response body (not this JSON shape).
+     *
+     * @example
+     * ```typescript
+     * const result = await dms.createExport({ path: 'legal', format: 'zip' });
+     * ```
+     */
+    createExport(payload?: LibraryExportCreatePayload): Promise<AxiosResponse<MediaExportCreateResult>>;
+    /**
+     * List export archives for the project's library
+     */
+    listExports(): Promise<AxiosResponse<LibraryExportListResponse>>;
+    /**
+     * Get a single export archive (an archived snapshot of a library/dir)
+     *
+     * @param exportUuid - Export UUID
+     * @returns `{ export, download_url }`
+     */
+    getExport(exportUuid: string): Promise<AxiosResponse<LibraryExportGetResult>>;
+    /**
+     * Get the effective library-level policy for the project's library
+     */
+    getLibraryPolicy(): Promise<AxiosResponse<LibraryPolicy>>;
+    /**
+     * Set/update the library-level policy for the project's library
+     *
+     * @param payload - Policy fields to set
+     */
+    setLibraryPolicy(payload: LibraryPolicyPayload): Promise<AxiosResponse<LibraryPolicy>>;
+    /**
+     * Get the directory-level policy (resolves platform-default → library → dir)
+     *
+     * @param path - Directory path
+     */
+    getDirPolicy(path: string): Promise<AxiosResponse<DirPolicy>>;
+    /**
+     * Set/update the directory-level policy
+     *
+     * @param path - Directory path
+     * @param payload - Policy fields to set (only fields provided override the library policy)
+     */
+    setDirPolicy(path: string, payload: DirPolicyPayload): Promise<AxiosResponse<DirPolicy>>;
+    /**
+     * Remove a directory-level policy override (directory falls back to the library policy)
+     *
+     * @param path - Directory path
+     */
+    deleteDirPolicy(path: string): Promise<AxiosResponse<any>>;
+    /**
+     * List notification rules for the project's library
+     */
+    listNotificationRules(): Promise<AxiosResponse<NotificationRuleListResponse>>;
+    /**
+     * Create a recurring reminder (notification rule) for a media file
+     *
+     * @param payload - Recurring reminder definition (media_uuid/file_key, frequency, start_at, ...)
+     */
+    createNotificationRule(payload: NotificationRuleCreatePayload): Promise<AxiosResponse<NotificationRule>>;
+    /**
+     * Delete a notification rule
+     *
+     * @param ruleUuid - Notification rule UUID
+     */
+    deleteNotificationRule(ruleUuid: string): Promise<AxiosResponse<any>>;
+    /**
+     * List custom reminders scheduled for a specific file
+     *
+     * @param mediaUuid - Media UUID
+     */
+    listFileNotifications(mediaUuid: string): Promise<AxiosResponse<FileNotificationListResponse>>;
+    /**
+     * Create a custom reminder for a specific file
+     *
+     * @param mediaUuid - Media UUID
+     * @param payload - Reminder details (note, notify_at, optional recipient)
+     */
+    createFileNotification(mediaUuid: string, payload: FileNotificationCreatePayload): Promise<AxiosResponse<FileNotification>>;
+    /**
+     * Cancel/delete a custom file reminder
+     *
+     * @param notificationUuid - Notification UUID
+     */
+    deleteFileNotification(notificationUuid: string): Promise<AxiosResponse<any>>;
     request(method: string, endpoint: string, params?: any): Promise<AxiosResponse<any, any>>;
     requestv2(method: string, endpoint: string, params?: any): Promise<AxiosResponse<any, any>>;
     requestv1(method: string, endpoint: string, params?: any): Promise<AxiosResponse<any, any>>;

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

@@ -27,5 +27,43 @@ export default class Integrations extends IntegrationsBaseClient {
     list(): Promise<any>;
     isInstalled(id: string): Promise<boolean>;
     isActive(id: string): Promise<boolean>;
+    /**
+     * Install (integrate) an integration into the current project.
+     * POST /v1/integrate
+     */
+    install(id: string, data?: Record<string, any>): Promise<any>;
+    /**
+     * Uninstall (remove) an integration from the current project.
+     * PUT /v1/integrate
+     */
+    uninstall(id: string): Promise<any>;
+    /**
+     * Activate an installed integration.
+     * POST /v1/integration/{id}/activate
+     */
+    activate(id: string): Promise<any>;
+    /**
+     * Deactivate an installed integration.
+     * POST /v1/integration/{id}/deactivate
+     */
+    deactivate(id: string): Promise<any>;
+    /**
+     * Advance/update the onboarding state of an installed integration.
+     * POST /v1/integration/{id}/onboarding
+     */
+    onboarding(id: string, data: {
+        step: string;
+        data?: Record<string, any>;
+    }): Promise<any>;
+    /**
+     * List marketplace-available integrations (subscription/geo aware).
+     * GET /v1/marketplace/integrations
+     */
+    marketplace(): Promise<any>;
+    /**
+     * List explorable integration templates (subscription/geo aware).
+     * GET /v1/integrations/explore
+     */
+    explore(): Promise<any>;
     getInterfaceOf(id: string): any;
 }

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

@@ -1,6 +1,6 @@
 import { AxiosResponse } from 'axios';
 import PlatformBaseClient from "./platformBaseClient";
-import { PagedResponse, PaginationParams, Agent, AgentCreatePayload, AgentUpdatePayload, KnowledgeBase, KnowledgeBaseCreatePayload, KnowledgeBaseUpdatePayload, Document, Conversation, ConversationCreatePayload, ConversationUpdatePayload, ParticipantAddPayload, Message, SendMessagePayload, InjectMessagePayload, OCRPayload, OCRResult, UserAccess, UserAccessCreatePayload, UserAccessUpdatePayload, UserMonthlyUsage, UserUsageBreakdown, MyAccess, AggregatedUsage, Tier } from '../types/kortex';
+import { PagedResponse, PaginationParams, Agent, AgentCreatePayload, AgentUpdatePayload, KnowledgeBase, KnowledgeBaseCreatePayload, KnowledgeBaseUpdatePayload, Document, Conversation, ConversationCreatePayload, ConversationUpdatePayload, ParticipantAddPayload, Message, SendMessagePayload, InjectMessagePayload, OCRPayload, OCRResult, UserAccess, UserAccessCreatePayload, UserAccessUpdatePayload, UserMonthlyUsage, UserUsageBreakdown, MyAccess, AggregatedUsage, Tier, KnowledgeBaseSearchPayload, KnowledgeBaseSearchResult, KortexWorkflowPayload, KortexWorkflowResult } from '../types/kortex';
 export default class Kortex extends PlatformBaseClient {
     createAgent(data: AgentCreatePayload): Promise<AxiosResponse<Agent>>;
     listAgents(params?: PaginationParams): Promise<AxiosResponse<PagedResponse<Agent>>>;
@@ -13,6 +13,7 @@ export default class Kortex extends PlatformBaseClient {
     getKnowledgeBase(uuid: string): Promise<AxiosResponse<KnowledgeBase>>;
     updateKnowledgeBase(uuid: string, data: KnowledgeBaseUpdatePayload): Promise<AxiosResponse<KnowledgeBase>>;
     deleteKnowledgeBase(uuid: string): Promise<AxiosResponse<void>>;
+    searchKnowledgeBase(data: KnowledgeBaseSearchPayload): Promise<AxiosResponse<KnowledgeBaseSearchResult>>;
     listDocuments(kbUUID: string, params?: PaginationParams): Promise<AxiosResponse<PagedResponse<Document>>>;
     uploadDocument(kbUUID: string, formData: FormData): Promise<AxiosResponse<Document>>;
     getDocument(kbUUID: string, uuid: string): Promise<AxiosResponse<Document>>;
@@ -35,6 +36,8 @@ export default class Kortex extends PlatformBaseClient {
     listMessages(conversationUUID: string, params?: PaginationParams): Promise<AxiosResponse<PagedResponse<Message>>>;
     injectMessage(conversationUUID: string, data: InjectMessagePayload): Promise<AxiosResponse<Message>>;
     ocr(data: OCRPayload): Promise<AxiosResponse<OCRResult>>;
+    workflowComplete(data: KortexWorkflowPayload): Promise<AxiosResponse<KortexWorkflowResult>>;
+    workflowOcr(data: OCRPayload): Promise<AxiosResponse<OCRResult>>;
     createUserAccess(data: UserAccessCreatePayload): Promise<AxiosResponse<UserAccess>>;
     listUserAccess(params?: PaginationParams): Promise<AxiosResponse<PagedResponse<UserAccess>>>;
     getUserAccess(uuid: string): Promise<AxiosResponse<UserAccess>>;

package/dist/v0.10/api/platform.d.ts

@@ -15,6 +15,9 @@ import Kortex from "./kortex";
 import Project from "./project";
 import Config from "./config";
 import PlatformBaseClient from "./platformBaseClient";
+import Integrations from "./integrations";
+import Satellites from "./satellites";
+import Transactions from "./transactions";
 export default class Platform extends PlatformBaseClient {
     getPlatformClient(): AxiosInstance;
     getPlatformBaseURL(): string;
@@ -33,4 +36,45 @@ export default class Platform extends PlatformBaseClient {
     thunder(): Thunder;
     project(): Project;
     config(): Config;
+    /**
+     * Convenience factory for the Integrations gateway façade.
+     *
+     * Integrations live behind a different gateway (`INTEGRATION_API` /
+     * `host/luma/integrations`) than the rest of the platform API, so this
+     * returns an independently-configured `Integrations` client (it does not
+     * reuse `this.client`, whose base URL points at the platform host). The
+     * Platform's resolved token/env/host are propagated so the child client
+     * carries the same credentials.
+     */
+    integrations(): Integrations;
+    /**
+     * Convenience factory for the Satellites (custom JSON-RPC integrations) client.
+     *
+     * Same gateway note as `integrations()` — Satellites talks to the
+     * integrations gateway, not the platform host, so a fresh, independently
+     * configured client is returned, with the Platform's credentials propagated.
+     */
+    satellites(): Satellites;
+    /**
+     * Builds the options for a child integrations-gateway client (`Integrations`/
+     * `Satellites`), propagating this Platform's resolved token/env, and deriving
+     * the gateway host from this Platform's host when one was explicitly set.
+     * When `this.host` is unset, `host` is left `undefined` so the child client's
+     * own env-var/default resolution applies.
+     */
+    private getIntegrationsGatewayOptions;
+    /**
+     * Transactions (billing) client — subscriptions, invoices, credits/balance,
+     * usage pricing and billing-mode overrides. Reached through the platform
+     * gateway (`transactions/…`), so it reuses `this.client` like the other
+     * native/proxied-service factories.
+     *
+     * This is the **billing** service — not distributed/database transactions.
+     */
+    transactions(): Transactions;
+    /**
+     * Alias for `transactions()` — reads more naturally at call sites that
+     * only care about billing (`platform.billing().getBalance()`).
+     */
+    billing(): Transactions;
 }

package/dist/v0.10/api/project.d.ts

@@ -23,11 +23,31 @@ export default class Project extends PlatformBaseClient {
      */
     archive(): Promise<AxiosResponse<any>>;
     /**
-     * Invite a user to the project
-     * @param emails Array of emails
-     * @param roles Array of role UUIDs
-     */
-    invite(emails: string[], roles: string[]): Promise<AxiosResponse<any>>;
+     * Invite one or more users to the project.
+     *
+     * `POST /v1/project/invite` only accepts a single `email` per request
+     * (see `InviteToProject` in platform-api's
+     * `internal/project/controllers/invite.go`), so this method issues one
+     * request per entry in `emails`, sequentially, with body
+     * `{ email, role_uuid: roles, subject?, comment? }`.
+     *
+     * Return shape (always a single `AxiosResponse`, so existing callers
+     * that do `(await project.invite(...)).data` keep compiling/working
+     * unchanged):
+     * - Exactly one email: the raw `AxiosResponse` from that single request
+     *   (`.data` is that invite's response body, as before).
+     * - More than one email: a response shaped like the last request's
+     *   `AxiosResponse`, but with `.data` replaced by an array of each
+     *   individual request's `.data`, in the same order as `emails`.
+     *
+     * @param emails Array of email addresses to invite
+     * @param roles Array of role UUIDs to grant every invitee
+     * @param extra Optional subject/comment applied to every invite
+     */
+    invite(emails: string[], roles: string[], extra?: {
+        subject?: string;
+        comment?: string;
+    }): Promise<AxiosResponse<any>>;
     /**
      * Get list of project invites
      */
@@ -122,8 +142,17 @@ export default class Project extends PlatformBaseClient {
      */
     getWorkspaceTemplates(): Promise<AxiosResponse<any>>;
     /**
-     * Install a template
-     * @param data Installation data
+     * Install a template.
+     *
+     * `POST /v1/project/template/install` decodes body `TemplateInstall = { id,
+     * data, activation_code }` and resolves the target workspace from the
+     * `X-Workspace-Uuid` request header (not the body) — see platform-api's
+     * `template_install.go`. This method keeps the ergonomic object-arg
+     * signature but maps it onto that contract: `template_id` becomes body
+     * `id`, `workspace_uuid` is sent as the `X-Workspace-Uuid` header, and any
+     * `data`/`activation_code` passed in are forwarded in the body as-is.
+     *
+     * @param data `{ template_id, workspace_uuid, data?, activation_code? }`
      */
     installTemplate(data: {
         template_id: string;
@@ -131,8 +160,14 @@ export default class Project extends PlatformBaseClient {
         [key: string]: any;
     }): Promise<AxiosResponse<any>>;
     /**
-     * Uninstall a template
-     * @param data Uninstallation data
+     * Uninstall a template.
+     *
+     * `POST /v1/project/template/uninstall` decodes body `TemplateInstall = {
+     * id, data, activation_code }` and resolves the target workspace from the
+     * `X-Workspace-Uuid` request header (not the body) — see platform-api's
+     * `template_uninstall.go`. See `installTemplate` for the mapping.
+     *
+     * @param data `{ template_id, workspace_uuid, data?, activation_code? }`
      */
     uninstallTemplate(data: {
         template_id: string;
@@ -140,8 +175,14 @@ export default class Project extends PlatformBaseClient {
         [key: string]: any;
     }): Promise<AxiosResponse<any>>;
     /**
-     * Upgrade a template
-     * @param data Upgrade data
+     * Upgrade a template.
+     *
+     * `POST /v1/project/template/upgrade` decodes body `TemplateInstall = {
+     * id, data, activation_code }` and resolves the target workspace from the
+     * `X-Workspace-Uuid` request header (not the body) — see platform-api's
+     * `template_upgrade.go`. See `installTemplate` for the mapping.
+     *
+     * @param data `{ template_id, workspace_uuid, data?, activation_code? }`
      */
     upgradeTemplate(data: {
         template_id: string;

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

@@ -1,7 +1,19 @@
+import { AxiosResponse } from "axios";
 import PlatformBaseClient from "./platformBaseClient";
+import type { CreateSparkPayload, UpdateSparkPayload, Spark, SparkEnv, SparkLogsParams, SparkTier, CreateRuntimePayload, UpdateRuntimePayload, Runtime, RuntimeLogsParams } from "../types/sandbox";
+/**
+ * Sandbox client — spark (FaaS) functions/apps, long-running runtimes, and
+ * their K8s deployments. All routes go through the `sandbox/…` gateway
+ * prefix (`/luma/sandbox/v1/...`), matching the sandbox service's REST
+ * surface (`internal/controllers/{spark.go,spark.v1.go,runtime.v1.go}` and
+ * the deployment lifecycle in `internal/controllers/ecomm/deployment.go`).
+ */
 export default class Sandbox extends PlatformBaseClient {
     /**
-     * Call the sandbox service to execute a serverless function
+     * Call the sandbox service to execute a serverless function.
+     *
+     * Kept for backwards compatibility — equivalent to
+     * `execSpark(name, data)`.
      *
      * @param name
      * @param data
@@ -10,5 +22,117 @@ export default class Sandbox extends PlatformBaseClient {
      * @example
      * const result = await platform.sandbox().spark("myFunction", { foo: "bar" })
      */
-    spark(name: string, data: any): Promise<import("axios").AxiosResponse<any, any>>;
+    spark(name: string, data: any): Promise<AxiosResponse<any, any>>;
+    /**
+     * Create a new spark (function or app).
+     *
+     * @example
+     * const spark = await platform.sandbox().createSpark({ name: "myFunction", runtime: "node20", memory: 256 })
+     */
+    createSpark(payload: CreateSparkPayload): Promise<AxiosResponse<Spark>>;
+    /**
+     * Get a spark by uuid.
+     */
+    getSpark(uuid: string): Promise<AxiosResponse<Spark>>;
+    /**
+     * Update a spark's memory/settings/env vars.
+     */
+    updateSpark(uuid: string, payload: UpdateSparkPayload): Promise<AxiosResponse<Spark>>;
+    /**
+     * Delete a spark.
+     */
+    deleteSpark(uuid: string): Promise<AxiosResponse<{
+        status: boolean;
+    }>>;
+    /**
+     * List all sparks for the current project.
+     */
+    listSparks(): Promise<AxiosResponse<Spark[]>>;
+    /**
+     * Deploy a specific spark version to the dev environment.
+     */
+    deploySpark(uuid: string, version: string): Promise<AxiosResponse<{
+        status: boolean;
+    }>>;
+    /**
+     * Cancel an in-progress spark deployment.
+     *
+     * @param uuid
+     * @param env - defaults to "dev" on the server if omitted
+     */
+    cancelSpark(uuid: string, env?: SparkEnv): Promise<AxiosResponse<{
+        status: boolean;
+    }>>;
+    /**
+     * Release a deployed spark version to the live/public environment.
+     */
+    releaseSpark(uuid: string, version: string): Promise<AxiosResponse<{
+        status: boolean;
+    }>>;
+    /**
+     * Execute a deployed spark by name. Mirrors `spark()` but accepts the
+     * full request shape (method/query/headers) — the exec route accepts
+     * GET/POST/PATCH/PUT/DELETE.
+     *
+     * @example
+     * const result = await platform.sandbox().execSpark("myFunction", { foo: "bar" })
+     * const result = await platform.sandbox().execSpark("myFunction", undefined, { method: "GET" })
+     */
+    execSpark(name: string, data?: any, options?: {
+        method?: "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
+        query?: Record<string, string>;
+        headers?: Record<string, string>;
+    }): Promise<AxiosResponse<any>>;
+    /**
+     * Fetch logs for a spark.
+     */
+    sparkLogs(uuid: string, params?: SparkLogsParams): Promise<AxiosResponse<any>>;
+    /**
+     * Get the current project's spark tier (plan/quota).
+     */
+    sparkTier(): Promise<AxiosResponse<SparkTier>>;
+    /**
+     * List all runtimes for the current project.
+     */
+    listRuntimes(): Promise<AxiosResponse<Runtime[]>>;
+    /**
+     * Create a new runtime.
+     */
+    createRuntime(payload: CreateRuntimePayload): Promise<AxiosResponse<{
+        status: boolean;
+    }>>;
+    /**
+     * Get a runtime by ref (name/uuid).
+     */
+    getRuntime(ref: string): Promise<AxiosResponse<{
+        status: boolean;
+    }>>;
+    /**
+     * Update a runtime's image/resources/env vars/tags.
+     */
+    updateRuntime(ref: string, payload: UpdateRuntimePayload): Promise<AxiosResponse<{
+        status: boolean;
+    }>>;
+    /**
+     * Delete a runtime.
+     */
+    deleteRuntime(ref: string): Promise<AxiosResponse<{
+        status: boolean;
+    }>>;
+    /**
+     * (Re)deploy a runtime.
+     */
+    deployRuntime(ref: string): Promise<AxiosResponse<{
+        status: boolean;
+    }>>;
+    /**
+     * Restart a running runtime.
+     */
+    restartRuntime(ref: string): Promise<AxiosResponse<{
+        status: boolean;
+    }>>;
+    /**
+     * Fetch logs for a runtime.
+     */
+    runtimeLogs(ref: string, params?: RuntimeLogsParams): Promise<AxiosResponse<any>>;
 }

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

@@ -0,0 +1,75 @@
+import { AxiosResponse } from "axios";
+import PlatformBaseClient from "./platformBaseClient";
+import type { Subscription, RenewSubscriptionPayload, RenewSubscriptionResult, CancelSubscriptionPayload, CancelSubscriptionResult, Invoice, BalanceResult, TopUpPayload, TopUpResult, CreditsHistoryQuery, CreditsHistoryResult, SubscriptionPrices, GetBillingModesResult, UpdateBillingModePayload, UpdateBillingModeResult } from "../types/transactions";
+/**
+ * Transactions client — billing/subscriptions, invoices, credits/balance,
+ * usage pricing and per-project billing-mode overrides. All routes go
+ * through the `transactions/…` gateway prefix (`/luma/transactions/v1/...`),
+ * matching the transactions service's REST surface
+ * (`internal/controllers/{subscription,invoices,topup,credit_history,billing_modes,prices,balance}.go`).
+ *
+ * This is the **billing** service — not distributed/database transactions.
+ */
+export default class Transactions extends PlatformBaseClient {
+    /**
+     * List all subscriptions (including expired) for the current project.
+     *
+     * @example
+     * const subs = await platform.transactions().getSubscriptions()
+     */
+    getSubscriptions(): Promise<AxiosResponse<Subscription[]>>;
+    /**
+     * Renew an expired subscription (and any others sharing its bundle
+     * `ref_no`) — creates a renewal invoice and returns a checkout link.
+     */
+    renewSubscription(payload: RenewSubscriptionPayload): Promise<AxiosResponse<RenewSubscriptionResult>>;
+    /**
+     * Cancel a subscription. Issues a refund automatically if still within
+     * the refund period.
+     */
+    cancelSubscription(payload: CancelSubscriptionPayload): Promise<AxiosResponse<CancelSubscriptionResult>>;
+    /**
+     * List all invoices for the current project.
+     */
+    getInvoices(): Promise<AxiosResponse<Invoice[]>>;
+    /**
+     * Get a single invoice by uuid.
+     */
+    getInvoice(uuid: string): Promise<AxiosResponse<Invoice>>;
+    /**
+     * Download an invoice as a PDF. Resolves with the raw PDF bytes
+     * (`responseType: "arraybuffer"`).
+     *
+     * @example
+     * const { data } = await platform.transactions().getInvoicePdf(uuid)
+     * fs.writeFileSync("invoice.pdf", Buffer.from(data))
+     */
+    getInvoicePdf(uuid: string): Promise<AxiosResponse<ArrayBuffer>>;
+    /**
+     * Get the current project's credit balance.
+     */
+    getBalance(): Promise<AxiosResponse<BalanceResult>>;
+    /**
+     * Generate a checkout link to manually top up the project's credit balance.
+     */
+    topUp(payload: TopUpPayload): Promise<AxiosResponse<TopUpResult>>;
+    /**
+     * Get the project's credit activity (deductions/top-ups) history, paginated.
+     */
+    getCreditsHistory(query?: CreditsHistoryQuery): Promise<AxiosResponse<CreditsHistoryResult>>;
+    /**
+     * Get the usage-based pricing table for a given currency.
+     *
+     * @param currency - ISO 4217 currency code, e.g. "USD" or "RSD".
+     */
+    getPrices(currency: string): Promise<AxiosResponse<SubscriptionPrices>>;
+    /**
+     * Get the project's usage-billing-mode overrides plus platform defaults.
+     */
+    getBillingModes(): Promise<AxiosResponse<GetBillingModesResult>>;
+    /**
+     * Set the billing mode ("credits" | "hybrid" | "invoice") for a usage
+     * option code on the current project.
+     */
+    updateBillingModes(payload: UpdateBillingModePayload): Promise<AxiosResponse<UpdateBillingModeResult>>;
+}