@gpt-platform/client 0.4.0 → 0.4.2

package/dist/index.d.ts

@@ -575,7 +575,7 @@ declare class BrowserApiKeyError extends Error {
 }
 
 /** SDK version — updated automatically by mix update.sdks */
-declare const SDK_VERSION = "0.4.0";
+declare const SDK_VERSION = "0.4.2";
 /** Default API version sent in every request — updated automatically by mix update.sdks */
 declare const DEFAULT_API_VERSION = "2026-02-27";
 
@@ -1308,6 +1308,131 @@ type CrmRelationshipType = {
     };
     type: string;
 };
+/**
+ * A "Resource object" representing a wallet
+ */
+type Wallet = {
+    /**
+     * An attributes object for a wallet
+     */
+    attributes?: {
+        /**
+         * Field included by default.
+         */
+        accounts?: Array<{
+            [key: string]: unknown;
+        }> | null | unknown;
+        /**
+         * Field included by default.
+         */
+        addons?: Array<{
+            [key: string]: unknown;
+        }> | null | unknown;
+        /**
+         * Optional application context - wallets belong to tenants, not applications. Field included by default.
+         */
+        application_id?: string | null | unknown;
+        /**
+         * Amount in credits. Field included by default.
+         */
+        auto_top_up_amount?: number | null | unknown;
+        /**
+         * Field included by default.
+         */
+        auto_top_up_enabled: boolean;
+        /**
+         * Threshold in credits. Field included by default.
+         */
+        auto_top_up_threshold?: number | null | unknown;
+        /**
+         * Field included by default.
+         */
+        credits: number;
+        /**
+         * Field included by default.
+         */
+        credits_free?: number | null | unknown;
+        /**
+         * Field included by default.
+         */
+        credits_paid?: number | null | unknown;
+        /**
+         * Total promotional credits ever allocated to this tenant. Field included by default.
+         */
+        credits_promotional_allocated?: number | null | unknown;
+        /**
+         * Total purchased credits ever allocated to this tenant. Field included by default.
+         */
+        credits_purchased_allocated?: number | null | unknown;
+        /**
+         * Field included by default.
+         */
+        credits_subscription?: number | null | unknown;
+        /**
+         * Total subscription credits ever allocated to this tenant. Field included by default.
+         */
+        credits_subscription_allocated?: number | null | unknown;
+        /**
+         * Field included by default.
+         */
+        payment_methods?: Array<{
+            [key: string]: unknown;
+        }> | null | unknown;
+        /**
+         * Field included by default.
+         */
+        plan_id?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        plan_slug?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        storage_quota_bytes: number;
+        /**
+         * Field included by default.
+         */
+        storage_used_bytes: number;
+        /**
+         * Daily usage history entries. Field included by default.
+         */
+        usage_history?: Array<{
+            [key: string]: unknown;
+        }> | null | unknown;
+        /**
+         * Storage breakdown by workspace (Top 3 + Others). Field included by default.
+         */
+        workspace_storage?: Array<{
+            [key: string]: unknown;
+        }> | null | unknown;
+        /**
+         * Usage breakdown by workspace (Top 3 + Others). Field included by default.
+         */
+        workspace_usage?: Array<{
+            [key: string]: unknown;
+        }> | null | unknown;
+    };
+    id: string;
+    /**
+     * A relationships object for a wallet
+     */
+    relationships?: {
+        plan?: {
+            /**
+             * An identifier for plan
+             */
+            data?: {
+                id: string;
+                meta?: {
+                    [key: string]: unknown;
+                };
+                type: string;
+            } | null;
+        };
+    };
+    type: string;
+};
 /**
  * A "Resource object" representing a email-marketing-sender-profile
  */
@@ -1811,6 +1936,12 @@ type EmailOutboundEmail = {
          * Field included by default.
          */
         ai_generated?: boolean | null | unknown;
+        /**
+         * Field included by default.
+         */
+        attachments?: Array<{
+            [key: string]: unknown;
+        }> | null | unknown;
         /**
          * Field included by default.
          */
@@ -3312,6 +3443,62 @@ type CrmCustomEntity = {
     };
     type: string;
 };
