@permute/sdk 0.6.0 → 0.8.0

package/dist/client.d.ts

@@ -1,6 +1,7 @@
+import type { EmailSender, EmailSendRequest, EmailReceipt, PermissionGrant, PermissionGrantInput, PermissionGrantUpdate, PermissionGrantQuery, PermissionGrantList, PermissionGrantRevoked, PermissionInspectionInput, PermissionInspection, AccessRequest, AccessRequestInput, AccessRequestQuery, AccessRequestList, AccessRequestDecision } from './types.js';
 export { PermuteApiError } from './errors.js';
-import type { BusinessAction, BusinessActionList, ActionCreateRequest, ActionDefinition, ActionDefinitionSaveRequest, ActionDefinitionSaved, ActionRequest, ActionReceipt } from './types.js';
-import type { ConnectorSession, ConnectorSessionCreated, ConnectorSessionCreateRequest, Database, AppDraft, AppDraftList, AppCreateRequest, AppUpdateRequest, AppDeleted, AppUploadsRequest, AppUploads, AppSiteSaveRequest, AppGrants, AppGrantSetRequest, AppUploadFile, DatabaseList, DatabaseCreateRequest, DatabaseDefinition, DatabaseDefinitionSaveRequest, DatabaseDefinitionSaved, DatabaseTables, DatabaseTableCreateRequest, DatabaseTableCreated, DatabaseRecords, DatabaseRecordsQuery, DatabaseTransactionRequest, DatabaseTransactionReceipt, WriteSync, WriteSyncCreateRequest, WriteSyncUpdateRequest, WriteSyncDetail, WriteSyncList, WriteSyncDeleted, WriteSyncDestinations, WriteSyncRun, WriteSyncRunList, WriteSyncRunQuery, WriteSyncExecution, ResourceVersionState, ResourceRevisionList, ResourceRevision, ResourceVersionRequest, ResourcePublishRequest, Fact, FactList, FactWriteRequest, SkillList, SkillContent, SkillWriteRequest, KnowledgeWriteResponse, OperationRunGroup, OperationRunQuery, Operation, OperationList, OperationListQuery, OperationSource, OperationSourceUpdateRequest, OperationUpdateRequest, OperationRunRequest, OperationRunStarted, OperationRunList, OperationRunOutput, DataFlow, DataFlowCreateRequest, DataFlowCommandRequest, DataFlowCommandResponse, Workspace, WorkspaceCreateRequest, WorkspaceDeleteResponse, WorkspaceList, WorkspaceUpdateRequest, AnswerRequest, AnswerJobResponse, AnswerResponse, PermuteClientOptions, PermuteRequestOptions, QueryRequest, QueryResponse, SearchRequest, SearchResponse, SourceDetail, CatalogTable, SourceList, CustomDatasetCreateRequest, DatasetDeleteResponse, DatasetResponse, FileDatasetCreateRequest, FileDatasetResponse, DatasetRows, CustomDatasetResponse, DashboardSource, DashboardSourceUpdateRequest } from './types.js';
+import type { BusinessAction, BusinessActionDetail, BusinessActionList, ActionCreateRequest, ActionDefinition, ActionDefinitionSaveRequest, ActionDefinitionSaved, ActionRequest, ActionReceipt, ActionPublicationRequest, ActionPublicationRequestInput, ActionPublicationRequestList, ActionPublicationDecision } from './types.js';
+import type { ConnectorSession, ConnectorSessionCreated, ConnectorSessionCreateRequest, Database, AppPublicationRequest, AppPublicationRequestInput, AppPublicationRequestList, AppPublicationDecision, AppDraft, AppAccess, AppAddressSettings, AppAddressSetRequest, AppAccessSetRequest, AppDraftList, AppCreateRequest, AppUpdateRequest, AppDeleted, AppUploadsRequest, AppUploads, AppSiteSaveRequest, AppSourceFileQuery, AppSourceFileContent, AppGrants, AppGrantSetRequest, AppUploadFile, DatabaseList, DatabaseCreateRequest, DatabaseDefinition, DatabaseDefinitionSaveRequest, DatabaseDefinitionSaved, DatabaseTables, DatabaseTableCreateRequest, DatabaseTableCreated, DatabaseRecords, DatabaseRecordsQuery, DatabaseTransactionRequest, DatabaseTransactionReceipt, WriteSync, WriteSyncCreateRequest, WriteSyncUpdateRequest, WriteSyncDetail, WriteSyncList, WriteSyncDeleted, WriteSyncDestinations, WriteSyncRun, WriteSyncRunList, WriteSyncRunQuery, WriteSyncExecution, ResourceVersionState, ResourceRevisionList, ResourceRevision, ResourceVersionRequest, ResourcePublishRequest, Fact, FactList, FactWriteRequest, SkillList, SkillContent, SkillWriteRequest, KnowledgeWriteResponse, OperationRunGroup, OperationRunQuery, Operation, OperationList, OperationListQuery, OperationSource, OperationSourceUpdateRequest, OperationUpdateRequest, OperationRunRequest, OperationRunStarted, OperationRunList, OperationRunOutput, DataFlow, DataFlowCreateRequest, DataFlowCommandRequest, DataFlowCommandResponse, Workspace, WorkspaceCreateRequest, WorkspaceDeleteResponse, WorkspaceList, WorkspaceUpdateRequest, AnswerRequest, AnswerResponse, PermuteClientOptions, PermuteRequestOptions, QueryRequest, SearchRequest, SourceDetail, CatalogTable, SourceList, CustomDatasetCreateRequest, DatasetDeleteResponse, DatasetResponse, FileDatasetCreateRequest, FileDatasetMetadataCreateRequest, FileDatasetResponse, DatasetRows, CustomDatasetResponse, DashboardSource, DashboardSourceUpdateRequest } from './types.js';
 type DatasetWriteInput = {
     tables: Record<string, DatasetRows>;
     mode: 'replace';
@@ -19,7 +20,7 @@ type DatasetReader = (id: string, options?: PermuteRequestOptions) => Promise<Da
 export declare class PermuteDataset {
     private readonly writeTables;
     private readonly readDataset;
-    readonly type: "custom";
+    readonly type: 'custom';
     private snapshot;
     constructor(snapshot: CustomDatasetResponse, writeTables: DatasetWriter, readDataset: DatasetReader);
     get data(): CustomDatasetResponse;
@@ -39,7 +40,7 @@ export declare class PermuteDataset {
 }
 export declare class PermuteFileDataset {
     private readonly readDataset;
-    readonly type: "file";
+    readonly type: 'file';
     private snapshot;
     constructor(snapshot: FileDatasetResponse, readDataset: DatasetReader);
     get data(): FileDatasetResponse;
@@ -56,6 +57,19 @@ export interface SkillsClient {
     delete(path: string, options?: PermuteRequestOptions): Promise<KnowledgeWriteResponse>;
 }
 export declare class PermuteClient {
+    readonly permissions: {
+        update(permissionId: string, body: PermissionGrantUpdate, options?: PermuteRequestOptions): Promise<PermissionGrant>;
+        list(query?: PermissionGrantQuery, options?: PermuteRequestOptions): Promise<PermissionGrantList>;
+        create(body: PermissionGrantInput, options?: PermuteRequestOptions): Promise<PermissionGrant>;
+        delete(permissionId: string, options?: PermuteRequestOptions): Promise<PermissionGrantRevoked>;
+        inspect(body: PermissionInspectionInput, options?: PermuteRequestOptions): Promise<PermissionInspection>;
+    };
+    readonly accessRequests: {
+        create(body: AccessRequestInput, options?: PermuteRequestOptions): Promise<AccessRequest>;
+        list(query?: AccessRequestQuery, options?: PermuteRequestOptions): Promise<AccessRequestList>;
+        get(requestId: string, options?: PermuteRequestOptions): Promise<AccessRequest>;
+        decide(requestId: string, body: AccessRequestDecision, options?: PermuteRequestOptions): Promise<AccessRequest>;
+    };
     readonly revisions: {
         list(resourceId: string, options?: PermuteRequestOptions): Promise<ResourceRevisionList>;
         get(resourceId: string, revisionId: string, options?: PermuteRequestOptions): Promise<ResourceRevision>;
@@ -72,14 +86,22 @@ export declare class PermuteClient {
     readonly skills: SkillsClient;
     readonly organizationSkills: SkillsClient;
     readonly actions: {
+        requestPublication(actionId: string, body: ActionPublicationRequestInput, options?: PermuteRequestOptions): Promise<ActionPublicationRequest>;
+        publicationRequests(actionId: string, options?: PermuteRequestOptions): Promise<ActionPublicationRequestList>;
+        decidePublication(actionId: string, requestId: string, body: ActionPublicationDecision, options?: PermuteRequestOptions): Promise<ActionPublicationRequest>;
         list(options?: PermuteRequestOptions): Promise<BusinessActionList>;
         create(body: ActionCreateRequest, options?: PermuteRequestOptions): Promise<BusinessAction>;
-        get(actionId: string, options?: PermuteRequestOptions): Promise<BusinessAction>;
+        get(actionId: string, options?: PermuteRequestOptions): Promise<BusinessActionDetail>;
         delete(actionId: string, options?: PermuteRequestOptions): Promise<BusinessAction>;
         definition(actionId: string, options?: PermuteRequestOptions): Promise<ActionDefinition>;
         saveDefinition(actionId: string, body: ActionDefinitionSaveRequest, options?: PermuteRequestOptions): Promise<ActionDefinitionSaved>;
         invoke(actionId: string, body: ActionRequest, options?: PermuteRequestOptions): Promise<ActionReceipt>;
     };
+    readonly emails: {
+        get(options?: PermuteRequestOptions): Promise<EmailSender>;
+        /** Only callable from Business Actions through platform.withStep(stepId). */
+        send(body: EmailSendRequest, options?: PermuteRequestOptions): Promise<EmailReceipt>;
+    };
     readonly databases: {
         list(options?: PermuteRequestOptions): Promise<DatabaseList>;
         create(body: DatabaseCreateRequest, options?: PermuteRequestOptions): Promise<Database>;
@@ -93,6 +115,13 @@ export declare class PermuteClient {
         transact(databaseId: string, body: DatabaseTransactionRequest, options?: PermuteRequestOptions): Promise<DatabaseTransactionReceipt>;
     };
     readonly apps: {
+        requestPublication(applicationId: string, body: AppPublicationRequestInput, options?: PermuteRequestOptions): Promise<AppPublicationRequest>;
+        publicationRequests(applicationId: string, options?: PermuteRequestOptions): Promise<AppPublicationRequestList>;
+        decidePublication(applicationId: string, requestId: string, body: AppPublicationDecision, options?: PermuteRequestOptions): Promise<AppPublicationRequest>;
+        address(applicationId: string, options?: PermuteRequestOptions): Promise<AppAddressSettings>;
+        setAddress(applicationId: string, body: AppAddressSetRequest, options?: PermuteRequestOptions): Promise<AppAddressSettings>;
+        access(applicationId: string, options?: PermuteRequestOptions): Promise<AppAccess>;
+        setAccess(applicationId: string, body: AppAccessSetRequest, options?: PermuteRequestOptions): Promise<AppAccess>;
         listGrants(applicationId: string, options?: PermuteRequestOptions): Promise<AppGrants>;
         setGrant(applicationId: string, resourceId: string, body: AppGrantSetRequest, options?: PermuteRequestOptions): Promise<AppGrants>;
         list(options?: PermuteRequestOptions): Promise<AppDraftList>;
@@ -103,6 +132,7 @@ export declare class PermuteClient {
         prepareUploads(applicationId: string, body: AppUploadsRequest, options?: PermuteRequestOptions): Promise<AppUploads>;
         uploadFiles(applicationId: string, files: AppUploadFile[], options?: PermuteRequestOptions): Promise<AppUploadsRequest['files']>;
         saveSite(applicationId: string, body: AppSiteSaveRequest, options?: PermuteRequestOptions): Promise<AppDraft>;
+        sourceFile(applicationId: string, query: AppSourceFileQuery, options?: PermuteRequestOptions): Promise<AppSourceFileContent>;
     };
     readonly connectorSessions: {
         create(request: ConnectorSessionCreateRequest, options?: PermuteRequestOptions): Promise<ConnectorSessionCreated>;
@@ -158,6 +188,7 @@ export declare class PermuteClient {
     };
     readonly datasets: {
         create: {
+            (request: FileDatasetMetadataCreateRequest, options?: PermuteRequestOptions): Promise<PermuteFileDataset>;
             (request: CustomDatasetCreateRequest, options?: PermuteRequestOptions): Promise<PermuteDataset>;
             (request: FileDatasetCreateRequest, options?: PermuteRequestOptions): Promise<PermuteFileDataset>;
         };
@@ -166,19 +197,130 @@ export declare class PermuteClient {
         download: (datasetId: string, options?: PermuteRequestOptions) => Promise<string>;
         delete: (datasetId: string, options?: PermuteRequestOptions) => Promise<DatasetDeleteResponse>;
     };
-    private readonly apiKey;
+    private readonly apiKey?;
+    private readonly accessToken?;
     private readonly baseUrl;
     /** Workspace selected for workspace-scoped API operations. */
     readonly workspaceId?: string;
     private readonly defaultHeaders;
     private readonly fetchImpl;
     constructor(options: PermuteClientOptions);
-    search(request: SearchRequest, options?: PermuteRequestOptions): Promise<SearchResponse>;
+    search: (request: SearchRequest, options?: PermuteRequestOptions) => Promise<{
+        items: {
+            citation?: {
+                [key: string]: unknown;
+            };
+            content: string;
+            metadata?: {
+                [key: string]: unknown;
+            };
+            score?: number;
+            sourceId?: string;
+            title?: string;
+            type: 'record' | 'document' | 'table' | 'text_block' | 'unknown';
+        }[];
+        meta: {
+            candidateCount?: number;
+            reranked: boolean;
+            strategy: 'semantic';
+            totalMs?: number;
+        };
+    }>;
     answer(request: AnswerRequest, options?: PermuteRequestOptions): Promise<AnswerResponse>;
-    answerJobs(request: AnswerRequest, options?: PermuteRequestOptions): Promise<AnswerJobResponse>;
-    getAnswerJob(answerJobId: string, options?: PermuteRequestOptions): Promise<AnswerJobResponse>;
+    answerJobs: (request: AnswerRequest, options?: PermuteRequestOptions) => Promise<{
+        answerJobId: string;
+        completedAt?: string | null;
+        createdAt?: string;
+        error?: string;
+        pollAfterMs?: number;
+        result?: {
+            answer: string;
+            assumptions?: {
+                [key: string]: unknown;
+            }[];
+            charts?: {
+                [key: string]: unknown;
+            }[];
+            citations: {
+                metadata?: {
+                    [key: string]: unknown;
+                };
+                ref?: string;
+                sourceId?: string;
+                title?: string;
+                type: 'text' | 'table' | 'web' | 'fact';
+                url?: string;
+            }[];
+            confidence?: {
+                queryComplexity: 'high' | 'medium' | 'low';
+                reason: string;
+                score: number;
+            };
+            followUps?: string[];
+        };
+        startedAt?: string | null;
+        status: 'queued' | 'running' | 'completed' | 'failed' | 'cancelled';
+        updatedAt?: string;
+    }>;
+    getAnswerJob: (answerJobId: string, options?: PermuteRequestOptions) => Promise<{
+        answerJobId: string;
+        completedAt?: string | null;
+        createdAt?: string;
+        error?: string;
+        pollAfterMs?: number;
+        result?: {
+            answer: string;
+            assumptions?: {
+                [key: string]: unknown;
+            }[];
+            charts?: {
+                [key: string]: unknown;
+            }[];
+            citations: {
+                metadata?: {
+                    [key: string]: unknown;
+                };
+                ref?: string;
+                sourceId?: string;
+                title?: string;
+                type: 'text' | 'table' | 'web' | 'fact';
+                url?: string;
+            }[];
+            confidence?: {
+                queryComplexity: 'high' | 'medium' | 'low';
+                reason: string;
+                score: number;
+            };
+            followUps?: string[];
+        };
+        startedAt?: string | null;
+        status: 'queued' | 'running' | 'completed' | 'failed' | 'cancelled';
+        updatedAt?: string;
+    }>;
     withWorkspace(workspaceId: string): PermuteClient;
-    query(request: QueryRequest, options?: PermuteRequestOptions): Promise<QueryResponse>;
+    query: (request: QueryRequest, options?: PermuteRequestOptions) => Promise<{
+        columns: {
+            name: string;
+            type?: string;
+        }[];
+        executionMs: number;
+        queryId: string;
+        rowCount: number;
+        rows: {
+            [key: string]: unknown;
+        }[];
+        sourceIds: string[];
+        sql: string;
+        timings?: {
+            initializationMs: number;
+            sourceLoadMs: number;
+            sourceValidationMs: number;
+            sqlExecutionMs: number;
+            totalMs: number;
+        };
+        truncated: boolean;
+    }>;
+    private bindMethod;
     private request;
     private validateRequestBody;
     private validateRequestQuery;