@ptkl/sdk 1.14.0 → 1.16.0

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>>;
+}

package/dist/v0.10/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
      */

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

@@ -1,6 +1,6 @@
 import { AxiosResponse } from 'axios';
 import PlatformBaseClient from "./platformBaseClient";
-import { WorkflowModel, WorkflowCreatePayload, WorkflowUpdatePayload, WorkflowListResponse } from '../types/workflow';
+import { WorkflowModel, WorkflowCreatePayload, WorkflowUpdatePayload, WorkflowListResponse, WorkflowInstallPayload, WorkflowHistoryQuery, WorkflowHistoryListResponse, WorkflowHistoryEntry, WorkflowStatsQuery, WorkflowStats, WorkflowRunningQuery, WorkflowRunningListResponse, WorkflowRunningExecution, WorkflowControlResponse, WorkflowRestartOptions, WorkflowRestartResponse, WorkflowNodeControlOptions, WorkflowErrorListResponse } from '../types/workflow';
 export default class Workflow extends PlatformBaseClient {
     create(data: WorkflowCreatePayload): Promise<AxiosResponse<WorkflowModel>>;
     update(id: string, data: WorkflowUpdatePayload): Promise<AxiosResponse<WorkflowModel>>;
@@ -9,4 +9,28 @@ export default class Workflow extends PlatformBaseClient {
     delete(id: string): Promise<AxiosResponse<void>>;
     trigger(id: string, event: string, data: any): Promise<AxiosResponse<any, any>>;
     publish(event: string, data: any): Promise<AxiosResponse<any, any>>;
+    /**
+     * Install (create + publish) a workflow in one call.
+     * Rejects if a workflow with the same name + integrator already exists.
+     */
+    install(data: WorkflowInstallPayload): Promise<AxiosResponse<WorkflowModel>>;
+    getHistory(query?: WorkflowHistoryQuery): Promise<AxiosResponse<WorkflowHistoryListResponse>>;
+    getHistoryEntry(executionUuid: string): Promise<AxiosResponse<WorkflowHistoryEntry>>;
+    getStats(query?: WorkflowStatsQuery): Promise<AxiosResponse<WorkflowStats>>;
+    getRunning(query?: WorkflowRunningQuery): Promise<AxiosResponse<WorkflowRunningListResponse>>;
+    getRunningEntry(executionUuid: string): Promise<AxiosResponse<WorkflowRunningExecution>>;
+    pause(executionUuid: string): Promise<AxiosResponse<WorkflowControlResponse>>;
+    resume(executionUuid: string): Promise<AxiosResponse<WorkflowControlResponse>>;
+    kill(executionUuid: string): Promise<AxiosResponse<WorkflowControlResponse>>;
+    /**
+     * Restart a failed/killed workflow execution from history.
+     * `clearState: true` discards prior node state instead of a smart resume.
+     */
+    restart(executionUuid: string, options?: WorkflowRestartOptions): Promise<AxiosResponse<WorkflowRestartResponse>>;
+    pauseNode(executionUuid: string, nodeId: number, options?: WorkflowNodeControlOptions): Promise<AxiosResponse<WorkflowControlResponse>>;
+    resumeNode(executionUuid: string, nodeId: number, options?: WorkflowNodeControlOptions): Promise<AxiosResponse<WorkflowControlResponse>>;
+    killNode(executionUuid: string, nodeId: number, options?: WorkflowNodeControlOptions): Promise<AxiosResponse<WorkflowControlResponse>>;
+    getErrors(): Promise<AxiosResponse<WorkflowErrorListResponse>>;
+    removeError(id: string): Promise<AxiosResponse<WorkflowControlResponse>>;
+    removeAllErrors(): Promise<AxiosResponse<WorkflowControlResponse>>;
 }