+/**
+ * A "Resource object" representing a invoice
+ */
+type Invoice = {
+    /**
+     * An attributes object for a invoice
+     */
+    attributes?: {
+        /**
+         * Field included by default.
+         */
+        amount_due?: number | null | unknown;
+        /**
+         * Field included by default.
+         */
+        amount_paid?: number | null | unknown;
+        /**
+         * Field included by default.
+         */
+        created_at?: unknown;
+        /**
+         * Field included by default.
+         */
+        currency?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        due_date?: unknown;
+        /**
+         * Field included by default.
+         */
+        invoice_number?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        line_items?: Array<{
+            [key: string]: unknown;
+        }> | null | unknown;
+        /**
+         * Field included by default.
+         */
+        pdf_url?: string | null | unknown;
+        /**
+         * Field included by default.
+         */
+        status?: "draft" | "open" | "paid" | "void" | unknown;
+    };
+    id: string;
+    /**
+     * A relationships object for a invoice
+     */
+    relationships?: {
+        [key: string]: never;
+    };
+    type: string;
+};
 /**
  * A "Resource object" representing a transaction
  */
@@ -4901,19 +5088,27 @@ type ConsentRecord = {
         /**
          * Field included by default.
          */
-        purpose: "ai_document_processing" | "data_analytics" | "marketing_communications" | "third_party_sharing";
+        purpose: "ai_document_processing" | "data_analytics" | "marketing_communications" | "third_party_sharing" | "session_recording";
         /**
          * Field included by default.
          */
         status: "granted" | "withdrawn";
+        /**
+         * Non-user subject identifier for consent (e.g., CRM contact UUID for HIPAA recording consent). Field included by default.
+         */
+        subject_id?: string | null | unknown;
         /**
          * Field included by default.
          */
-        user_id: string;
+        user_id?: string | null | unknown;
         /**
          * Field included by default.
          */
         withdrawn_at?: unknown;
+        /**
+         * Workspace scope for subject-based consent records. Field included by default.
+         */
+        workspace_id?: string | null | unknown;
     };
     id: string;
     /**
@@ -6139,6 +6334,15 @@ type Workspace = {
                  * Explicitly enabled AI features for this workspace. Field included by default.
                  */
                 enabled_capabilities?: Array<string> | null | unknown;
+                /**
+                 * Maps diarization speaker IDs to role labels for transcript formatting.
+                 * E.g.: %{"SPEAKER_00" => "RD", "SPEAKER_01" => "Client"}
+                 * ISV-configured. The platform normalizes transcripts to these labels before passing to agents.
+                 * . Field included by default.
+                 */
+                speaker_role_map: {
+                    [key: string]: unknown;
+                };
                 /**
                  * Agent that validates extracted data post-extraction. Field included by default.
                  */
@@ -7100,6 +7304,98 @@ declare function createVoiceNamespace(rb: RequestBuilder): {
             page?: number;
             pageSize?: number;
         } & RequestOptions) => Promise<VoiceTranscriptionResult[]>;
