@gpt-platform/client 0.8.2 → 0.8.3

package/dist/index.d.mts

@@ -606,7 +606,7 @@ declare class BrowserApiKeyError extends Error {
 }
 
 /** SDK version — updated automatically by mix update.sdks */
-declare const SDK_VERSION = "0.8.2";
+declare const SDK_VERSION = "0.8.3";
 /** Default API version sent in every request — updated automatically by mix update.sdks */
 declare const DEFAULT_API_VERSION = "2026-03-11";
 
@@ -772,6 +772,32 @@ declare abstract class BaseClient {
      * Clear the authentication token (e.g., on logout).
      */
     clearToken(): void;
+    /**
+     * Switch the workspace context for all subsequent requests.
+     *
+     * Sets the `workspace_id` query parameter appended to every request.
+     * Use this after creating a new workspace or switching workspace context
+     * without constructing a new client instance.
+     *
+     * @param workspaceId - The workspace UUID to scope requests to, or
+     *   `undefined` to clear workspace scoping.
+     *
+     * @example
+     * ```typescript
+     * const org = await sdk.platform.tenants.createOrg({ name: 'Acme' });
+     * const workspaces = await sdk.platform.workspaces.mine();
+     * const ws = workspaces.find(w => w.tenant_id === org.id);
+     *
+     * sdk.setWorkspaceId(ws.id);
+     * // All subsequent calls are scoped to the new workspace
+     * await sdk.scheduling.events.create({ ... });
+     * ```
+     */
+    setWorkspaceId(workspaceId: string | undefined): void;
+    /**
+     * Get the current workspace ID, if set.
+     */
+    getWorkspaceId(): string | undefined;
 }
 
 /**
@@ -4173,6 +4199,10 @@ type Plan = {
          * Field included by default.
          */
         created_at: unknown;
+        /**
+         * Credits allocated per seat at renewal. nil = falls back to monthly_credits. Field included by default.
+         */
+        credits_per_seat?: number | null | unknown;
         /**
          * Human-readable feature list derived from capability_tiers, for pricing tables
          */
