@gpt-platform/client 0.10.5 → 0.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/_internal/client/client.gen.d.ts +3 -0
- package/dist/_internal/client/client.gen.d.ts.map +1 -0
- package/dist/_internal/client/index.d.ts +9 -0
- package/dist/_internal/client/index.d.ts.map +1 -0
- package/dist/_internal/client/types.gen.d.ts +118 -0
- package/dist/_internal/client/types.gen.d.ts.map +1 -0
- package/dist/_internal/client/utils.gen.d.ts +34 -0
- package/dist/_internal/client/utils.gen.d.ts.map +1 -0
- package/dist/_internal/client.gen.d.ts +13 -0
- package/dist/_internal/client.gen.d.ts.map +1 -0
- package/dist/_internal/core/auth.gen.d.ts +19 -0
- package/dist/_internal/core/auth.gen.d.ts.map +1 -0
- package/dist/_internal/core/bodySerializer.gen.d.ts +26 -0
- package/dist/_internal/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/_internal/core/params.gen.d.ts +44 -0
- package/dist/_internal/core/params.gen.d.ts.map +1 -0
- package/dist/_internal/core/pathSerializer.gen.d.ts +34 -0
- package/dist/_internal/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/_internal/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/_internal/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/_internal/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/_internal/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/_internal/core/types.gen.d.ts +79 -0
- package/dist/_internal/core/types.gen.d.ts.map +1 -0
- package/dist/_internal/core/utils.gen.d.ts +20 -0
- package/dist/_internal/core/utils.gen.d.ts.map +1 -0
- package/dist/_internal/index.d.ts +3 -0
- package/dist/_internal/index.d.ts.map +1 -0
- package/dist/_internal/sdk.gen.d.ts +7053 -0
- package/dist/_internal/sdk.gen.d.ts.map +1 -0
- package/dist/_internal/types.gen.d.ts +146633 -0
- package/dist/_internal/types.gen.d.ts.map +1 -0
- package/dist/base-client.d.ts +199 -0
- package/dist/base-client.d.ts.map +1 -0
- package/dist/errors/index.d.ts +128 -0
- package/dist/errors/index.d.ts.map +1 -0
- package/dist/events.d.ts +69 -0
- package/dist/events.d.ts.map +1 -0
- package/dist/execution-events.d.ts +95 -0
- package/dist/execution-events.d.ts.map +1 -0
- package/dist/gpt-client.d.ts +2175 -0
- package/dist/gpt-client.d.ts.map +1 -0
- package/dist/index.d.ts +51 -30734
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +318 -9
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +318 -9
- package/dist/index.mjs.map +1 -1
- package/dist/json-api.d.ts +26 -0
- package/dist/json-api.d.ts.map +1 -0
- package/dist/logging.d.ts +22 -0
- package/dist/logging.d.ts.map +1 -0
- package/dist/namespace-types.d.ts +79 -0
- package/dist/namespace-types.d.ts.map +1 -0
- package/dist/namespaces/access-grants.d.ts +71 -0
- package/dist/namespaces/access-grants.d.ts.map +1 -0
- package/dist/namespaces/agents.d.ts +1406 -0
- package/dist/namespaces/agents.d.ts.map +1 -0
- package/dist/namespaces/ai.d.ts +407 -0
- package/dist/namespaces/ai.d.ts.map +1 -0
- package/dist/namespaces/audit.d.ts +83 -0
- package/dist/namespaces/audit.d.ts.map +1 -0
- package/dist/namespaces/billing.d.ts +854 -0
- package/dist/namespaces/billing.d.ts.map +1 -0
- package/dist/namespaces/campaigns.d.ts +973 -0
- package/dist/namespaces/campaigns.d.ts.map +1 -0
- package/dist/namespaces/catalog.d.ts +964 -0
- package/dist/namespaces/catalog.d.ts.map +1 -0
- package/dist/namespaces/channels.d.ts +162 -0
- package/dist/namespaces/channels.d.ts.map +1 -0
- package/dist/namespaces/clinical.d.ts +2443 -0
- package/dist/namespaces/clinical.d.ts.map +1 -0
- package/dist/namespaces/communication.d.ts +439 -0
- package/dist/namespaces/communication.d.ts.map +1 -0
- package/dist/namespaces/compliance.d.ts +2310 -0
- package/dist/namespaces/compliance.d.ts.map +1 -0
- package/dist/namespaces/connectors.d.ts +1368 -0
- package/dist/namespaces/connectors.d.ts.map +1 -0
- package/dist/namespaces/content.d.ts +188 -0
- package/dist/namespaces/content.d.ts.map +1 -0
- package/dist/namespaces/crawler.d.ts +408 -0
- package/dist/namespaces/crawler.d.ts.map +1 -0
- package/dist/namespaces/crm-clusters.d.ts +31 -0
- package/dist/namespaces/crm-clusters.d.ts.map +1 -0
- package/dist/namespaces/crm.d.ts +1539 -0
- package/dist/namespaces/crm.d.ts.map +1 -0
- package/dist/namespaces/documents.d.ts +136 -0
- package/dist/namespaces/documents.d.ts.map +1 -0
- package/dist/namespaces/email.d.ts +550 -0
- package/dist/namespaces/email.d.ts.map +1 -0
- package/dist/namespaces/extraction.d.ts +1249 -0
- package/dist/namespaces/extraction.d.ts.map +1 -0
- package/dist/namespaces/identity.d.ts +411 -0
- package/dist/namespaces/identity.d.ts.map +1 -0
- package/dist/namespaces/imports.d.ts +177 -0
- package/dist/namespaces/imports.d.ts.map +1 -0
- package/dist/namespaces/index.d.ts +119 -0
- package/dist/namespaces/index.d.ts.map +1 -0
- package/dist/namespaces/memory.d.ts +105 -0
- package/dist/namespaces/memory.d.ts.map +1 -0
- package/dist/namespaces/models.d.ts +75 -0
- package/dist/namespaces/models.d.ts.map +1 -0
- package/dist/namespaces/permissions.d.ts +75 -0
- package/dist/namespaces/permissions.d.ts.map +1 -0
- package/dist/namespaces/pipeline-executions.d.ts +130 -0
- package/dist/namespaces/pipeline-executions.d.ts.map +1 -0
- package/dist/namespaces/pipelines.d.ts +120 -0
- package/dist/namespaces/pipelines.d.ts.map +1 -0
- package/dist/namespaces/platform.d.ts +1430 -0
- package/dist/namespaces/platform.d.ts.map +1 -0
- package/dist/namespaces/portal.d.ts +198 -0
- package/dist/namespaces/portal.d.ts.map +1 -0
- package/dist/namespaces/projects.d.ts +553 -0
- package/dist/namespaces/projects.d.ts.map +1 -0
- package/dist/namespaces/roles.d.ts +65 -0
- package/dist/namespaces/roles.d.ts.map +1 -0
- package/dist/namespaces/scheduling.d.ts +944 -0
- package/dist/namespaces/scheduling.d.ts.map +1 -0
- package/dist/namespaces/search.d.ts +224 -0
- package/dist/namespaces/search.d.ts.map +1 -0
- package/dist/namespaces/session-notes.d.ts +67 -0
- package/dist/namespaces/session-notes.d.ts.map +1 -0
- package/dist/namespaces/social.d.ts +330 -0
- package/dist/namespaces/social.d.ts.map +1 -0
- package/dist/namespaces/storage.d.ts +378 -0
- package/dist/namespaces/storage.d.ts.map +1 -0
- package/dist/namespaces/support.d.ts +427 -0
- package/dist/namespaces/support.d.ts.map +1 -0
- package/dist/namespaces/threads.d.ts +596 -0
- package/dist/namespaces/threads.d.ts.map +1 -0
- package/dist/namespaces/training.d.ts +358 -0
- package/dist/namespaces/training.d.ts.map +1 -0
- package/dist/namespaces/voice.d.ts +752 -0
- package/dist/namespaces/voice.d.ts.map +1 -0
- package/dist/namespaces/watcher.d.ts +425 -0
- package/dist/namespaces/watcher.d.ts.map +1 -0
- package/dist/namespaces/webhooks-ns.d.ts +3 -0
- package/dist/namespaces/webhooks-ns.d.ts.map +1 -0
- package/dist/pagination.d.ts +57 -0
- package/dist/pagination.d.ts.map +1 -0
- package/dist/request-builder.d.ts +95 -0
- package/dist/request-builder.d.ts.map +1 -0
- package/dist/security.d.ts +32 -0
- package/dist/security.d.ts.map +1 -0
- package/dist/streaming.d.ts +135 -0
- package/dist/streaming.d.ts.map +1 -0
- package/dist/utils/retry.d.ts +63 -0
- package/dist/utils/retry.d.ts.map +1 -0
- package/dist/version.d.ts +5 -0
- package/dist/version.d.ts.map +1 -0
- package/dist/webhook-signature.d.ts +109 -0
- package/dist/webhook-signature.d.ts.map +1 -0
- package/llms.txt +7 -1
- package/package.json +286 -36
- package/dist/index.d.mts +0 -30734
|
@@ -0,0 +1,2175 @@
|
|
|
1
|
+
import { BaseClient, BaseClientConfig } from "./base-client";
|
|
2
|
+
import { createClinicalNamespace } from "./namespaces/clinical";
|
|
3
|
+
import type { SdkEvents } from "./events";
|
|
4
|
+
/**
|
|
5
|
+
* GPT Core Client SDK
|
|
6
|
+
*
|
|
7
|
+
* The main entry point for interacting with the GPT Core API.
|
|
8
|
+
* Provides a namespaced, type-safe interface for all API operations.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```typescript
|
|
12
|
+
* import { GptClient } from '@gpt-platform/client';
|
|
13
|
+
*
|
|
14
|
+
* const client = new GptClient({
|
|
15
|
+
* baseUrl: 'https://api.gpt-core.com',
|
|
16
|
+
* apiKey: 'sk_app_...',
|
|
17
|
+
* });
|
|
18
|
+
*
|
|
19
|
+
* // Authentication
|
|
20
|
+
* const user = await client.identity.me();
|
|
21
|
+
*
|
|
22
|
+
* // Workspaces
|
|
23
|
+
* const workspaces = await client.platform.workspaces.mine();
|
|
24
|
+
*
|
|
25
|
+
* // AI Search
|
|
26
|
+
* const results = await client.ai.search('quarterly earnings');
|
|
27
|
+
*
|
|
28
|
+
* // Documents
|
|
29
|
+
* const docs = await client.extraction.documents.list();
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
export declare class GptClient extends BaseClient {
|
|
33
|
+
/** Audit log activity feed — read-only tenant activity feed scoped to the authenticated tenant */
|
|
34
|
+
readonly audit: {
|
|
35
|
+
activityFeed(params: import("./namespaces/audit").ActivityFeedParams, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/audit").AuditLog[]>;
|
|
36
|
+
};
|
|
37
|
+
/** Agent creation, versioning, training, and testing */
|
|
38
|
+
readonly agents: {
|
|
39
|
+
list: (options?: {
|
|
40
|
+
page?: number;
|
|
41
|
+
pageSize?: number;
|
|
42
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").Agent[]>;
|
|
43
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import(".").Agent[]>;
|
|
44
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
45
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Agent>;
|
|
46
|
+
getBySlug: (slug: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Agent>;
|
|
47
|
+
create: (name: string, attributes?: import("./namespaces/agents").CreateAgentAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").Agent>;
|
|
48
|
+
update: (id: string, attributes: import("./namespaces/agents").UpdateAgentAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").Agent>;
|
|
49
|
+
test: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Agent>;
|
|
50
|
+
validate: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Agent>;
|
|
51
|
+
clone: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Agent>;
|
|
52
|
+
export: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Agent>;
|
|
53
|
+
analyzeTraining: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Agent>;
|
|
54
|
+
teach: (id: string, params?: import("./namespaces/agents").TeachParams, options?: import("./base-client").RequestOptions) => Promise<import(".").Agent>;
|
|
55
|
+
publishVersion: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Agent>;
|
|
56
|
+
restoreVersion: (id: string, body?: {
|
|
57
|
+
version_id?: string;
|
|
58
|
+
}, options?: import("./base-client").RequestOptions) => Promise<import(".").Agent>;
|
|
59
|
+
stats: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").AgentStatsResponse>;
|
|
60
|
+
import: (data: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import(".").Agent>;
|
|
61
|
+
usage: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").AgentUsageResponse>;
|
|
62
|
+
usageAll: (options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").AgentUsageResponse[]>;
|
|
63
|
+
getOrCreateDraft: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").AgentVersion>;
|
|
64
|
+
publishDraft: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").AgentVersion>;
|
|
65
|
+
cloneForWorkspace: (agentId: string, targetWorkspaceId: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Agent>;
|
|
66
|
+
trainingStats: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").TrainingStatsResponse>;
|
|
67
|
+
createTestResult: (attributes: import("./namespaces/agents").CreateTestResultAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").AgentTestResultResponse>;
|
|
68
|
+
versions: {
|
|
69
|
+
list: (options?: {
|
|
70
|
+
page?: number;
|
|
71
|
+
pageSize?: number;
|
|
72
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").AgentVersion[]>;
|
|
73
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import(".").AgentVersion[]>;
|
|
74
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").AgentVersion>;
|
|
75
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
76
|
+
create: (attributes: import("./namespaces/agents").CreateAgentVersionAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").AgentVersion>;
|
|
77
|
+
addSystemField: (id: string, fieldName: string, options?: import("./base-client").RequestOptions) => Promise<import(".").AgentVersion>;
|
|
78
|
+
removeSystemField: (id: string, fieldName: string, options?: import("./base-client").RequestOptions) => Promise<import(".").AgentVersion>;
|
|
79
|
+
setSystemFields: (id: string, fieldNames: string[], options?: import("./base-client").RequestOptions) => Promise<import(".").AgentVersion>;
|
|
80
|
+
metrics: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").VersionMetricsResponse>;
|
|
81
|
+
revisions: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").VersionRevision[]>;
|
|
82
|
+
getRevision: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").VersionRevision>;
|
|
83
|
+
listAllRevisions: (options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").VersionRevision[]>;
|
|
84
|
+
compare: (versionAId: string, versionBId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").VersionComparisonResponse>;
|
|
85
|
+
schemaVersions: {
|
|
86
|
+
list: (agentId: string, options?: import("./base-client").RequestOptions) => Promise<import(".").AgentVersion[]>;
|
|
87
|
+
create: (agentId: string, attributes: import("./namespaces/agents").CreateAgentVersionAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").AgentVersion>;
|
|
88
|
+
activate: (agentId: string, versionId: string, options?: import("./base-client").RequestOptions) => Promise<import(".").AgentVersion>;
|
|
89
|
+
update: (agentId: string, versionId: string, attributes: import("./namespaces/agents").UpdateAgentVersionAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").AgentVersion>;
|
|
90
|
+
};
|
|
91
|
+
};
|
|
92
|
+
training: {
|
|
93
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
94
|
+
list: (options?: {
|
|
95
|
+
page?: number;
|
|
96
|
+
pageSize?: number;
|
|
97
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingExample[]>;
|
|
98
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingExample[]>;
|
|
99
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingExample>;
|
|
100
|
+
create: (attributes: import("./namespaces/agents").CreateAgentTrainingExampleAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingExample>;
|
|
101
|
+
update: (id: string, attributes: import("./namespaces/agents").UpdateAgentTrainingExampleAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingExample>;
|
|
102
|
+
bulkCreate: (examples: import("./namespaces/agents").CreateAgentTrainingExampleAttributes[], options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingExample[]>;
|
|
103
|
+
bulkDelete: (ids: string[], options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").BulkDeleteResponse>;
|
|
104
|
+
search: (query: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingExample[]>;
|
|
105
|
+
listForAgent: (agentId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingExample[]>;
|
|
106
|
+
deleteForAgent: (agentId: string, exampleId: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
107
|
+
sessions: {
|
|
108
|
+
list: (agentId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingSession[]>;
|
|
109
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingSession>;
|
|
110
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
111
|
+
};
|
|
112
|
+
};
|
|
113
|
+
fieldTemplates: {
|
|
114
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal/types.gen").FieldTemplate[]>;
|
|
115
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal/types.gen").FieldTemplate>;
|
|
116
|
+
create: (attributes: import("./namespaces/agents").CreateFieldTemplateAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal/types.gen").FieldTemplate>;
|
|
117
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
118
|
+
};
|
|
119
|
+
executions: {
|
|
120
|
+
start: (agentId: string, input: Record<string, unknown>, opts?: {
|
|
121
|
+
workspace_id?: string;
|
|
122
|
+
model_id?: string;
|
|
123
|
+
} & import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").Execution>;
|
|
124
|
+
estimate: (agentId: string, input: Record<string, unknown>, opts?: {
|
|
125
|
+
workspace_id?: string;
|
|
126
|
+
} & import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").ExecutionEstimateResponse>;
|
|
127
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").Execution>;
|
|
128
|
+
list: (opts?: {
|
|
129
|
+
workspace_id?: string;
|
|
130
|
+
} & import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").Execution[]>;
|
|
131
|
+
stream: (id: string, options?: import("./base-client").RequestOptions & import("./streaming").StreamOptions) => Promise<AsyncIterableIterator<import("./execution-events").ExecutionEvent>>;
|
|
132
|
+
approve: (id: string, approvedData?: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").Execution>;
|
|
133
|
+
deny: (id: string, reason: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").Execution>;
|
|
134
|
+
cancel: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").Execution>;
|
|
135
|
+
children: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").Execution[]>;
|
|
136
|
+
tree: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/agents").ExecutionTreeResponse>;
|
|
137
|
+
};
|
|
138
|
+
deployments: {
|
|
139
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<import(".").AgentDeployment[]>;
|
|
140
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").AgentDeployment>;
|
|
141
|
+
};
|
|
142
|
+
workspaceConfigs: {
|
|
143
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<import(".").WorkspaceAgentConfig[]>;
|
|
144
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").WorkspaceAgentConfig>;
|
|
145
|
+
update: (id: string, attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import(".").WorkspaceAgentConfig>;
|
|
146
|
+
};
|
|
147
|
+
};
|
|
148
|
+
/** Semantic search, embeddings, and AI conversations */
|
|
149
|
+
readonly ai: {
|
|
150
|
+
search: (query: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/ai").AiSearchResponse>;
|
|
151
|
+
searchAdvanced: (query: string, params?: import("./namespaces/ai").AiSearchAdvancedParams, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/ai").AiSearchResponse>;
|
|
152
|
+
embed: (text: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/ai").AiEmbedResponse>;
|
|
153
|
+
conversations: {
|
|
154
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/ai").AiConversation[]>;
|
|
155
|
+
create: (attributes?: import("./namespaces/ai").CreateAiConversationAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/ai").AiConversation>;
|
|
156
|
+
};
|
|
157
|
+
messages: {
|
|
158
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/ai").AiMessage[]>;
|
|
159
|
+
send: (conversationId: string, body: import("./namespaces/ai").AiMessageBody, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/ai").AiMessage>;
|
|
160
|
+
};
|
|
161
|
+
graph: {
|
|
162
|
+
listNodes: (options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/ai").GraphNode[]>;
|
|
163
|
+
createNode: (attributes: import("./namespaces/ai").CreateGraphNodeAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/ai").GraphNode>;
|
|
164
|
+
deleteNode: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
165
|
+
};
|
|
166
|
+
};
|
|
167
|
+
/** Wallet, plans, transactions, and payment methods */
|
|
168
|
+
readonly billing: {
|
|
169
|
+
wallet: {
|
|
170
|
+
get: (options?: import("./base-client").RequestOptions) => Promise<import(".").Wallet>;
|
|
171
|
+
previewPlanChange: (planSlug: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Wallet>;
|
|
172
|
+
changePlan: (walletIdOrSlug: string, planSlugOrOptions?: string | import("./base-client").RequestOptions, options?: import("./base-client").RequestOptions) => Promise<import(".").Wallet>;
|
|
173
|
+
buyCredits: (walletId: string, packageSlug: string, paymentMethodId?: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Wallet>;
|
|
174
|
+
updateAutoTopUp: (walletId: string, opts: {
|
|
175
|
+
enabled: boolean;
|
|
176
|
+
threshold?: number;
|
|
177
|
+
amount?: number;
|
|
178
|
+
packageId?: string;
|
|
179
|
+
}, options?: import("./base-client").RequestOptions) => Promise<import(".").Wallet>;
|
|
180
|
+
invoices: {
|
|
181
|
+
list: (options?: {
|
|
182
|
+
page?: number;
|
|
183
|
+
pageSize?: number;
|
|
184
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").Invoice[]>;
|
|
185
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import(".").Invoice[]>;
|
|
186
|
+
};
|
|
187
|
+
buyAddon: (addonSlug: string, paymentMethodId?: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Wallet>;
|
|
188
|
+
cancelAddon: (addonSlug: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Wallet>;
|
|
189
|
+
cancelPlan: (immediateOrOptions?: boolean | import("./base-client").RequestOptions, options?: import("./base-client").RequestOptions) => Promise<import(".").Wallet>;
|
|
190
|
+
retryPayment: (options?: import("./base-client").RequestOptions) => Promise<import(".").Wallet>;
|
|
191
|
+
};
|
|
192
|
+
seats: {
|
|
193
|
+
get: (options?: import("./base-client").RequestOptions) => Promise<import(".").SeatInfo>;
|
|
194
|
+
};
|
|
195
|
+
plans: {
|
|
196
|
+
list: (options?: {
|
|
197
|
+
page?: number;
|
|
198
|
+
pageSize?: number;
|
|
199
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").Plan[]>;
|
|
200
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import(".").Plan[]>;
|
|
201
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Plan>;
|
|
202
|
+
};
|
|
203
|
+
transactions: {
|
|
204
|
+
list: (options?: {
|
|
205
|
+
page?: number;
|
|
206
|
+
pageSize?: number;
|
|
207
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").Transaction[]>;
|
|
208
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import(".").Transaction[]>;
|
|
209
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Transaction>;
|
|
210
|
+
};
|
|
211
|
+
creditPackages: {
|
|
212
|
+
list: (options?: {
|
|
213
|
+
page?: number;
|
|
214
|
+
pageSize?: number;
|
|
215
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").CreditPackage[]>;
|
|
216
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import(".").CreditPackage[]>;
|
|
217
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").CreditPackage>;
|
|
218
|
+
};
|
|
219
|
+
paymentMethods: {
|
|
220
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
221
|
+
list: (options?: {
|
|
222
|
+
page?: number;
|
|
223
|
+
pageSize?: number;
|
|
224
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").PaymentMethod[]>;
|
|
225
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import(".").PaymentMethod[]>;
|
|
226
|
+
create: (attributes: import("./namespaces/billing").PaymentMethodCreateAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").PaymentMethod>;
|
|
227
|
+
tokenize: (cardDetails: import("./namespaces/billing").PaymentMethodTokenizeAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").PaymentMethod>;
|
|
228
|
+
update: (id: string, attributes: import("./namespaces/billing").PaymentMethodUpdateAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").PaymentMethod>;
|
|
229
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").PaymentMethod>;
|
|
230
|
+
setDefault: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").PaymentMethod>;
|
|
231
|
+
};
|
|
232
|
+
featureDefinitions: {
|
|
233
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<import(".").FeatureDefinition[]>;
|
|
234
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").FeatureDefinition>;
|
|
235
|
+
listByApplication: (applicationId: string, options?: import("./base-client").RequestOptions) => Promise<import(".").FeatureDefinition[]>;
|
|
236
|
+
create: (attrs: {
|
|
237
|
+
key: string;
|
|
238
|
+
name: string;
|
|
239
|
+
metering_mode: "unlimited" | "counted" | "credit_cost";
|
|
240
|
+
default_limit?: number;
|
|
241
|
+
credit_cost?: number;
|
|
242
|
+
platform_capability?: string;
|
|
243
|
+
metadata?: Record<string, unknown>;
|
|
244
|
+
}, options?: import("./base-client").RequestOptions) => Promise<import(".").FeatureDefinition>;
|
|
245
|
+
update: (id: string, attrs: import("./namespaces/billing").UpdateFeatureDefinitionAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").FeatureDefinition>;
|
|
246
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<void>;
|
|
247
|
+
};
|
|
248
|
+
featureUsages: {
|
|
249
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<import(".").FeatureUsage[]>;
|
|
250
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").FeatureUsage>;
|
|
251
|
+
listByTenant: (tenantId: string, options?: import("./base-client").RequestOptions) => Promise<import(".").FeatureUsage[]>;
|
|
252
|
+
increment: (featureKey: string, options?: import("./base-client").RequestOptions) => Promise<{
|
|
253
|
+
used: number;
|
|
254
|
+
remaining: number | null;
|
|
255
|
+
}>;
|
|
256
|
+
};
|
|
257
|
+
planFeatureAllocations: {
|
|
258
|
+
list: (options?: {
|
|
259
|
+
page?: number;
|
|
260
|
+
pageSize?: number;
|
|
261
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").PlanFeatureAllocation[]>;
|
|
262
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import(".").PlanFeatureAllocation[]>;
|
|
263
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").PlanFeatureAllocation>;
|
|
264
|
+
listByPlan: (planId: string, options?: import("./base-client").RequestOptions) => Promise<import(".").PlanFeatureAllocation[]>;
|
|
265
|
+
};
|
|
266
|
+
featureSummary: {
|
|
267
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<import(".").FeatureSummary[]>;
|
|
268
|
+
};
|
|
269
|
+
capacityCalculator: (planSlug: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/billing").CapacityCalculatorResponse>;
|
|
270
|
+
};
|
|
271
|
+
/** Product catalog, inventory, pricing, and taxonomy */
|
|
272
|
+
readonly catalog: {
|
|
273
|
+
products: {
|
|
274
|
+
list: (workspaceId: string, options?: {
|
|
275
|
+
page?: number;
|
|
276
|
+
pageSize?: number;
|
|
277
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").CatalogProduct[]>;
|
|
278
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogProduct>;
|
|
279
|
+
create: (attributes: import("./namespaces/catalog").CreateCatalogProductAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogProduct>;
|
|
280
|
+
update: (id: string, attributes: import("./namespaces/catalog").UpdateCatalogProductAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogProduct>;
|
|
281
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
282
|
+
};
|
|
283
|
+
variants: {
|
|
284
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogProductVariant>;
|
|
285
|
+
listByProduct: (productId: string, options?: {
|
|
286
|
+
page?: number;
|
|
287
|
+
pageSize?: number;
|
|
288
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").CatalogProductVariant[]>;
|
|
289
|
+
create: (attributes: import("./namespaces/catalog").CreateCatalogProductVariantAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogProductVariant>;
|
|
290
|
+
update: (id: string, attributes: import("./namespaces/catalog").UpdateCatalogProductVariantAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogProductVariant>;
|
|
291
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
292
|
+
};
|
|
293
|
+
optionTypes: {
|
|
294
|
+
listByApplication: (applicationId: string, options?: {
|
|
295
|
+
page?: number;
|
|
296
|
+
pageSize?: number;
|
|
297
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").CatalogOptionType[]>;
|
|
298
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogOptionType>;
|
|
299
|
+
create: (attributes: import("./namespaces/catalog").CreateCatalogOptionTypeAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogOptionType>;
|
|
300
|
+
update: (id: string, attributes: import("./namespaces/catalog").UpdateCatalogOptionTypeAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogOptionType>;
|
|
301
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
302
|
+
};
|
|
303
|
+
optionValues: {
|
|
304
|
+
listByOptionType: (optionTypeId: string, options?: {
|
|
305
|
+
page?: number;
|
|
306
|
+
pageSize?: number;
|
|
307
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").CatalogOptionValue[]>;
|
|
308
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogOptionValue>;
|
|
309
|
+
create: (attributes: import("./namespaces/catalog").CreateCatalogOptionValueAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogOptionValue>;
|
|
310
|
+
update: (id: string, attributes: import("./namespaces/catalog").UpdateCatalogOptionValueAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogOptionValue>;
|
|
311
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
312
|
+
};
|
|
313
|
+
taxonomies: {
|
|
314
|
+
listByApplication: (applicationId: string, options?: {
|
|
315
|
+
page?: number;
|
|
316
|
+
pageSize?: number;
|
|
317
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").CatalogTaxonomy[]>;
|
|
318
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogTaxonomy>;
|
|
319
|
+
create: (attributes: import("./namespaces/catalog").CreateCatalogTaxonomyAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogTaxonomy>;
|
|
320
|
+
update: (id: string, attributes: import("./namespaces/catalog").UpdateCatalogTaxonomyAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogTaxonomy>;
|
|
321
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
322
|
+
};
|
|
323
|
+
taxonomyNodes: {
|
|
324
|
+
listByTaxonomy: (taxonomyId: string, options?: {
|
|
325
|
+
page?: number;
|
|
326
|
+
pageSize?: number;
|
|
327
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").CatalogTaxonomyNode[]>;
|
|
328
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogTaxonomyNode>;
|
|
329
|
+
create: (attributes: import("./namespaces/catalog").CreateCatalogTaxonomyNodeAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogTaxonomyNode>;
|
|
330
|
+
update: (id: string, attributes: import("./namespaces/catalog").UpdateCatalogTaxonomyNodeAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogTaxonomyNode>;
|
|
331
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
332
|
+
};
|
|
333
|
+
views: {
|
|
334
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
335
|
+
page?: number;
|
|
336
|
+
pageSize?: number;
|
|
337
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").CatalogView[]>;
|
|
338
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogView>;
|
|
339
|
+
create: (attributes: import("./namespaces/catalog").CreateCatalogViewAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogView>;
|
|
340
|
+
update: (id: string, attributes: import("./namespaces/catalog").UpdateCatalogViewAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogView>;
|
|
341
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
342
|
+
};
|
|
343
|
+
priceLists: {
|
|
344
|
+
listByApplication: (applicationId: string, options?: {
|
|
345
|
+
page?: number;
|
|
346
|
+
pageSize?: number;
|
|
347
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").CatalogPriceList[]>;
|
|
348
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogPriceList>;
|
|
349
|
+
create: (attributes: import("./namespaces/catalog").CreateCatalogPriceListAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogPriceList>;
|
|
350
|
+
update: (id: string, attributes: import("./namespaces/catalog").UpdateCatalogPriceListAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogPriceList>;
|
|
351
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
352
|
+
};
|
|
353
|
+
priceListEntries: {
|
|
354
|
+
listByPriceList: (priceListId: string, options?: {
|
|
355
|
+
page?: number;
|
|
356
|
+
pageSize?: number;
|
|
357
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").CatalogPriceListEntry[]>;
|
|
358
|
+
create: (attributes: import("./namespaces/catalog").CreateCatalogPriceListEntryAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogPriceListEntry>;
|
|
359
|
+
update: (id: string, attributes: import("./namespaces/catalog").UpdateCatalogPriceListEntryAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").CatalogPriceListEntry>;
|
|
360
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
361
|
+
};
|
|
362
|
+
};
|
|
363
|
+
/** Patient management, sessions, notes, health metrics, and care plans */
|
|
364
|
+
readonly clinical: ReturnType<typeof createClinicalNamespace>;
|
|
365
|
+
/** HIPAA/GDPR compliance — audit logs, breach incidents, consent, DPIA, data subject requests */
|
|
366
|
+
readonly compliance: {
|
|
367
|
+
auditLogs: {
|
|
368
|
+
list: (options?: {
|
|
369
|
+
page?: number;
|
|
370
|
+
pageSize?: number;
|
|
371
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").AuditLog[]>;
|
|
372
|
+
};
|
|
373
|
+
auditChain: {
|
|
374
|
+
list: (options?: {
|
|
375
|
+
page?: number;
|
|
376
|
+
pageSize?: number;
|
|
377
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").AuditChainEntry[]>;
|
|
378
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").AuditChainEntry>;
|
|
379
|
+
};
|
|
380
|
+
breachIncidents: {
|
|
381
|
+
list: (options?: {
|
|
382
|
+
page?: number;
|
|
383
|
+
pageSize?: number;
|
|
384
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").BreachIncident[]>;
|
|
385
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BreachIncident>;
|
|
386
|
+
create: (attributes: import("./namespaces/compliance").CreateBreachIncidentAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BreachIncident>;
|
|
387
|
+
updateStatus: (id: string, status: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BreachIncident>;
|
|
388
|
+
};
|
|
389
|
+
breachNotifications: {
|
|
390
|
+
list: (options?: {
|
|
391
|
+
page?: number;
|
|
392
|
+
pageSize?: number;
|
|
393
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").BreachNotification[]>;
|
|
394
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BreachNotification>;
|
|
395
|
+
};
|
|
396
|
+
consentRecords: {
|
|
397
|
+
list: (options?: {
|
|
398
|
+
page?: number;
|
|
399
|
+
pageSize?: number;
|
|
400
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").ConsentRecord[]>;
|
|
401
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ConsentRecord>;
|
|
402
|
+
listActive: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ConsentRecord[]>;
|
|
403
|
+
create: (attributes: import("./namespaces/compliance").CreateConsentRecordAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ConsentRecord>;
|
|
404
|
+
withdraw: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ConsentRecord>;
|
|
405
|
+
};
|
|
406
|
+
impactAssessments: {
|
|
407
|
+
list: (options?: {
|
|
408
|
+
page?: number;
|
|
409
|
+
pageSize?: number;
|
|
410
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").DataProtectionImpactAssessment[]>;
|
|
411
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").DataProtectionImpactAssessment>;
|
|
412
|
+
create: (attributes: import("./namespaces/compliance").CreateImpactAssessmentAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").DataProtectionImpactAssessment>;
|
|
413
|
+
update: (id: string, attributes: import("./namespaces/compliance").UpdateImpactAssessmentAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").DataProtectionImpactAssessment>;
|
|
414
|
+
approve: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").DataProtectionImpactAssessment>;
|
|
415
|
+
};
|
|
416
|
+
processingActivities: {
|
|
417
|
+
list: (options?: {
|
|
418
|
+
page?: number;
|
|
419
|
+
pageSize?: number;
|
|
420
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").ProcessingActivity[]>;
|
|
421
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ProcessingActivity>;
|
|
422
|
+
create: (attributes: import("./namespaces/compliance").CreateProcessingActivityAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ProcessingActivity>;
|
|
423
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
424
|
+
};
|
|
425
|
+
retentionPolicies: {
|
|
426
|
+
list: (options?: {
|
|
427
|
+
page?: number;
|
|
428
|
+
pageSize?: number;
|
|
429
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").RetentionPolicy[]>;
|
|
430
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").RetentionPolicy>;
|
|
431
|
+
create: (attributes: import("./namespaces/compliance").CreateRetentionPolicyAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").RetentionPolicy>;
|
|
432
|
+
update: (id: string, attributes: import("./namespaces/compliance").UpdateRetentionPolicyAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").RetentionPolicy>;
|
|
433
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
434
|
+
};
|
|
435
|
+
dataSubjectRequests: {
|
|
436
|
+
list: (options?: {
|
|
437
|
+
page?: number;
|
|
438
|
+
pageSize?: number;
|
|
439
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").DataSubjectRequest[]>;
|
|
440
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").DataSubjectRequest>;
|
|
441
|
+
create: (attributes: import("./namespaces/compliance").CreateDataSubjectRequestAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").DataSubjectRequest>;
|
|
442
|
+
updateStatus: (id: string, status: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").DataSubjectRequest>;
|
|
443
|
+
};
|
|
444
|
+
legalDocuments: {
|
|
445
|
+
list: (options?: {
|
|
446
|
+
page?: number;
|
|
447
|
+
pageSize?: number;
|
|
448
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").LegalDocument[]>;
|
|
449
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").LegalDocument>;
|
|
450
|
+
create: (attributes: import("./namespaces/compliance").CreateLegalDocumentAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").LegalDocument>;
|
|
451
|
+
update: (id: string, attributes: import("./namespaces/compliance").UpdateLegalDocumentAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").LegalDocument>;
|
|
452
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
453
|
+
byLocale: (locale: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").LegalDocument[]>;
|
|
454
|
+
forApplication: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").LegalDocument[]>;
|
|
455
|
+
publish: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").LegalDocument>;
|
|
456
|
+
unpublish: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").LegalDocument>;
|
|
457
|
+
};
|
|
458
|
+
legalAcceptances: {
|
|
459
|
+
list: (options?: {
|
|
460
|
+
page?: number;
|
|
461
|
+
pageSize?: number;
|
|
462
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").LegalAcceptance[]>;
|
|
463
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").LegalAcceptance>;
|
|
464
|
+
latest: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").LegalAcceptance>;
|
|
465
|
+
};
|
|
466
|
+
scanResults: {
|
|
467
|
+
list: (options?: {
|
|
468
|
+
page?: number;
|
|
469
|
+
pageSize?: number;
|
|
470
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").ScanResult[]>;
|
|
471
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ScanResult>;
|
|
472
|
+
};
|
|
473
|
+
getPosture: (params: {
|
|
474
|
+
workspace_id: string;
|
|
475
|
+
}, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/compliance").CompliancePosture>;
|
|
476
|
+
riskAssessments: {
|
|
477
|
+
list: (options?: {
|
|
478
|
+
page?: number;
|
|
479
|
+
pageSize?: number;
|
|
480
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").RiskAssessment[]>;
|
|
481
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").RiskAssessment>;
|
|
482
|
+
create: (attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").RiskAssessment>;
|
|
483
|
+
updateStatus: (id: string, attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").RiskAssessment>;
|
|
484
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
485
|
+
};
|
|
486
|
+
dataTransferRecords: {
|
|
487
|
+
list: (options?: {
|
|
488
|
+
page?: number;
|
|
489
|
+
pageSize?: number;
|
|
490
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").DataTransferRecord[]>;
|
|
491
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").DataTransferRecord>;
|
|
492
|
+
create: (attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").DataTransferRecord>;
|
|
493
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
494
|
+
};
|
|
495
|
+
cdeScopeReports: {
|
|
496
|
+
list: (options?: {
|
|
497
|
+
page?: number;
|
|
498
|
+
pageSize?: number;
|
|
499
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").CdeScopeReport[]>;
|
|
500
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CdeScopeReport>;
|
|
501
|
+
create: (attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CdeScopeReport>;
|
|
502
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
503
|
+
};
|
|
504
|
+
accessLogs: {
|
|
505
|
+
list: (options?: {
|
|
506
|
+
page?: number;
|
|
507
|
+
pageSize?: number;
|
|
508
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").AccessLog[]>;
|
|
509
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").AccessLog>;
|
|
510
|
+
};
|
|
511
|
+
disclosureLogs: {
|
|
512
|
+
list: (options?: {
|
|
513
|
+
page?: number;
|
|
514
|
+
pageSize?: number;
|
|
515
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").DisclosureLog[]>;
|
|
516
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").DisclosureLog>;
|
|
517
|
+
create: (attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").DisclosureLog>;
|
|
518
|
+
listBySubject: (options?: {
|
|
519
|
+
filter?: Record<string, unknown>;
|
|
520
|
+
page?: number;
|
|
521
|
+
pageSize?: number;
|
|
522
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").DisclosureLog[]>;
|
|
523
|
+
};
|
|
524
|
+
amendmentRequests: {
|
|
525
|
+
list: (options?: {
|
|
526
|
+
page?: number;
|
|
527
|
+
pageSize?: number;
|
|
528
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").AmendmentRequest[]>;
|
|
529
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").AmendmentRequest>;
|
|
530
|
+
create: (attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").AmendmentRequest>;
|
|
531
|
+
review: (id: string, attributes?: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").AmendmentRequest>;
|
|
532
|
+
approve: (id: string, attributes?: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").AmendmentRequest>;
|
|
533
|
+
deny: (id: string, attributes?: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").AmendmentRequest>;
|
|
534
|
+
apply: (id: string, attributes?: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").AmendmentRequest>;
|
|
535
|
+
};
|
|
536
|
+
complianceDocumentTemplates: {
|
|
537
|
+
list: (options?: {
|
|
538
|
+
page?: number;
|
|
539
|
+
pageSize?: number;
|
|
540
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").ComplianceDocumentTemplate[]>;
|
|
541
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ComplianceDocumentTemplate>;
|
|
542
|
+
create: (attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ComplianceDocumentTemplate>;
|
|
543
|
+
update: (id: string, attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ComplianceDocumentTemplate>;
|
|
544
|
+
clone: (attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ComplianceDocumentTemplate>;
|
|
545
|
+
};
|
|
546
|
+
businessAssociateAgreements: {
|
|
547
|
+
list: (options?: {
|
|
548
|
+
page?: number;
|
|
549
|
+
pageSize?: number;
|
|
550
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").BusinessAssociateAgreement[]>;
|
|
551
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BusinessAssociateAgreement>;
|
|
552
|
+
create: (attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BusinessAssociateAgreement>;
|
|
553
|
+
update: (id: string, attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BusinessAssociateAgreement>;
|
|
554
|
+
sign: (id: string, attributes?: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BusinessAssociateAgreement>;
|
|
555
|
+
terminate: (id: string, attributes?: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BusinessAssociateAgreement>;
|
|
556
|
+
};
|
|
557
|
+
policyReviewSchedules: {
|
|
558
|
+
list: (options?: {
|
|
559
|
+
page?: number;
|
|
560
|
+
pageSize?: number;
|
|
561
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").PolicyReviewSchedule[]>;
|
|
562
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").PolicyReviewSchedule>;
|
|
563
|
+
create: (attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").PolicyReviewSchedule>;
|
|
564
|
+
completeReview: (id: string, attributes?: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").PolicyReviewSchedule>;
|
|
565
|
+
markDue: (id: string, attributes?: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").PolicyReviewSchedule>;
|
|
566
|
+
markOverdue: (id: string, attributes?: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").PolicyReviewSchedule>;
|
|
567
|
+
};
|
|
568
|
+
complianceRequirements: {
|
|
569
|
+
list: (options?: {
|
|
570
|
+
page?: number;
|
|
571
|
+
pageSize?: number;
|
|
572
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").ComplianceRequirement[]>;
|
|
573
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ComplianceRequirement>;
|
|
574
|
+
create: (attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ComplianceRequirement>;
|
|
575
|
+
update: (id: string, attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ComplianceRequirement>;
|
|
576
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
577
|
+
};
|
|
578
|
+
complianceRequirementCompletions: {
|
|
579
|
+
list: (options?: {
|
|
580
|
+
page?: number;
|
|
581
|
+
pageSize?: number;
|
|
582
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").ComplianceRequirementCompletion[]>;
|
|
583
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ComplianceRequirementCompletion>;
|
|
584
|
+
create: (attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ComplianceRequirementCompletion>;
|
|
585
|
+
};
|
|
586
|
+
complianceOfficerDesignations: {
|
|
587
|
+
list: (options?: {
|
|
588
|
+
page?: number;
|
|
589
|
+
pageSize?: number;
|
|
590
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").ComplianceOfficerDesignation[]>;
|
|
591
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ComplianceOfficerDesignation>;
|
|
592
|
+
create: (attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ComplianceOfficerDesignation>;
|
|
593
|
+
revoke: (id: string, attributes?: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ComplianceOfficerDesignation>;
|
|
594
|
+
};
|
|
595
|
+
ephiAssets: {
|
|
596
|
+
list: (options?: {
|
|
597
|
+
page?: number;
|
|
598
|
+
pageSize?: number;
|
|
599
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").EphiAsset[]>;
|
|
600
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EphiAsset>;
|
|
601
|
+
create: (attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EphiAsset>;
|
|
602
|
+
update: (id: string, attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EphiAsset>;
|
|
603
|
+
};
|
|
604
|
+
ephiDataFlows: {
|
|
605
|
+
list: (options?: {
|
|
606
|
+
page?: number;
|
|
607
|
+
pageSize?: number;
|
|
608
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").EphiDataFlow[]>;
|
|
609
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EphiDataFlow>;
|
|
610
|
+
create: (attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EphiDataFlow>;
|
|
611
|
+
update: (id: string, attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EphiDataFlow>;
|
|
612
|
+
};
|
|
613
|
+
breachNotificationArtifacts: {
|
|
614
|
+
list: (options?: {
|
|
615
|
+
page?: number;
|
|
616
|
+
pageSize?: number;
|
|
617
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").BreachNotificationArtifact[]>;
|
|
618
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BreachNotificationArtifact>;
|
|
619
|
+
create: (attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BreachNotificationArtifact>;
|
|
620
|
+
update: (id: string, attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BreachNotificationArtifact>;
|
|
621
|
+
send: (id: string, attributes?: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BreachNotificationArtifact>;
|
|
622
|
+
};
|
|
623
|
+
};
|
|
624
|
+
/** Notification logs, methods, and preferences */
|
|
625
|
+
readonly communication: {
|
|
626
|
+
notifications: {
|
|
627
|
+
logs: (options?: {
|
|
628
|
+
page?: number;
|
|
629
|
+
pageSize?: number;
|
|
630
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").NotificationLog[]>;
|
|
631
|
+
list: (options?: {
|
|
632
|
+
page?: number;
|
|
633
|
+
pageSize?: number;
|
|
634
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").NotificationLog[]>;
|
|
635
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").NotificationLog[]>;
|
|
636
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").NotificationLog>;
|
|
637
|
+
methods: {
|
|
638
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
639
|
+
list: (options?: {
|
|
640
|
+
page?: number;
|
|
641
|
+
pageSize?: number;
|
|
642
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").NotificationMethod[]>;
|
|
643
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").NotificationMethod[]>;
|
|
644
|
+
create: (attributes: import("./namespaces/communication").CreateNotificationMethodAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").NotificationMethod>;
|
|
645
|
+
update: (id: string, attributes: import("./namespaces/communication").UpdateNotificationMethodAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").NotificationMethod>;
|
|
646
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").NotificationMethod>;
|
|
647
|
+
};
|
|
648
|
+
preferences: {
|
|
649
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
650
|
+
list: (options?: {
|
|
651
|
+
page?: number;
|
|
652
|
+
pageSize?: number;
|
|
653
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").NotificationPreference[]>;
|
|
654
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").NotificationPreference[]>;
|
|
655
|
+
create: (attributes: import("./namespaces/communication").CreateNotificationPreferenceAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").NotificationPreference>;
|
|
656
|
+
update: (id: string, attributes: import("./namespaces/communication").UpdateNotificationPreferenceAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").NotificationPreference>;
|
|
657
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").NotificationPreference>;
|
|
658
|
+
};
|
|
659
|
+
};
|
|
660
|
+
};
|
|
661
|
+
/** OAuth and API adapters for external systems */
|
|
662
|
+
readonly connectors: {
|
|
663
|
+
instances: {
|
|
664
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ConnectorInstance[]>;
|
|
665
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ConnectorInstance>;
|
|
666
|
+
create: (attributes: import("./namespaces/connectors").CreateConnectorInstanceAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ConnectorInstance>;
|
|
667
|
+
update: (id: string, attributes: import("./namespaces/connectors").UpdateConnectorInstanceAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ConnectorInstance>;
|
|
668
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
669
|
+
};
|
|
670
|
+
credentials: {
|
|
671
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Credential[]>;
|
|
672
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Credential>;
|
|
673
|
+
refresh: (id: string, workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Credential>;
|
|
674
|
+
upsert: (attributes: import("./namespaces/connectors").UpsertCredentialAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Credential>;
|
|
675
|
+
deleteByType: (workspaceId: string, connectorType: string, scopeLevel: string, options?: import("./base-client").RequestOptions) => Promise<{
|
|
676
|
+
deleted: boolean;
|
|
677
|
+
}>;
|
|
678
|
+
};
|
|
679
|
+
oauth: {
|
|
680
|
+
connect: (connectorType: string, workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").OAuthInitiateResult>;
|
|
681
|
+
callback: (connectorType: string, code: string, state: string, workspaceId: string, redirectUri?: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ConnectorInstance>;
|
|
682
|
+
};
|
|
683
|
+
available: {
|
|
684
|
+
list: () => string[];
|
|
685
|
+
};
|
|
686
|
+
sync: {
|
|
687
|
+
trigger: (connectorInstanceId: string, params: import("./namespaces/connectors").TriggerSyncParams, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").SyncTriggerResult>;
|
|
688
|
+
logs: (options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").SyncLog[]>;
|
|
689
|
+
log: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").SyncLog>;
|
|
690
|
+
};
|
|
691
|
+
edamam: {
|
|
692
|
+
recipes: {
|
|
693
|
+
search: (connectorInstanceId: string, workspaceId: string, params: import("./namespaces/connectors").EdamamSearchParams, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").EdamamSearchResult>;
|
|
694
|
+
get: (connectorInstanceId: string, workspaceId: string, recipeId: string, options?: import("./base-client").RequestOptions) => Promise<{
|
|
695
|
+
recipe: import("./namespaces/connectors").EdamamRecipe;
|
|
696
|
+
}>;
|
|
697
|
+
};
|
|
698
|
+
};
|
|
699
|
+
fullscript: {
|
|
700
|
+
checkPatient: (connectorId: string, workspaceId: string, email: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").FullscriptPatient | null>;
|
|
701
|
+
createPatient: (connectorId: string, workspaceId: string, attrs: {
|
|
702
|
+
first_name: string;
|
|
703
|
+
last_name: string;
|
|
704
|
+
email: string;
|
|
705
|
+
date_of_birth?: string;
|
|
706
|
+
}, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").FullscriptPatient>;
|
|
707
|
+
sessionGrant: (connectorId: string, workspaceId: string, patientId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").FullscriptSessionGrant>;
|
|
708
|
+
listTreatmentPlans: (connectorId: string, workspaceId: string, patientId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").FullscriptTreatmentPlan[]>;
|
|
709
|
+
getTreatmentPlan: (connectorId: string, workspaceId: string, treatmentPlanId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").FullscriptTreatmentPlan>;
|
|
710
|
+
cancelTreatmentPlan: (connectorId: string, workspaceId: string, treatmentPlanId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").FullscriptTreatmentPlan>;
|
|
711
|
+
createTreatmentPlan: (connectorId: string, workspaceId: string, attrs: import("./namespaces/connectors").CreateTreatmentPlanAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").FullscriptTreatmentPlan>;
|
|
712
|
+
matchProducts: (connectorId: string, workspaceId: string, queries: import("./namespaces/connectors").ProductMatchQuery[], options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").ProductMatchResult[]>;
|
|
713
|
+
searchProducts: (connectorId: string, workspaceId: string, query: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").FullscriptProduct[]>;
|
|
714
|
+
getProduct: (connectorId: string, workspaceId: string, productId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").FullscriptProduct>;
|
|
715
|
+
listSimilarProducts: (connectorId: string, workspaceId: string, productId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").FullscriptProduct[]>;
|
|
716
|
+
listPatientOrders: (connectorId: string, workspaceId: string, patientId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").FullscriptOrder[]>;
|
|
717
|
+
getOrder: (connectorId: string, workspaceId: string, orderId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").FullscriptOrder>;
|
|
718
|
+
oauth: {
|
|
719
|
+
connect: (workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").OAuthInitiateResult>;
|
|
720
|
+
callback: (code: string, state: string, workspaceId: string, redirectUri?: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ConnectorInstance>;
|
|
721
|
+
};
|
|
722
|
+
};
|
|
723
|
+
practiceBetter: {
|
|
724
|
+
pushNote: (connectorInstanceId: string, params: import("./namespaces/connectors").PBPushNoteParams, options?: import("./base-client").RequestOptions) => Promise<Record<string, unknown>>;
|
|
725
|
+
};
|
|
726
|
+
healthie: {
|
|
727
|
+
listPatients: (connectorId: string, workspaceId: string, options?: import("./namespaces/connectors").HealthieListOptions & import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").HealthiePatient[]>;
|
|
728
|
+
syncPatients: (connectorId: string, workspaceId: string, requestOptions?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").HealthieSyncResult>;
|
|
729
|
+
listAppointments: (connectorId: string, workspaceId: string, options?: import("./namespaces/connectors").HealthieListOptions & import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").HealthieAppointment[]>;
|
|
730
|
+
syncAppointments: (connectorId: string, workspaceId: string, requestOptions?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").HealthieSyncResult>;
|
|
731
|
+
syncAll: (connectorId: string, workspaceId: string, requestOptions?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").HealthieSyncAllResult>;
|
|
732
|
+
getStatus: (connectorId: string, workspaceId: string, requestOptions?: import("./base-client").RequestOptions) => Promise<import("./namespaces/connectors").HealthieSyncStatus>;
|
|
733
|
+
};
|
|
734
|
+
};
|
|
735
|
+
/** Web crawling and content extraction */
|
|
736
|
+
readonly crawler: {
|
|
737
|
+
jobs: {
|
|
738
|
+
list: (options?: {
|
|
739
|
+
page?: number;
|
|
740
|
+
pageSize?: number;
|
|
741
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").CrawlerJob[]>;
|
|
742
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrawlerJob>;
|
|
743
|
+
create: (attributes: import("./namespaces/crawler").CreateCrawlerJobAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrawlerJob>;
|
|
744
|
+
cancel: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrawlerJob>;
|
|
745
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
746
|
+
};
|
|
747
|
+
schedules: {
|
|
748
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrawlerSchedule[]>;
|
|
749
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrawlerSchedule>;
|
|
750
|
+
create: (attributes: import("./namespaces/crawler").CreateCrawlerScheduleAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrawlerSchedule>;
|
|
751
|
+
update: (id: string, attributes: import("./namespaces/crawler").UpdateCrawlerScheduleAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrawlerSchedule>;
|
|
752
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
753
|
+
enable: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrawlerSchedule>;
|
|
754
|
+
disable: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrawlerSchedule>;
|
|
755
|
+
trigger: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrawlerSchedule>;
|
|
756
|
+
};
|
|
757
|
+
results: {
|
|
758
|
+
list: (options?: {
|
|
759
|
+
page?: number;
|
|
760
|
+
pageSize?: number;
|
|
761
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").CrawlerResult[]>;
|
|
762
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrawlerResult>;
|
|
763
|
+
};
|
|
764
|
+
};
|
|
765
|
+
/** Contacts, companies, deals, activities, pipelines, relationships, and custom entities */
|
|
766
|
+
readonly crm: {
|
|
767
|
+
contacts: {
|
|
768
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmContact>;
|
|
769
|
+
create: (attributes: import("./namespaces/crm").CreateCrmContactAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmContact>;
|
|
770
|
+
update: (id: string, attributes: import("./namespaces/crm").UpdateCrmContactAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmContact>;
|
|
771
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
772
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
773
|
+
name?: string;
|
|
774
|
+
status?: "lead" | "marketing_qualified" | "sales_qualified" | "opportunity" | "customer" | "evangelist" | "churned";
|
|
775
|
+
filters?: import("./namespaces/crm").AttributeFilter[];
|
|
776
|
+
tags?: string[];
|
|
777
|
+
page?: number;
|
|
778
|
+
pageSize?: number;
|
|
779
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").CrmContact[]>;
|
|
780
|
+
archive: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmContact>;
|
|
781
|
+
unarchive: (id: string, workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmContact>;
|
|
782
|
+
listArchived: (workspaceId: string, options?: {
|
|
783
|
+
page?: number;
|
|
784
|
+
pageSize?: number;
|
|
785
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").CrmContact[]>;
|
|
786
|
+
};
|
|
787
|
+
companies: {
|
|
788
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmCompany>;
|
|
789
|
+
create: (attributes: import("./namespaces/crm").CreateCrmCompanyAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmCompany>;
|
|
790
|
+
update: (id: string, attributes: import("./namespaces/crm").UpdateCrmCompanyAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmCompany>;
|
|
791
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
792
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
793
|
+
page?: number;
|
|
794
|
+
pageSize?: number;
|
|
795
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").CrmCompany[]>;
|
|
796
|
+
};
|
|
797
|
+
deals: {
|
|
798
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmDeal>;
|
|
799
|
+
create: (attributes: import("./namespaces/crm").CreateCrmDealAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmDeal>;
|
|
800
|
+
update: (id: string, attributes: import("./namespaces/crm").UpdateCrmDealAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmDeal>;
|
|
801
|
+
moveStage: (id: string, attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmDeal>;
|
|
802
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
803
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
804
|
+
page?: number;
|
|
805
|
+
pageSize?: number;
|
|
806
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").CrmDeal[]>;
|
|
807
|
+
};
|
|
808
|
+
activities: {
|
|
809
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmActivity>;
|
|
810
|
+
create: (attributes: import("./namespaces/crm").CreateCrmActivityAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmActivity>;
|
|
811
|
+
update: (id: string, attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmActivity>;
|
|
812
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
813
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
814
|
+
page?: number;
|
|
815
|
+
pageSize?: number;
|
|
816
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").CrmActivity[]>;
|
|
817
|
+
};
|
|
818
|
+
pipelines: {
|
|
819
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmPipeline>;
|
|
820
|
+
create: (attributes: import("./namespaces/crm").CreateCrmPipelineAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmPipeline>;
|
|
821
|
+
update: (id: string, attributes: import("./namespaces/crm").UpdateCrmPipelineAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmPipeline>;
|
|
822
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
823
|
+
listByWorkspace: (workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmPipeline[]>;
|
|
824
|
+
};
|
|
825
|
+
pipelineStages: {
|
|
826
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmPipelineStage>;
|
|
827
|
+
create: (attributes: import("./namespaces/crm").CreateCrmPipelineStageAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmPipelineStage>;
|
|
828
|
+
update: (id: string, attributes: import("./namespaces/crm").UpdateCrmPipelineStageAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmPipelineStage>;
|
|
829
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
830
|
+
listByPipeline: (pipelineId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmPipelineStage[]>;
|
|
831
|
+
};
|
|
832
|
+
relationshipTypes: {
|
|
833
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmRelationshipType>;
|
|
834
|
+
create: (attributes: import("./namespaces/crm").CreateCrmRelationshipTypeAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmRelationshipType>;
|
|
835
|
+
update: (id: string, attributes: import("./namespaces/crm").UpdateCrmRelationshipTypeAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmRelationshipType>;
|
|
836
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
837
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmRelationshipType[]>;
|
|
838
|
+
};
|
|
839
|
+
relationships: {
|
|
840
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmRelationship>;
|
|
841
|
+
create: (attributes: import("./namespaces/crm").CreateCrmRelationshipAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmRelationship>;
|
|
842
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
843
|
+
listByWorkspace: (workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmRelationship[]>;
|
|
844
|
+
};
|
|
845
|
+
customEntities: {
|
|
846
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmCustomEntity>;
|
|
847
|
+
create: (attributes: import("./namespaces/crm").CreateCrmCustomEntityAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmCustomEntity>;
|
|
848
|
+
update: (id: string, attributes: import("./namespaces/crm").UpdateCrmCustomEntityAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmCustomEntity>;
|
|
849
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
850
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
851
|
+
type?: string;
|
|
852
|
+
filters?: import("./namespaces/crm").AttributeFilter[];
|
|
853
|
+
page?: number;
|
|
854
|
+
pageSize?: number;
|
|
855
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").CrmCustomEntity[]>;
|
|
856
|
+
batchUpdate: (workspaceId: string, updates: Array<{
|
|
857
|
+
id: string;
|
|
858
|
+
attributes: import("./namespaces/crm").UpdateCrmCustomEntityAttributes;
|
|
859
|
+
}>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmCustomEntity[]>;
|
|
860
|
+
aggregate: (workspaceId: string, params: {
|
|
861
|
+
type?: string;
|
|
862
|
+
metrics: Array<import("./namespaces/crm").AggregateMetric | import("./namespaces/crm").AggregateFieldMetric>;
|
|
863
|
+
group_by?: string;
|
|
864
|
+
filters?: import("./namespaces/crm").AttributeFilter[];
|
|
865
|
+
}, options?: import("./base-client").RequestOptions) => Promise<Array<Record<string, unknown>>>;
|
|
866
|
+
versions: {
|
|
867
|
+
list: (entityId: string, options?: {
|
|
868
|
+
page?: number;
|
|
869
|
+
pageSize?: number;
|
|
870
|
+
} & import("./base-client").RequestOptions) => Promise<{
|
|
871
|
+
data: import("./namespaces/crm").CrmCustomEntityVersion[];
|
|
872
|
+
meta?: unknown;
|
|
873
|
+
}>;
|
|
874
|
+
get: (entityId: string, versionId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/crm").CrmCustomEntityVersion>;
|
|
875
|
+
restore: (entityId: string, versionId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").CrmCustomEntity>;
|
|
876
|
+
};
|
|
877
|
+
};
|
|
878
|
+
export: {
|
|
879
|
+
create: (workspaceId: string, params: import("./namespaces/crm").CrmExportCreateParams, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/crm").CrmDataExportJob>;
|
|
880
|
+
get: (jobId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/crm").CrmDataExportJob>;
|
|
881
|
+
list: (workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/crm").CrmDataExportJob[]>;
|
|
882
|
+
refreshUrl: (jobId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/crm").CrmDataExportJob>;
|
|
883
|
+
};
|
|
884
|
+
};
|
|
885
|
+
/** AI content generation — text, images, tone rewriting, hashtags, SEO */
|
|
886
|
+
readonly content: {
|
|
887
|
+
generateText: (attributes: {
|
|
888
|
+
prompt: string;
|
|
889
|
+
workspace_id: string;
|
|
890
|
+
brand_identity_id?: string;
|
|
891
|
+
task?: string;
|
|
892
|
+
}, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
893
|
+
generateImage: (attributes: {
|
|
894
|
+
prompt: string;
|
|
895
|
+
workspace_id: string;
|
|
896
|
+
style?: string;
|
|
897
|
+
}, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
898
|
+
editImage: (attributes: {
|
|
899
|
+
image_url: string;
|
|
900
|
+
instructions: string;
|
|
901
|
+
workspace_id: string;
|
|
902
|
+
}, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
903
|
+
rewriteTone: (attributes: {
|
|
904
|
+
text: string;
|
|
905
|
+
target_tone: string;
|
|
906
|
+
workspace_id: string;
|
|
907
|
+
max_length?: number;
|
|
908
|
+
}, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
909
|
+
shorten: (attributes: {
|
|
910
|
+
text: string;
|
|
911
|
+
max_chars: number;
|
|
912
|
+
workspace_id: string;
|
|
913
|
+
platform?: string;
|
|
914
|
+
}, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
915
|
+
refine: (attributes: {
|
|
916
|
+
text: string;
|
|
917
|
+
instructions: string;
|
|
918
|
+
workspace_id: string;
|
|
919
|
+
}, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
920
|
+
suggestTopics: (attributes: {
|
|
921
|
+
workspace_id: string;
|
|
922
|
+
industry?: string;
|
|
923
|
+
brand_identity_id?: string;
|
|
924
|
+
count?: number;
|
|
925
|
+
}, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
926
|
+
generateImagePrompt: (attributes: {
|
|
927
|
+
marketing_copy: string;
|
|
928
|
+
workspace_id: string;
|
|
929
|
+
style?: string;
|
|
930
|
+
}, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
931
|
+
generateHashtags: (attributes: {
|
|
932
|
+
text: string;
|
|
933
|
+
platform: string;
|
|
934
|
+
workspace_id: string;
|
|
935
|
+
industry?: string;
|
|
936
|
+
count?: number;
|
|
937
|
+
}, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
938
|
+
seoEnrich: (attributes: {
|
|
939
|
+
text: string;
|
|
940
|
+
target_keywords: string[];
|
|
941
|
+
workspace_id: string;
|
|
942
|
+
}, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
943
|
+
};
|
|
944
|
+
/** Email campaigns, recipients, AI generation, and sequences */
|
|
945
|
+
readonly campaigns: {
|
|
946
|
+
campaigns: {
|
|
947
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Campaign>;
|
|
948
|
+
create: (attributes: import("./namespaces/campaigns").CreateCampaignAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Campaign>;
|
|
949
|
+
update: (id: string, attributes: import("./namespaces/campaigns").UpdateCampaignAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Campaign>;
|
|
950
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
951
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
952
|
+
page?: number;
|
|
953
|
+
pageSize?: number;
|
|
954
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").Campaign[]>;
|
|
955
|
+
send: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Campaign>;
|
|
956
|
+
analyze: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/campaigns").CampaignAnalysisResult>;
|
|
957
|
+
optimizeSendTimes: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Campaign>;
|
|
958
|
+
createFollowup: (id: string, attributes: import("./namespaces/campaigns").CreateFollowupCampaignAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Campaign>;
|
|
959
|
+
importRecipients: (id: string, attributes: import("./namespaces/campaigns").ImportRecipientsAttributes, options?: import("./base-client").RequestOptions) => Promise<Record<string, unknown>>;
|
|
960
|
+
generateEmails: (id: string, workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<Record<string, unknown>>;
|
|
961
|
+
optimizeSubjects: (id: string, attributes: import("./namespaces/campaigns").OptimizeSubjectsAttributes, options?: import("./base-client").RequestOptions) => Promise<Record<string, unknown>>;
|
|
962
|
+
export: (id: string, attributes: import("./namespaces/campaigns").ExportCampaignAttributes, options?: import("./base-client").RequestOptions) => Promise<Record<string, unknown>>;
|
|
963
|
+
};
|
|
964
|
+
templates: {
|
|
965
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
966
|
+
page?: number;
|
|
967
|
+
pageSize?: number;
|
|
968
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingTemplate[]>;
|
|
969
|
+
compile: (mjml: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/email").MjmlCompileResult>;
|
|
970
|
+
preview: (templateId: string, variables: Record<string, string>, options?: import("./base-client").RequestOptions) => Promise<{
|
|
971
|
+
preview_html: string;
|
|
972
|
+
}>;
|
|
973
|
+
publish: (templateId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingTemplate>;
|
|
974
|
+
unpublish: (templateId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingTemplate>;
|
|
975
|
+
rollback: (templateId: string, versionNumber: number, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingTemplate>;
|
|
976
|
+
versions: (templateId: string, options?: import("./base-client").RequestOptions) => Promise<Omit<import("./namespaces/email").TemplateVersion, "body_html" | "body_mjml">[]>;
|
|
977
|
+
getVersion: (templateId: string, versionNumber: number, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/email").TemplateVersion>;
|
|
978
|
+
};
|
|
979
|
+
generatedEmails: {
|
|
980
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingGeneratedEmail>;
|
|
981
|
+
update: (id: string, attributes: import("./namespaces/campaigns").UpdateGeneratedEmailAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingGeneratedEmail>;
|
|
982
|
+
approve: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingGeneratedEmail>;
|
|
983
|
+
reject: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingGeneratedEmail>;
|
|
984
|
+
schedule: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingGeneratedEmail>;
|
|
985
|
+
listByCampaign: (campaignId: string, options?: {
|
|
986
|
+
page?: number;
|
|
987
|
+
pageSize?: number;
|
|
988
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingGeneratedEmail[]>;
|
|
989
|
+
};
|
|
990
|
+
senderProfiles: {
|
|
991
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingSenderProfile>;
|
|
992
|
+
update: (id: string, attributes: import("./namespaces/campaigns").UpdateSenderProfileAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingSenderProfile>;
|
|
993
|
+
validateDns: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingSenderProfile>;
|
|
994
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
995
|
+
};
|
|
996
|
+
sequences: {
|
|
997
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingSequence>;
|
|
998
|
+
create: (attributes: import("./namespaces/campaigns").CreateSequenceAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingSequence>;
|
|
999
|
+
update: (id: string, attributes: import("./namespaces/campaigns").UpdateSequenceAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingSequence>;
|
|
1000
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1001
|
+
activate: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingSequence>;
|
|
1002
|
+
pause: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingSequence>;
|
|
1003
|
+
complete: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingSequence>;
|
|
1004
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
1005
|
+
page?: number;
|
|
1006
|
+
pageSize?: number;
|
|
1007
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingSequence[]>;
|
|
1008
|
+
resume: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingSequence>;
|
|
1009
|
+
};
|
|
1010
|
+
recipients: {
|
|
1011
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<Record<string, unknown>>;
|
|
1012
|
+
listByCampaign: (campaignId: string, options?: {
|
|
1013
|
+
page?: number;
|
|
1014
|
+
pageSize?: number;
|
|
1015
|
+
} & import("./base-client").RequestOptions) => Promise<Record<string, unknown>[]>;
|
|
1016
|
+
};
|
|
1017
|
+
sequenceSteps: {
|
|
1018
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<Record<string, unknown>>;
|
|
1019
|
+
create: (attributes: import("./namespaces/campaigns").CreateSequenceStepAttributes, options?: import("./base-client").RequestOptions) => Promise<Record<string, unknown>>;
|
|
1020
|
+
listBySequence: (sequenceId: string, options?: {
|
|
1021
|
+
page?: number;
|
|
1022
|
+
pageSize?: number;
|
|
1023
|
+
} & import("./base-client").RequestOptions) => Promise<Record<string, unknown>[]>;
|
|
1024
|
+
};
|
|
1025
|
+
};
|
|
1026
|
+
/** Direct email composition, AI drafting, sender profiles, and tracking */
|
|
1027
|
+
readonly email: {
|
|
1028
|
+
outboundEmails: {
|
|
1029
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailOutboundEmail>;
|
|
1030
|
+
create: (attributes: import("./namespaces/email").CreateOutboundEmailAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailOutboundEmail>;
|
|
1031
|
+
composeWithAi: (attributes: import("./namespaces/email").ComposeWithAiAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailOutboundEmail>;
|
|
1032
|
+
update: (id: string, attributes: import("./namespaces/email").UpdateOutboundEmailAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailOutboundEmail>;
|
|
1033
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1034
|
+
send: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailOutboundEmail>;
|
|
1035
|
+
schedule: (id: string, attributes: {
|
|
1036
|
+
scheduled_for: string;
|
|
1037
|
+
}, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailOutboundEmail>;
|
|
1038
|
+
cancelSchedule: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailOutboundEmail>;
|
|
1039
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
1040
|
+
page?: number;
|
|
1041
|
+
pageSize?: number;
|
|
1042
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").EmailOutboundEmail[]>;
|
|
1043
|
+
listByContact: (workspaceId: string, contactRefId: string, options?: {
|
|
1044
|
+
page?: number;
|
|
1045
|
+
pageSize?: number;
|
|
1046
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").EmailOutboundEmail[]>;
|
|
1047
|
+
};
|
|
1048
|
+
senderProfiles: {
|
|
1049
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingSenderProfile>;
|
|
1050
|
+
create: (attributes: import("./namespaces/email").CreateEmailSenderProfileAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingSenderProfile>;
|
|
1051
|
+
update: (id: string, attributes: import("./namespaces/email").UpdateEmailSenderProfileAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingSenderProfile>;
|
|
1052
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1053
|
+
validateDns: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingSenderProfile>;
|
|
1054
|
+
setDefault: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingSenderProfile>;
|
|
1055
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
1056
|
+
page?: number;
|
|
1057
|
+
pageSize?: number;
|
|
1058
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").EmailMarketingSenderProfile[]>;
|
|
1059
|
+
};
|
|
1060
|
+
recipients: {
|
|
1061
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailRecipient>;
|
|
1062
|
+
create: (attributes: {
|
|
1063
|
+
outbound_email_id: string;
|
|
1064
|
+
email: string;
|
|
1065
|
+
name?: string;
|
|
1066
|
+
recipient_type?: "to" | "cc" | "bcc";
|
|
1067
|
+
}, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailRecipient>;
|
|
1068
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1069
|
+
listByEmail: (outboundEmailId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailRecipient[]>;
|
|
1070
|
+
};
|
|
1071
|
+
inclusions: {
|
|
1072
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailInclusion>;
|
|
1073
|
+
create: (attributes: {
|
|
1074
|
+
outbound_email_id: string;
|
|
1075
|
+
inclusion_type: "goal" | "metric" | "chart" | "resource" | "supplement" | "custom";
|
|
1076
|
+
ref_id?: string;
|
|
1077
|
+
title?: string;
|
|
1078
|
+
data?: Record<string, unknown>;
|
|
1079
|
+
position?: number;
|
|
1080
|
+
}, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailInclusion>;
|
|
1081
|
+
update: (id: string, attributes: {
|
|
1082
|
+
title?: string;
|
|
1083
|
+
rendered_html?: string;
|
|
1084
|
+
data?: Record<string, unknown>;
|
|
1085
|
+
position?: number;
|
|
1086
|
+
}, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailInclusion>;
|
|
1087
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1088
|
+
listByEmail: (outboundEmailId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailInclusion[]>;
|
|
1089
|
+
};
|
|
1090
|
+
trackingEvents: {
|
|
1091
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailTrackingEvent>;
|
|
1092
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
1093
|
+
page?: number;
|
|
1094
|
+
pageSize?: number;
|
|
1095
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").EmailTrackingEvent[]>;
|
|
1096
|
+
};
|
|
1097
|
+
unsubscribers: {
|
|
1098
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailUnsubscriber>;
|
|
1099
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
1100
|
+
page?: number;
|
|
1101
|
+
pageSize?: number;
|
|
1102
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").EmailUnsubscriber[]>;
|
|
1103
|
+
};
|
|
1104
|
+
sendLimits: {
|
|
1105
|
+
get: (workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/email").EmailSendLimit>;
|
|
1106
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
1107
|
+
page?: number;
|
|
1108
|
+
pageSize?: number;
|
|
1109
|
+
} & import("./base-client").RequestOptions) => Promise<import("./namespaces/email").EmailSendLimit[]>;
|
|
1110
|
+
};
|
|
1111
|
+
inbound: {
|
|
1112
|
+
addresses: {
|
|
1113
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailInboundAddress>;
|
|
1114
|
+
create: (attributes: {
|
|
1115
|
+
workspace_id: string;
|
|
1116
|
+
name: string;
|
|
1117
|
+
routing_target: "extraction" | "agent" | "invoices" | "crm";
|
|
1118
|
+
handler_config?: Record<string, unknown>;
|
|
1119
|
+
max_attachment_size_mb?: number;
|
|
1120
|
+
allowed_mime_types?: string[] | null;
|
|
1121
|
+
daily_receive_limit?: number;
|
|
1122
|
+
}, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailInboundAddress>;
|
|
1123
|
+
update: (id: string, attributes: import("./namespaces/email").UpdateInboundAddressAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailInboundAddress>;
|
|
1124
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1125
|
+
rotateToken: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailInboundAddress>;
|
|
1126
|
+
disable: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailInboundAddress>;
|
|
1127
|
+
enable: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailInboundAddress>;
|
|
1128
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
1129
|
+
page?: number;
|
|
1130
|
+
pageSize?: number;
|
|
1131
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").EmailInboundAddress[]>;
|
|
1132
|
+
};
|
|
1133
|
+
received: {
|
|
1134
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").EmailInboundEmail>;
|
|
1135
|
+
listByAddress: (addressId: string, options?: {
|
|
1136
|
+
page?: number;
|
|
1137
|
+
pageSize?: number;
|
|
1138
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").EmailInboundEmail[]>;
|
|
1139
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
1140
|
+
page?: number;
|
|
1141
|
+
pageSize?: number;
|
|
1142
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").EmailInboundEmail[]>;
|
|
1143
|
+
};
|
|
1144
|
+
};
|
|
1145
|
+
};
|
|
1146
|
+
/** Support tickets, tags, and SLA tracking */
|
|
1147
|
+
readonly support: {
|
|
1148
|
+
tickets: {
|
|
1149
|
+
list: (workspaceId: string, options?: {
|
|
1150
|
+
page?: number;
|
|
1151
|
+
pageSize?: number;
|
|
1152
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").SupportTicket[]>;
|
|
1153
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SupportTicket>;
|
|
1154
|
+
create: (attributes: import("./namespaces/support").CreateSupportTicketAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SupportTicket>;
|
|
1155
|
+
update: (id: string, attributes: import("./namespaces/support").UpdateSupportTicketAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SupportTicket>;
|
|
1156
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1157
|
+
assign: (id: string, attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SupportTicket>;
|
|
1158
|
+
resolve: (id: string, attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SupportTicket>;
|
|
1159
|
+
close: (id: string, attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SupportTicket>;
|
|
1160
|
+
reopen: (id: string, attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SupportTicket>;
|
|
1161
|
+
merge: (id: string, attributes: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SupportTicket>;
|
|
1162
|
+
addMessage: (ticketId: string, attributes: import("./namespaces/support").CreateTicketMessageAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SupportTicketMessage>;
|
|
1163
|
+
listMessages: (ticketId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SupportTicketMessage[]>;
|
|
1164
|
+
rate: (attributes: import("./namespaces/support").CreateTicketRatingAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SupportTicketRating>;
|
|
1165
|
+
};
|
|
1166
|
+
tags: {
|
|
1167
|
+
list: (workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SupportTag[]>;
|
|
1168
|
+
create: (attributes: import("./namespaces/support").CreateSupportTagAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SupportTag>;
|
|
1169
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1170
|
+
};
|
|
1171
|
+
};
|
|
1172
|
+
/** HTML→PDF generation and report delivery */
|
|
1173
|
+
readonly documents: {
|
|
1174
|
+
generatePdf: (params: import("./namespaces/documents").GeneratePdfParams, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/documents").GeneratePdfResponse>;
|
|
1175
|
+
emailReport: (params: import("./namespaces/documents").EmailReportParams, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/documents").EmailReportResponse>;
|
|
1176
|
+
};
|
|
1177
|
+
/** Document upload, processing, results, and exports */
|
|
1178
|
+
readonly extraction: {
|
|
1179
|
+
documents: {
|
|
1180
|
+
list: (options?: {
|
|
1181
|
+
page?: number;
|
|
1182
|
+
pageSize?: number;
|
|
1183
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionDocument[]>;
|
|
1184
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionDocument[]>;
|
|
1185
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionDocument>;
|
|
1186
|
+
view: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionDocument>;
|
|
1187
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1188
|
+
bulkDelete: (ids: string[], options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/extraction").BulkOperationResult>;
|
|
1189
|
+
reprocess: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionDocument>;
|
|
1190
|
+
bulkReprocess: (documentIds: string[], options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/extraction").BulkReprocessResult>;
|
|
1191
|
+
cancel: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionDocument>;
|
|
1192
|
+
status: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/extraction").DocumentStatusResponse>;
|
|
1193
|
+
beginUpload: (attrs: import("./namespaces/extraction").BeginUploadAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionDocument>;
|
|
1194
|
+
findOrBeginUpload: (attrs?: import("./namespaces/extraction").FindOrBeginUploadAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionDocument>;
|
|
1195
|
+
finishUpload: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionDocument>;
|
|
1196
|
+
stats: (options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/extraction").DocumentStatsResponse>;
|
|
1197
|
+
dismiss: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionDocument>;
|
|
1198
|
+
updateVerification: (id: string, attrs: import("./namespaces/extraction").UpdateVerificationAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionDocument>;
|
|
1199
|
+
dismissAllTrained: (workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/extraction").DismissAllTrainedResult>;
|
|
1200
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
1201
|
+
page?: number;
|
|
1202
|
+
pageSize?: number;
|
|
1203
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionDocument[]>;
|
|
1204
|
+
upload: (file: File | Blob, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionDocument>;
|
|
1205
|
+
presignedUpload: (attrs: import("./namespaces/extraction").ExtractionPresignedUploadAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/extraction").ExtractionPresignedUploadResponse>;
|
|
1206
|
+
};
|
|
1207
|
+
results: {
|
|
1208
|
+
list: (options?: {
|
|
1209
|
+
page?: number;
|
|
1210
|
+
pageSize?: number;
|
|
1211
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionResult[]>;
|
|
1212
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionResult[]>;
|
|
1213
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionResult>;
|
|
1214
|
+
update: (id: string, attributes: import("./namespaces/extraction").UpdateExtractionResultAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionResult>;
|
|
1215
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1216
|
+
byDocument: (documentId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionResult[]>;
|
|
1217
|
+
regenerate: (id: string, attrs: import("./namespaces/extraction").RegenerateResultAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionResult>;
|
|
1218
|
+
saveCorrections: (id: string, attrs: import("./namespaces/extraction").SaveCorrectionsAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionResult>;
|
|
1219
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
1220
|
+
page?: number;
|
|
1221
|
+
pageSize?: number;
|
|
1222
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionResult[]>;
|
|
1223
|
+
query: (resultId: string, params?: import("./namespaces/extraction").ExtractionRowQueryParams, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/extraction").ExtractionRowQueryResult>;
|
|
1224
|
+
};
|
|
1225
|
+
batches: {
|
|
1226
|
+
create: (attributes: import("./namespaces/extraction").CreateExtractionBatchAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionBatch>;
|
|
1227
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionBatch>;
|
|
1228
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1229
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
1230
|
+
page?: number;
|
|
1231
|
+
pageSize?: number;
|
|
1232
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionBatch[]>;
|
|
1233
|
+
};
|
|
1234
|
+
exports: {
|
|
1235
|
+
list: (workspaceId: string, options?: {
|
|
1236
|
+
page?: number;
|
|
1237
|
+
pageSize?: number;
|
|
1238
|
+
} & import("./base-client").RequestOptions) => Promise<import("./namespaces/extraction").ExtractionExportRecord[]>;
|
|
1239
|
+
create: (workspaceId: string, attrs: import("./namespaces/extraction").CreateExtractionExportAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/extraction").ExtractionExportRecord>;
|
|
1240
|
+
get: (workspaceId: string, id: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/extraction").ExtractionExportRecord>;
|
|
1241
|
+
};
|
|
1242
|
+
schemaDiscoveries: {
|
|
1243
|
+
create: (attrs: import("./namespaces/extraction").CreateSchemaDiscoveryAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/extraction").SchemaDiscoveryRecord>;
|
|
1244
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/extraction").SchemaDiscoveryRecord>;
|
|
1245
|
+
};
|
|
1246
|
+
fieldTemplates: {
|
|
1247
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/extraction").FieldTemplateRecord[]>;
|
|
1248
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/extraction").FieldTemplateRecord>;
|
|
1249
|
+
create: (attrs: import("./namespaces/extraction").CreateFieldTemplateAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/extraction").FieldTemplateRecord>;
|
|
1250
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1251
|
+
};
|
|
1252
|
+
fieldMappings: {
|
|
1253
|
+
get: (workspaceId: string, documentId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/extraction").FieldMappingRecord>;
|
|
1254
|
+
create: (workspaceId: string, documentId: string, attrs: import("./namespaces/extraction").CreateFieldMappingAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/extraction").FieldMappingRecord>;
|
|
1255
|
+
};
|
|
1256
|
+
extractionAgents: {
|
|
1257
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionAgent[]>;
|
|
1258
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").ExtractionAgent>;
|
|
1259
|
+
predict: (attributes: {
|
|
1260
|
+
name?: string;
|
|
1261
|
+
description?: string;
|
|
1262
|
+
file_content?: string;
|
|
1263
|
+
document_id?: string;
|
|
1264
|
+
[key: string]: unknown;
|
|
1265
|
+
}, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1266
|
+
};
|
|
1267
|
+
trainingAnalytics: {
|
|
1268
|
+
forWorkspace: (workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingAnalytics>;
|
|
1269
|
+
};
|
|
1270
|
+
};
|
|
1271
|
+
/** User authentication, profiles, and API key management */
|
|
1272
|
+
readonly identity: {
|
|
1273
|
+
login: (email: string, password: string, options?: import("./base-client").RequestOptions) => Promise<import(".").User>;
|
|
1274
|
+
refresh: (refreshToken: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/identity").RefreshResponse>;
|
|
1275
|
+
register: (email: string, password: string, passwordConfirmation: string, tenantName: string, attrs?: import("./namespaces/identity").RegisterExtraAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").User>;
|
|
1276
|
+
registerViaInvitation: (email: string, password: string, passwordConfirmation: string, invitationToken: string, attrs?: import("./namespaces/identity").RegisterExtraAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").User>;
|
|
1277
|
+
me: (options?: import("./base-client").RequestOptions) => Promise<import(".").User>;
|
|
1278
|
+
profile: (options?: import("./base-client").RequestOptions) => Promise<import(".").User>;
|
|
1279
|
+
list: (options?: {
|
|
1280
|
+
page?: number;
|
|
1281
|
+
pageSize?: number;
|
|
1282
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").User[]>;
|
|
1283
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import(".").User[]>;
|
|
1284
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").User>;
|
|
1285
|
+
create: (attributes: import("./namespaces/identity").CreateUserAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").User>;
|
|
1286
|
+
resendConfirmation: (email: string, options?: import("./base-client").RequestOptions) => Promise<import(".").User>;
|
|
1287
|
+
confirmEmail: (email: string, confirmationToken: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/identity").AuthResponse>;
|
|
1288
|
+
requestMagicLink: (email: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/identity").AuthResponse>;
|
|
1289
|
+
requestPasswordReset: (email: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/identity").AuthResponse>;
|
|
1290
|
+
signInWithMagicLink: (token: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/identity").AuthResponse>;
|
|
1291
|
+
resetPasswordWithToken: (token: string, password: string, passwordConfirmation: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/identity").AuthResponse>;
|
|
1292
|
+
changePassword: (currentPassword: string, password: string, passwordConfirmation: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/identity").AuthResponse>;
|
|
1293
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1294
|
+
myTenants: (options?: import("./base-client").RequestOptions) => Promise<import(".").Tenant[]>;
|
|
1295
|
+
myDashboard: (options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/identity").DashboardResponse>;
|
|
1296
|
+
myStats: (options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/identity").UserStatsResponse>;
|
|
1297
|
+
myActivity: (options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/identity").AuthResponse[]>;
|
|
1298
|
+
tokens: {
|
|
1299
|
+
create: (attributes: import("./namespaces/identity").CreateTokenAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Token>;
|
|
1300
|
+
};
|
|
1301
|
+
profiles: {
|
|
1302
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1303
|
+
list: (options?: {
|
|
1304
|
+
page?: number;
|
|
1305
|
+
pageSize?: number;
|
|
1306
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").UserProfile[]>;
|
|
1307
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import(".").UserProfile[]>;
|
|
1308
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").UserProfile>;
|
|
1309
|
+
create: (attributes: import("./namespaces/identity").CreateUserProfileAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").UserProfile>;
|
|
1310
|
+
update: (id: string, attributes: import("./namespaces/identity").UpdateUserProfileAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").UserProfile>;
|
|
1311
|
+
me: (options?: import("./base-client").RequestOptions) => Promise<import(".").UserProfile>;
|
|
1312
|
+
acceptTos: (id: string, tosVersion: string, privacyPolicyVersion?: string, options?: import("./base-client").RequestOptions) => Promise<import(".").UserProfile>;
|
|
1313
|
+
dismissWelcome: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").UserProfile>;
|
|
1314
|
+
dismissAnnouncement: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").UserProfile>;
|
|
1315
|
+
};
|
|
1316
|
+
oauth: {
|
|
1317
|
+
getAuthorizationUrl(provider: import("./namespaces/identity").OAuthProvider, options: import("./namespaces/identity").OAuthSignInOptions): string;
|
|
1318
|
+
signIn(provider: import("./namespaces/identity").OAuthProvider, options: import("./namespaces/identity").OAuthSignInOptions): void;
|
|
1319
|
+
};
|
|
1320
|
+
apiKeys: {
|
|
1321
|
+
list: (options?: {
|
|
1322
|
+
page?: number;
|
|
1323
|
+
pageSize?: number;
|
|
1324
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").ApiKey[]>;
|
|
1325
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import(".").ApiKey[]>;
|
|
1326
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1327
|
+
update: (id: string, attributes: import("./namespaces/identity").UpdateApiKeyAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").ApiKey>;
|
|
1328
|
+
create: (name: string, options?: import("./base-client").RequestOptions) => Promise<import(".").ApiKey>;
|
|
1329
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").ApiKey>;
|
|
1330
|
+
revoke: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").ApiKey>;
|
|
1331
|
+
rotate: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").ApiKey>;
|
|
1332
|
+
setBudget: (id: string, creditLimit: number | null, creditLimitPeriod: string | null, options?: import("./base-client").RequestOptions) => Promise<import(".").ApiKey>;
|
|
1333
|
+
usageStats: (options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/identity").ApiKeyUsageStat[]>;
|
|
1334
|
+
active: (options?: {
|
|
1335
|
+
page?: number;
|
|
1336
|
+
pageSize?: number;
|
|
1337
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").ApiKey[]>;
|
|
1338
|
+
resetBudgetPeriod: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").ApiKey>;
|
|
1339
|
+
};
|
|
1340
|
+
};
|
|
1341
|
+
/** Customer portal operations: auth, profile, forms, notifications, chat */
|
|
1342
|
+
readonly portal: {
|
|
1343
|
+
auth: {
|
|
1344
|
+
requestMagicLink: (email: string, tenantId: string, options?: import("./base-client").RequestOptions) => Promise<{
|
|
1345
|
+
message: string;
|
|
1346
|
+
}>;
|
|
1347
|
+
verifyMagicLink: (magicToken: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/portal").PortalAuthResponse>;
|
|
1348
|
+
verify: (token: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/portal").PortalAuthResponse>;
|
|
1349
|
+
login: (email: string, password: string, tenantId: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/portal").PortalAuthResponse>;
|
|
1350
|
+
refresh: (refreshToken: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/portal").PortalAuthResponse>;
|
|
1351
|
+
};
|
|
1352
|
+
profile: {
|
|
1353
|
+
get: (options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/portal").PortalProfile>;
|
|
1354
|
+
update: (params: {
|
|
1355
|
+
avatar_url?: string;
|
|
1356
|
+
locale?: string;
|
|
1357
|
+
timezone?: string;
|
|
1358
|
+
notification_preferences?: Record<string, unknown>;
|
|
1359
|
+
}, options?: import("./base-client").RequestOptions) => Promise<{
|
|
1360
|
+
id: string;
|
|
1361
|
+
status: string;
|
|
1362
|
+
}>;
|
|
1363
|
+
};
|
|
1364
|
+
forms: {
|
|
1365
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<{
|
|
1366
|
+
data: import("./namespaces/portal").PortalForm[];
|
|
1367
|
+
}>;
|
|
1368
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<{
|
|
1369
|
+
data: import("./namespaces/portal").PortalForm;
|
|
1370
|
+
}>;
|
|
1371
|
+
submit: (formId: string, data: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/portal").PortalFormSubmissionResult>;
|
|
1372
|
+
};
|
|
1373
|
+
notifications: {
|
|
1374
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<{
|
|
1375
|
+
data: import("./namespaces/portal").PortalNotification[];
|
|
1376
|
+
}>;
|
|
1377
|
+
markRead: (id: string, options?: import("./base-client").RequestOptions) => Promise<{
|
|
1378
|
+
id: string;
|
|
1379
|
+
read_at: string;
|
|
1380
|
+
}>;
|
|
1381
|
+
};
|
|
1382
|
+
changeRequests: {
|
|
1383
|
+
create: (fieldName: string, newValue: string, oldValue?: string, options?: import("./base-client").RequestOptions) => Promise<{
|
|
1384
|
+
data: import("./namespaces/portal").PortalChangeRequest;
|
|
1385
|
+
}>;
|
|
1386
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<{
|
|
1387
|
+
data: import("./namespaces/portal").PortalChangeRequest[];
|
|
1388
|
+
}>;
|
|
1389
|
+
};
|
|
1390
|
+
threads: {
|
|
1391
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<{
|
|
1392
|
+
data: import("./namespaces/portal").PortalThread[];
|
|
1393
|
+
}>;
|
|
1394
|
+
create: (title?: string, options?: import("./base-client").RequestOptions) => Promise<{
|
|
1395
|
+
data: import("./namespaces/portal").PortalThread;
|
|
1396
|
+
}>;
|
|
1397
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<{
|
|
1398
|
+
data: import("./namespaces/portal").PortalThread;
|
|
1399
|
+
}>;
|
|
1400
|
+
sendMessage: (threadId: string, message: string, options?: import("./base-client").RequestOptions) => Promise<{
|
|
1401
|
+
data: import("./namespaces/portal").PortalMessageResponse;
|
|
1402
|
+
}>;
|
|
1403
|
+
};
|
|
1404
|
+
};
|
|
1405
|
+
/** Workspaces, applications, tenants, and invitations */
|
|
1406
|
+
readonly platform: {
|
|
1407
|
+
workspaces: {
|
|
1408
|
+
list: (options?: {
|
|
1409
|
+
page?: number;
|
|
1410
|
+
pageSize?: number;
|
|
1411
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").Workspace[]>;
|
|
1412
|
+
mine: (options?: import("./base-client").RequestOptions) => Promise<import(".").Workspace[]>;
|
|
1413
|
+
shared: (options?: import("./base-client").RequestOptions) => Promise<import(".").Workspace[]>;
|
|
1414
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Workspace>;
|
|
1415
|
+
create: (name: string, slug?: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Workspace>;
|
|
1416
|
+
listExtractionExportsByWorkspace: (workspaceId: string, options?: {
|
|
1417
|
+
page?: number;
|
|
1418
|
+
pageSize?: number;
|
|
1419
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").Workspace[]>;
|
|
1420
|
+
listAllExtractionExportsByWorkspace: (workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Workspace[]>;
|
|
1421
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1422
|
+
update: (id: string, attributes: import("./namespaces/platform").UpdateWorkspaceAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").Workspace>;
|
|
1423
|
+
updateStorageSettings: (id: string, settings: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import(".").Workspace>;
|
|
1424
|
+
allocateCredits: (workspaceId: string, amount: number, options?: import("./base-client").RequestOptions) => Promise<import(".").Workspace>;
|
|
1425
|
+
populateHashes: (workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Workspace>;
|
|
1426
|
+
};
|
|
1427
|
+
applications: {
|
|
1428
|
+
list: (options?: {
|
|
1429
|
+
page?: number;
|
|
1430
|
+
pageSize?: number;
|
|
1431
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").Application[]>;
|
|
1432
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1433
|
+
create: (attributes: import("./namespaces/platform").CreateApplicationAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Application>;
|
|
1434
|
+
update: (id: string, attributes: import("./namespaces/platform").UpdateApplicationAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Application>;
|
|
1435
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Application>;
|
|
1436
|
+
readCurrent: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Application>;
|
|
1437
|
+
getBySlug: (slug: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Application>;
|
|
1438
|
+
};
|
|
1439
|
+
tenants: {
|
|
1440
|
+
list: (options?: {
|
|
1441
|
+
page?: number;
|
|
1442
|
+
pageSize?: number;
|
|
1443
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").Tenant[]>;
|
|
1444
|
+
listDocumentStats: (tenantId: string, options?: {
|
|
1445
|
+
page?: number;
|
|
1446
|
+
pageSize?: number;
|
|
1447
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").Tenant[]>;
|
|
1448
|
+
listAllDocumentStats: (tenantId: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Tenant[]>;
|
|
1449
|
+
credit: (id: string, amount: number, description?: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Tenant>;
|
|
1450
|
+
deactivate: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Tenant>;
|
|
1451
|
+
reactivate: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Tenant>;
|
|
1452
|
+
create: (attributes: import("./namespaces/platform").CreateTenantAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").Tenant>;
|
|
1453
|
+
update: (id: string, attributes: import("./namespaces/platform").UpdateTenantAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").Tenant>;
|
|
1454
|
+
schedulePurge: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Tenant>;
|
|
1455
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Tenant>;
|
|
1456
|
+
transferOwnership: (tenantId: string, newOwnerId: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Tenant>;
|
|
1457
|
+
convertToOrg: (tenantId: string, attributes: {
|
|
1458
|
+
name: string;
|
|
1459
|
+
slug?: string;
|
|
1460
|
+
application_id?: string;
|
|
1461
|
+
}, options?: import("./base-client").RequestOptions) => Promise<import(".").Tenant>;
|
|
1462
|
+
createOrg: (attributes: {
|
|
1463
|
+
name: string;
|
|
1464
|
+
logo_url?: string;
|
|
1465
|
+
[key: string]: unknown;
|
|
1466
|
+
}, options?: import("./base-client").RequestOptions) => Promise<import(".").Tenant>;
|
|
1467
|
+
createPersonal: (options?: import("./base-client").RequestOptions) => Promise<import(".").Tenant>;
|
|
1468
|
+
};
|
|
1469
|
+
invitations: {
|
|
1470
|
+
accept: (id: string, token: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Invitation>;
|
|
1471
|
+
decline: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Invitation>;
|
|
1472
|
+
revoke: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Invitation>;
|
|
1473
|
+
listMe: (options?: {
|
|
1474
|
+
page?: number;
|
|
1475
|
+
pageSize?: number;
|
|
1476
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").Invitation[]>;
|
|
1477
|
+
listAllMe: (options?: import("./base-client").RequestOptions) => Promise<import(".").Invitation[]>;
|
|
1478
|
+
create: (attributes: import("./namespaces/platform").CreateInvitationAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").Invitation>;
|
|
1479
|
+
resend: (id: string, applicationId?: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Invitation>;
|
|
1480
|
+
list: (options?: {
|
|
1481
|
+
page?: number;
|
|
1482
|
+
pageSize?: number;
|
|
1483
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").Invitation[]>;
|
|
1484
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import(".").Invitation[]>;
|
|
1485
|
+
consumeByToken: (token: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Invitation | null>;
|
|
1486
|
+
acceptByToken: (token: string, options?: import("./base-client").RequestOptions) => Promise<import(".").Invitation>;
|
|
1487
|
+
};
|
|
1488
|
+
roles: {
|
|
1489
|
+
list: () => Promise<{
|
|
1490
|
+
data?: Array<import("./_internal/types.gen").Role>;
|
|
1491
|
+
}>;
|
|
1492
|
+
create: (name: string, permissions: string[]) => Promise<{
|
|
1493
|
+
data?: import("./_internal/types.gen").Role;
|
|
1494
|
+
}>;
|
|
1495
|
+
update: (id: string, attributes: Partial<{
|
|
1496
|
+
name: string;
|
|
1497
|
+
permissions: string[];
|
|
1498
|
+
}>) => Promise<{
|
|
1499
|
+
data?: import("./_internal/types.gen").Role;
|
|
1500
|
+
}>;
|
|
1501
|
+
destroy: (id: string) => Promise<void>;
|
|
1502
|
+
};
|
|
1503
|
+
permissions: {
|
|
1504
|
+
list: (params?: Record<string, string>) => Promise<{
|
|
1505
|
+
data?: Array<import("./_internal/types.gen").Permission>;
|
|
1506
|
+
}>;
|
|
1507
|
+
get: (id: string) => Promise<{
|
|
1508
|
+
data?: import("./_internal/types.gen").Permission;
|
|
1509
|
+
}>;
|
|
1510
|
+
meta: () => Promise<unknown>;
|
|
1511
|
+
presets: {
|
|
1512
|
+
list: (params?: Record<string, string>) => Promise<{
|
|
1513
|
+
data?: Array<import("./_internal/types.gen").PermissionPreset>;
|
|
1514
|
+
}>;
|
|
1515
|
+
get: (id: string) => Promise<{
|
|
1516
|
+
data?: import("./_internal/types.gen").PermissionPreset;
|
|
1517
|
+
}>;
|
|
1518
|
+
};
|
|
1519
|
+
};
|
|
1520
|
+
brandIdentities: {
|
|
1521
|
+
list: (options?: {
|
|
1522
|
+
page?: number;
|
|
1523
|
+
pageSize?: number;
|
|
1524
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").BrandIdentity[]>;
|
|
1525
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BrandIdentity>;
|
|
1526
|
+
create: (attributes: import("./namespaces/platform").CreateBrandIdentityAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BrandIdentity>;
|
|
1527
|
+
update: (id: string, attributes: import("./namespaces/platform").UpdateBrandIdentityAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BrandIdentity>;
|
|
1528
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1529
|
+
listByTenant: (tenantId: string, options?: {
|
|
1530
|
+
page?: number;
|
|
1531
|
+
pageSize?: number;
|
|
1532
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").BrandIdentity[]>;
|
|
1533
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
1534
|
+
page?: number;
|
|
1535
|
+
pageSize?: number;
|
|
1536
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").BrandIdentity[]>;
|
|
1537
|
+
getDefaultForTenant: (tenantId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BrandIdentity>;
|
|
1538
|
+
getDefaultForWorkspace: (workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BrandIdentity>;
|
|
1539
|
+
setDefault: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BrandIdentity>;
|
|
1540
|
+
unsetDefault: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").BrandIdentity>;
|
|
1541
|
+
};
|
|
1542
|
+
platformTones: {
|
|
1543
|
+
list: (options?: {
|
|
1544
|
+
page?: number;
|
|
1545
|
+
pageSize?: number;
|
|
1546
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").PlatformTone[]>;
|
|
1547
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").PlatformTone>;
|
|
1548
|
+
create: (attributes: import("./namespaces/platform").CreatePlatformToneAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").PlatformTone>;
|
|
1549
|
+
update: (id: string, attributes: import("./namespaces/platform").UpdatePlatformToneAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").PlatformTone>;
|
|
1550
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1551
|
+
listByBrand: (brandIdentityId: string, options?: {
|
|
1552
|
+
page?: number;
|
|
1553
|
+
pageSize?: number;
|
|
1554
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").PlatformTone[]>;
|
|
1555
|
+
};
|
|
1556
|
+
};
|
|
1557
|
+
/** Event types, scheduled events, bookings, participants, and calendar sync */
|
|
1558
|
+
readonly scheduling: {
|
|
1559
|
+
eventTypes: {
|
|
1560
|
+
list: (options?: {
|
|
1561
|
+
page?: number;
|
|
1562
|
+
pageSize?: number;
|
|
1563
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingEventType[]>;
|
|
1564
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingEventType[]>;
|
|
1565
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingEventType>;
|
|
1566
|
+
create: (attributes: import("./namespaces/scheduling").CreateSchedulingEventTypeAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingEventType>;
|
|
1567
|
+
update: (id: string, attributes: import("./namespaces/scheduling").UpdateSchedulingEventTypeAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingEventType>;
|
|
1568
|
+
archive: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingEventType>;
|
|
1569
|
+
getBySlug: (slug: string, workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingEventType>;
|
|
1570
|
+
};
|
|
1571
|
+
events: {
|
|
1572
|
+
list: (workspaceId: string, options?: {
|
|
1573
|
+
page?: number;
|
|
1574
|
+
pageSize?: number;
|
|
1575
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingEvent[]>;
|
|
1576
|
+
listAll: (workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingEvent[]>;
|
|
1577
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingEvent>;
|
|
1578
|
+
create: (attributes: import("./namespaces/scheduling").CreateSchedulingEventAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingEvent>;
|
|
1579
|
+
update: (id: string, attributes: import("./namespaces/scheduling").UpdateSchedulingEventAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingEvent>;
|
|
1580
|
+
cancel: (id: string, attributes?: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingEvent>;
|
|
1581
|
+
complete: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingEvent>;
|
|
1582
|
+
reschedule: (id: string, attributes: {
|
|
1583
|
+
new_start_time: string;
|
|
1584
|
+
new_end_time: string;
|
|
1585
|
+
}, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingEvent>;
|
|
1586
|
+
listByDateRange: (workspaceId: string, startTime: string, endTime: string, options?: {
|
|
1587
|
+
page?: number;
|
|
1588
|
+
pageSize?: number;
|
|
1589
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingEvent[]>;
|
|
1590
|
+
listByParticipant: (email: string, workspaceId: string, options?: {
|
|
1591
|
+
page?: number;
|
|
1592
|
+
pageSize?: number;
|
|
1593
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingEvent[]>;
|
|
1594
|
+
};
|
|
1595
|
+
participants: {
|
|
1596
|
+
list: (options?: {
|
|
1597
|
+
page?: number;
|
|
1598
|
+
pageSize?: number;
|
|
1599
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingParticipant[]>;
|
|
1600
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingParticipant[]>;
|
|
1601
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingParticipant>;
|
|
1602
|
+
create: (attributes: import("./namespaces/scheduling").CreateSchedulingParticipantAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingParticipant>;
|
|
1603
|
+
update: (id: string, attributes: import("./namespaces/scheduling").UpdateSchedulingParticipantAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingParticipant>;
|
|
1604
|
+
respond: (id: string, status: "accepted" | "declined" | "tentative", options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingParticipant>;
|
|
1605
|
+
remove: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1606
|
+
};
|
|
1607
|
+
bookings: {
|
|
1608
|
+
list: (options?: {
|
|
1609
|
+
page?: number;
|
|
1610
|
+
pageSize?: number;
|
|
1611
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingBooking[]>;
|
|
1612
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingBooking[]>;
|
|
1613
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingBooking>;
|
|
1614
|
+
create: (attributes: import("./namespaces/scheduling").CreateSchedulingBookingAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingBooking>;
|
|
1615
|
+
confirm: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingBooking>;
|
|
1616
|
+
cancel: (id: string, attributes?: import("./namespaces/scheduling").CancelSchedulingBookingAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingBooking>;
|
|
1617
|
+
reschedule: (id: string, attributes: import("./namespaces/scheduling").RescheduleSchedulingBookingAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingBooking>;
|
|
1618
|
+
markNoShow: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingBooking>;
|
|
1619
|
+
listByBooker: (email: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingBooking[]>;
|
|
1620
|
+
};
|
|
1621
|
+
calendarSyncs: {
|
|
1622
|
+
list: (options?: {
|
|
1623
|
+
page?: number;
|
|
1624
|
+
pageSize?: number;
|
|
1625
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingCalendarSync[]>;
|
|
1626
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingCalendarSync[]>;
|
|
1627
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingCalendarSync>;
|
|
1628
|
+
create: (attributes: import("./namespaces/scheduling").CreateSchedulingCalendarSyncAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingCalendarSync>;
|
|
1629
|
+
update: (id: string, attributes: import("./namespaces/scheduling").UpdateSchedulingCalendarSyncAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingCalendarSync>;
|
|
1630
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1631
|
+
pause: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingCalendarSync>;
|
|
1632
|
+
resume: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SchedulingCalendarSync>;
|
|
1633
|
+
};
|
|
1634
|
+
sessionNotes: {
|
|
1635
|
+
get: (eventId: string, noteType: import("./namespaces/session-notes").SessionNoteType, workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").DataStoreRecord | null>;
|
|
1636
|
+
upsert: (eventId: string, noteType: import("./namespaces/session-notes").SessionNoteType, workspaceId: string, value: import("./namespaces/session-notes").SessionNoteValue, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").DataStoreRecord>;
|
|
1637
|
+
};
|
|
1638
|
+
};
|
|
1639
|
+
/** Full-text, semantic, and saved search operations */
|
|
1640
|
+
readonly search: {
|
|
1641
|
+
query: (query: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/search").SearchResponse>;
|
|
1642
|
+
semantic: (query: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/search").SearchResponse>;
|
|
1643
|
+
suggest: (query: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/search").SuggestResponse>;
|
|
1644
|
+
indexes: (options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/search").IndexesResponse>;
|
|
1645
|
+
saved: {
|
|
1646
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SavedSearch[]>;
|
|
1647
|
+
create: (attributes: import("./namespaces/search").CreateSavedSearchAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").SavedSearch>;
|
|
1648
|
+
run: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/search").SearchResponse>;
|
|
1649
|
+
};
|
|
1650
|
+
};
|
|
1651
|
+
/** Bucket and object management, presigned URLs */
|
|
1652
|
+
readonly storage: {
|
|
1653
|
+
signUpload: (attributes?: import("./namespaces/storage").PresignedUploadAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/storage").PresignedUploadResponse>;
|
|
1654
|
+
buckets: {
|
|
1655
|
+
list: (options?: {
|
|
1656
|
+
page?: number;
|
|
1657
|
+
pageSize?: number;
|
|
1658
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").Bucket[]>;
|
|
1659
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Bucket[]>;
|
|
1660
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1661
|
+
create: (attributes: import("./namespaces/storage").CreateBucketAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Bucket>;
|
|
1662
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Bucket>;
|
|
1663
|
+
update: (id: string, attributes: import("./namespaces/storage").UpdateBucketAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").Bucket>;
|
|
1664
|
+
};
|
|
1665
|
+
files: {
|
|
1666
|
+
list: (options?: {
|
|
1667
|
+
page?: number;
|
|
1668
|
+
pageSize?: number;
|
|
1669
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").StorageFile[]>;
|
|
1670
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").StorageFile>;
|
|
1671
|
+
archive: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").StorageFile>;
|
|
1672
|
+
restore: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").StorageFile>;
|
|
1673
|
+
confirmUpload: (id: string, attributes?: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").StorageFile>;
|
|
1674
|
+
softDelete: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").StorageFile>;
|
|
1675
|
+
tag: (id: string, tags: string[], options?: import("./base-client").RequestOptions) => Promise<import("./_internal").StorageFile>;
|
|
1676
|
+
updateMetadata: (id: string, newMetadata: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").StorageFile>;
|
|
1677
|
+
byChecksum: (checksum: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").StorageFile[]>;
|
|
1678
|
+
listChildren: (parentId: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").StorageFile[]>;
|
|
1679
|
+
requestDownloadUrl: (id: string, params?: import("./namespaces/storage").RequestDownloadUrlParams, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/storage").DownloadUrlResponse>;
|
|
1680
|
+
};
|
|
1681
|
+
};
|
|
1682
|
+
/** Conversation threads, messaging, and thread management */
|
|
1683
|
+
readonly threads: {
|
|
1684
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1685
|
+
list: (options?: {
|
|
1686
|
+
page?: number;
|
|
1687
|
+
pageSize?: number;
|
|
1688
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").ChatThread[]>;
|
|
1689
|
+
listMine: (options?: {
|
|
1690
|
+
page?: number;
|
|
1691
|
+
pageSize?: number;
|
|
1692
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").ChatThread[]>;
|
|
1693
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import(".").ChatThread[]>;
|
|
1694
|
+
create: (attributes: import("./namespaces/threads").CreateThreadAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").ChatThread>;
|
|
1695
|
+
update: (id: string, attributes: import("./namespaces/threads").UpdateThreadAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").ChatThread>;
|
|
1696
|
+
updateMetadata: (id: string, metadata: Record<string, unknown>, options?: import("./base-client").RequestOptions) => Promise<import(".").ChatThread>;
|
|
1697
|
+
summarize: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").ChatThread>;
|
|
1698
|
+
fork: (id: string, title?: string, options?: import("./base-client").RequestOptions) => Promise<import(".").ChatThread>;
|
|
1699
|
+
export: (id: string, format?: "json" | "markdown" | "text", options?: import("./base-client").RequestOptions) => Promise<import(".").ChatThread>;
|
|
1700
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").ChatThread>;
|
|
1701
|
+
archive: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").ChatThread>;
|
|
1702
|
+
unarchive: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").ChatThread>;
|
|
1703
|
+
messages: {
|
|
1704
|
+
list: (threadId: string, options?: import("./base-client").RequestOptions) => Promise<import(".").ChatMessage[]>;
|
|
1705
|
+
send: (threadId: string, content: string, attributes?: import("./namespaces/threads").SendMessageAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").ChatMessage>;
|
|
1706
|
+
insert: (threadId: string, content: string, attributes: import("./namespaces/threads").InsertMessageAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").ChatMessage>;
|
|
1707
|
+
rate: (messageId: string, rating: "up" | "down", comment?: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/threads").MessageFeedback>;
|
|
1708
|
+
update: (messageId: string, attributes: import("./namespaces/threads").UpdateMessageAttributes, options?: import("./base-client").RequestOptions) => Promise<import(".").ChatMessage>;
|
|
1709
|
+
stream: (threadId: string, body: Record<string, unknown>, options?: import("./base-client").RequestOptions, streamOptions?: import("./streaming").StreamOptions) => Promise<AsyncIterableIterator<import("./streaming").StreamMessageChunk>>;
|
|
1710
|
+
search: (query: string, threadId?: string, options?: import("./base-client").RequestOptions) => Promise<import(".").ChatMessage[]>;
|
|
1711
|
+
semanticSearch: (query: string, limit?: number, threadId?: string, options?: import("./base-client").RequestOptions) => Promise<import(".").ChatMessage[]>;
|
|
1712
|
+
};
|
|
1713
|
+
complete: (threadId: string, options?: import("./base-client").RequestOptions) => Promise<import(".").ChatThread>;
|
|
1714
|
+
completeStream: (threadId: string, options?: import("./base-client").RequestOptions, streamOptions?: import("./streaming").StreamOptions) => Promise<AsyncIterableIterator<import("./streaming").StreamMessageChunk>>;
|
|
1715
|
+
search: (query: string, options?: import("./base-client").RequestOptions) => Promise<import(".").ChatThread[]>;
|
|
1716
|
+
};
|
|
1717
|
+
/** Training examples and sessions */
|
|
1718
|
+
readonly training: {
|
|
1719
|
+
examples: {
|
|
1720
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1721
|
+
list: (options?: {
|
|
1722
|
+
page?: number;
|
|
1723
|
+
pageSize?: number;
|
|
1724
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingExample[]>;
|
|
1725
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingExample[]>;
|
|
1726
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingExample>;
|
|
1727
|
+
create: (attributes: import("./namespaces/training").CreateTrainingExampleAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingExample>;
|
|
1728
|
+
update: (id: string, attributes: import("./namespaces/training").UpdateTrainingExampleAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingExample>;
|
|
1729
|
+
bulkCreate: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingExample>;
|
|
1730
|
+
bulkDestroy: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingExample>;
|
|
1731
|
+
searchByVector: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingExample>;
|
|
1732
|
+
};
|
|
1733
|
+
sessions: {
|
|
1734
|
+
listAgentsSessions: (options?: {
|
|
1735
|
+
page?: number;
|
|
1736
|
+
pageSize?: number;
|
|
1737
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingSession[]>;
|
|
1738
|
+
listAllAgentsSessions: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingSession[]>;
|
|
1739
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingSession>;
|
|
1740
|
+
create: (attributes: import("./namespaces/training").CreateTrainingSessionAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingSession>;
|
|
1741
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1742
|
+
update: (agentId: string, attributes: import("./namespaces/training").UpdateTrainingSessionAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").TrainingSession>;
|
|
1743
|
+
};
|
|
1744
|
+
};
|
|
1745
|
+
/** Voice transcription, TTS, and real-time voice session management */
|
|
1746
|
+
readonly voice: {
|
|
1747
|
+
transcribe: (audio: File | Blob, params?: import("./namespaces/voice").VoiceTranscribeOptions, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/voice").VoiceTranscribeResult>;
|
|
1748
|
+
sessions: {
|
|
1749
|
+
list: (options?: {
|
|
1750
|
+
page?: number;
|
|
1751
|
+
pageSize?: number;
|
|
1752
|
+
status?: "active" | "ended" | "failed" | "timed_out";
|
|
1753
|
+
insertedAfter?: string;
|
|
1754
|
+
insertedBefore?: string;
|
|
1755
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").VoiceSession[]>;
|
|
1756
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").VoiceSession>;
|
|
1757
|
+
listMine: (options?: {
|
|
1758
|
+
page?: number;
|
|
1759
|
+
pageSize?: number;
|
|
1760
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").VoiceSession[]>;
|
|
1761
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
1762
|
+
page?: number;
|
|
1763
|
+
pageSize?: number;
|
|
1764
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").VoiceSession[]>;
|
|
1765
|
+
start: (params?: import("./namespaces/voice").VoiceStartOptions, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/voice").VoiceSessionStart>;
|
|
1766
|
+
stop: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").VoiceSession>;
|
|
1767
|
+
finalize: (id: string, params?: import("./namespaces/voice").VoiceFinalizeOptions, options?: import("./base-client").RequestOptions) => Promise<import(".").VoiceSession>;
|
|
1768
|
+
destroy: (id: string, options?: import("./base-client").RequestOptions) => Promise<void>;
|
|
1769
|
+
};
|
|
1770
|
+
recordings: {
|
|
1771
|
+
list: (options?: {
|
|
1772
|
+
page?: number;
|
|
1773
|
+
pageSize?: number;
|
|
1774
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").VoiceRecording[]>;
|
|
1775
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").VoiceRecording>;
|
|
1776
|
+
bySession: (sessionId: string, options?: import("./base-client").RequestOptions) => Promise<import(".").VoiceRecording[]>;
|
|
1777
|
+
};
|
|
1778
|
+
transcriptionResults: {
|
|
1779
|
+
list: (options?: {
|
|
1780
|
+
page?: number;
|
|
1781
|
+
pageSize?: number;
|
|
1782
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").VoiceTranscriptionResult[]>;
|
|
1783
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").VoiceTranscriptionResult>;
|
|
1784
|
+
bySession: (sessionId: string, options?: {
|
|
1785
|
+
page?: number;
|
|
1786
|
+
pageSize?: number;
|
|
1787
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").VoiceTranscriptionResult[]>;
|
|
1788
|
+
create: (attributes: {
|
|
1789
|
+
text: string;
|
|
1790
|
+
recording_id?: string;
|
|
1791
|
+
session_id?: string;
|
|
1792
|
+
document_id?: string;
|
|
1793
|
+
segments?: Array<{
|
|
1794
|
+
text: string;
|
|
1795
|
+
start: number;
|
|
1796
|
+
end: number;
|
|
1797
|
+
confidence?: number;
|
|
1798
|
+
}>;
|
|
1799
|
+
language_detected?: string;
|
|
1800
|
+
duration_seconds?: number;
|
|
1801
|
+
processing_seconds?: number;
|
|
1802
|
+
stt_engine?: string;
|
|
1803
|
+
stt_model?: string;
|
|
1804
|
+
metadata?: Record<string, unknown>;
|
|
1805
|
+
}, options?: import("./base-client").RequestOptions) => Promise<import(".").VoiceTranscriptionResult>;
|
|
1806
|
+
update: (id: string, attributes: {
|
|
1807
|
+
text?: string;
|
|
1808
|
+
segments?: Array<{
|
|
1809
|
+
text: string;
|
|
1810
|
+
start: number;
|
|
1811
|
+
end: number;
|
|
1812
|
+
confidence?: number;
|
|
1813
|
+
}>;
|
|
1814
|
+
metadata?: Record<string, unknown>;
|
|
1815
|
+
}, options?: import("./base-client").RequestOptions) => Promise<import(".").VoiceTranscriptionResult>;
|
|
1816
|
+
destroy: (id: string, options?: import("./base-client").RequestOptions) => Promise<void>;
|
|
1817
|
+
};
|
|
1818
|
+
transcriptionJobs: {
|
|
1819
|
+
create: (params?: import("./namespaces/voice").TranscriptionJobCreateOptions, options?: import("./base-client").RequestOptions) => Promise<import(".").TranscriptionJob>;
|
|
1820
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").TranscriptionJob>;
|
|
1821
|
+
listMine: (options?: {
|
|
1822
|
+
page?: number;
|
|
1823
|
+
pageSize?: number;
|
|
1824
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").TranscriptionJob[]>;
|
|
1825
|
+
list: (options?: {
|
|
1826
|
+
page?: number;
|
|
1827
|
+
pageSize?: number;
|
|
1828
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").TranscriptionJob[]>;
|
|
1829
|
+
listByWorkspace: (workspaceId: string, options?: {
|
|
1830
|
+
page?: number;
|
|
1831
|
+
pageSize?: number;
|
|
1832
|
+
} & import("./base-client").RequestOptions) => Promise<import(".").TranscriptionJob[]>;
|
|
1833
|
+
uploadChunk: (jobId: string, audio: File | Blob, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/voice").TranscriptionChunkResult>;
|
|
1834
|
+
finalize: (jobId: string, params?: import("./namespaces/voice").TranscriptionJobFinalizeOptions, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/voice").TranscriptionJobFinalizeResult>;
|
|
1835
|
+
destroy: (id: string, options?: import("./base-client").RequestOptions) => Promise<void>;
|
|
1836
|
+
};
|
|
1837
|
+
};
|
|
1838
|
+
/** File watcher claims and event management */
|
|
1839
|
+
readonly watcher: {
|
|
1840
|
+
claims: {
|
|
1841
|
+
list: (options?: {
|
|
1842
|
+
page?: number;
|
|
1843
|
+
pageSize?: number;
|
|
1844
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").WatcherClaim[]>;
|
|
1845
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").WatcherClaim[]>;
|
|
1846
|
+
claim: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").WatcherClaim>;
|
|
1847
|
+
create: (attributes: import("./namespaces/watcher").CreateWatcherClaimAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").WatcherClaim>;
|
|
1848
|
+
update: (id: string, attributes: import("./namespaces/watcher").UpdateWatcherClaimAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").WatcherClaim>;
|
|
1849
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1850
|
+
registerCompleted: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").WatcherClaim>;
|
|
1851
|
+
readStatus: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").WatcherClaim>;
|
|
1852
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").WatcherClaim>;
|
|
1853
|
+
};
|
|
1854
|
+
events: {
|
|
1855
|
+
create: (attributes: import("./namespaces/watcher").CreateWatcherEventAttributes, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").WatcherEvent>;
|
|
1856
|
+
list: (options?: {
|
|
1857
|
+
page?: number;
|
|
1858
|
+
pageSize?: number;
|
|
1859
|
+
} & import("./base-client").RequestOptions) => Promise<import("./_internal").WatcherEvent[]>;
|
|
1860
|
+
listAll: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").WatcherEvent[]>;
|
|
1861
|
+
delete: (options?: import("./base-client").RequestOptions) => Promise<true>;
|
|
1862
|
+
batchCreate: (options?: import("./base-client").RequestOptions) => Promise<import("./_internal").WatcherEvent>;
|
|
1863
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./_internal").WatcherEvent>;
|
|
1864
|
+
};
|
|
1865
|
+
};
|
|
1866
|
+
/** Social media accounts, posts, metrics, and AI campaigns */
|
|
1867
|
+
readonly social: {
|
|
1868
|
+
accounts: {
|
|
1869
|
+
listByWorkspace: (workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1870
|
+
listByPlatform: (platform: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1871
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1872
|
+
create: (attributes: import("./namespaces/social").SocialAccountCreateAttributes, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1873
|
+
update: (id: string, attributes: import("./namespaces/social").SocialAccountUpdateAttributes, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1874
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1875
|
+
enablePosting: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1876
|
+
disablePosting: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1877
|
+
deactivate: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1878
|
+
};
|
|
1879
|
+
posts: {
|
|
1880
|
+
create: (attributes: import("./namespaces/social").SocialPostCreateAttributes, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1881
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1882
|
+
update: (id: string, attributes: import("./namespaces/social").SocialPostUpdateAttributes, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1883
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1884
|
+
schedule: (id: string, scheduledAt: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1885
|
+
publishNow: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1886
|
+
cancel: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1887
|
+
retry: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1888
|
+
updateSeo: (id: string, attributes: {
|
|
1889
|
+
seo_score?: number;
|
|
1890
|
+
seo_analysis?: Record<string, unknown>;
|
|
1891
|
+
}, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1892
|
+
listScheduled: (options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1893
|
+
listByAccount: (socialAccountId: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1894
|
+
listByCampaign: (socialCampaignId: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1895
|
+
listByWorkspace: (workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1896
|
+
};
|
|
1897
|
+
metrics: {
|
|
1898
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1899
|
+
listByPost: (socialPostId: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1900
|
+
latestForPost: (socialPostId: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1901
|
+
byAccount: (socialAccountId: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1902
|
+
byCampaign: (socialCampaignId: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1903
|
+
};
|
|
1904
|
+
campaigns: {
|
|
1905
|
+
list: (options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1906
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1907
|
+
create: (workspaceId: string, attributes: import("./namespaces/social").SocialCampaignCreateAttributes, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1908
|
+
update: (id: string, attributes: import("./namespaces/social").SocialCampaignUpdateAttributes, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1909
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1910
|
+
schedule: (id: string, scheduledAt: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1911
|
+
cancel: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1912
|
+
generateMasterCopy: (id: string, workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1913
|
+
adaptForPlatforms: (id: string, workspaceId: string, socialAccountId: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1914
|
+
previewAdaptations: (id: string, workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1915
|
+
};
|
|
1916
|
+
trending: {
|
|
1917
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1918
|
+
listByWorkspace: (workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1919
|
+
create: (attributes: {
|
|
1920
|
+
workspace_id: string;
|
|
1921
|
+
enrichment_level?: "raw" | "scored" | "summarized" | "full";
|
|
1922
|
+
query?: string;
|
|
1923
|
+
source_breakdown?: Record<string, unknown>;
|
|
1924
|
+
item_count?: number;
|
|
1925
|
+
fetched_at?: string;
|
|
1926
|
+
}, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1927
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1928
|
+
listByDateRange: (from: string, to: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1929
|
+
items: {
|
|
1930
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1931
|
+
listBySnapshot: (snapshotId: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1932
|
+
};
|
|
1933
|
+
};
|
|
1934
|
+
watches: {
|
|
1935
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1936
|
+
listByWorkspace: (workspaceId: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1937
|
+
create: (attributes: {
|
|
1938
|
+
workspace_id: string;
|
|
1939
|
+
name: string;
|
|
1940
|
+
query: string;
|
|
1941
|
+
sources?: string[];
|
|
1942
|
+
conditions?: Record<string, unknown>;
|
|
1943
|
+
notification_config?: Record<string, unknown>;
|
|
1944
|
+
enabled?: boolean;
|
|
1945
|
+
}, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1946
|
+
update: (id: string, attributes: {
|
|
1947
|
+
name?: string;
|
|
1948
|
+
query?: string;
|
|
1949
|
+
sources?: string[];
|
|
1950
|
+
conditions?: Record<string, unknown>;
|
|
1951
|
+
notification_config?: Record<string, unknown>;
|
|
1952
|
+
enabled?: boolean;
|
|
1953
|
+
}, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1954
|
+
delete: (id: string, options?: import("./base-client").RequestOptions) => Promise<unknown>;
|
|
1955
|
+
};
|
|
1956
|
+
};
|
|
1957
|
+
/** Project, milestone, task, time entry, member, risk, and AI management */
|
|
1958
|
+
readonly projects: {
|
|
1959
|
+
list(params?: import("./namespaces/projects").ListProjectsParams, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").Project[]>;
|
|
1960
|
+
get(id: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").Project>;
|
|
1961
|
+
create(data: import("./namespaces/projects").CreateProjectInput, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").Project>;
|
|
1962
|
+
update(id: string, data: import("./namespaces/projects").UpdateProjectInput, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").Project>;
|
|
1963
|
+
archive(id: string, options?: import("./base-client").RequestOptions): Promise<void>;
|
|
1964
|
+
milestones: {
|
|
1965
|
+
list(projectId: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").Milestone[]>;
|
|
1966
|
+
create(projectId: string, data: import("./namespaces/projects").CreateMilestoneInput, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").Milestone>;
|
|
1967
|
+
};
|
|
1968
|
+
tasks: {
|
|
1969
|
+
list(projectId: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").Task[]>;
|
|
1970
|
+
create(data: import("./namespaces/projects").CreateTaskInput, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").Task>;
|
|
1971
|
+
suggestAssignee(taskId: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").AssigneeSuggestion[]>;
|
|
1972
|
+
};
|
|
1973
|
+
timeEntries: {
|
|
1974
|
+
list(projectId: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").TimeEntry[]>;
|
|
1975
|
+
create(data: import("./namespaces/projects").CreateTimeEntryInput, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").TimeEntry>;
|
|
1976
|
+
};
|
|
1977
|
+
members: {
|
|
1978
|
+
list(projectId: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").ProjectMember[]>;
|
|
1979
|
+
add(projectId: string, data: import("./namespaces/projects").AddMemberInput, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").ProjectMember>;
|
|
1980
|
+
remove(projectId: string, memberId: string, options?: import("./base-client").RequestOptions): Promise<void>;
|
|
1981
|
+
};
|
|
1982
|
+
risks: {
|
|
1983
|
+
list(projectId: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").ProjectRisk[]>;
|
|
1984
|
+
};
|
|
1985
|
+
activity: {
|
|
1986
|
+
list(projectId: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").ProjectActivity[]>;
|
|
1987
|
+
};
|
|
1988
|
+
updates: {
|
|
1989
|
+
list(projectId: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").ProjectUpdate[]>;
|
|
1990
|
+
};
|
|
1991
|
+
ai: {
|
|
1992
|
+
decompose(projectId: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").DecomposedPlan>;
|
|
1993
|
+
estimateCompletion(projectId: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").CompletionEstimate>;
|
|
1994
|
+
getSummary(projectId: string, options?: import("./base-client").RequestOptions): Promise<string>;
|
|
1995
|
+
};
|
|
1996
|
+
templates: {
|
|
1997
|
+
list(options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").ProjectTemplate[]>;
|
|
1998
|
+
};
|
|
1999
|
+
labels: {
|
|
2000
|
+
list(options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").TaskLabel[]>;
|
|
2001
|
+
create(data: import("./namespaces/projects").CreateLabelInput, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/projects").TaskLabel>;
|
|
2002
|
+
};
|
|
2003
|
+
tags: {
|
|
2004
|
+
list(options?: import("./base-client").RequestOptions): Promise<unknown[]>;
|
|
2005
|
+
};
|
|
2006
|
+
};
|
|
2007
|
+
/** Model catalog — available models with tier classification */
|
|
2008
|
+
readonly models: {
|
|
2009
|
+
list(options?: import("./namespaces/models").ListModelsOptions, reqOptions?: import("./base-client").RequestOptions): Promise<import("./namespaces/models").ModelInfo[]>;
|
|
2010
|
+
get(modelId: string, reqOptions?: import("./base-client").RequestOptions): Promise<import("./namespaces/models").ModelInfo>;
|
|
2011
|
+
};
|
|
2012
|
+
/** CRM cluster discovery — AI-labeled relationship clusters via community detection */
|
|
2013
|
+
readonly crmClusters: {
|
|
2014
|
+
discover(workspaceId: string): Promise<{
|
|
2015
|
+
data: import("./namespaces/crm-clusters").CrmCluster[];
|
|
2016
|
+
}>;
|
|
2017
|
+
};
|
|
2018
|
+
/** Pipeline execution polling and HITL checkpoint management */
|
|
2019
|
+
readonly pipelineExecutions: {
|
|
2020
|
+
get(id: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/pipeline-executions").PipelineExecution>;
|
|
2021
|
+
list(workspaceId: string, filters?: {
|
|
2022
|
+
status?: import("./namespaces/pipeline-executions").PipelineExecutionStatus;
|
|
2023
|
+
pipeline_id?: string;
|
|
2024
|
+
}, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/pipeline-executions").PipelineExecution[]>;
|
|
2025
|
+
listByPipeline(pipelineId: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/pipeline-executions").PipelineExecution[]>;
|
|
2026
|
+
approve(id: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/pipeline-executions").PipelineExecution>;
|
|
2027
|
+
reject(id: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/pipeline-executions").PipelineExecution>;
|
|
2028
|
+
updateCheckpoint(id: string, attributes: import("./namespaces/pipeline-executions").UpdateCheckpointAttributes, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/pipeline-executions").PipelineExecution>;
|
|
2029
|
+
addNote(id: string, note: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/pipeline-executions").PipelineExecution>;
|
|
2030
|
+
aiRefine(id: string, nodeId: string, instruction: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/pipeline-executions").PipelineExecution>;
|
|
2031
|
+
};
|
|
2032
|
+
/** Pipeline trigger — execute multi-node agent pipelines */
|
|
2033
|
+
readonly pipelines: {
|
|
2034
|
+
list(options?: import("./base-client").RequestOptions): Promise<import("./namespaces/pipelines").Pipeline[]>;
|
|
2035
|
+
get(id: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/pipelines").Pipeline>;
|
|
2036
|
+
getBySlug(slug: string, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/pipelines").Pipeline>;
|
|
2037
|
+
trigger(id: string, attributes: import("./namespaces/pipelines").TriggerPipelineAttributes, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/pipelines").PipelineTriggerResponse>;
|
|
2038
|
+
dryRun(id: string, attributes: import("./namespaces/pipelines").DryRunAttributes, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/pipelines").DryRunResponse>;
|
|
2039
|
+
};
|
|
2040
|
+
/** Access grants — workspace and tenant role assignments (ReBAC) */
|
|
2041
|
+
readonly accessGrants: {
|
|
2042
|
+
list(params?: Record<string, string>): Promise<import("./namespaces/access-grants").AccessGrantListResult>;
|
|
2043
|
+
get(id: string): Promise<import("./namespaces/access-grants").AccessGrantResult>;
|
|
2044
|
+
create(attrs: import("./_internal").PostAccessGrantsData["body"]): Promise<import("./namespaces/access-grants").AccessGrantResult>;
|
|
2045
|
+
update(id: string, attrs: import("./_internal").PatchAccessGrantsByIdData["body"]): Promise<import("./namespaces/access-grants").AccessGrantResult>;
|
|
2046
|
+
revoke(id: string): Promise<void>;
|
|
2047
|
+
};
|
|
2048
|
+
/** Roles — permission bundles for assignment via access grants */
|
|
2049
|
+
readonly roles: {
|
|
2050
|
+
list(params?: Record<string, string>): Promise<import("./namespaces/roles").RoleListResult>;
|
|
2051
|
+
get(id: string): Promise<import("./namespaces/roles").RoleResult>;
|
|
2052
|
+
create(attrs: import("./_internal").PostRolesData["body"]): Promise<import("./namespaces/roles").RoleResult>;
|
|
2053
|
+
update(id: string, attrs: import("./_internal").PatchRolesByIdData["body"]): Promise<import("./namespaces/roles").RoleResult>;
|
|
2054
|
+
delete(id: string): Promise<void>;
|
|
2055
|
+
};
|
|
2056
|
+
/** Permissions — platform permission registry, presets, and metadata */
|
|
2057
|
+
readonly permissions: {
|
|
2058
|
+
list(params?: Record<string, string>): Promise<import("./namespaces/permissions").PermissionListResult>;
|
|
2059
|
+
get(id: string): Promise<import("./namespaces/permissions").PermissionResult>;
|
|
2060
|
+
meta(): Promise<import("./namespaces/permissions").PermissionMetaResult>;
|
|
2061
|
+
listPresets(params?: Record<string, string>): Promise<import("./namespaces/permissions").PermissionPresetListResult>;
|
|
2062
|
+
getPreset(id: string): Promise<import("./namespaces/permissions").PermissionPresetResult>;
|
|
2063
|
+
};
|
|
2064
|
+
/** Structured document sections — section documents and document sections */
|
|
2065
|
+
readonly memory: {
|
|
2066
|
+
sectionDocuments: {
|
|
2067
|
+
list: (params?: {
|
|
2068
|
+
page?: number;
|
|
2069
|
+
pageSize?: number;
|
|
2070
|
+
}, options?: import("./base-client").RequestOptions) => Promise<import(".").SectionDocument[]>;
|
|
2071
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").SectionDocument>;
|
|
2072
|
+
};
|
|
2073
|
+
documentSections: {
|
|
2074
|
+
list: (params?: {
|
|
2075
|
+
page?: number;
|
|
2076
|
+
pageSize?: number;
|
|
2077
|
+
}, options?: import("./base-client").RequestOptions) => Promise<import(".").DocumentSection[]>;
|
|
2078
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import(".").DocumentSection>;
|
|
2079
|
+
};
|
|
2080
|
+
};
|
|
2081
|
+
/** Scoped channel tokens for WebSocket authentication */
|
|
2082
|
+
readonly channels: {
|
|
2083
|
+
authorize(request: import("./namespaces/channels").ChannelTokenRequest, options?: import("./base-client").RequestOptions): Promise<import("./namespaces/channels").ChannelTokenResponse>;
|
|
2084
|
+
createTokenManager(options: Omit<import("./namespaces/channels").SocketManagerOptions, "socketUrl">): Promise<import("./namespaces/channels").SocketManager>;
|
|
2085
|
+
};
|
|
2086
|
+
/** Unified import hub — CSV/JSON batch imports across Clinical, CRM, and Catalog */
|
|
2087
|
+
readonly imports: {
|
|
2088
|
+
listAdapters: (options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/imports").ImportAdapter[]>;
|
|
2089
|
+
batch: (params: {
|
|
2090
|
+
adapter: string;
|
|
2091
|
+
workspace_id: string;
|
|
2092
|
+
rows: Record<string, unknown>[];
|
|
2093
|
+
metadata?: Record<string, unknown>;
|
|
2094
|
+
}, options?: import("./base-client").RequestOptions) => Promise<{
|
|
2095
|
+
data: {
|
|
2096
|
+
import_id: string;
|
|
2097
|
+
status: string;
|
|
2098
|
+
};
|
|
2099
|
+
}>;
|
|
2100
|
+
upload: (file: File | Blob, params: {
|
|
2101
|
+
adapter: string;
|
|
2102
|
+
workspace_id: string;
|
|
2103
|
+
column_mapping? /** Wallet, plans, transactions, and payment methods */: Record<string, string>;
|
|
2104
|
+
metadata?: Record<string, unknown>;
|
|
2105
|
+
}, options?: import("./base-client").RequestOptions) => Promise<{
|
|
2106
|
+
data: {
|
|
2107
|
+
import_id: string;
|
|
2108
|
+
status: string;
|
|
2109
|
+
};
|
|
2110
|
+
}>;
|
|
2111
|
+
list: (params: {
|
|
2112
|
+
workspace_id: string;
|
|
2113
|
+
adapter?: string;
|
|
2114
|
+
status?: string;
|
|
2115
|
+
offset?: number;
|
|
2116
|
+
limit?: number;
|
|
2117
|
+
}, options?: import("./base-client").RequestOptions) => Promise<{
|
|
2118
|
+
data: import("./namespaces/imports").Import[];
|
|
2119
|
+
meta: {
|
|
2120
|
+
count: number;
|
|
2121
|
+
};
|
|
2122
|
+
}>;
|
|
2123
|
+
get: (id: string, options?: import("./base-client").RequestOptions) => Promise<import("./namespaces/imports").Import>;
|
|
2124
|
+
rows: (importId: string, params?: {
|
|
2125
|
+
offset?: number;
|
|
2126
|
+
limit?: number;
|
|
2127
|
+
}, options?: import("./base-client").RequestOptions) => Promise<{
|
|
2128
|
+
data: import("./namespaces/imports").ImportRow[];
|
|
2129
|
+
meta: {
|
|
2130
|
+
count: number;
|
|
2131
|
+
};
|
|
2132
|
+
}>;
|
|
2133
|
+
confirm: (id: string, params: {
|
|
2134
|
+
workspace_id: string;
|
|
2135
|
+
}, options?: import("./base-client").RequestOptions) => Promise<{
|
|
2136
|
+
data: {
|
|
2137
|
+
import_id: string;
|
|
2138
|
+
status: string;
|
|
2139
|
+
};
|
|
2140
|
+
}>;
|
|
2141
|
+
cancel: (id: string, params: {
|
|
2142
|
+
workspace_id: string;
|
|
2143
|
+
}, options?: import("./base-client").RequestOptions) => Promise<{
|
|
2144
|
+
data: {
|
|
2145
|
+
import_id: string;
|
|
2146
|
+
status: string;
|
|
2147
|
+
};
|
|
2148
|
+
}>;
|
|
2149
|
+
};
|
|
2150
|
+
constructor(config?: BaseClientConfig);
|
|
2151
|
+
/**
|
|
2152
|
+
* Subscribe to SDK lifecycle events.
|
|
2153
|
+
* Returns an unsubscribe function for cleanup.
|
|
2154
|
+
*
|
|
2155
|
+
* @example
|
|
2156
|
+
* ```typescript
|
|
2157
|
+
* const client = new GptClient({ apiKey: 'sk_...' });
|
|
2158
|
+
*
|
|
2159
|
+
* // Listen for all requests
|
|
2160
|
+
* const unsubscribe = client.on('request', (event) => {
|
|
2161
|
+
* console.log(`${event.method} ${event.url}`);
|
|
2162
|
+
* });
|
|
2163
|
+
*
|
|
2164
|
+
* // Listen for responses
|
|
2165
|
+
* client.on('response', (event) => {
|
|
2166
|
+
* console.log(`${event.status} in ${event.duration}ms`);
|
|
2167
|
+
* });
|
|
2168
|
+
*
|
|
2169
|
+
* // Clean up
|
|
2170
|
+
* unsubscribe();
|
|
2171
|
+
* ```
|
|
2172
|
+
*/
|
|
2173
|
+
on<K extends keyof SdkEvents>(event: K, handler: (event: SdkEvents[K]) => void): () => void;
|
|
2174
|
+
}
|
|
2175
|
+
//# sourceMappingURL=gpt-client.d.ts.map
|