+        /**
+         * Create a transcript record manually.
+         *
+         * Creates a `VoiceTranscriptionResult` record in the current workspace.
+         * Useful when you have a pre-computed transcript (e.g. from an external STT
+         * service) that you want to associate with a recording or session.
+         *
+         * @param attributes - Transcript data. Required: `text` (string).
+         *   Optional: `recording_id`, `session_id`, `document_id`, `segments`,
+         *   `language_detected`, `duration_seconds`, `processing_seconds`,
+         *   `stt_engine`, `stt_model`, `metadata`.
+         * @param options - Optional request options.
+         * @returns The created `VoiceTranscriptionResult`.
+         *
+         * @example
+         * ```typescript
+         * const client = new GptClient({ apiKey: 'sk_app_...' });
+         * const result = await client.voice.transcriptionResults.create({
+         *   text: 'Patient reports chest pain since this morning.',
+         *   session_id: 'vs_abc123',
+         *   language_detected: 'en',
+         *   duration_seconds: 47.2,
+         * });
+         * console.log(result.id);
+         * ```
+         */
+        create: (attributes: {
+            text: string;
+            recording_id?: string;
+            session_id?: string;
+            document_id?: string;
+            segments?: Array<{
+                text: string;
+                start: number;
+                end: number;
+                confidence?: number;
+            }>;
+            language_detected?: string;
+            duration_seconds?: number;
+            processing_seconds?: number;
+            stt_engine?: string;
+            stt_model?: string;
+            metadata?: Record<string, unknown>;
+        }, options?: RequestOptions) => Promise<VoiceTranscriptionResult>;
+        /**
+         * Update a transcript's text, segments, or metadata.
+         *
+         * Allows correcting transcript text after review, updating segments
+         * with corrected timestamps or confidence scores, or annotating with
+         * additional metadata. `recording_id`, `session_id`, and STT engine
+         * fields are immutable after creation.
+         *
+         * @param id - The UUID of the transcription result to update.
+         * @param attributes - Fields to update. One or more of: `text`, `segments`, `metadata`.
+         * @param options - Optional request options.
+         * @returns The updated `VoiceTranscriptionResult`.
+         *
+         * @example
+         * ```typescript
+         * const client = new GptClient({ apiKey: 'sk_app_...' });
+         * const updated = await client.voice.transcriptionResults.update('tr_abc123', {
+         *   text: 'Patient reports chest pain since yesterday morning.',
+         * });
+         * ```
+         */
+        update: (id: string, attributes: {
+            text?: string;
+            segments?: Array<{
+                text: string;
+                start: number;
+                end: number;
+                confidence?: number;
+            }>;
+            metadata?: Record<string, unknown>;
+        }, options?: RequestOptions) => Promise<VoiceTranscriptionResult>;
+        /**
+         * Delete a transcription result by its ID.
+         *
+         * Permanently removes the transcript record. Associated recordings and
+         * voice sessions are not affected.
+         *
+         * @param id - The UUID of the transcription result to delete.
+         * @param options - Optional request options.
+         * @returns A promise that resolves when the record is deleted.
+         *
+         * @example
+         * ```typescript
+         * const client = new GptClient({ apiKey: 'sk_app_...' });
+         * await client.voice.transcriptionResults.destroy('tr_abc123');
+         * ```
+         */
+        destroy: (id: string, options?: RequestOptions) => Promise<void>;
     };
 };
 