@@ -5828,6 +5858,10 @@ type Tenant = {
          */
         contact_phone?: string | null | unknown;
         credit_balance?: number | null | unknown;
+        /**
+         * Field included by default.
+         */
+        deactivated_at?: unknown;
         /**
          * Field included by default.
          */
@@ -7313,7 +7347,7 @@ type ClinicalPracticeResource = {
         /**
          * Field included by default.
          */
-        resource_type: "article" | "video" | "handout" | "worksheet" | "tool_link";
+        resource_type: "article" | "video" | "handout" | "worksheet" | "tool_link" | "infographic" | "audio" | "recipe" | "checklist" | "protocol" | "assessment" | "exercise" | "template" | "presentation" | "ebook";
         /**
          * Field included by default.
          */
@@ -14144,24 +14178,42 @@ declare function createPlatformNamespace(rb: RequestBuilder): {
          */
         credit: (id: string, amount: number, description?: string, options?: RequestOptions) => Promise<Tenant>;
         /**
-         * Delete a tenant and all associated data.
+         * Deactivate a tenant (hide from user's account).
+         *
+         * Sets `deactivated_at` on the tenant. The tenant and its workspaces
+         * disappear from `workspaces.mine()` and tenant listings. Billing and
+         * data are completely unaffected. Reversible via `reactivate()`.
          *
-         * Permanently removes the tenant, all their workspaces, documents, and
-         * billing records. This operation is irreversible. For a graceful
-         * off-boarding, prefer `schedulePurge` which allows data export before
-         * deletion.
+         * Only the tenant owner can deactivate.
          *
-         * @param id - The UUID of the tenant to delete.
+         * @param id - The UUID of the tenant to deactivate.
          * @param options - Optional request options.
-         * @returns `true` on successful deletion.
+         * @returns The updated tenant record.
          *
          * @example
          * ```typescript
-         * const client = new GptClient({ apiKey: 'sk_app_...' });
-         * await client.platform.tenants.delete('tenant_abc123');
+         * await client.platform.tenants.deactivate('tenant_abc123');
          * ```
          */
-        delete: (id: string, options?: RequestOptions) => Promise<true>;
+        deactivate: (id: string, options?: RequestOptions) => Promise<Tenant>;
+        /**
+         * Reactivate a previously deactivated tenant.
+         *
+         * Clears `deactivated_at`, restoring the tenant and its workspaces
+         * to the user's account. Only works on deactivated tenants.
+         *
+         * Only the tenant owner can reactivate.
+         *
+         * @param id - The UUID of the tenant to reactivate.
+         * @param options - Optional request options.
+         * @returns The updated tenant record.
+         *
+         * @example
+         * ```typescript
+         * await client.platform.tenants.reactivate('tenant_abc123');
+         * ```
+         */
+        reactivate: (id: string, options?: RequestOptions) => Promise<Tenant>;
         /**
          * Create a new tenant (ISV provisioning flow).
          *
@@ -14415,6 +14467,39 @@ declare function createPlatformNamespace(rb: RequestBuilder): {
          * ```
          */
         resend: (id: string, applicationId?: string, options?: RequestOptions) => Promise<Invitation>;
+        /**
+         * List invitations visible to the current actor.
+         *
+         * Returns invitations where the actor is the inviter, the tenant owner,
+         * or the recipient (matched by email). Use this to build admin views
+         * of pending/accepted invitations for a tenant or workspace.
+         *
+         * @param options - Optional page number, page size, and request options.
+         * @returns A page of `Invitation` records.
+         *
+         * @example
+         * ```typescript
+         * const client = new GptClient({ apiKey: 'sk_app_...' });
+         * const invites = await client.platform.invitations.list();
+         * ```
+         */
+        list: (options?: {
+            page?: number;
+            pageSize?: number;
+        } & RequestOptions) => Promise<Invitation[]>;
+        /**
+         * List all invitations visible to the current actor, auto-paginating.
+         *
+         * @param options - Optional request options.
+         * @returns All visible `Invitation` records as a flat array.
+         *
+         * @example
+         * ```typescript
+         * const client = new GptClient({ apiKey: 'sk_app_...' });
+         * const all = await client.platform.invitations.listAll();
+         * ```
+         */
+        listAll: (options?: RequestOptions) => Promise<Invitation[]>;
         /**
          * Look up a pending invitation by its raw token.
          *
@@ -15102,6 +15187,32 @@ declare function createIdentityNamespace(rb: RequestBuilder, baseUrl?: string):
      * invite-flow or SSO registrations where acceptance is handled separately.
      */
     register: (email: string, password: string, passwordConfirmation: string, tenantName: string, attrs?: RegisterExtraAttributes, options?: RequestOptions) => Promise<User>;
+    /**
+     * Register a new user via invitation — skips personal tenant creation.
+     *
+     * Creates the user account, accepts the invitation (creating tenant/workspace
+     * memberships), and returns the authenticated user with a session token.
+     * The email must match the invitation's recipient email.
+     *
+     * @param email - Must match the invitation recipient email
+     * @param password - Minimum 8 characters
+     * @param passwordConfirmation - Must match password
+     * @param invitationToken - Raw token from the invitation email link
+     * @param attrs - Optional extra attributes (first_name, last_name)
+     * @param options - Optional request options
+     * @returns The newly created `User` with session token
+     *
+     * @example
+     * ```typescript
+     * const client = new GptClient({ apiKey: 'sk_app_...' });
+     * const user = await client.identity.registerViaInvitation(
+     *   'invited@example.com', 'securepass', 'securepass', 'raw-token-from-email',
+     *   { first_name: 'Jane', last_name: 'Doe' },
+     * );
+     * console.log(user.token); // JWT session token
+     * ```
+     */
+    registerViaInvitation: (email: string, password: string, passwordConfirmation: string, invitationToken: string, attrs?: RegisterExtraAttributes, options?: RequestOptions) => Promise<User>;
     /** Get the currently authenticated user */
     me: (options?: RequestOptions) => Promise<User>;
     /** Get the current user profile (alias for me()) */
@@ -19490,7 +19601,52 @@ declare function createBillingNamespace(rb: RequestBuilder): {
          */
         list: (options?: RequestOptions) => Promise<FeatureSummary[]>;
     };
+    /**
+     * Get capacity estimates for a plan's monthly credits.
+     *
+     * Returns how many of each ISV-defined feature the plan supports per month.
+     * No Bearer token required — uses application key only.
+     *
+     * @param planSlug - The plan slug to calculate capacity for.
+     * @param options - Optional request-level overrides.
+     * @returns Plan details and capacity breakdown per composite operation.
+     *
+     * @example
+     * ```typescript
+     * const result = await client.billing.capacityCalculator("pro-plan");
+     * console.log(`Plan: ${result.plan.name}`);
+     * for (const item of result.capacity) {
+     *   console.log(`${item.display_name}: ~${item.estimated_monthly_count}/month`);
+     * }
+     * ```
+     */
+    capacityCalculator: (planSlug: string, options?: RequestOptions) => Promise<CapacityCalculatorResponse>;
 };
+/** Response from the capacity-calculator endpoint. */
+interface CapacityCalculatorResponse {
+    plan: {
+        slug: string;
+        name: string;
+        monthly_credits: number;
+    };
+    capacity: Array<{
+        key: string;
+        display_name: string;
+        description: string | null;
+        credits_per_use: number;
+        estimated_monthly_count: number;
+        is_estimate: boolean;
+        components: Array<{
+            operation_key: string;
+            quantity: number;
+            unit: string;
+            credits_per_unit: number | null;
+            total_credits: number;
+            is_estimate: boolean;
+        }>;
+    }>;
+    is_estimate: boolean;
+}
 
 /** Response from a semantic search query. */
 interface AiSearchResponse {
@@ -21601,7 +21757,7 @@ interface CreatePracticeResourceAttributes {
     workspace_id: string;
     title: string;
     description?: string;
-    resource_type?: "article" | "video" | "handout" | "worksheet" | "tool_link";
+    resource_type?: "article" | "video" | "handout" | "worksheet" | "tool_link" | "infographic" | "audio" | "recipe" | "checklist" | "protocol" | "assessment" | "exercise" | "template" | "presentation" | "ebook";
     storage_key?: string;
     url?: string;
     tags?: string[];
@@ -21621,7 +21777,7 @@ interface CreatePracticeResourceAttributes {
 interface UpdatePracticeResourceAttributes {
     title?: string;
     description?: string;
-    resource_type?: "article" | "video" | "handout" | "worksheet" | "tool_link";
+    resource_type?: "article" | "video" | "handout" | "worksheet" | "tool_link" | "infographic" | "audio" | "recipe" | "checklist" | "protocol" | "assessment" | "exercise" | "template" | "presentation" | "ebook";
     storage_key?: string;
     url?: string;
     tags?: string[];
@@ -21694,6 +21850,11 @@ interface PracticeToolCategory {
     category: string;
     tool_count: number;
 }
+/** A practice resource category with usage count. */
+interface PracticeResourceCategory {
+    category: string;
+    resource_count: number;
+}
 interface CreateClientResourceAssignmentAttributes {
     workspace_id: string;
     patient_id: string;
@@ -22463,6 +22624,42 @@ declare function createClinicalNamespace(rb: RequestBuilder): {
             filter?: Record<string, unknown>;
             sort?: string;
         }, options?: RequestOptions) => Promise<ClinicalPracticeResource[]>;
+        /**
+         * List distinct practice resource categories in a workspace.
+         *
+         * Returns unique `resource_type` values with their active resource counts,
+         * sorted by count descending.
+         *
+         * @param params - Must include `workspace_id`
+         * @param options - Request options
+         * @returns Array of {@link PracticeResourceCategory} records
+         *
+         * @example
+         * ```typescript
+         * const categories = await client.clinical.practiceResources.listCategories({
+         *   workspace_id: "..."
+         * });
+         * // [{ category: "article", resource_count: 5 }, { category: "video", resource_count: 3 }]
+         * ```
+         */
+        listCategories: (params: {
+            workspace_id: string;
+        }, options?: RequestOptions) => Promise<PracticeResourceCategory[]>;
+        /**
+         * List distinct catalog practice resource categories.
+         *
+         * Returns unique `resource_type` values from application-level catalog resources.
+         * Application ID is resolved from the API key context.
+         *
+         * @param options - Request options
+         * @returns Array of {@link PracticeResourceCategory} records
+         *
+         * @example
+         * ```typescript
+         * const cats = await client.clinical.practiceResources.listCatalogCategories();
+         * ```
+         */
+        listCatalogCategories: (options?: RequestOptions) => Promise<PracticeResourceCategory[]>;
     };
     /**
      * Manage practice-level assessment and therapeutic tools.
@@ -22541,6 +22738,21 @@ declare function createClinicalNamespace(rb: RequestBuilder): {
             filter?: Record<string, unknown>;
             sort?: string;
         }, options?: RequestOptions) => Promise<ClinicalPracticeTool[]>;
+        /**
+         * List distinct catalog practice tool categories.
+         *
+         * Returns unique `tool_type` values from application-level catalog tools.
+         * Application ID is resolved from the API key context.
+         *
+         * @param options - Request options
+         * @returns Array of {@link PracticeToolCategory} records
+         *
+         * @example
+         * ```typescript
+         * const cats = await client.clinical.practiceTools.listCatalogCategories();
+         * ```
+         */
+        listCatalogCategories: (options?: RequestOptions) => Promise<PracticeToolCategory[]>;
     };
     /**
      * Manage assignments of practice resources to patients.
@@ -22747,6 +22959,21 @@ declare function createClinicalNamespace(rb: RequestBuilder): {
             filter?: Record<string, unknown>;
             sort?: string;
         }, options?: RequestOptions) => Promise<ClinicalGoalTemplate[]>;
+        /**
+         * List distinct catalog goal template categories.
+         *
+         * Returns unique `category` values from application-level catalog templates.
+         * Application ID is resolved from the API key context.
+         *
+         * @param options - Request options
+         * @returns Array of {@link ClinicalGoalTemplateCategory} records
+         *
+         * @example
+         * ```typescript
+         * const cats = await client.clinical.goalTemplates.listCatalogCategories();
+         * ```
+         */
+        listCatalogCategories: (options?: RequestOptions) => Promise<ClinicalGoalTemplateCategory[]>;
     };
     /**
      * Recipe search via configured Edamam connector.
@@ -23031,6 +23258,7 @@ declare class GptClient extends BaseClient {
         featureSummary: {
             list: (options?: RequestOptions) => Promise<FeatureSummary[]>;
         };
+        capacityCalculator: (planSlug: string, options?: RequestOptions) => Promise<CapacityCalculatorResponse>;
     };
     /** Product catalog, inventory, pricing, and taxonomy */
     readonly catalog: {
@@ -23910,6 +24138,7 @@ declare class GptClient extends BaseClient {
     readonly identity: {
         login: (email: string, password: string, options?: RequestOptions) => Promise<User>;
         register: (email: string, password: string, passwordConfirmation: string, tenantName: string, attrs?: RegisterExtraAttributes, options?: RequestOptions) => Promise<User>;
+        registerViaInvitation: (email: string, password: string, passwordConfirmation: string, invitationToken: string, attrs?: RegisterExtraAttributes, options?: RequestOptions) => Promise<User>;
         me: (options?: RequestOptions) => Promise<User>;
         profile: (options?: RequestOptions) => Promise<User>;
         list: (options?: {
@@ -24083,7 +24312,8 @@ declare class GptClient extends BaseClient {
             } & RequestOptions) => Promise<Tenant[]>;
             listAllDocumentStats: (tenantId: string, options?: RequestOptions) => Promise<Tenant[]>;
             credit: (id: string, amount: number, description?: string, options?: RequestOptions) => Promise<Tenant>;
-            delete: (id: string, options?: RequestOptions) => Promise<true>;
+            deactivate: (id: string, options?: RequestOptions) => Promise<Tenant>;
+            reactivate: (id: string, options?: RequestOptions) => Promise<Tenant>;
             create: (attributes: CreateTenantAttributes, options?: RequestOptions) => Promise<Tenant>;
             update: (id: string, attributes: UpdateTenantAttributes, options?: RequestOptions) => Promise<Tenant>;
             schedulePurge: (id: string, options?: RequestOptions) => Promise<Tenant>;
@@ -24112,6 +24342,11 @@ declare class GptClient extends BaseClient {
             listAllMe: (options?: RequestOptions) => Promise<Invitation[]>;
             create: (attributes: CreateInvitationAttributes, options?: RequestOptions) => Promise<Invitation>;
             resend: (id: string, applicationId?: string, options?: RequestOptions) => Promise<Invitation>;
+            list: (options?: {
+                page?: number;
+                pageSize?: number;
+            } & RequestOptions) => Promise<Invitation[]>;
+            listAll: (options?: RequestOptions) => Promise<Invitation[]>;
             consumeByToken: (token: string, options?: RequestOptions) => Promise<Invitation | null>;
             acceptByToken: (token: string, options?: RequestOptions) => Promise<Invitation>;
         };
@@ -25090,4 +25325,4 @@ type SocialAPI = ReturnType<typeof createSocialNamespace>;
 type ModelsAPI = ReturnType<typeof createModelsNamespace>;
 type MemoryAPI = ReturnType<typeof createMemoryNamespace>;
 
-export { API_KEY_PREFIXES, type AccessGrant, type Agent, type AgentDeployment, type AgentVersion, type AgentsAPI, type AiAPI, type ApiKey, type AppInfo, type ApprovalRequiredEvent, type AttributeFilter$1 as AttributeFilter, AuthenticationError, AuthorizationError, type BaseClientConfig, type BillingAPI, type BillingAccount, BrowserApiKeyError, type BuyAddonAttributes, type CampaignsAPI, CardDeclinedError, type CommunicationAPI, type ComplianceFrameworkReadiness, type CompliancePosture, type ComposeWithAiAttributes, ConflictError, type CreditPackage, DEFAULT_API_VERSION, DEFAULT_RETRY_CONFIG, type DocumentSection, type DoneEvent, type EmailAPI, type ErrorEvent, type Execution, type ExecutionEvent, type ExtractionAPI, type ExtractionRowQueryParams, type ExtractionRowQueryResult, type FeatureDefinition, type FeatureUsage, GptClient, GptCoreError, type IdentityAPI, InsecureConnectionError, type Invitation, type Invoice, type IterationCompleteEvent, LOG_LEVELS, type ListModelsOptions, type ListPracticeToolsParams, type LogLevel, type Logger, type MemoryAPI, type MjmlCompileResult, type ModelInfo, type ModelTier, type ModelsAPI, NetworkError, NotFoundError, type PaginatedResponse, type PaginationLinks, type PaginationOptions, type PaymentMethod, type PaymentMethodCreateAttributes, type PaymentMethodTokenizeAttributes, type PaymentMethodUpdateAttributes, PaymentRequiredError, type Plan, type PlanFeatureAllocation, type PlatformAPI, type PracticeToolCategory, RateLimitError, RequestBuilder, type RequestOptions, type RetryConfig, RetryTimeoutError, SDK_VERSION, type SchedulingAPI, type SdkErrorEvent, SdkEventEmitter, type SdkEvents, type SdkRequestEvent, type SdkResponseEvent, type SdkRetryEvent, type SearchAPI, type SeatInfo, type SectionDocument, type SecurityConfig, ServerError, type SessionNoteType, type SessionNoteValue, type SocialAPI, type StorageAPI, type StreamMessageChunk, type StreamOptions, SubscriptionConflictError, type TemplateVariableSchema, type TemplateVersion, type Tenant, type ThreadsAPI, TimeoutError, type TokenDeltaEvent, type ToolCallEvent, type ToolResultEvent, type Transaction, type TrendingSnapshot, type TrendingSnapshotItem, type TrendingWatch, type TriggerPipelineAttributes, type UpdateFeatureDefinitionAttributes, type UsageHistoryEntry, type User, type UserProfile, ValidationError, type VoiceAPI, type VoiceFinalizeOptions, type VoiceRecording, type VoiceSession, type VoiceSessionStart, type VoiceStartOptions, type VoiceTranscribeOptions, type VoiceTranscribeResult, type VoiceTranscriptionResult, type Wallet, type WalletPaymentMethod, WebhookSignatureError, type WebhookVerifyOptions, Webhooks, type Workspace, type WorkspaceAgentConfig, buildHeaders, buildUserAgent, collectStreamedMessage, handleApiError, isBrowserEnvironment, isSecureUrl, paginateAll, paginateToArray, retryWithBackoff, streamMessage, streamSSE, validateApiKey, withRetry };
+export { API_KEY_PREFIXES, type AccessGrant, type Agent, type AgentDeployment, type AgentVersion, type AgentsAPI, type AiAPI, type ApiKey, type AppInfo, type ApprovalRequiredEvent, type AttributeFilter$1 as AttributeFilter, AuthenticationError, AuthorizationError, type BaseClientConfig, type BillingAPI, type BillingAccount, BrowserApiKeyError, type BuyAddonAttributes, type CampaignsAPI, type CapacityCalculatorResponse, CardDeclinedError, type CommunicationAPI, type ComplianceFrameworkReadiness, type CompliancePosture, type ComposeWithAiAttributes, ConflictError, type CreditPackage, DEFAULT_API_VERSION, DEFAULT_RETRY_CONFIG, type DocumentSection, type DoneEvent, type EmailAPI, type ErrorEvent, type Execution, type ExecutionEvent, type ExtractionAPI, type ExtractionRowQueryParams, type ExtractionRowQueryResult, type FeatureDefinition, type FeatureUsage, GptClient, GptCoreError, type IdentityAPI, InsecureConnectionError, type Invitation, type Invoice, type IterationCompleteEvent, LOG_LEVELS, type ListModelsOptions, type ListPracticeToolsParams, type LogLevel, type Logger, type MemoryAPI, type MjmlCompileResult, type ModelInfo, type ModelTier, type ModelsAPI, NetworkError, NotFoundError, type PaginatedResponse, type PaginationLinks, type PaginationOptions, type PaymentMethod, type PaymentMethodCreateAttributes, type PaymentMethodTokenizeAttributes, type PaymentMethodUpdateAttributes, PaymentRequiredError, type Plan, type PlanFeatureAllocation, type PlatformAPI, type PracticeToolCategory, RateLimitError, RequestBuilder, type RequestOptions, type RetryConfig, RetryTimeoutError, SDK_VERSION, type SchedulingAPI, type SdkErrorEvent, SdkEventEmitter, type SdkEvents, type SdkRequestEvent, type SdkResponseEvent, type SdkRetryEvent, type SearchAPI, type SeatInfo, type SectionDocument, type SecurityConfig, ServerError, type SessionNoteType, type SessionNoteValue, type SocialAPI, type StorageAPI, type StreamMessageChunk, type StreamOptions, SubscriptionConflictError, type TemplateVariableSchema, type TemplateVersion, type Tenant, type ThreadsAPI, TimeoutError, type TokenDeltaEvent, type ToolCallEvent, type ToolResultEvent, type Transaction, type TrendingSnapshot, type TrendingSnapshotItem, type TrendingWatch, type TriggerPipelineAttributes, type UpdateFeatureDefinitionAttributes, type UsageHistoryEntry, type User, type UserProfile, ValidationError, type VoiceAPI, type VoiceFinalizeOptions, type VoiceRecording, type VoiceSession, type VoiceSessionStart, type VoiceStartOptions, type VoiceTranscribeOptions, type VoiceTranscribeResult, type VoiceTranscriptionResult, type Wallet, type WalletPaymentMethod, WebhookSignatureError, type WebhookVerifyOptions, Webhooks, type Workspace, type WorkspaceAgentConfig, buildHeaders, buildUserAgent, collectStreamedMessage, handleApiError, isBrowserEnvironment, isSecureUrl, paginateAll, paginateToArray, retryWithBackoff, streamMessage, streamSSE, validateApiKey, withRetry };