@@ -11063,7 +11359,23 @@ declare class GptClient extends BaseClient {
     /** Wallet, plans, transactions, and payment methods */
     readonly billing: {
         wallet: {
-            get: (options?: RequestOptions) => Promise<Record<string, unknown>>;
+            get: (options?: RequestOptions) => Promise<Wallet>;
+            previewPlanChange: (planSlug: string, options?: RequestOptions) => Promise<Wallet>;
+            changePlan: (walletId: string, planSlug: string, options?: RequestOptions) => Promise<Wallet>;
+            buyCredits: (walletId: string, packageSlug: string, paymentMethodId?: string, options?: RequestOptions) => Promise<Wallet>;
+            updateAutoTopUp: (walletId: string, opts: {
+                enabled: boolean;
+                threshold?: number;
+                amount?: number;
+                packageId?: string;
+            }, options?: RequestOptions) => Promise<Wallet>;
+            invoices: {
+                list: (options?: {
+                    page?: number;
+                    pageSize?: number;
+                } & RequestOptions) => Promise<Invoice[]>;
+                listAll: (options?: RequestOptions) => Promise<Invoice[]>;
+            };
         };
         plans: {
             list: (options?: {
@@ -11096,7 +11408,29 @@ declare class GptClient extends BaseClient {
                 pageSize?: number;
             } & RequestOptions) => Promise<PaymentMethod[]>;
             listAll: (options?: RequestOptions) => Promise<PaymentMethod[]>;
-            create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<PaymentMethod>;
+            create: (attributes: {
+                provider_token: string;
+                type?: "card" | "bank_account";
+                last4?: string;
+                exp_month?: number;
+                exp_year?: number;
+                brand?: string;
+                nickname?: string;
+            }, options?: RequestOptions) => Promise<PaymentMethod>;
+            tokenize: (cardDetails: {
+                card_number: string;
+                exp_month: number;
+                exp_year: number;
+                cvc: string;
+                holder_name: string;
+                billing_address: string;
+                billing_city: string;
+                billing_state: string;
+                zip_code: string;
+                phone?: string;
+                nickname?: string;
+                customer_id?: string;
+            }, options?: RequestOptions) => Promise<PaymentMethod>;
             update: (id: string, attributes: Record<string, unknown>, options?: RequestOptions) => Promise<PaymentMethod>;
             get: (id: string, options?: RequestOptions) => Promise<PaymentMethod>;
             setDefault: (id: string, options?: RequestOptions) => Promise<PaymentMethod>;
@@ -11960,6 +12294,8 @@ declare class GptClient extends BaseClient {
             send: (threadId: string, content: string, attributes?: Record<string, unknown>, options?: RequestOptions) => Promise<Record<string, unknown>>;
             stream: (threadId: string, body: Record<string, unknown>, options?: RequestOptions, streamOptions?: StreamOptions) => Promise<AsyncIterableIterator<StreamMessageChunk>>;
         };
+        complete: (threadId: string, options?: RequestOptions) => Promise<Thread>;
+        completeStream: (threadId: string, options?: RequestOptions, streamOptions?: StreamOptions) => Promise<AsyncIterableIterator<StreamMessageChunk>>;
     };
     /** Training examples and sessions */
     readonly training: {
@@ -12046,6 +12382,35 @@ declare class GptClient extends BaseClient {
                 page?: number;
                 pageSize?: number;
             } & RequestOptions) => Promise<VoiceTranscriptionResult[]>;
+            create: (attributes: {
+                text: string;
+                recording_id?: string;
+                session_id?: string;
+                document_id?: string;
+                segments?: Array<{
+                    text: string;
+                    start: number;
+                    end: number;
+                    confidence?: number;
+                }>;
+                language_detected?: string;
+                duration_seconds?: number;
+                processing_seconds?: number;
+                stt_engine?: string;
+                stt_model?: string;
+                metadata?: Record<string, unknown>;
+            }, options?: RequestOptions) => Promise<VoiceTranscriptionResult>;
+            update: (id: string, attributes: {
+                text?: string;
+                segments?: Array<{
+                    text: string;
+                    start: number;
+                    end: number;
+                    confidence?: number;
+                }>;
+                metadata?: Record<string, unknown>;
+            }, options?: RequestOptions) => Promise<VoiceTranscriptionResult>;
+            destroy: (id: string, options?: RequestOptions) => Promise<void>;
         };
     };
     /** File watcher claims and event management */
@@ -12612,6 +12977,59 @@ declare function createThreadsNamespace(rb: RequestBuilder): {
          */
         stream: (threadId: string, body: Record<string, unknown>, options?: RequestOptions, streamOptions?: StreamOptions) => Promise<AsyncIterableIterator<StreamMessageChunk>>;
     };
+    /**
+     * Trigger AI inference on a thread without sending a new user message.
+     *
+     * Runs the full RAG pipeline (VectorSearch + GraphLookup + SynthesizeResponse)
+     * using the thread's last user message as query context. Saves the AI response
+     * as an assistant message and returns the updated Thread.
+     *
+     * Use this to let the AI proactively continue a conversation — for example,
+     * after a voice session finalizes, to generate a follow-up or summary without
+     * requiring the user to explicitly ask.
+     *
+     * @param threadId - The UUID of the thread to run AI completion on.
+     * @param options - Optional request options.
+     * @returns A promise resolving to the updated `Thread` after the assistant
+     *   message has been saved.
+     *
+     * @example
+     * ```typescript
+     * const client = new GptClient({ apiKey: 'sk_app_...' });
+     *
+     * // After a voice session finalizes, trigger AI continuation:
+     * const thread = await client.threads.complete('thr_01HXYZ...');
+     * console.log(`Thread updated at: ${thread.attributes?.updated_at}`);
+     * ```
+     */
+    complete: (threadId: string, options?: RequestOptions) => Promise<Thread>;
+    /**
+     * Trigger AI inference on a thread and receive the response via Server-Sent Events.
+     *
+     * Identical to {@link complete} in behavior but delivers the result as an SSE
+     * stream. The stream yields a single `StreamMessageChunk` with `done: true`
+     * when the AI response is ready.
+     *
+     * Note: This endpoint delivers the full response as one event (not token-by-token).
+     * It gives the frontend a consistent SSE interface for uniform handling of both
+     * streaming and non-streaming completions.
+     *
+     * @param threadId - The UUID of the thread to run AI completion on.
+     * @param options - Optional request options (e.g. abort signal).
+     * @param streamOptions - Optional streaming configuration.
+     * @returns A promise resolving to an `AsyncIterableIterator<StreamMessageChunk>`.
+     *
+     * @example
+     * ```typescript
+     * const client = new GptClient({ apiKey: 'sk_app_...' });
+     *
+     * const stream = await client.threads.completeStream('thr_01HXYZ...');
+     * for await (const chunk of stream) {
+     *   if (chunk.type === 'done') console.log(`AI response: ${chunk.content}`);
+     * }
+     * ```
+     */
+    completeStream: (threadId: string, options?: RequestOptions, streamOptions?: StreamOptions) => Promise<AsyncIterableIterator<StreamMessageChunk>>;
 };
 
 /**
@@ -12811,6 +13229,32 @@ declare function createSearchNamespace(rb: RequestBuilder): {
     };
 };
 
+/** Attributes for saving a pre-tokenized payment method. */
+type PaymentMethodCreateAttributes = {
+    /** Provider token from a hosted fields flow (e.g. QorPay hosted iframe). Never pass raw card numbers here. */
+    provider_token: string;
+    type?: "card" | "bank_account";
+    last4?: string;
+    exp_month?: number;
+    exp_year?: number;
+    brand?: string;
+    nickname?: string;
+};
+/** Attributes for S2S card tokenization (raw card details). Server tokenizes with QorPay. */
+type PaymentMethodTokenizeAttributes = {
+    card_number: string;
+    exp_month: number;
+    exp_year: number;
+    cvc: string;
+    holder_name: string;
+    billing_address: string;
+    billing_city: string;
+    billing_state: string;
+    zip_code: string;
+    phone?: string;
+    nickname?: string;
+    customer_id?: string;
+};
 /**
  * Creates the billing namespace, providing access to wallet balances, subscription
  * plans, transaction history, credit packages, and payment methods for the
@@ -12836,21 +13280,87 @@ declare function createBillingNamespace(rb: RequestBuilder): {
         /**
          * Retrieves the current workspace wallet, including the available credit
          * balance, usage totals, and any pending charges.
+         */
+        get: (options?: RequestOptions) => Promise<Wallet>;
+        /**
+         * Preview the cost and effective date of a plan change before committing.
          *
-         * @param options - Optional request options such as custom headers or an
-         *   abort signal.
-         * @returns A promise resolving to a record containing wallet fields such as
-         *   `balance`, `currency`, and usage metadata.
+         * @param planSlug - The slug of the target plan (e.g. `"pro-monthly"`).
+         */
+        previewPlanChange: (planSlug: string, options?: RequestOptions) => Promise<Wallet>;
+        /**
+         * Change the workspace's subscription plan.
          *
-         * @example
-         * ```typescript
-         * const client = new GptClient({ apiKey: 'sk_app_...' });
+         * Upgrades charge a prorated amount immediately against the default payment
+         * method. Downgrades are deferred to the end of the current billing period.
+         * Use `previewPlanChange` first to show the user a cost estimate.
          *
-         * const wallet = await client.billing.wallet.get();
-         * console.log(`Available credits: ${wallet.balance}`);
-         * ```
+         * @param walletId - The wallet UUID from `wallet.get()`.
+         * @param planSlug - The slug of the target plan (e.g. `"pro-monthly"`).
          */
-        get: (options?: RequestOptions) => Promise<Record<string, unknown>>;
+        changePlan: (walletId: string, planSlug: string, options?: RequestOptions) => Promise<Wallet>;
+        /**
+         * Purchase a credit package to top up the workspace wallet immediately.
+         *
+         * Charges the specified (or default) payment method. Credits are added to
+         * the `purchased` bucket and never expire.
+         *
+         * @param walletId - The wallet UUID from `wallet.get()`.
+         * @param packageSlug - The slug of the credit package to purchase.
+         * @param paymentMethodId - Optional payment method UUID. Uses the default if omitted.
+         */
+        buyCredits: (walletId: string, packageSlug: string, paymentMethodId?: string, options?: RequestOptions) => Promise<Wallet>;
+        /**
+         * Update the workspace's auto top-up settings.
+         *
+         * When enabled, the platform automatically purchases the specified credit
+         * package whenever the balance drops below `threshold`.
+         *
+         * @param walletId - The wallet UUID from `wallet.get()`.
+         * @param opts.enabled - Enable or disable auto top-up.
+         * @param opts.threshold - Credit balance floor that triggers a purchase.
+         * @param opts.amount - Credits to purchase per top-up event.
+         * @param opts.packageId - Credit package UUID to auto-purchase.
+         */
+        updateAutoTopUp: (walletId: string, opts: {
+            enabled: boolean;
+            threshold?: number;
+            amount?: number;
+            packageId?: string;
+        }, options?: RequestOptions) => Promise<Wallet>;
+        /**
+         * Sub-namespace for invoice operations.
+         *
+         * Invoices are generated per billing period and carry a `pdf_url` for
+         * receipt download. Use `invoices.list()` for the transaction history page.
+         */
+        invoices: {
+            /**
+             * Returns a single page of invoices for the current workspace.
+             *
+             * Each invoice includes `pdf_url` for receipt download.
+             *
+             * @example
+             * ```typescript
+             * const invoices = await client.billing.wallet.invoices.list();
+             * const paidInvoices = invoices.filter(inv => inv.attributes?.status === "paid");
+             * ```
+             */
+            list: (options?: {
+                page?: number;
+                pageSize?: number;
+            } & RequestOptions) => Promise<Invoice[]>;
+            /**
+             * Fetches all invoices by automatically paginating through every page.
+             *
+             * @example
+             * ```typescript
+             * const all = await client.billing.wallet.invoices.listAll();
+             * const downloadUrl = all[0].attributes?.pdf_url;
+             * ```
+             */
+            listAll: (options?: RequestOptions) => Promise<Invoice[]>;
+        };
     };
     /**
      * Sub-namespace for subscription plan operations.
@@ -13158,7 +13668,20 @@ declare function createBillingNamespace(rb: RequestBuilder): {
          * console.log(`Added card ending in ${method.last4}`);
          * ```
          */
-        create: (attributes: Record<string, unknown>, options?: RequestOptions) => Promise<PaymentMethod>;
+        create: (attributes: PaymentMethodCreateAttributes, options?: RequestOptions) => Promise<PaymentMethod>;
+        /**
+         * Tokenizes a raw card server-side and saves the resulting payment method.
+         *
+         * Use this for direct card collection flows where your server handles card
+         * data (PCI-DSS scope applies). The platform tokenizes the card with QorPay
+         * and stores only the token — raw card data is never persisted.
+         *
+         * For hosted-fields flows where the client tokenizes the card, use
+         * `paymentMethods.create({ provider_token })` instead.
+         *
+         * @param cardDetails - Raw card fields including number, CVC, expiry, and billing address.
+         */
+        tokenize: (cardDetails: PaymentMethodTokenizeAttributes, options?: RequestOptions) => Promise<PaymentMethod>;
         /**
          * Updates the mutable attributes of an existing payment method, such as
          * the billing name or expiry date override.