@alvera-ai/platform-sdk 0.1.0
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/LICENSE +21 -0
- package/README.md +99 -0
- package/dist/client.d.ts +198 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +129 -0
- package/dist/client.js.map +1 -0
- package/dist/generated/client/client.gen.d.ts +3 -0
- package/dist/generated/client/client.gen.d.ts.map +1 -0
- package/dist/generated/client/client.gen.js +236 -0
- package/dist/generated/client/client.gen.js.map +1 -0
- package/dist/generated/client/index.d.ts +9 -0
- package/dist/generated/client/index.d.ts.map +1 -0
- package/dist/generated/client/index.js +7 -0
- package/dist/generated/client/index.js.map +1 -0
- package/dist/generated/client/types.gen.d.ts +118 -0
- package/dist/generated/client/types.gen.d.ts.map +1 -0
- package/dist/generated/client/types.gen.js +3 -0
- package/dist/generated/client/types.gen.js.map +1 -0
- package/dist/generated/client/utils.gen.d.ts +34 -0
- package/dist/generated/client/utils.gen.d.ts.map +1 -0
- package/dist/generated/client/utils.gen.js +229 -0
- package/dist/generated/client/utils.gen.js.map +1 -0
- package/dist/generated/client.gen.d.ts +13 -0
- package/dist/generated/client.gen.d.ts.map +1 -0
- package/dist/generated/client.gen.js +4 -0
- package/dist/generated/client.gen.js.map +1 -0
- package/dist/generated/core/auth.gen.d.ts +19 -0
- package/dist/generated/core/auth.gen.d.ts.map +1 -0
- package/dist/generated/core/auth.gen.js +15 -0
- package/dist/generated/core/auth.gen.js.map +1 -0
- package/dist/generated/core/bodySerializer.gen.d.ts +26 -0
- package/dist/generated/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/bodySerializer.gen.js +58 -0
- package/dist/generated/core/bodySerializer.gen.js.map +1 -0
- package/dist/generated/core/params.gen.d.ts +44 -0
- package/dist/generated/core/params.gen.d.ts.map +1 -0
- package/dist/generated/core/params.gen.js +101 -0
- package/dist/generated/core/params.gen.js.map +1 -0
- package/dist/generated/core/pathSerializer.gen.d.ts +34 -0
- package/dist/generated/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/pathSerializer.gen.js +107 -0
- package/dist/generated/core/pathSerializer.gen.js.map +1 -0
- package/dist/generated/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/generated/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/queryKeySerializer.gen.js +93 -0
- package/dist/generated/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/generated/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/generated/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/generated/core/serverSentEvents.gen.js +134 -0
- package/dist/generated/core/serverSentEvents.gen.js.map +1 -0
- package/dist/generated/core/types.gen.d.ts +79 -0
- package/dist/generated/core/types.gen.d.ts.map +1 -0
- package/dist/generated/core/types.gen.js +3 -0
- package/dist/generated/core/types.gen.js.map +1 -0
- package/dist/generated/core/utils.gen.d.ts +20 -0
- package/dist/generated/core/utils.gen.d.ts.map +1 -0
- package/dist/generated/core/utils.gen.js +88 -0
- package/dist/generated/core/utils.gen.js.map +1 -0
- package/dist/generated/index.d.ts +3 -0
- package/dist/generated/index.d.ts.map +1 -0
- package/dist/generated/index.js +3 -0
- package/dist/generated/index.js.map +1 -0
- package/dist/generated/sdk.gen.d.ts +263 -0
- package/dist/generated/sdk.gen.d.ts.map +1 -0
- package/dist/generated/sdk.gen.js +433 -0
- package/dist/generated/sdk.gen.js.map +1 -0
- package/dist/generated/types.gen.d.ts +3958 -0
- package/dist/generated/types.gen.d.ts.map +1 -0
- package/dist/generated/types.gen.js +3 -0
- package/dist/generated/types.gen.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -0
- package/package.json +60 -0
|
@@ -0,0 +1,3958 @@
|
|
|
1
|
+
export type ClientOptions = {
|
|
2
|
+
baseUrl: string;
|
|
3
|
+
};
|
|
4
|
+
/**
|
|
5
|
+
* DataSourceResponse
|
|
6
|
+
*
|
|
7
|
+
* Data source — connection to a third-party system or API
|
|
8
|
+
*/
|
|
9
|
+
export type DataSourceResponse = {
|
|
10
|
+
datalake?: DatalakeResponse;
|
|
11
|
+
/**
|
|
12
|
+
* Data source description
|
|
13
|
+
*/
|
|
14
|
+
description?: string | null;
|
|
15
|
+
/**
|
|
16
|
+
* Data Source ID
|
|
17
|
+
*/
|
|
18
|
+
id?: string;
|
|
19
|
+
/**
|
|
20
|
+
* Image URL
|
|
21
|
+
*/
|
|
22
|
+
image_url?: string | null;
|
|
23
|
+
/**
|
|
24
|
+
* Creation timestamp
|
|
25
|
+
*/
|
|
26
|
+
inserted_at?: string;
|
|
27
|
+
/**
|
|
28
|
+
* Whether this is the default data source
|
|
29
|
+
*/
|
|
30
|
+
is_default: boolean;
|
|
31
|
+
/**
|
|
32
|
+
* Data source name
|
|
33
|
+
*/
|
|
34
|
+
name: string;
|
|
35
|
+
/**
|
|
36
|
+
* Data source status
|
|
37
|
+
*/
|
|
38
|
+
status: 'draft' | 'active' | 'inactive';
|
|
39
|
+
/**
|
|
40
|
+
* Last update timestamp
|
|
41
|
+
*/
|
|
42
|
+
updated_at?: string;
|
|
43
|
+
/**
|
|
44
|
+
* Data source URI
|
|
45
|
+
*/
|
|
46
|
+
uri: string;
|
|
47
|
+
};
|
|
48
|
+
/**
|
|
49
|
+
* RESTAPIBody
|
|
50
|
+
*
|
|
51
|
+
* REST API tool configuration with multiple auth methods.
|
|
52
|
+
*/
|
|
53
|
+
export type RestapiBody = {
|
|
54
|
+
/**
|
|
55
|
+
* Polymorphic discriminator
|
|
56
|
+
*/
|
|
57
|
+
__type__: 'rest_api';
|
|
58
|
+
api_key_location?: 'header' | 'query';
|
|
59
|
+
api_key_name?: string;
|
|
60
|
+
auth_method: 'none' | 'api_key' | 'basic' | 'bearer' | 'oauth2' | 'oidc';
|
|
61
|
+
/**
|
|
62
|
+
* Base URL (https)
|
|
63
|
+
*/
|
|
64
|
+
base_url: string;
|
|
65
|
+
oauth2_client_id?: string;
|
|
66
|
+
oauth2_grant_type?: 'client_credentials' | 'authorization_code';
|
|
67
|
+
oauth2_scope?: string | null;
|
|
68
|
+
oauth2_token_ttl?: number;
|
|
69
|
+
oauth2_token_url?: string;
|
|
70
|
+
oidc_client_id?: string;
|
|
71
|
+
oidc_issuer_url?: string;
|
|
72
|
+
oidc_token_ttl?: number;
|
|
73
|
+
request_type: 'json' | 'xml' | 'form_urlencoded' | 'multipart_form';
|
|
74
|
+
response_type: 'json' | 'xml' | 'text' | 'binary';
|
|
75
|
+
timeout_ms?: number;
|
|
76
|
+
username?: string;
|
|
77
|
+
};
|
|
78
|
+
/**
|
|
79
|
+
* AiAgentListResponse
|
|
80
|
+
*
|
|
81
|
+
* Paginated list of AI agents
|
|
82
|
+
*/
|
|
83
|
+
export type AiAgentListResponse = {
|
|
84
|
+
/**
|
|
85
|
+
* List of AI agents
|
|
86
|
+
*/
|
|
87
|
+
data: Array<AiAgentResponse>;
|
|
88
|
+
meta: PaginationMeta;
|
|
89
|
+
};
|
|
90
|
+
/**
|
|
91
|
+
* ActionStatusUpdaterRequest
|
|
92
|
+
*
|
|
93
|
+
* Action Status Updater — automated polling for delivery status updates. Request
|
|
94
|
+
*/
|
|
95
|
+
export type ActionStatusUpdaterRequest = {
|
|
96
|
+
/**
|
|
97
|
+
* Cron schedule expression (e.g. "*30 * * * *")
|
|
98
|
+
*/
|
|
99
|
+
cron_expression?: string;
|
|
100
|
+
/**
|
|
101
|
+
* Datalake ID
|
|
102
|
+
*/
|
|
103
|
+
datalake_id?: string;
|
|
104
|
+
/**
|
|
105
|
+
* Updater name
|
|
106
|
+
*/
|
|
107
|
+
name?: string;
|
|
108
|
+
/**
|
|
109
|
+
* IDs of sender tools whose messages this updater monitors
|
|
110
|
+
*/
|
|
111
|
+
sender_tool_ids?: Array<string> | null;
|
|
112
|
+
/**
|
|
113
|
+
* Tool providing auth credentials for polling
|
|
114
|
+
*/
|
|
115
|
+
updater_tool_id?: string;
|
|
116
|
+
/**
|
|
117
|
+
* Updater type — determines the updater_body shape
|
|
118
|
+
*/
|
|
119
|
+
updater_type?: 'cloud_watch' | 'restapi';
|
|
120
|
+
};
|
|
121
|
+
/**
|
|
122
|
+
* AiAgentResponse
|
|
123
|
+
*
|
|
124
|
+
* AI Agent configuration — reusable chat-completion resource
|
|
125
|
+
*/
|
|
126
|
+
export type AiAgentResponse = {
|
|
127
|
+
/**
|
|
128
|
+
* Data access level
|
|
129
|
+
*/
|
|
130
|
+
data_access: 'regulated' | 'unregulated';
|
|
131
|
+
datalake?: DatalakeResponse;
|
|
132
|
+
/**
|
|
133
|
+
* Agent description
|
|
134
|
+
*/
|
|
135
|
+
description?: string | null;
|
|
136
|
+
/**
|
|
137
|
+
* Whether the agent is enabled
|
|
138
|
+
*/
|
|
139
|
+
enabled: boolean;
|
|
140
|
+
/**
|
|
141
|
+
* AI Agent ID
|
|
142
|
+
*/
|
|
143
|
+
id?: string;
|
|
144
|
+
/**
|
|
145
|
+
* Creation timestamp
|
|
146
|
+
*/
|
|
147
|
+
inserted_at?: string;
|
|
148
|
+
/**
|
|
149
|
+
* Maximum tokens for LLM response
|
|
150
|
+
*/
|
|
151
|
+
max_tokens: number;
|
|
152
|
+
/**
|
|
153
|
+
* LLM model identifier
|
|
154
|
+
*/
|
|
155
|
+
model: string;
|
|
156
|
+
/**
|
|
157
|
+
* Agent name
|
|
158
|
+
*/
|
|
159
|
+
name: string;
|
|
160
|
+
/**
|
|
161
|
+
* URL-friendly slug
|
|
162
|
+
*/
|
|
163
|
+
slug?: string;
|
|
164
|
+
/**
|
|
165
|
+
* Sampling temperature (0.0–2.0)
|
|
166
|
+
*/
|
|
167
|
+
temperature: number;
|
|
168
|
+
tenant?: TenantResponse;
|
|
169
|
+
tool?: ToolResponse;
|
|
170
|
+
/**
|
|
171
|
+
* Tool ID
|
|
172
|
+
*/
|
|
173
|
+
tool_id: string;
|
|
174
|
+
/**
|
|
175
|
+
* Last update timestamp
|
|
176
|
+
*/
|
|
177
|
+
updated_at?: string;
|
|
178
|
+
};
|
|
179
|
+
/**
|
|
180
|
+
* ManualUploadBody
|
|
181
|
+
*
|
|
182
|
+
* Manual upload tool — no configuration required.
|
|
183
|
+
*/
|
|
184
|
+
export type ManualUploadBody = {
|
|
185
|
+
/**
|
|
186
|
+
* Polymorphic discriminator
|
|
187
|
+
*/
|
|
188
|
+
__type__: 'manual_upload';
|
|
189
|
+
};
|
|
190
|
+
/**
|
|
191
|
+
* AWSLambdaBody
|
|
192
|
+
*
|
|
193
|
+
* AWS Lambda tool configuration (managed or external).
|
|
194
|
+
*/
|
|
195
|
+
export type AwsLambdaBody = {
|
|
196
|
+
/**
|
|
197
|
+
* Polymorphic discriminator
|
|
198
|
+
*/
|
|
199
|
+
__type__: 'aws_lambda';
|
|
200
|
+
access_key_id?: string;
|
|
201
|
+
auth_method?: 'access_key' | 'iam_role' | 'cloudformation';
|
|
202
|
+
readonly error?: string | null;
|
|
203
|
+
/**
|
|
204
|
+
* Lambda function ARN (external type)
|
|
205
|
+
*/
|
|
206
|
+
function_arn?: string;
|
|
207
|
+
/**
|
|
208
|
+
* SSM config key (managed type)
|
|
209
|
+
*/
|
|
210
|
+
ssm_config_key?: string;
|
|
211
|
+
readonly stack_id?: string;
|
|
212
|
+
readonly stack_name?: string;
|
|
213
|
+
stack_status?: 'create_in_progress' | 'create_complete' | 'create_failed' | 'delete_in_progress' | 'delete_complete' | 'delete_failed' | 'update_in_progress' | 'update_complete' | 'update_failed' | 'rollback_in_progress' | 'rollback_complete' | 'rollback_failed' | 'update_rollback_complete' | 'update_rollback_failed';
|
|
214
|
+
type: 'managed' | 'external';
|
|
215
|
+
};
|
|
216
|
+
/**
|
|
217
|
+
* ActionStatusUpdaterListResponse
|
|
218
|
+
*
|
|
219
|
+
* Paginated list of action status updaters
|
|
220
|
+
*/
|
|
221
|
+
export type ActionStatusUpdaterListResponse = {
|
|
222
|
+
/**
|
|
223
|
+
* List of action status updaters
|
|
224
|
+
*/
|
|
225
|
+
data: Array<ActionStatusUpdaterResponse>;
|
|
226
|
+
meta: PaginationMeta;
|
|
227
|
+
};
|
|
228
|
+
/**
|
|
229
|
+
* SQSBody
|
|
230
|
+
*
|
|
231
|
+
* AWS SQS queue configuration.
|
|
232
|
+
*/
|
|
233
|
+
export type SqsBody = {
|
|
234
|
+
/**
|
|
235
|
+
* Polymorphic discriminator
|
|
236
|
+
*/
|
|
237
|
+
__type__: 'sqs';
|
|
238
|
+
access_key_id?: string;
|
|
239
|
+
auth_method: 'access_key' | 'iam_role';
|
|
240
|
+
fifo?: boolean;
|
|
241
|
+
queue_name?: string | null;
|
|
242
|
+
/**
|
|
243
|
+
* Full SQS queue URL
|
|
244
|
+
*/
|
|
245
|
+
queue_url: string;
|
|
246
|
+
region: string;
|
|
247
|
+
};
|
|
248
|
+
/**
|
|
249
|
+
* GenericTableResponse
|
|
250
|
+
*
|
|
251
|
+
* Generic Table — custom or system dataset table with column definitions.
|
|
252
|
+
*/
|
|
253
|
+
export type GenericTableResponse = {
|
|
254
|
+
/**
|
|
255
|
+
* Table column definitions
|
|
256
|
+
*/
|
|
257
|
+
columns?: Array<unknown>;
|
|
258
|
+
/**
|
|
259
|
+
* Industry data domain
|
|
260
|
+
*/
|
|
261
|
+
data_domain?: 'healthcare' | 'core_banking' | 'payment_risk' | 'accounts_receivable' | 'service_commerce' | 'trading';
|
|
262
|
+
/**
|
|
263
|
+
* Datalake ID
|
|
264
|
+
*/
|
|
265
|
+
readonly datalake_id?: string;
|
|
266
|
+
/**
|
|
267
|
+
* Table description
|
|
268
|
+
*/
|
|
269
|
+
description?: string;
|
|
270
|
+
/**
|
|
271
|
+
* Generic Table ID
|
|
272
|
+
*/
|
|
273
|
+
readonly id?: string;
|
|
274
|
+
/**
|
|
275
|
+
* Creation timestamp
|
|
276
|
+
*/
|
|
277
|
+
readonly inserted_at?: string;
|
|
278
|
+
/**
|
|
279
|
+
* Auto-generated table name (from title)
|
|
280
|
+
*/
|
|
281
|
+
readonly name?: string;
|
|
282
|
+
/**
|
|
283
|
+
* Table deployment status
|
|
284
|
+
*/
|
|
285
|
+
status?: 'new' | 'stale' | 'processing' | 'deployed';
|
|
286
|
+
/**
|
|
287
|
+
* Tenant ID
|
|
288
|
+
*/
|
|
289
|
+
readonly tenant_id?: string;
|
|
290
|
+
/**
|
|
291
|
+
* User-friendly table title
|
|
292
|
+
*/
|
|
293
|
+
title?: string;
|
|
294
|
+
/**
|
|
295
|
+
* Table type
|
|
296
|
+
*/
|
|
297
|
+
type?: 'custom' | 'system';
|
|
298
|
+
/**
|
|
299
|
+
* Last update timestamp
|
|
300
|
+
*/
|
|
301
|
+
readonly updated_at?: string;
|
|
302
|
+
};
|
|
303
|
+
/**
|
|
304
|
+
* ExecuteActionResponse
|
|
305
|
+
*
|
|
306
|
+
* Response from executing a workflow action
|
|
307
|
+
*/
|
|
308
|
+
export type ExecuteActionResponse = {
|
|
309
|
+
/**
|
|
310
|
+
* Number of action executions scheduled
|
|
311
|
+
*/
|
|
312
|
+
scheduled_count?: number;
|
|
313
|
+
/**
|
|
314
|
+
* Current status of the workflow execution
|
|
315
|
+
*/
|
|
316
|
+
status?: 'pending' | 'completed' | 'filtered' | 'failed';
|
|
317
|
+
/**
|
|
318
|
+
* ID of the workflow execution log (nil when async, populated when synchronous)
|
|
319
|
+
*/
|
|
320
|
+
workflow_execution_log_id?: string | null;
|
|
321
|
+
};
|
|
322
|
+
/**
|
|
323
|
+
* DatalakeListResponse
|
|
324
|
+
*
|
|
325
|
+
* Paginated list of datalakes
|
|
326
|
+
*/
|
|
327
|
+
export type DatalakeListResponse = {
|
|
328
|
+
/**
|
|
329
|
+
* List of datalakes
|
|
330
|
+
*/
|
|
331
|
+
data: Array<DatalakeResponse>;
|
|
332
|
+
meta: PaginationMeta;
|
|
333
|
+
};
|
|
334
|
+
/**
|
|
335
|
+
* SFTPBody
|
|
336
|
+
*
|
|
337
|
+
* SFTP server connection configuration.
|
|
338
|
+
*/
|
|
339
|
+
export type SftpBody = {
|
|
340
|
+
/**
|
|
341
|
+
* Polymorphic discriminator
|
|
342
|
+
*/
|
|
343
|
+
__type__: 'sftp';
|
|
344
|
+
auth_method: 'password' | 'ssh_key';
|
|
345
|
+
base_path: string;
|
|
346
|
+
host: string;
|
|
347
|
+
port: number;
|
|
348
|
+
user_name: string;
|
|
349
|
+
};
|
|
350
|
+
/**
|
|
351
|
+
* PaginationMeta
|
|
352
|
+
*
|
|
353
|
+
* Pagination metadata for list responses
|
|
354
|
+
*/
|
|
355
|
+
export type PaginationMeta = {
|
|
356
|
+
/**
|
|
357
|
+
* Current page number (1-indexed)
|
|
358
|
+
*/
|
|
359
|
+
page: number;
|
|
360
|
+
/**
|
|
361
|
+
* Number of items per page
|
|
362
|
+
*/
|
|
363
|
+
page_size: number;
|
|
364
|
+
/**
|
|
365
|
+
* Total number of items across all pages
|
|
366
|
+
*/
|
|
367
|
+
total_count: number;
|
|
368
|
+
/**
|
|
369
|
+
* Total number of pages
|
|
370
|
+
*/
|
|
371
|
+
total_pages: number;
|
|
372
|
+
};
|
|
373
|
+
/**
|
|
374
|
+
* ToolListResponse
|
|
375
|
+
*
|
|
376
|
+
* Paginated list of tools
|
|
377
|
+
*/
|
|
378
|
+
export type ToolListResponse = {
|
|
379
|
+
/**
|
|
380
|
+
* List of tools
|
|
381
|
+
*/
|
|
382
|
+
data: Array<ToolResponse>;
|
|
383
|
+
meta: PaginationMeta;
|
|
384
|
+
};
|
|
385
|
+
/**
|
|
386
|
+
* MDMVerifyResponse
|
|
387
|
+
*
|
|
388
|
+
* Result of MDM subject identity verification
|
|
389
|
+
*/
|
|
390
|
+
export type MdmVerifyResponse = {
|
|
391
|
+
status: 'verified';
|
|
392
|
+
/**
|
|
393
|
+
* The verified subject ID
|
|
394
|
+
*/
|
|
395
|
+
subject_id: string;
|
|
396
|
+
/**
|
|
397
|
+
* Timestamp of verification
|
|
398
|
+
*/
|
|
399
|
+
verified_at: string;
|
|
400
|
+
} | {
|
|
401
|
+
/**
|
|
402
|
+
* Field-level verification failure details
|
|
403
|
+
*/
|
|
404
|
+
errors: {
|
|
405
|
+
[key: string]: Array<string>;
|
|
406
|
+
};
|
|
407
|
+
status: 'not_verified';
|
|
408
|
+
/**
|
|
409
|
+
* The subject ID that failed verification
|
|
410
|
+
*/
|
|
411
|
+
subject_id: string;
|
|
412
|
+
/**
|
|
413
|
+
* Timestamp of verification attempt
|
|
414
|
+
*/
|
|
415
|
+
verified_at: string;
|
|
416
|
+
};
|
|
417
|
+
/**
|
|
418
|
+
* CloudWatchLogGroupBody
|
|
419
|
+
*
|
|
420
|
+
* AWS CloudWatch Logs authentication configuration.
|
|
421
|
+
*/
|
|
422
|
+
export type CloudWatchLogGroupBody = {
|
|
423
|
+
/**
|
|
424
|
+
* Polymorphic discriminator
|
|
425
|
+
*/
|
|
426
|
+
__type__: 'cloud_watch_log_group';
|
|
427
|
+
access_key_id?: string;
|
|
428
|
+
assume_role_arn?: string | null;
|
|
429
|
+
assume_role_external_id?: string | null;
|
|
430
|
+
auth_method: 'access_key' | 'iam_role' | 'assume_role';
|
|
431
|
+
endpoint_url?: string | null;
|
|
432
|
+
region: string;
|
|
433
|
+
};
|
|
434
|
+
/**
|
|
435
|
+
* DataSourceListResponse
|
|
436
|
+
*
|
|
437
|
+
* Paginated list of data sources
|
|
438
|
+
*/
|
|
439
|
+
export type DataSourceListResponse = {
|
|
440
|
+
/**
|
|
441
|
+
* List of data sources
|
|
442
|
+
*/
|
|
443
|
+
data: Array<DataSourceResponse>;
|
|
444
|
+
meta: PaginationMeta;
|
|
445
|
+
};
|
|
446
|
+
/**
|
|
447
|
+
* ToolResponse
|
|
448
|
+
*
|
|
449
|
+
* Tool — a configurable capability reference for external services.
|
|
450
|
+
*/
|
|
451
|
+
export type ToolResponse = {
|
|
452
|
+
/**
|
|
453
|
+
* Data Source ID
|
|
454
|
+
*/
|
|
455
|
+
data_source_id?: string | null;
|
|
456
|
+
/**
|
|
457
|
+
* Datalake ID
|
|
458
|
+
*/
|
|
459
|
+
datalake_id?: string;
|
|
460
|
+
/**
|
|
461
|
+
* Tool description
|
|
462
|
+
*/
|
|
463
|
+
description?: string | null;
|
|
464
|
+
/**
|
|
465
|
+
* Tool ID
|
|
466
|
+
*/
|
|
467
|
+
readonly id?: string;
|
|
468
|
+
/**
|
|
469
|
+
* Creation timestamp
|
|
470
|
+
*/
|
|
471
|
+
readonly inserted_at?: string;
|
|
472
|
+
/**
|
|
473
|
+
* Tool intent — what category of capability the tool provides
|
|
474
|
+
*/
|
|
475
|
+
intent?: 'sms' | 'email' | 'export' | 'voice' | 'data_exchange' | 'status_poller' | 'chat_completion' | 'context_extraction';
|
|
476
|
+
/**
|
|
477
|
+
* Tool name
|
|
478
|
+
*/
|
|
479
|
+
name?: string;
|
|
480
|
+
/**
|
|
481
|
+
* Tool status
|
|
482
|
+
*/
|
|
483
|
+
status?: 'draft' | 'active' | 'inactive' | 'error' | 'marked_for_deletion';
|
|
484
|
+
/**
|
|
485
|
+
* Last update timestamp
|
|
486
|
+
*/
|
|
487
|
+
readonly updated_at?: string;
|
|
488
|
+
};
|
|
489
|
+
/**
|
|
490
|
+
* IngestResponse
|
|
491
|
+
*
|
|
492
|
+
* Response from data ingestion
|
|
493
|
+
*/
|
|
494
|
+
export type IngestResponse = {
|
|
495
|
+
/**
|
|
496
|
+
* Batch ID for tracking
|
|
497
|
+
*/
|
|
498
|
+
batch_id: string;
|
|
499
|
+
/**
|
|
500
|
+
* Number of processing jobs created
|
|
501
|
+
*/
|
|
502
|
+
jobs_count: number;
|
|
503
|
+
/**
|
|
504
|
+
* Storage key for the ingested data
|
|
505
|
+
*/
|
|
506
|
+
key: string;
|
|
507
|
+
};
|
|
508
|
+
/**
|
|
509
|
+
* SessionResponse
|
|
510
|
+
*
|
|
511
|
+
* Session token and metadata returned after successful authentication
|
|
512
|
+
*/
|
|
513
|
+
export type SessionResponse = {
|
|
514
|
+
/**
|
|
515
|
+
* API key info (M2M sessions only)
|
|
516
|
+
*/
|
|
517
|
+
api_key?: {
|
|
518
|
+
id: string;
|
|
519
|
+
last_four: string;
|
|
520
|
+
name: string;
|
|
521
|
+
} | null;
|
|
522
|
+
/**
|
|
523
|
+
* Expiration timestamp (null for non-expiring M2M sessions)
|
|
524
|
+
*/
|
|
525
|
+
expires_at?: string | null;
|
|
526
|
+
/**
|
|
527
|
+
* Assumed role
|
|
528
|
+
*/
|
|
529
|
+
role: {
|
|
530
|
+
id: string;
|
|
531
|
+
name: string;
|
|
532
|
+
};
|
|
533
|
+
/**
|
|
534
|
+
* Bearer token for subsequent API requests. Returned on create, null on verify (token is not re-exposed).
|
|
535
|
+
*/
|
|
536
|
+
session_token: string | null;
|
|
537
|
+
/**
|
|
538
|
+
* Authenticated tenant
|
|
539
|
+
*/
|
|
540
|
+
tenant: {
|
|
541
|
+
id: string;
|
|
542
|
+
name: string;
|
|
543
|
+
slug: string;
|
|
544
|
+
};
|
|
545
|
+
/**
|
|
546
|
+
* Session type
|
|
547
|
+
*/
|
|
548
|
+
type: 'user' | 'api';
|
|
549
|
+
/**
|
|
550
|
+
* User info (human sessions only)
|
|
551
|
+
*/
|
|
552
|
+
user?: {
|
|
553
|
+
first_name?: string | null;
|
|
554
|
+
id: string;
|
|
555
|
+
last_name?: string | null;
|
|
556
|
+
} | null;
|
|
557
|
+
};
|
|
558
|
+
/**
|
|
559
|
+
* EmailBody
|
|
560
|
+
*
|
|
561
|
+
* Email provider configuration (SES, Mailgun, SendGrid, SMTP).
|
|
562
|
+
*/
|
|
563
|
+
export type EmailBody = {
|
|
564
|
+
/**
|
|
565
|
+
* Polymorphic discriminator
|
|
566
|
+
*/
|
|
567
|
+
__type__: 'email';
|
|
568
|
+
/**
|
|
569
|
+
* AWS access key (SES)
|
|
570
|
+
*/
|
|
571
|
+
access_key_id?: string;
|
|
572
|
+
/**
|
|
573
|
+
* Domain (Mailgun)
|
|
574
|
+
*/
|
|
575
|
+
domain?: string;
|
|
576
|
+
from_email: string;
|
|
577
|
+
from_name?: string | null;
|
|
578
|
+
provider: 'ses' | 'mailgun' | 'sendgrid' | 'smtp';
|
|
579
|
+
/**
|
|
580
|
+
* AWS region (SES)
|
|
581
|
+
*/
|
|
582
|
+
region?: string;
|
|
583
|
+
reply_to?: string | null;
|
|
584
|
+
smtp_host?: string;
|
|
585
|
+
smtp_port?: number;
|
|
586
|
+
smtp_username?: string;
|
|
587
|
+
};
|
|
588
|
+
/**
|
|
589
|
+
* PingResponse
|
|
590
|
+
*
|
|
591
|
+
* Health check response with version and database connectivity status
|
|
592
|
+
*/
|
|
593
|
+
export type PingResponse = {
|
|
594
|
+
database_status: 'connected' | 'disconnected';
|
|
595
|
+
status: 'ok' | 'error';
|
|
596
|
+
timestamp: string;
|
|
597
|
+
version: string;
|
|
598
|
+
};
|
|
599
|
+
/**
|
|
600
|
+
* DatalakeResponse
|
|
601
|
+
*
|
|
602
|
+
* Datalake configuration. Secrets (DB passwords, credentials) are write-only — accepted on create but never returned in responses.
|
|
603
|
+
*/
|
|
604
|
+
export type DatalakeResponse = {
|
|
605
|
+
/**
|
|
606
|
+
* Industry data domain
|
|
607
|
+
*/
|
|
608
|
+
data_domain: 'healthcare' | 'core_banking' | 'payment_risk' | 'accounts_receivable' | 'service_commerce' | 'trading';
|
|
609
|
+
/**
|
|
610
|
+
* IANA timezone
|
|
611
|
+
*/
|
|
612
|
+
timezone: string | null;
|
|
613
|
+
/**
|
|
614
|
+
* Regulated reader auth method
|
|
615
|
+
*/
|
|
616
|
+
regulated_data_db_reader_auth_method: 'password' | 'iam_role';
|
|
617
|
+
/**
|
|
618
|
+
* Regulated writer DB host
|
|
619
|
+
*/
|
|
620
|
+
regulated_data_db_writer_host: string;
|
|
621
|
+
/**
|
|
622
|
+
* Creation timestamp
|
|
623
|
+
*/
|
|
624
|
+
readonly inserted_at?: string;
|
|
625
|
+
/**
|
|
626
|
+
* Regulated writer auth method
|
|
627
|
+
*/
|
|
628
|
+
regulated_data_db_writer_auth_method: 'password' | 'iam_role';
|
|
629
|
+
/**
|
|
630
|
+
* Regulated writer DB schema name
|
|
631
|
+
*/
|
|
632
|
+
regulated_data_db_writer_schema: string;
|
|
633
|
+
/**
|
|
634
|
+
* Enable SSL for regulated writer
|
|
635
|
+
*/
|
|
636
|
+
regulated_data_db_writer_enable_ssl: boolean;
|
|
637
|
+
/**
|
|
638
|
+
* Unregulated reader DB schema name
|
|
639
|
+
*/
|
|
640
|
+
unregulated_db_reader_schema: string;
|
|
641
|
+
/**
|
|
642
|
+
* Enable SSL for unregulated writer
|
|
643
|
+
*/
|
|
644
|
+
unregulated_db_writer_enable_ssl: boolean;
|
|
645
|
+
/**
|
|
646
|
+
* Unregulated writer DB port
|
|
647
|
+
*/
|
|
648
|
+
unregulated_db_writer_port: number;
|
|
649
|
+
/**
|
|
650
|
+
* Regulated writer DB port
|
|
651
|
+
*/
|
|
652
|
+
regulated_data_db_writer_port: number;
|
|
653
|
+
/**
|
|
654
|
+
* Enable SSL for unregulated reader
|
|
655
|
+
*/
|
|
656
|
+
unregulated_db_reader_enable_ssl: boolean;
|
|
657
|
+
/**
|
|
658
|
+
* Enable SSL for regulated reader
|
|
659
|
+
*/
|
|
660
|
+
regulated_data_db_reader_enable_ssl: boolean;
|
|
661
|
+
/**
|
|
662
|
+
* Unregulated reader DB host
|
|
663
|
+
*/
|
|
664
|
+
unregulated_db_reader_host: string;
|
|
665
|
+
/**
|
|
666
|
+
* Unregulated reader DB port
|
|
667
|
+
*/
|
|
668
|
+
unregulated_db_reader_port: number;
|
|
669
|
+
/**
|
|
670
|
+
* Datalake setup status
|
|
671
|
+
*/
|
|
672
|
+
status?: 'new' | 'processing' | 'ready';
|
|
673
|
+
/**
|
|
674
|
+
* Last update timestamp
|
|
675
|
+
*/
|
|
676
|
+
readonly updated_at?: string;
|
|
677
|
+
/**
|
|
678
|
+
* Database connection pool size
|
|
679
|
+
*/
|
|
680
|
+
pool_size: number | null;
|
|
681
|
+
/**
|
|
682
|
+
* Datalake description
|
|
683
|
+
*/
|
|
684
|
+
description?: string | null;
|
|
685
|
+
/**
|
|
686
|
+
* Datalake name
|
|
687
|
+
*/
|
|
688
|
+
name: string;
|
|
689
|
+
/**
|
|
690
|
+
* Datalake ID
|
|
691
|
+
*/
|
|
692
|
+
readonly id?: string;
|
|
693
|
+
tenant?: TenantResponse;
|
|
694
|
+
/**
|
|
695
|
+
* Unregulated writer auth method
|
|
696
|
+
*/
|
|
697
|
+
unregulated_db_writer_auth_method: 'password' | 'iam_role';
|
|
698
|
+
/**
|
|
699
|
+
* Unregulated reader DB name
|
|
700
|
+
*/
|
|
701
|
+
unregulated_db_reader_name: string;
|
|
702
|
+
/**
|
|
703
|
+
* Regulated writer DB name
|
|
704
|
+
*/
|
|
705
|
+
regulated_data_db_writer_name: string;
|
|
706
|
+
/**
|
|
707
|
+
* Unregulated writer DB host
|
|
708
|
+
*/
|
|
709
|
+
unregulated_db_writer_host: string;
|
|
710
|
+
/**
|
|
711
|
+
* Regulated reader DB schema name
|
|
712
|
+
*/
|
|
713
|
+
regulated_data_db_reader_schema: string;
|
|
714
|
+
/**
|
|
715
|
+
* Unregulated writer DB name
|
|
716
|
+
*/
|
|
717
|
+
unregulated_db_writer_name: string;
|
|
718
|
+
/**
|
|
719
|
+
* Unregulated writer DB schema name
|
|
720
|
+
*/
|
|
721
|
+
unregulated_db_writer_schema: string;
|
|
722
|
+
/**
|
|
723
|
+
* Regulated reader DB port
|
|
724
|
+
*/
|
|
725
|
+
regulated_data_db_reader_port: number;
|
|
726
|
+
/**
|
|
727
|
+
* Regulated reader DB name
|
|
728
|
+
*/
|
|
729
|
+
regulated_data_db_reader_name: string;
|
|
730
|
+
/**
|
|
731
|
+
* Regulated reader DB host
|
|
732
|
+
*/
|
|
733
|
+
regulated_data_db_reader_host: string;
|
|
734
|
+
/**
|
|
735
|
+
* Unregulated reader auth method
|
|
736
|
+
*/
|
|
737
|
+
unregulated_db_reader_auth_method: 'password' | 'iam_role';
|
|
738
|
+
/**
|
|
739
|
+
* URL-friendly slug
|
|
740
|
+
*/
|
|
741
|
+
slug?: string;
|
|
742
|
+
};
|
|
743
|
+
/**
|
|
744
|
+
* DataSourceRequest
|
|
745
|
+
*
|
|
746
|
+
* Data source — connection to a third-party system or API Request
|
|
747
|
+
*/
|
|
748
|
+
export type DataSourceRequest = {
|
|
749
|
+
/**
|
|
750
|
+
* Data source description
|
|
751
|
+
*/
|
|
752
|
+
description?: string | null;
|
|
753
|
+
/**
|
|
754
|
+
* Data Source ID
|
|
755
|
+
*/
|
|
756
|
+
id?: string;
|
|
757
|
+
/**
|
|
758
|
+
* Image URL
|
|
759
|
+
*/
|
|
760
|
+
image_url?: string | null;
|
|
761
|
+
/**
|
|
762
|
+
* Creation timestamp
|
|
763
|
+
*/
|
|
764
|
+
inserted_at?: string;
|
|
765
|
+
/**
|
|
766
|
+
* Whether this is the default data source
|
|
767
|
+
*/
|
|
768
|
+
is_default: boolean;
|
|
769
|
+
/**
|
|
770
|
+
* Data source name
|
|
771
|
+
*/
|
|
772
|
+
name: string;
|
|
773
|
+
/**
|
|
774
|
+
* Data source status
|
|
775
|
+
*/
|
|
776
|
+
status: 'draft' | 'active' | 'inactive';
|
|
777
|
+
/**
|
|
778
|
+
* Last update timestamp
|
|
779
|
+
*/
|
|
780
|
+
updated_at?: string;
|
|
781
|
+
/**
|
|
782
|
+
* Data source URI
|
|
783
|
+
*/
|
|
784
|
+
uri: string;
|
|
785
|
+
};
|
|
786
|
+
/**
|
|
787
|
+
* DatasetSearchResponse
|
|
788
|
+
*
|
|
789
|
+
* Paginated dataset search results
|
|
790
|
+
*/
|
|
791
|
+
export type DatasetSearchResponse = {
|
|
792
|
+
/**
|
|
793
|
+
* Array of dataset records
|
|
794
|
+
*/
|
|
795
|
+
data: Array<{
|
|
796
|
+
[key: string]: unknown;
|
|
797
|
+
}>;
|
|
798
|
+
meta: PaginationMeta;
|
|
799
|
+
};
|
|
800
|
+
/**
|
|
801
|
+
* UpdatePageResponse
|
|
802
|
+
*
|
|
803
|
+
* Confirmation of message tracking update
|
|
804
|
+
*/
|
|
805
|
+
export type UpdatePageResponse = {
|
|
806
|
+
/**
|
|
807
|
+
* Updated message details
|
|
808
|
+
*/
|
|
809
|
+
message: {
|
|
810
|
+
/**
|
|
811
|
+
* When the linked form was submitted
|
|
812
|
+
*/
|
|
813
|
+
form_submitted_at?: string | null;
|
|
814
|
+
/**
|
|
815
|
+
* Regulated message UUID
|
|
816
|
+
*/
|
|
817
|
+
id: string;
|
|
818
|
+
/**
|
|
819
|
+
* When the page was opened by the recipient
|
|
820
|
+
*/
|
|
821
|
+
opened_at?: string | null;
|
|
822
|
+
};
|
|
823
|
+
};
|
|
824
|
+
/**
|
|
825
|
+
* GenericTableRequest
|
|
826
|
+
*
|
|
827
|
+
* Generic Table — custom or system dataset table with column definitions. Request
|
|
828
|
+
*/
|
|
829
|
+
export type GenericTableRequest = {
|
|
830
|
+
/**
|
|
831
|
+
* Table column definitions
|
|
832
|
+
*/
|
|
833
|
+
columns?: Array<unknown>;
|
|
834
|
+
/**
|
|
835
|
+
* Industry data domain
|
|
836
|
+
*/
|
|
837
|
+
data_domain?: 'healthcare' | 'core_banking' | 'payment_risk' | 'accounts_receivable' | 'service_commerce' | 'trading';
|
|
838
|
+
/**
|
|
839
|
+
* Table description
|
|
840
|
+
*/
|
|
841
|
+
description?: string;
|
|
842
|
+
/**
|
|
843
|
+
* User-friendly table title
|
|
844
|
+
*/
|
|
845
|
+
title?: string;
|
|
846
|
+
};
|
|
847
|
+
/**
|
|
848
|
+
* SessionRequest
|
|
849
|
+
*
|
|
850
|
+
* Exchange user credentials for a Bearer session token.
|
|
851
|
+
* For M2M authentication, use `X-API-Key` header directly instead.
|
|
852
|
+
*
|
|
853
|
+
*/
|
|
854
|
+
export type SessionRequest = {
|
|
855
|
+
/**
|
|
856
|
+
* User email address
|
|
857
|
+
*/
|
|
858
|
+
email: string;
|
|
859
|
+
/**
|
|
860
|
+
* Session duration in seconds. Default: 86400 (24h). Maximum: 2592000 (30 days).
|
|
861
|
+
*/
|
|
862
|
+
expires_in?: number | null;
|
|
863
|
+
/**
|
|
864
|
+
* User password
|
|
865
|
+
*/
|
|
866
|
+
password: string;
|
|
867
|
+
/**
|
|
868
|
+
* Tenant slug to create session for
|
|
869
|
+
*/
|
|
870
|
+
tenant_slug: string;
|
|
871
|
+
};
|
|
872
|
+
/**
|
|
873
|
+
* GenericTableListResponse
|
|
874
|
+
*
|
|
875
|
+
* Paginated list of generic tables
|
|
876
|
+
*/
|
|
877
|
+
export type GenericTableListResponse = {
|
|
878
|
+
/**
|
|
879
|
+
* List of generic tables
|
|
880
|
+
*/
|
|
881
|
+
data: Array<GenericTableResponse>;
|
|
882
|
+
meta: PaginationMeta;
|
|
883
|
+
};
|
|
884
|
+
/**
|
|
885
|
+
* SharePointBody
|
|
886
|
+
*
|
|
887
|
+
* Microsoft SharePoint integration configuration.
|
|
888
|
+
*/
|
|
889
|
+
export type SharePointBody = {
|
|
890
|
+
/**
|
|
891
|
+
* Polymorphic discriminator
|
|
892
|
+
*/
|
|
893
|
+
__type__: 'sharepoint';
|
|
894
|
+
auth_method: 'client_credentials' | 'managed_identity';
|
|
895
|
+
client_id?: string;
|
|
896
|
+
drive_id?: string | null;
|
|
897
|
+
drive_path?: string | null;
|
|
898
|
+
resource_type: 'site' | 'library' | 'list';
|
|
899
|
+
site_url?: string | null;
|
|
900
|
+
/**
|
|
901
|
+
* Microsoft tenant ID
|
|
902
|
+
*/
|
|
903
|
+
tenant_id: string;
|
|
904
|
+
};
|
|
905
|
+
/**
|
|
906
|
+
* AiAgentRequest
|
|
907
|
+
*
|
|
908
|
+
* AI Agent configuration — reusable chat-completion resource Request
|
|
909
|
+
*/
|
|
910
|
+
export type AiAgentRequest = {
|
|
911
|
+
/**
|
|
912
|
+
* Data access level
|
|
913
|
+
*/
|
|
914
|
+
data_access: 'regulated' | 'unregulated';
|
|
915
|
+
/**
|
|
916
|
+
* Agent description
|
|
917
|
+
*/
|
|
918
|
+
description?: string | null;
|
|
919
|
+
/**
|
|
920
|
+
* Whether the agent is enabled
|
|
921
|
+
*/
|
|
922
|
+
enabled: boolean;
|
|
923
|
+
/**
|
|
924
|
+
* AI Agent ID
|
|
925
|
+
*/
|
|
926
|
+
id?: string;
|
|
927
|
+
/**
|
|
928
|
+
* Creation timestamp
|
|
929
|
+
*/
|
|
930
|
+
inserted_at?: string;
|
|
931
|
+
/**
|
|
932
|
+
* Maximum tokens for LLM response
|
|
933
|
+
*/
|
|
934
|
+
max_tokens: number;
|
|
935
|
+
/**
|
|
936
|
+
* LLM model identifier
|
|
937
|
+
*/
|
|
938
|
+
model: string;
|
|
939
|
+
/**
|
|
940
|
+
* Agent name
|
|
941
|
+
*/
|
|
942
|
+
name: string;
|
|
943
|
+
/**
|
|
944
|
+
* URL-friendly slug
|
|
945
|
+
*/
|
|
946
|
+
slug?: string;
|
|
947
|
+
/**
|
|
948
|
+
* Sampling temperature (0.0–2.0)
|
|
949
|
+
*/
|
|
950
|
+
temperature: number;
|
|
951
|
+
/**
|
|
952
|
+
* Tool ID
|
|
953
|
+
*/
|
|
954
|
+
tool_id: string;
|
|
955
|
+
/**
|
|
956
|
+
* Last update timestamp
|
|
957
|
+
*/
|
|
958
|
+
updated_at?: string;
|
|
959
|
+
};
|
|
960
|
+
/**
|
|
961
|
+
* ResolvePageRequest
|
|
962
|
+
*
|
|
963
|
+
* Request body for resolving a connected app page from a short URL token
|
|
964
|
+
*/
|
|
965
|
+
export type ResolvePageRequest = {
|
|
966
|
+
/**
|
|
967
|
+
* Client country code (CF-IPCountry)
|
|
968
|
+
*/
|
|
969
|
+
country?: string;
|
|
970
|
+
/**
|
|
971
|
+
* Original client IP (CF-Connecting-IP)
|
|
972
|
+
*/
|
|
973
|
+
ip?: string;
|
|
974
|
+
/**
|
|
975
|
+
* Additional Cloudflare metadata (CF-Ray, etc.)
|
|
976
|
+
*/
|
|
977
|
+
metadata?: {
|
|
978
|
+
[key: string]: unknown;
|
|
979
|
+
};
|
|
980
|
+
/**
|
|
981
|
+
* Puid token extracted from the short URL
|
|
982
|
+
*/
|
|
983
|
+
short_path: string;
|
|
984
|
+
/**
|
|
985
|
+
* Original client User-Agent forwarded by Cloudflare
|
|
986
|
+
*/
|
|
987
|
+
user_agent?: string;
|
|
988
|
+
};
|
|
989
|
+
/**
|
|
990
|
+
* MDMVerified
|
|
991
|
+
*/
|
|
992
|
+
export type MdmVerified = {
|
|
993
|
+
status: 'verified';
|
|
994
|
+
/**
|
|
995
|
+
* The verified subject ID
|
|
996
|
+
*/
|
|
997
|
+
subject_id: string;
|
|
998
|
+
/**
|
|
999
|
+
* Timestamp of verification
|
|
1000
|
+
*/
|
|
1001
|
+
verified_at: string;
|
|
1002
|
+
};
|
|
1003
|
+
/**
|
|
1004
|
+
* ToolRequest
|
|
1005
|
+
*
|
|
1006
|
+
* Tool — a configurable capability reference for external services. Request
|
|
1007
|
+
*/
|
|
1008
|
+
export type ToolRequest = {
|
|
1009
|
+
/**
|
|
1010
|
+
* Data Source ID
|
|
1011
|
+
*/
|
|
1012
|
+
data_source_id?: string | null;
|
|
1013
|
+
/**
|
|
1014
|
+
* Datalake ID
|
|
1015
|
+
*/
|
|
1016
|
+
datalake_id?: string;
|
|
1017
|
+
/**
|
|
1018
|
+
* Tool description
|
|
1019
|
+
*/
|
|
1020
|
+
description?: string | null;
|
|
1021
|
+
/**
|
|
1022
|
+
* Tool intent — what category of capability the tool provides
|
|
1023
|
+
*/
|
|
1024
|
+
intent?: 'sms' | 'email' | 'export' | 'voice' | 'data_exchange' | 'status_poller' | 'chat_completion' | 'context_extraction';
|
|
1025
|
+
/**
|
|
1026
|
+
* Tool name
|
|
1027
|
+
*/
|
|
1028
|
+
name?: string;
|
|
1029
|
+
/**
|
|
1030
|
+
* Tool status
|
|
1031
|
+
*/
|
|
1032
|
+
status?: 'draft' | 'active' | 'inactive' | 'error' | 'marked_for_deletion';
|
|
1033
|
+
};
|
|
1034
|
+
/**
|
|
1035
|
+
* SQLDatabaseBody
|
|
1036
|
+
*
|
|
1037
|
+
* SQL database connection configuration.
|
|
1038
|
+
*/
|
|
1039
|
+
export type SqlDatabaseBody = {
|
|
1040
|
+
/**
|
|
1041
|
+
* Polymorphic discriminator
|
|
1042
|
+
*/
|
|
1043
|
+
__type__: 'sql_database';
|
|
1044
|
+
db_host: string;
|
|
1045
|
+
db_name: string;
|
|
1046
|
+
db_type: 'postgres' | 'mysql' | 'mssql' | 'sqlite' | 'snowflake';
|
|
1047
|
+
pool_size?: number;
|
|
1048
|
+
port?: number;
|
|
1049
|
+
ssl?: boolean;
|
|
1050
|
+
ssl_mode?: string | null;
|
|
1051
|
+
user_name: string;
|
|
1052
|
+
};
|
|
1053
|
+
/**
|
|
1054
|
+
* UpdatePageRequest
|
|
1055
|
+
*
|
|
1056
|
+
* Request body for updating message tracking fields on a resolved page
|
|
1057
|
+
*/
|
|
1058
|
+
export type UpdatePageRequest = {
|
|
1059
|
+
/**
|
|
1060
|
+
* When the linked form was submitted
|
|
1061
|
+
*/
|
|
1062
|
+
form_submitted_at?: string | null;
|
|
1063
|
+
/**
|
|
1064
|
+
* When the page was opened by the recipient
|
|
1065
|
+
*/
|
|
1066
|
+
opened_at?: string | null;
|
|
1067
|
+
/**
|
|
1068
|
+
* Puid token extracted from the short URL
|
|
1069
|
+
*/
|
|
1070
|
+
short_path: string;
|
|
1071
|
+
};
|
|
1072
|
+
/**
|
|
1073
|
+
* ChangesetErrors
|
|
1074
|
+
*
|
|
1075
|
+
* Validation error response in JSON:API format (from OpenApiSpex v2)
|
|
1076
|
+
*/
|
|
1077
|
+
export type ChangesetErrors = {
|
|
1078
|
+
/**
|
|
1079
|
+
* Array of validation error objects
|
|
1080
|
+
*/
|
|
1081
|
+
errors?: Array<{
|
|
1082
|
+
/**
|
|
1083
|
+
* Error message
|
|
1084
|
+
*/
|
|
1085
|
+
detail?: string;
|
|
1086
|
+
source?: {
|
|
1087
|
+
/**
|
|
1088
|
+
* JSON pointer to the field
|
|
1089
|
+
*/
|
|
1090
|
+
pointer?: string;
|
|
1091
|
+
};
|
|
1092
|
+
/**
|
|
1093
|
+
* Error title
|
|
1094
|
+
*/
|
|
1095
|
+
title?: string;
|
|
1096
|
+
}>;
|
|
1097
|
+
};
|
|
1098
|
+
/**
|
|
1099
|
+
* MDMVerifyRequest
|
|
1100
|
+
*
|
|
1101
|
+
* Request body for MDM subject identity verification
|
|
1102
|
+
*/
|
|
1103
|
+
export type MdmVerifyRequest = {
|
|
1104
|
+
/**
|
|
1105
|
+
* Date of birth for fuzzy verification (component matching >= 0.80)
|
|
1106
|
+
*/
|
|
1107
|
+
birth_date?: string;
|
|
1108
|
+
/**
|
|
1109
|
+
* Family/last name for fuzzy verification (Jaro distance >= 0.85)
|
|
1110
|
+
*/
|
|
1111
|
+
family_name?: string;
|
|
1112
|
+
/**
|
|
1113
|
+
* Given/first name for fuzzy verification (Jaro distance >= 0.80)
|
|
1114
|
+
*/
|
|
1115
|
+
given_name?: string;
|
|
1116
|
+
/**
|
|
1117
|
+
* List of identifiers for exact (system, value) matching
|
|
1118
|
+
*/
|
|
1119
|
+
identifiers?: Array<{
|
|
1120
|
+
/**
|
|
1121
|
+
* Identifier system (e.g. MRN, SSN)
|
|
1122
|
+
*/
|
|
1123
|
+
system: string;
|
|
1124
|
+
/**
|
|
1125
|
+
* Identifier value
|
|
1126
|
+
*/
|
|
1127
|
+
value: string;
|
|
1128
|
+
}>;
|
|
1129
|
+
/**
|
|
1130
|
+
* The MDM subject ID to verify against
|
|
1131
|
+
*/
|
|
1132
|
+
subject_id: string;
|
|
1133
|
+
};
|
|
1134
|
+
/**
|
|
1135
|
+
* ResolvePageResponse
|
|
1136
|
+
*
|
|
1137
|
+
* Resolved page token details for the connected app to render
|
|
1138
|
+
*/
|
|
1139
|
+
export type ResolvePageResponse = {
|
|
1140
|
+
/**
|
|
1141
|
+
* Arbitrary context data rendered from workflow action template
|
|
1142
|
+
*/
|
|
1143
|
+
additional_context?: {
|
|
1144
|
+
[key: string]: unknown;
|
|
1145
|
+
} | null;
|
|
1146
|
+
/**
|
|
1147
|
+
* When this page token expires
|
|
1148
|
+
*/
|
|
1149
|
+
expires_at: string;
|
|
1150
|
+
/**
|
|
1151
|
+
* Regulated message from the workflow action that generated this page token (raw body/subject)
|
|
1152
|
+
*/
|
|
1153
|
+
message?: {
|
|
1154
|
+
/**
|
|
1155
|
+
* Raw message body text (SMS content or email body)
|
|
1156
|
+
*/
|
|
1157
|
+
body?: string | null;
|
|
1158
|
+
/**
|
|
1159
|
+
* Message channel
|
|
1160
|
+
*/
|
|
1161
|
+
channel: 'sms' | 'email' | 'voice' | 'web_form' | 'push';
|
|
1162
|
+
/**
|
|
1163
|
+
* When delivery was confirmed
|
|
1164
|
+
*/
|
|
1165
|
+
delivered_at?: string | null;
|
|
1166
|
+
/**
|
|
1167
|
+
* External system reference (Twilio SID, SES ID)
|
|
1168
|
+
*/
|
|
1169
|
+
external_id?: string | null;
|
|
1170
|
+
/**
|
|
1171
|
+
* Reason for delivery failure
|
|
1172
|
+
*/
|
|
1173
|
+
failure_reason?: string | null;
|
|
1174
|
+
/**
|
|
1175
|
+
* When the linked form was submitted
|
|
1176
|
+
*/
|
|
1177
|
+
form_submitted_at?: string | null;
|
|
1178
|
+
/**
|
|
1179
|
+
* Regulated message UUID
|
|
1180
|
+
*/
|
|
1181
|
+
id: string;
|
|
1182
|
+
/**
|
|
1183
|
+
* Message metadata (e.g. recipient phone/email)
|
|
1184
|
+
*/
|
|
1185
|
+
metadata?: {
|
|
1186
|
+
[key: string]: unknown;
|
|
1187
|
+
} | null;
|
|
1188
|
+
/**
|
|
1189
|
+
* When the message was opened by the recipient
|
|
1190
|
+
*/
|
|
1191
|
+
opened_at?: string | null;
|
|
1192
|
+
/**
|
|
1193
|
+
* When the message was queued for delivery
|
|
1194
|
+
*/
|
|
1195
|
+
queued_at?: string | null;
|
|
1196
|
+
/**
|
|
1197
|
+
* When the message was read by the recipient
|
|
1198
|
+
*/
|
|
1199
|
+
read_at?: string | null;
|
|
1200
|
+
/**
|
|
1201
|
+
* When the message was sent
|
|
1202
|
+
*/
|
|
1203
|
+
sent_at?: string | null;
|
|
1204
|
+
/**
|
|
1205
|
+
* SMS carrier of the recipient
|
|
1206
|
+
*/
|
|
1207
|
+
sms_carrier?: string | null;
|
|
1208
|
+
/**
|
|
1209
|
+
* Delivery status
|
|
1210
|
+
*/
|
|
1211
|
+
status: 'pending' | 'queued' | 'sent' | 'delivered' | 'failed' | 'received' | 'clicked';
|
|
1212
|
+
/**
|
|
1213
|
+
* Raw email subject line (null for SMS)
|
|
1214
|
+
*/
|
|
1215
|
+
subject?: string | null;
|
|
1216
|
+
} | null;
|
|
1217
|
+
/**
|
|
1218
|
+
* Route path within the connected app (e.g. /forms/cahps)
|
|
1219
|
+
*/
|
|
1220
|
+
route_path: string;
|
|
1221
|
+
/**
|
|
1222
|
+
* MDM subject ID associated with this page token
|
|
1223
|
+
*/
|
|
1224
|
+
subject_id: string;
|
|
1225
|
+
/**
|
|
1226
|
+
* Puid token that was resolved
|
|
1227
|
+
*/
|
|
1228
|
+
url_hash: string;
|
|
1229
|
+
/**
|
|
1230
|
+
* Original client User-Agent from the request
|
|
1231
|
+
*/
|
|
1232
|
+
user_agent?: string | null;
|
|
1233
|
+
};
|
|
1234
|
+
/**
|
|
1235
|
+
* ErrorResponse
|
|
1236
|
+
*
|
|
1237
|
+
* Error response
|
|
1238
|
+
*/
|
|
1239
|
+
export type ErrorResponse = {
|
|
1240
|
+
/**
|
|
1241
|
+
* Error details - values can be strings or arrays of strings (for validation errors)
|
|
1242
|
+
*/
|
|
1243
|
+
errors?: {
|
|
1244
|
+
[key: string]: string | Array<string>;
|
|
1245
|
+
};
|
|
1246
|
+
};
|
|
1247
|
+
/**
|
|
1248
|
+
* MDMNotVerified
|
|
1249
|
+
*/
|
|
1250
|
+
export type MdmNotVerified = {
|
|
1251
|
+
/**
|
|
1252
|
+
* Field-level verification failure details
|
|
1253
|
+
*/
|
|
1254
|
+
errors: {
|
|
1255
|
+
[key: string]: Array<string>;
|
|
1256
|
+
};
|
|
1257
|
+
status: 'not_verified';
|
|
1258
|
+
/**
|
|
1259
|
+
* The subject ID that failed verification
|
|
1260
|
+
*/
|
|
1261
|
+
subject_id: string;
|
|
1262
|
+
/**
|
|
1263
|
+
* Timestamp of verification attempt
|
|
1264
|
+
*/
|
|
1265
|
+
verified_at: string;
|
|
1266
|
+
};
|
|
1267
|
+
/**
|
|
1268
|
+
* ExecuteActionRequest
|
|
1269
|
+
*
|
|
1270
|
+
* Request body for executing a workflow action for a dataset record
|
|
1271
|
+
*/
|
|
1272
|
+
export type ExecuteActionRequest = {
|
|
1273
|
+
/**
|
|
1274
|
+
* ID of the dataset record to process
|
|
1275
|
+
*/
|
|
1276
|
+
dataset_id: string;
|
|
1277
|
+
/**
|
|
1278
|
+
* Decision key identifying which action to execute (e.g. 'cahps_survey')
|
|
1279
|
+
*/
|
|
1280
|
+
decision_key: string;
|
|
1281
|
+
/**
|
|
1282
|
+
* Execution mode. 'live' fires real tool calls (default); 'dry_run' runs the full pipeline and records the computed payload without making external calls.
|
|
1283
|
+
*/
|
|
1284
|
+
mode?: 'live' | 'dry_run';
|
|
1285
|
+
};
|
|
1286
|
+
/**
|
|
1287
|
+
* S3Body
|
|
1288
|
+
*
|
|
1289
|
+
* S3-compatible storage tool configuration.
|
|
1290
|
+
*/
|
|
1291
|
+
export type S3Body = {
|
|
1292
|
+
/**
|
|
1293
|
+
* Polymorphic discriminator
|
|
1294
|
+
*/
|
|
1295
|
+
__type__: 's3';
|
|
1296
|
+
/**
|
|
1297
|
+
* Provider config — must include __type__ ("aws" or "r2")
|
|
1298
|
+
*/
|
|
1299
|
+
config: {
|
|
1300
|
+
__type__: 'aws' | 'r2';
|
|
1301
|
+
access_key_id?: string;
|
|
1302
|
+
base_path?: string | null;
|
|
1303
|
+
bucket: string;
|
|
1304
|
+
endpoint?: string | null;
|
|
1305
|
+
region?: string;
|
|
1306
|
+
};
|
|
1307
|
+
};
|
|
1308
|
+
/**
|
|
1309
|
+
* IngestRequest
|
|
1310
|
+
*
|
|
1311
|
+
* Request body for data ingestion
|
|
1312
|
+
*/
|
|
1313
|
+
export type IngestRequest = {
|
|
1314
|
+
/**
|
|
1315
|
+
* JSON data to ingest
|
|
1316
|
+
*/
|
|
1317
|
+
data: {
|
|
1318
|
+
[key: string]: unknown;
|
|
1319
|
+
};
|
|
1320
|
+
};
|
|
1321
|
+
/**
|
|
1322
|
+
* ActionStatusUpdaterResponse
|
|
1323
|
+
*
|
|
1324
|
+
* Action Status Updater — automated polling for delivery status updates.
|
|
1325
|
+
*/
|
|
1326
|
+
export type ActionStatusUpdaterResponse = {
|
|
1327
|
+
/**
|
|
1328
|
+
* Cron schedule expression (e.g. "*30 * * * *")
|
|
1329
|
+
*/
|
|
1330
|
+
cron_expression?: string;
|
|
1331
|
+
/**
|
|
1332
|
+
* Datalake ID
|
|
1333
|
+
*/
|
|
1334
|
+
datalake_id?: string;
|
|
1335
|
+
/**
|
|
1336
|
+
* Action Status Updater ID
|
|
1337
|
+
*/
|
|
1338
|
+
readonly id?: string;
|
|
1339
|
+
/**
|
|
1340
|
+
* Creation timestamp
|
|
1341
|
+
*/
|
|
1342
|
+
readonly inserted_at?: string;
|
|
1343
|
+
/**
|
|
1344
|
+
* Updater name
|
|
1345
|
+
*/
|
|
1346
|
+
name?: string;
|
|
1347
|
+
/**
|
|
1348
|
+
* IDs of sender tools whose messages this updater monitors
|
|
1349
|
+
*/
|
|
1350
|
+
sender_tool_ids?: Array<string> | null;
|
|
1351
|
+
/**
|
|
1352
|
+
* Tenant ID
|
|
1353
|
+
*/
|
|
1354
|
+
readonly tenant_id?: string;
|
|
1355
|
+
/**
|
|
1356
|
+
* Last update timestamp
|
|
1357
|
+
*/
|
|
1358
|
+
readonly updated_at?: string;
|
|
1359
|
+
/**
|
|
1360
|
+
* Tool providing auth credentials for polling
|
|
1361
|
+
*/
|
|
1362
|
+
updater_tool_id?: string;
|
|
1363
|
+
/**
|
|
1364
|
+
* Updater type — determines the updater_body shape
|
|
1365
|
+
*/
|
|
1366
|
+
updater_type?: 'cloud_watch' | 'restapi';
|
|
1367
|
+
};
|
|
1368
|
+
/**
|
|
1369
|
+
* TenantResponse
|
|
1370
|
+
*
|
|
1371
|
+
* Lean tenant reference — id, slug, and name only
|
|
1372
|
+
*/
|
|
1373
|
+
export type TenantResponse = {
|
|
1374
|
+
/**
|
|
1375
|
+
* Tenant ID
|
|
1376
|
+
*/
|
|
1377
|
+
readonly id: string;
|
|
1378
|
+
/**
|
|
1379
|
+
* Human-readable tenant name
|
|
1380
|
+
*/
|
|
1381
|
+
readonly name: string;
|
|
1382
|
+
/**
|
|
1383
|
+
* URL-friendly tenant slug
|
|
1384
|
+
*/
|
|
1385
|
+
readonly slug: string;
|
|
1386
|
+
};
|
|
1387
|
+
/**
|
|
1388
|
+
* SNSBody
|
|
1389
|
+
*
|
|
1390
|
+
* AWS SNS tool configuration for sending SMS messages.
|
|
1391
|
+
*/
|
|
1392
|
+
export type SnsBody = {
|
|
1393
|
+
/**
|
|
1394
|
+
* Polymorphic discriminator
|
|
1395
|
+
*/
|
|
1396
|
+
__type__: 'sns';
|
|
1397
|
+
/**
|
|
1398
|
+
* AWS access key ID
|
|
1399
|
+
*/
|
|
1400
|
+
access_key_id?: string;
|
|
1401
|
+
assume_role_arn?: string | null;
|
|
1402
|
+
assume_role_external_id?: string | null;
|
|
1403
|
+
auth_method: 'access_key' | 'iam_role' | 'assume_role';
|
|
1404
|
+
/**
|
|
1405
|
+
* Custom SNS endpoint
|
|
1406
|
+
*/
|
|
1407
|
+
endpoint_url?: string | null;
|
|
1408
|
+
/**
|
|
1409
|
+
* E.164 phone number
|
|
1410
|
+
*/
|
|
1411
|
+
phone_number: string;
|
|
1412
|
+
/**
|
|
1413
|
+
* AWS region
|
|
1414
|
+
*/
|
|
1415
|
+
region: string;
|
|
1416
|
+
};
|
|
1417
|
+
/**
|
|
1418
|
+
* DatalakeRequest
|
|
1419
|
+
*
|
|
1420
|
+
* Datalake configuration. Secrets (DB passwords, credentials) are write-only — accepted on create but never returned in responses. Request
|
|
1421
|
+
*/
|
|
1422
|
+
export type DatalakeRequest = {
|
|
1423
|
+
/**
|
|
1424
|
+
* Industry data domain
|
|
1425
|
+
*/
|
|
1426
|
+
data_domain: 'healthcare' | 'core_banking' | 'payment_risk' | 'accounts_receivable' | 'service_commerce' | 'trading';
|
|
1427
|
+
/**
|
|
1428
|
+
* IANA timezone
|
|
1429
|
+
*/
|
|
1430
|
+
timezone: string | null;
|
|
1431
|
+
/**
|
|
1432
|
+
* Regulated reader auth method
|
|
1433
|
+
*/
|
|
1434
|
+
regulated_data_db_reader_auth_method: 'password' | 'iam_role';
|
|
1435
|
+
/**
|
|
1436
|
+
* Regulated writer DB host
|
|
1437
|
+
*/
|
|
1438
|
+
regulated_data_db_writer_host: string;
|
|
1439
|
+
/**
|
|
1440
|
+
* Regulated writer auth method
|
|
1441
|
+
*/
|
|
1442
|
+
regulated_data_db_writer_auth_method: 'password' | 'iam_role';
|
|
1443
|
+
/**
|
|
1444
|
+
* Regulated writer DB schema name
|
|
1445
|
+
*/
|
|
1446
|
+
regulated_data_db_writer_schema: string;
|
|
1447
|
+
/**
|
|
1448
|
+
* Enable SSL for regulated writer
|
|
1449
|
+
*/
|
|
1450
|
+
regulated_data_db_writer_enable_ssl: boolean;
|
|
1451
|
+
/**
|
|
1452
|
+
* Unregulated reader DB schema name
|
|
1453
|
+
*/
|
|
1454
|
+
unregulated_db_reader_schema: string;
|
|
1455
|
+
/**
|
|
1456
|
+
* Enable SSL for unregulated writer
|
|
1457
|
+
*/
|
|
1458
|
+
unregulated_db_writer_enable_ssl: boolean;
|
|
1459
|
+
/**
|
|
1460
|
+
* Unregulated writer DB port
|
|
1461
|
+
*/
|
|
1462
|
+
unregulated_db_writer_port: number;
|
|
1463
|
+
/**
|
|
1464
|
+
* Regulated writer DB port
|
|
1465
|
+
*/
|
|
1466
|
+
regulated_data_db_writer_port: number;
|
|
1467
|
+
/**
|
|
1468
|
+
* Enable SSL for unregulated reader
|
|
1469
|
+
*/
|
|
1470
|
+
unregulated_db_reader_enable_ssl: boolean;
|
|
1471
|
+
/**
|
|
1472
|
+
* Enable SSL for regulated reader
|
|
1473
|
+
*/
|
|
1474
|
+
regulated_data_db_reader_enable_ssl: boolean;
|
|
1475
|
+
/**
|
|
1476
|
+
* Unregulated reader DB host
|
|
1477
|
+
*/
|
|
1478
|
+
unregulated_db_reader_host: string;
|
|
1479
|
+
/**
|
|
1480
|
+
* Unregulated reader DB port
|
|
1481
|
+
*/
|
|
1482
|
+
unregulated_db_reader_port: number;
|
|
1483
|
+
/**
|
|
1484
|
+
* Database connection pool size
|
|
1485
|
+
*/
|
|
1486
|
+
pool_size: number | null;
|
|
1487
|
+
/**
|
|
1488
|
+
* Datalake description
|
|
1489
|
+
*/
|
|
1490
|
+
description?: string | null;
|
|
1491
|
+
/**
|
|
1492
|
+
* Datalake name
|
|
1493
|
+
*/
|
|
1494
|
+
name: string;
|
|
1495
|
+
/**
|
|
1496
|
+
* Unregulated writer auth method
|
|
1497
|
+
*/
|
|
1498
|
+
unregulated_db_writer_auth_method: 'password' | 'iam_role';
|
|
1499
|
+
/**
|
|
1500
|
+
* Unregulated reader DB name
|
|
1501
|
+
*/
|
|
1502
|
+
unregulated_db_reader_name: string;
|
|
1503
|
+
/**
|
|
1504
|
+
* Regulated writer DB name
|
|
1505
|
+
*/
|
|
1506
|
+
regulated_data_db_writer_name: string;
|
|
1507
|
+
/**
|
|
1508
|
+
* Unregulated writer DB host
|
|
1509
|
+
*/
|
|
1510
|
+
unregulated_db_writer_host: string;
|
|
1511
|
+
/**
|
|
1512
|
+
* Regulated reader DB schema name
|
|
1513
|
+
*/
|
|
1514
|
+
regulated_data_db_reader_schema: string;
|
|
1515
|
+
/**
|
|
1516
|
+
* Unregulated writer DB name
|
|
1517
|
+
*/
|
|
1518
|
+
unregulated_db_writer_name: string;
|
|
1519
|
+
/**
|
|
1520
|
+
* Unregulated writer DB schema name
|
|
1521
|
+
*/
|
|
1522
|
+
unregulated_db_writer_schema: string;
|
|
1523
|
+
/**
|
|
1524
|
+
* Regulated reader DB port
|
|
1525
|
+
*/
|
|
1526
|
+
regulated_data_db_reader_port: number;
|
|
1527
|
+
/**
|
|
1528
|
+
* Regulated reader DB name
|
|
1529
|
+
*/
|
|
1530
|
+
regulated_data_db_reader_name: string;
|
|
1531
|
+
/**
|
|
1532
|
+
* Regulated reader DB host
|
|
1533
|
+
*/
|
|
1534
|
+
regulated_data_db_reader_host: string;
|
|
1535
|
+
/**
|
|
1536
|
+
* Unregulated reader auth method
|
|
1537
|
+
*/
|
|
1538
|
+
unregulated_db_reader_auth_method: 'password' | 'iam_role';
|
|
1539
|
+
/**
|
|
1540
|
+
* URL-friendly slug
|
|
1541
|
+
*/
|
|
1542
|
+
slug?: string;
|
|
1543
|
+
};
|
|
1544
|
+
/**
|
|
1545
|
+
* DataSourceResponse
|
|
1546
|
+
*
|
|
1547
|
+
* Data source — connection to a third-party system or API
|
|
1548
|
+
*/
|
|
1549
|
+
export type DataSourceResponseWritable = {
|
|
1550
|
+
datalake?: DatalakeResponseWritable;
|
|
1551
|
+
/**
|
|
1552
|
+
* Data source description
|
|
1553
|
+
*/
|
|
1554
|
+
description?: string | null;
|
|
1555
|
+
/**
|
|
1556
|
+
* Data Source ID
|
|
1557
|
+
*/
|
|
1558
|
+
id?: string;
|
|
1559
|
+
/**
|
|
1560
|
+
* Image URL
|
|
1561
|
+
*/
|
|
1562
|
+
image_url?: string | null;
|
|
1563
|
+
/**
|
|
1564
|
+
* Creation timestamp
|
|
1565
|
+
*/
|
|
1566
|
+
inserted_at?: string;
|
|
1567
|
+
/**
|
|
1568
|
+
* Whether this is the default data source
|
|
1569
|
+
*/
|
|
1570
|
+
is_default: boolean;
|
|
1571
|
+
/**
|
|
1572
|
+
* Data source name
|
|
1573
|
+
*/
|
|
1574
|
+
name: string;
|
|
1575
|
+
/**
|
|
1576
|
+
* Data source status
|
|
1577
|
+
*/
|
|
1578
|
+
status: 'draft' | 'active' | 'inactive';
|
|
1579
|
+
/**
|
|
1580
|
+
* Last update timestamp
|
|
1581
|
+
*/
|
|
1582
|
+
updated_at?: string;
|
|
1583
|
+
/**
|
|
1584
|
+
* Data source URI
|
|
1585
|
+
*/
|
|
1586
|
+
uri: string;
|
|
1587
|
+
};
|
|
1588
|
+
/**
|
|
1589
|
+
* RESTAPIBody
|
|
1590
|
+
*
|
|
1591
|
+
* REST API tool configuration with multiple auth methods.
|
|
1592
|
+
*/
|
|
1593
|
+
export type RestapiBodyWritable = {
|
|
1594
|
+
/**
|
|
1595
|
+
* Polymorphic discriminator
|
|
1596
|
+
*/
|
|
1597
|
+
__type__: 'rest_api';
|
|
1598
|
+
api_key?: string;
|
|
1599
|
+
api_key_location?: 'header' | 'query';
|
|
1600
|
+
api_key_name?: string;
|
|
1601
|
+
auth_method: 'none' | 'api_key' | 'basic' | 'bearer' | 'oauth2' | 'oidc';
|
|
1602
|
+
/**
|
|
1603
|
+
* Base URL (https)
|
|
1604
|
+
*/
|
|
1605
|
+
base_url: string;
|
|
1606
|
+
bearer_token?: string;
|
|
1607
|
+
oauth2_client_id?: string;
|
|
1608
|
+
oauth2_client_secret?: string;
|
|
1609
|
+
oauth2_grant_type?: 'client_credentials' | 'authorization_code';
|
|
1610
|
+
oauth2_scope?: string | null;
|
|
1611
|
+
oauth2_token_ttl?: number;
|
|
1612
|
+
oauth2_token_url?: string;
|
|
1613
|
+
oidc_client_id?: string;
|
|
1614
|
+
oidc_client_secret?: string;
|
|
1615
|
+
oidc_issuer_url?: string;
|
|
1616
|
+
oidc_token_ttl?: number;
|
|
1617
|
+
password?: string;
|
|
1618
|
+
request_type: 'json' | 'xml' | 'form_urlencoded' | 'multipart_form';
|
|
1619
|
+
response_type: 'json' | 'xml' | 'text' | 'binary';
|
|
1620
|
+
timeout_ms?: number;
|
|
1621
|
+
username?: string;
|
|
1622
|
+
};
|
|
1623
|
+
/**
|
|
1624
|
+
* AiAgentListResponse
|
|
1625
|
+
*
|
|
1626
|
+
* Paginated list of AI agents
|
|
1627
|
+
*/
|
|
1628
|
+
export type AiAgentListResponseWritable = {
|
|
1629
|
+
/**
|
|
1630
|
+
* List of AI agents
|
|
1631
|
+
*/
|
|
1632
|
+
data: Array<AiAgentResponseWritable>;
|
|
1633
|
+
meta: PaginationMeta;
|
|
1634
|
+
};
|
|
1635
|
+
/**
|
|
1636
|
+
* ActionStatusUpdaterRequest
|
|
1637
|
+
*
|
|
1638
|
+
* Action Status Updater — automated polling for delivery status updates. Request
|
|
1639
|
+
*/
|
|
1640
|
+
export type ActionStatusUpdaterRequestWritable = {
|
|
1641
|
+
/**
|
|
1642
|
+
* Cron schedule expression (e.g. "*30 * * * *")
|
|
1643
|
+
*/
|
|
1644
|
+
cron_expression?: string;
|
|
1645
|
+
/**
|
|
1646
|
+
* Datalake ID
|
|
1647
|
+
*/
|
|
1648
|
+
datalake_id?: string;
|
|
1649
|
+
/**
|
|
1650
|
+
* Updater name
|
|
1651
|
+
*/
|
|
1652
|
+
name?: string;
|
|
1653
|
+
/**
|
|
1654
|
+
* IDs of sender tools whose messages this updater monitors
|
|
1655
|
+
*/
|
|
1656
|
+
sender_tool_ids?: Array<string> | null;
|
|
1657
|
+
/**
|
|
1658
|
+
* Tool providing auth credentials for polling
|
|
1659
|
+
*/
|
|
1660
|
+
updater_tool_id?: string;
|
|
1661
|
+
/**
|
|
1662
|
+
* Updater type — determines the updater_body shape
|
|
1663
|
+
*/
|
|
1664
|
+
updater_type?: 'cloud_watch' | 'restapi';
|
|
1665
|
+
};
|
|
1666
|
+
/**
|
|
1667
|
+
* AiAgentResponse
|
|
1668
|
+
*
|
|
1669
|
+
* AI Agent configuration — reusable chat-completion resource
|
|
1670
|
+
*/
|
|
1671
|
+
export type AiAgentResponseWritable = {
|
|
1672
|
+
/**
|
|
1673
|
+
* Data access level
|
|
1674
|
+
*/
|
|
1675
|
+
data_access: 'regulated' | 'unregulated';
|
|
1676
|
+
datalake?: DatalakeResponseWritable;
|
|
1677
|
+
/**
|
|
1678
|
+
* Agent description
|
|
1679
|
+
*/
|
|
1680
|
+
description?: string | null;
|
|
1681
|
+
/**
|
|
1682
|
+
* Whether the agent is enabled
|
|
1683
|
+
*/
|
|
1684
|
+
enabled: boolean;
|
|
1685
|
+
/**
|
|
1686
|
+
* AI Agent ID
|
|
1687
|
+
*/
|
|
1688
|
+
id?: string;
|
|
1689
|
+
/**
|
|
1690
|
+
* Creation timestamp
|
|
1691
|
+
*/
|
|
1692
|
+
inserted_at?: string;
|
|
1693
|
+
/**
|
|
1694
|
+
* Maximum tokens for LLM response
|
|
1695
|
+
*/
|
|
1696
|
+
max_tokens: number;
|
|
1697
|
+
/**
|
|
1698
|
+
* LLM model identifier
|
|
1699
|
+
*/
|
|
1700
|
+
model: string;
|
|
1701
|
+
/**
|
|
1702
|
+
* Agent name
|
|
1703
|
+
*/
|
|
1704
|
+
name: string;
|
|
1705
|
+
/**
|
|
1706
|
+
* URL-friendly slug
|
|
1707
|
+
*/
|
|
1708
|
+
slug?: string;
|
|
1709
|
+
/**
|
|
1710
|
+
* Sampling temperature (0.0–2.0)
|
|
1711
|
+
*/
|
|
1712
|
+
temperature: number;
|
|
1713
|
+
tool?: ToolResponseWritable;
|
|
1714
|
+
/**
|
|
1715
|
+
* Tool ID
|
|
1716
|
+
*/
|
|
1717
|
+
tool_id: string;
|
|
1718
|
+
/**
|
|
1719
|
+
* Last update timestamp
|
|
1720
|
+
*/
|
|
1721
|
+
updated_at?: string;
|
|
1722
|
+
};
|
|
1723
|
+
/**
|
|
1724
|
+
* AWSLambdaBody
|
|
1725
|
+
*
|
|
1726
|
+
* AWS Lambda tool configuration (managed or external).
|
|
1727
|
+
*/
|
|
1728
|
+
export type AwsLambdaBodyWritable = {
|
|
1729
|
+
/**
|
|
1730
|
+
* Polymorphic discriminator
|
|
1731
|
+
*/
|
|
1732
|
+
__type__: 'aws_lambda';
|
|
1733
|
+
access_key_id?: string;
|
|
1734
|
+
auth_method?: 'access_key' | 'iam_role' | 'cloudformation';
|
|
1735
|
+
/**
|
|
1736
|
+
* Lambda function ARN (external type)
|
|
1737
|
+
*/
|
|
1738
|
+
function_arn?: string;
|
|
1739
|
+
secret_access_key?: string;
|
|
1740
|
+
/**
|
|
1741
|
+
* SSM config key (managed type)
|
|
1742
|
+
*/
|
|
1743
|
+
ssm_config_key?: string;
|
|
1744
|
+
type: 'managed' | 'external';
|
|
1745
|
+
};
|
|
1746
|
+
/**
|
|
1747
|
+
* ActionStatusUpdaterListResponse
|
|
1748
|
+
*
|
|
1749
|
+
* Paginated list of action status updaters
|
|
1750
|
+
*/
|
|
1751
|
+
export type ActionStatusUpdaterListResponseWritable = {
|
|
1752
|
+
/**
|
|
1753
|
+
* List of action status updaters
|
|
1754
|
+
*/
|
|
1755
|
+
data: Array<ActionStatusUpdaterResponseWritable>;
|
|
1756
|
+
meta: PaginationMeta;
|
|
1757
|
+
};
|
|
1758
|
+
/**
|
|
1759
|
+
* SQSBody
|
|
1760
|
+
*
|
|
1761
|
+
* AWS SQS queue configuration.
|
|
1762
|
+
*/
|
|
1763
|
+
export type SqsBodyWritable = {
|
|
1764
|
+
/**
|
|
1765
|
+
* Polymorphic discriminator
|
|
1766
|
+
*/
|
|
1767
|
+
__type__: 'sqs';
|
|
1768
|
+
access_key_id?: string;
|
|
1769
|
+
auth_method: 'access_key' | 'iam_role';
|
|
1770
|
+
fifo?: boolean;
|
|
1771
|
+
queue_name?: string | null;
|
|
1772
|
+
/**
|
|
1773
|
+
* Full SQS queue URL
|
|
1774
|
+
*/
|
|
1775
|
+
queue_url: string;
|
|
1776
|
+
region: string;
|
|
1777
|
+
secret_access_key?: string;
|
|
1778
|
+
};
|
|
1779
|
+
/**
|
|
1780
|
+
* GenericTableResponse
|
|
1781
|
+
*
|
|
1782
|
+
* Generic Table — custom or system dataset table with column definitions.
|
|
1783
|
+
*/
|
|
1784
|
+
export type GenericTableResponseWritable = {
|
|
1785
|
+
/**
|
|
1786
|
+
* Table column definitions
|
|
1787
|
+
*/
|
|
1788
|
+
columns?: Array<unknown>;
|
|
1789
|
+
/**
|
|
1790
|
+
* Industry data domain
|
|
1791
|
+
*/
|
|
1792
|
+
data_domain?: 'healthcare' | 'core_banking' | 'payment_risk' | 'accounts_receivable' | 'service_commerce' | 'trading';
|
|
1793
|
+
/**
|
|
1794
|
+
* Table description
|
|
1795
|
+
*/
|
|
1796
|
+
description?: string;
|
|
1797
|
+
/**
|
|
1798
|
+
* User-friendly table title
|
|
1799
|
+
*/
|
|
1800
|
+
title?: string;
|
|
1801
|
+
};
|
|
1802
|
+
/**
|
|
1803
|
+
* DatalakeListResponse
|
|
1804
|
+
*
|
|
1805
|
+
* Paginated list of datalakes
|
|
1806
|
+
*/
|
|
1807
|
+
export type DatalakeListResponseWritable = {
|
|
1808
|
+
/**
|
|
1809
|
+
* List of datalakes
|
|
1810
|
+
*/
|
|
1811
|
+
data: Array<DatalakeResponseWritable>;
|
|
1812
|
+
meta: PaginationMeta;
|
|
1813
|
+
};
|
|
1814
|
+
/**
|
|
1815
|
+
* SFTPBody
|
|
1816
|
+
*
|
|
1817
|
+
* SFTP server connection configuration.
|
|
1818
|
+
*/
|
|
1819
|
+
export type SftpBodyWritable = {
|
|
1820
|
+
/**
|
|
1821
|
+
* Polymorphic discriminator
|
|
1822
|
+
*/
|
|
1823
|
+
__type__: 'sftp';
|
|
1824
|
+
auth_method: 'password' | 'ssh_key';
|
|
1825
|
+
base_path: string;
|
|
1826
|
+
host: string;
|
|
1827
|
+
password?: string;
|
|
1828
|
+
port: number;
|
|
1829
|
+
private_key?: string;
|
|
1830
|
+
private_key_passphrase?: string | null;
|
|
1831
|
+
user_name: string;
|
|
1832
|
+
};
|
|
1833
|
+
/**
|
|
1834
|
+
* ToolListResponse
|
|
1835
|
+
*
|
|
1836
|
+
* Paginated list of tools
|
|
1837
|
+
*/
|
|
1838
|
+
export type ToolListResponseWritable = {
|
|
1839
|
+
/**
|
|
1840
|
+
* List of tools
|
|
1841
|
+
*/
|
|
1842
|
+
data: Array<ToolResponseWritable>;
|
|
1843
|
+
meta: PaginationMeta;
|
|
1844
|
+
};
|
|
1845
|
+
/**
|
|
1846
|
+
* CloudWatchLogGroupBody
|
|
1847
|
+
*
|
|
1848
|
+
* AWS CloudWatch Logs authentication configuration.
|
|
1849
|
+
*/
|
|
1850
|
+
export type CloudWatchLogGroupBodyWritable = {
|
|
1851
|
+
/**
|
|
1852
|
+
* Polymorphic discriminator
|
|
1853
|
+
*/
|
|
1854
|
+
__type__: 'cloud_watch_log_group';
|
|
1855
|
+
access_key_id?: string;
|
|
1856
|
+
assume_role_arn?: string | null;
|
|
1857
|
+
assume_role_external_id?: string | null;
|
|
1858
|
+
auth_method: 'access_key' | 'iam_role' | 'assume_role';
|
|
1859
|
+
endpoint_url?: string | null;
|
|
1860
|
+
region: string;
|
|
1861
|
+
secret_access_key?: string;
|
|
1862
|
+
};
|
|
1863
|
+
/**
|
|
1864
|
+
* DataSourceListResponse
|
|
1865
|
+
*
|
|
1866
|
+
* Paginated list of data sources
|
|
1867
|
+
*/
|
|
1868
|
+
export type DataSourceListResponseWritable = {
|
|
1869
|
+
/**
|
|
1870
|
+
* List of data sources
|
|
1871
|
+
*/
|
|
1872
|
+
data: Array<DataSourceResponseWritable>;
|
|
1873
|
+
meta: PaginationMeta;
|
|
1874
|
+
};
|
|
1875
|
+
/**
|
|
1876
|
+
* ToolResponse
|
|
1877
|
+
*
|
|
1878
|
+
* Tool — a configurable capability reference for external services.
|
|
1879
|
+
*/
|
|
1880
|
+
export type ToolResponseWritable = {
|
|
1881
|
+
/**
|
|
1882
|
+
* Data Source ID
|
|
1883
|
+
*/
|
|
1884
|
+
data_source_id?: string | null;
|
|
1885
|
+
/**
|
|
1886
|
+
* Datalake ID
|
|
1887
|
+
*/
|
|
1888
|
+
datalake_id?: string;
|
|
1889
|
+
/**
|
|
1890
|
+
* Tool description
|
|
1891
|
+
*/
|
|
1892
|
+
description?: string | null;
|
|
1893
|
+
/**
|
|
1894
|
+
* Tool intent — what category of capability the tool provides
|
|
1895
|
+
*/
|
|
1896
|
+
intent?: 'sms' | 'email' | 'export' | 'voice' | 'data_exchange' | 'status_poller' | 'chat_completion' | 'context_extraction';
|
|
1897
|
+
/**
|
|
1898
|
+
* Tool name
|
|
1899
|
+
*/
|
|
1900
|
+
name?: string;
|
|
1901
|
+
/**
|
|
1902
|
+
* Tool status
|
|
1903
|
+
*/
|
|
1904
|
+
status?: 'draft' | 'active' | 'inactive' | 'error' | 'marked_for_deletion';
|
|
1905
|
+
};
|
|
1906
|
+
/**
|
|
1907
|
+
* EmailBody
|
|
1908
|
+
*
|
|
1909
|
+
* Email provider configuration (SES, Mailgun, SendGrid, SMTP).
|
|
1910
|
+
*/
|
|
1911
|
+
export type EmailBodyWritable = {
|
|
1912
|
+
/**
|
|
1913
|
+
* Polymorphic discriminator
|
|
1914
|
+
*/
|
|
1915
|
+
__type__: 'email';
|
|
1916
|
+
/**
|
|
1917
|
+
* AWS access key (SES)
|
|
1918
|
+
*/
|
|
1919
|
+
access_key_id?: string;
|
|
1920
|
+
/**
|
|
1921
|
+
* API key (Mailgun/SendGrid)
|
|
1922
|
+
*/
|
|
1923
|
+
api_key?: string;
|
|
1924
|
+
/**
|
|
1925
|
+
* Domain (Mailgun)
|
|
1926
|
+
*/
|
|
1927
|
+
domain?: string;
|
|
1928
|
+
from_email: string;
|
|
1929
|
+
from_name?: string | null;
|
|
1930
|
+
provider: 'ses' | 'mailgun' | 'sendgrid' | 'smtp';
|
|
1931
|
+
/**
|
|
1932
|
+
* AWS region (SES)
|
|
1933
|
+
*/
|
|
1934
|
+
region?: string;
|
|
1935
|
+
reply_to?: string | null;
|
|
1936
|
+
secret_access_key?: string;
|
|
1937
|
+
smtp_host?: string;
|
|
1938
|
+
smtp_password?: string;
|
|
1939
|
+
smtp_port?: number;
|
|
1940
|
+
smtp_username?: string;
|
|
1941
|
+
};
|
|
1942
|
+
/**
|
|
1943
|
+
* DatalakeResponse
|
|
1944
|
+
*
|
|
1945
|
+
* Datalake configuration. Secrets (DB passwords, credentials) are write-only — accepted on create but never returned in responses.
|
|
1946
|
+
*/
|
|
1947
|
+
export type DatalakeResponseWritable = {
|
|
1948
|
+
/**
|
|
1949
|
+
* Industry data domain
|
|
1950
|
+
*/
|
|
1951
|
+
data_domain: 'healthcare' | 'core_banking' | 'payment_risk' | 'accounts_receivable' | 'service_commerce' | 'trading';
|
|
1952
|
+
/**
|
|
1953
|
+
* IANA timezone
|
|
1954
|
+
*/
|
|
1955
|
+
timezone: string | null;
|
|
1956
|
+
/**
|
|
1957
|
+
* Regulated reader auth method
|
|
1958
|
+
*/
|
|
1959
|
+
regulated_data_db_reader_auth_method: 'password' | 'iam_role';
|
|
1960
|
+
/**
|
|
1961
|
+
* Regulated writer DB host
|
|
1962
|
+
*/
|
|
1963
|
+
regulated_data_db_writer_host: string;
|
|
1964
|
+
/**
|
|
1965
|
+
* Regulated writer auth method
|
|
1966
|
+
*/
|
|
1967
|
+
regulated_data_db_writer_auth_method: 'password' | 'iam_role';
|
|
1968
|
+
/**
|
|
1969
|
+
* Regulated writer DB schema name
|
|
1970
|
+
*/
|
|
1971
|
+
regulated_data_db_writer_schema: string;
|
|
1972
|
+
/**
|
|
1973
|
+
* Enable SSL for regulated writer
|
|
1974
|
+
*/
|
|
1975
|
+
regulated_data_db_writer_enable_ssl: boolean;
|
|
1976
|
+
/**
|
|
1977
|
+
* Unregulated reader DB schema name
|
|
1978
|
+
*/
|
|
1979
|
+
unregulated_db_reader_schema: string;
|
|
1980
|
+
/**
|
|
1981
|
+
* Enable SSL for unregulated writer
|
|
1982
|
+
*/
|
|
1983
|
+
unregulated_db_writer_enable_ssl: boolean;
|
|
1984
|
+
/**
|
|
1985
|
+
* Unregulated writer DB port
|
|
1986
|
+
*/
|
|
1987
|
+
unregulated_db_writer_port: number;
|
|
1988
|
+
/**
|
|
1989
|
+
* Regulated writer DB port
|
|
1990
|
+
*/
|
|
1991
|
+
regulated_data_db_writer_port: number;
|
|
1992
|
+
/**
|
|
1993
|
+
* Enable SSL for unregulated reader
|
|
1994
|
+
*/
|
|
1995
|
+
unregulated_db_reader_enable_ssl: boolean;
|
|
1996
|
+
/**
|
|
1997
|
+
* Enable SSL for regulated reader
|
|
1998
|
+
*/
|
|
1999
|
+
regulated_data_db_reader_enable_ssl: boolean;
|
|
2000
|
+
/**
|
|
2001
|
+
* Unregulated reader DB host
|
|
2002
|
+
*/
|
|
2003
|
+
unregulated_db_reader_host: string;
|
|
2004
|
+
/**
|
|
2005
|
+
* Unregulated reader DB port
|
|
2006
|
+
*/
|
|
2007
|
+
unregulated_db_reader_port: number;
|
|
2008
|
+
/**
|
|
2009
|
+
* Database connection pool size
|
|
2010
|
+
*/
|
|
2011
|
+
pool_size: number | null;
|
|
2012
|
+
/**
|
|
2013
|
+
* Datalake description
|
|
2014
|
+
*/
|
|
2015
|
+
description?: string | null;
|
|
2016
|
+
/**
|
|
2017
|
+
* Datalake name
|
|
2018
|
+
*/
|
|
2019
|
+
name: string;
|
|
2020
|
+
/**
|
|
2021
|
+
* Unregulated writer auth method
|
|
2022
|
+
*/
|
|
2023
|
+
unregulated_db_writer_auth_method: 'password' | 'iam_role';
|
|
2024
|
+
/**
|
|
2025
|
+
* Unregulated reader DB name
|
|
2026
|
+
*/
|
|
2027
|
+
unregulated_db_reader_name: string;
|
|
2028
|
+
/**
|
|
2029
|
+
* Regulated writer DB name
|
|
2030
|
+
*/
|
|
2031
|
+
regulated_data_db_writer_name: string;
|
|
2032
|
+
/**
|
|
2033
|
+
* Unregulated writer DB host
|
|
2034
|
+
*/
|
|
2035
|
+
unregulated_db_writer_host: string;
|
|
2036
|
+
/**
|
|
2037
|
+
* Regulated reader DB schema name
|
|
2038
|
+
*/
|
|
2039
|
+
regulated_data_db_reader_schema: string;
|
|
2040
|
+
/**
|
|
2041
|
+
* Unregulated writer DB name
|
|
2042
|
+
*/
|
|
2043
|
+
unregulated_db_writer_name: string;
|
|
2044
|
+
/**
|
|
2045
|
+
* Unregulated writer DB schema name
|
|
2046
|
+
*/
|
|
2047
|
+
unregulated_db_writer_schema: string;
|
|
2048
|
+
/**
|
|
2049
|
+
* Regulated reader DB port
|
|
2050
|
+
*/
|
|
2051
|
+
regulated_data_db_reader_port: number;
|
|
2052
|
+
/**
|
|
2053
|
+
* Regulated reader DB name
|
|
2054
|
+
*/
|
|
2055
|
+
regulated_data_db_reader_name: string;
|
|
2056
|
+
/**
|
|
2057
|
+
* Regulated reader DB host
|
|
2058
|
+
*/
|
|
2059
|
+
regulated_data_db_reader_host: string;
|
|
2060
|
+
/**
|
|
2061
|
+
* Unregulated reader auth method
|
|
2062
|
+
*/
|
|
2063
|
+
unregulated_db_reader_auth_method: 'password' | 'iam_role';
|
|
2064
|
+
/**
|
|
2065
|
+
* URL-friendly slug
|
|
2066
|
+
*/
|
|
2067
|
+
slug?: string;
|
|
2068
|
+
};
|
|
2069
|
+
/**
|
|
2070
|
+
* GenericTableRequest
|
|
2071
|
+
*
|
|
2072
|
+
* Generic Table — custom or system dataset table with column definitions. Request
|
|
2073
|
+
*/
|
|
2074
|
+
export type GenericTableRequestWritable = {
|
|
2075
|
+
/**
|
|
2076
|
+
* Table column definitions
|
|
2077
|
+
*/
|
|
2078
|
+
columns?: Array<unknown>;
|
|
2079
|
+
/**
|
|
2080
|
+
* Industry data domain
|
|
2081
|
+
*/
|
|
2082
|
+
data_domain?: 'healthcare' | 'core_banking' | 'payment_risk' | 'accounts_receivable' | 'service_commerce' | 'trading';
|
|
2083
|
+
/**
|
|
2084
|
+
* Table description
|
|
2085
|
+
*/
|
|
2086
|
+
description?: string;
|
|
2087
|
+
/**
|
|
2088
|
+
* User-friendly table title
|
|
2089
|
+
*/
|
|
2090
|
+
title?: string;
|
|
2091
|
+
};
|
|
2092
|
+
/**
|
|
2093
|
+
* GenericTableListResponse
|
|
2094
|
+
*
|
|
2095
|
+
* Paginated list of generic tables
|
|
2096
|
+
*/
|
|
2097
|
+
export type GenericTableListResponseWritable = {
|
|
2098
|
+
/**
|
|
2099
|
+
* List of generic tables
|
|
2100
|
+
*/
|
|
2101
|
+
data: Array<GenericTableResponseWritable>;
|
|
2102
|
+
meta: PaginationMeta;
|
|
2103
|
+
};
|
|
2104
|
+
/**
|
|
2105
|
+
* SharePointBody
|
|
2106
|
+
*
|
|
2107
|
+
* Microsoft SharePoint integration configuration.
|
|
2108
|
+
*/
|
|
2109
|
+
export type SharePointBodyWritable = {
|
|
2110
|
+
/**
|
|
2111
|
+
* Polymorphic discriminator
|
|
2112
|
+
*/
|
|
2113
|
+
__type__: 'sharepoint';
|
|
2114
|
+
auth_method: 'client_credentials' | 'managed_identity';
|
|
2115
|
+
client_id?: string;
|
|
2116
|
+
client_secret?: string;
|
|
2117
|
+
drive_id?: string | null;
|
|
2118
|
+
drive_path?: string | null;
|
|
2119
|
+
resource_type: 'site' | 'library' | 'list';
|
|
2120
|
+
site_url?: string | null;
|
|
2121
|
+
/**
|
|
2122
|
+
* Microsoft tenant ID
|
|
2123
|
+
*/
|
|
2124
|
+
tenant_id: string;
|
|
2125
|
+
};
|
|
2126
|
+
/**
|
|
2127
|
+
* AiAgentRequest
|
|
2128
|
+
*
|
|
2129
|
+
* AI Agent configuration — reusable chat-completion resource Request
|
|
2130
|
+
*/
|
|
2131
|
+
export type AiAgentRequestWritable = {
|
|
2132
|
+
/**
|
|
2133
|
+
* Data access level
|
|
2134
|
+
*/
|
|
2135
|
+
data_access: 'regulated' | 'unregulated';
|
|
2136
|
+
/**
|
|
2137
|
+
* Agent description
|
|
2138
|
+
*/
|
|
2139
|
+
description?: string | null;
|
|
2140
|
+
/**
|
|
2141
|
+
* Whether the agent is enabled
|
|
2142
|
+
*/
|
|
2143
|
+
enabled: boolean;
|
|
2144
|
+
/**
|
|
2145
|
+
* AI Agent ID
|
|
2146
|
+
*/
|
|
2147
|
+
id?: string;
|
|
2148
|
+
/**
|
|
2149
|
+
* Creation timestamp
|
|
2150
|
+
*/
|
|
2151
|
+
inserted_at?: string;
|
|
2152
|
+
/**
|
|
2153
|
+
* Maximum tokens for LLM response
|
|
2154
|
+
*/
|
|
2155
|
+
max_tokens: number;
|
|
2156
|
+
/**
|
|
2157
|
+
* LLM model identifier
|
|
2158
|
+
*/
|
|
2159
|
+
model: string;
|
|
2160
|
+
/**
|
|
2161
|
+
* Agent name
|
|
2162
|
+
*/
|
|
2163
|
+
name: string;
|
|
2164
|
+
/**
|
|
2165
|
+
* URL-friendly slug
|
|
2166
|
+
*/
|
|
2167
|
+
slug?: string;
|
|
2168
|
+
/**
|
|
2169
|
+
* Sampling temperature (0.0–2.0)
|
|
2170
|
+
*/
|
|
2171
|
+
temperature: number;
|
|
2172
|
+
/**
|
|
2173
|
+
* Tool ID
|
|
2174
|
+
*/
|
|
2175
|
+
tool_id: string;
|
|
2176
|
+
/**
|
|
2177
|
+
* Last update timestamp
|
|
2178
|
+
*/
|
|
2179
|
+
updated_at?: string;
|
|
2180
|
+
};
|
|
2181
|
+
/**
|
|
2182
|
+
* ToolRequest
|
|
2183
|
+
*
|
|
2184
|
+
* Tool — a configurable capability reference for external services. Request
|
|
2185
|
+
*/
|
|
2186
|
+
export type ToolRequestWritable = {
|
|
2187
|
+
/**
|
|
2188
|
+
* Tool body configuration (polymorphic — type determined by __type__ field)
|
|
2189
|
+
*/
|
|
2190
|
+
body?: {
|
|
2191
|
+
/**
|
|
2192
|
+
* Polymorphic discriminator
|
|
2193
|
+
*/
|
|
2194
|
+
__type__: 'sns';
|
|
2195
|
+
/**
|
|
2196
|
+
* AWS access key ID
|
|
2197
|
+
*/
|
|
2198
|
+
access_key_id?: string;
|
|
2199
|
+
assume_role_arn?: string | null;
|
|
2200
|
+
assume_role_external_id?: string | null;
|
|
2201
|
+
auth_method: 'access_key' | 'iam_role' | 'assume_role';
|
|
2202
|
+
/**
|
|
2203
|
+
* Custom SNS endpoint
|
|
2204
|
+
*/
|
|
2205
|
+
endpoint_url?: string | null;
|
|
2206
|
+
/**
|
|
2207
|
+
* E.164 phone number
|
|
2208
|
+
*/
|
|
2209
|
+
phone_number: string;
|
|
2210
|
+
/**
|
|
2211
|
+
* AWS region
|
|
2212
|
+
*/
|
|
2213
|
+
region: string;
|
|
2214
|
+
secret_access_key?: string;
|
|
2215
|
+
} | {
|
|
2216
|
+
/**
|
|
2217
|
+
* Polymorphic discriminator
|
|
2218
|
+
*/
|
|
2219
|
+
__type__: 'rest_api';
|
|
2220
|
+
api_key?: string;
|
|
2221
|
+
api_key_location?: 'header' | 'query';
|
|
2222
|
+
api_key_name?: string;
|
|
2223
|
+
auth_method: 'none' | 'api_key' | 'basic' | 'bearer' | 'oauth2' | 'oidc';
|
|
2224
|
+
/**
|
|
2225
|
+
* Base URL (https)
|
|
2226
|
+
*/
|
|
2227
|
+
base_url: string;
|
|
2228
|
+
bearer_token?: string;
|
|
2229
|
+
oauth2_client_id?: string;
|
|
2230
|
+
oauth2_client_secret?: string;
|
|
2231
|
+
oauth2_grant_type?: 'client_credentials' | 'authorization_code';
|
|
2232
|
+
oauth2_scope?: string | null;
|
|
2233
|
+
oauth2_token_ttl?: number;
|
|
2234
|
+
oauth2_token_url?: string;
|
|
2235
|
+
oidc_client_id?: string;
|
|
2236
|
+
oidc_client_secret?: string;
|
|
2237
|
+
oidc_issuer_url?: string;
|
|
2238
|
+
oidc_token_ttl?: number;
|
|
2239
|
+
password?: string;
|
|
2240
|
+
request_type: 'json' | 'xml' | 'form_urlencoded' | 'multipart_form';
|
|
2241
|
+
response_type: 'json' | 'xml' | 'text' | 'binary';
|
|
2242
|
+
timeout_ms?: number;
|
|
2243
|
+
username?: string;
|
|
2244
|
+
} | {
|
|
2245
|
+
/**
|
|
2246
|
+
* Polymorphic discriminator
|
|
2247
|
+
*/
|
|
2248
|
+
__type__: 'aws_lambda';
|
|
2249
|
+
access_key_id?: string;
|
|
2250
|
+
auth_method?: 'access_key' | 'iam_role' | 'cloudformation';
|
|
2251
|
+
/**
|
|
2252
|
+
* Lambda function ARN (external type)
|
|
2253
|
+
*/
|
|
2254
|
+
function_arn?: string;
|
|
2255
|
+
secret_access_key?: string;
|
|
2256
|
+
/**
|
|
2257
|
+
* SSM config key (managed type)
|
|
2258
|
+
*/
|
|
2259
|
+
ssm_config_key?: string;
|
|
2260
|
+
type: 'managed' | 'external';
|
|
2261
|
+
} | {
|
|
2262
|
+
/**
|
|
2263
|
+
* Polymorphic discriminator
|
|
2264
|
+
*/
|
|
2265
|
+
__type__: 's3';
|
|
2266
|
+
/**
|
|
2267
|
+
* Provider config — must include __type__ ("aws" or "r2")
|
|
2268
|
+
*/
|
|
2269
|
+
config: {
|
|
2270
|
+
__type__: 'aws' | 'r2';
|
|
2271
|
+
access_key_id?: string;
|
|
2272
|
+
base_path?: string | null;
|
|
2273
|
+
bucket: string;
|
|
2274
|
+
endpoint?: string | null;
|
|
2275
|
+
region?: string;
|
|
2276
|
+
secret_access_key?: string;
|
|
2277
|
+
};
|
|
2278
|
+
} | {
|
|
2279
|
+
/**
|
|
2280
|
+
* Polymorphic discriminator
|
|
2281
|
+
*/
|
|
2282
|
+
__type__: 'sftp';
|
|
2283
|
+
auth_method: 'password' | 'ssh_key';
|
|
2284
|
+
base_path: string;
|
|
2285
|
+
host: string;
|
|
2286
|
+
password?: string;
|
|
2287
|
+
port: number;
|
|
2288
|
+
private_key?: string;
|
|
2289
|
+
private_key_passphrase?: string | null;
|
|
2290
|
+
user_name: string;
|
|
2291
|
+
} | {
|
|
2292
|
+
/**
|
|
2293
|
+
* Polymorphic discriminator
|
|
2294
|
+
*/
|
|
2295
|
+
__type__: 'sql_database';
|
|
2296
|
+
db_host: string;
|
|
2297
|
+
db_name: string;
|
|
2298
|
+
db_type: 'postgres' | 'mysql' | 'mssql' | 'sqlite' | 'snowflake';
|
|
2299
|
+
password: string;
|
|
2300
|
+
pool_size?: number;
|
|
2301
|
+
port?: number;
|
|
2302
|
+
ssl?: boolean;
|
|
2303
|
+
ssl_mode?: string | null;
|
|
2304
|
+
user_name: string;
|
|
2305
|
+
} | {
|
|
2306
|
+
/**
|
|
2307
|
+
* Polymorphic discriminator
|
|
2308
|
+
*/
|
|
2309
|
+
__type__: 'sqs';
|
|
2310
|
+
access_key_id?: string;
|
|
2311
|
+
auth_method: 'access_key' | 'iam_role';
|
|
2312
|
+
fifo?: boolean;
|
|
2313
|
+
queue_name?: string | null;
|
|
2314
|
+
/**
|
|
2315
|
+
* Full SQS queue URL
|
|
2316
|
+
*/
|
|
2317
|
+
queue_url: string;
|
|
2318
|
+
region: string;
|
|
2319
|
+
secret_access_key?: string;
|
|
2320
|
+
} | {
|
|
2321
|
+
/**
|
|
2322
|
+
* Polymorphic discriminator
|
|
2323
|
+
*/
|
|
2324
|
+
__type__: 'sharepoint';
|
|
2325
|
+
auth_method: 'client_credentials' | 'managed_identity';
|
|
2326
|
+
client_id?: string;
|
|
2327
|
+
client_secret?: string;
|
|
2328
|
+
drive_id?: string | null;
|
|
2329
|
+
drive_path?: string | null;
|
|
2330
|
+
resource_type: 'site' | 'library' | 'list';
|
|
2331
|
+
site_url?: string | null;
|
|
2332
|
+
/**
|
|
2333
|
+
* Microsoft tenant ID
|
|
2334
|
+
*/
|
|
2335
|
+
tenant_id: string;
|
|
2336
|
+
} | {
|
|
2337
|
+
/**
|
|
2338
|
+
* Polymorphic discriminator
|
|
2339
|
+
*/
|
|
2340
|
+
__type__: 'cloud_watch_log_group';
|
|
2341
|
+
access_key_id?: string;
|
|
2342
|
+
assume_role_arn?: string | null;
|
|
2343
|
+
assume_role_external_id?: string | null;
|
|
2344
|
+
auth_method: 'access_key' | 'iam_role' | 'assume_role';
|
|
2345
|
+
endpoint_url?: string | null;
|
|
2346
|
+
region: string;
|
|
2347
|
+
secret_access_key?: string;
|
|
2348
|
+
} | {
|
|
2349
|
+
/**
|
|
2350
|
+
* Polymorphic discriminator
|
|
2351
|
+
*/
|
|
2352
|
+
__type__: 'email';
|
|
2353
|
+
/**
|
|
2354
|
+
* AWS access key (SES)
|
|
2355
|
+
*/
|
|
2356
|
+
access_key_id?: string;
|
|
2357
|
+
/**
|
|
2358
|
+
* API key (Mailgun/SendGrid)
|
|
2359
|
+
*/
|
|
2360
|
+
api_key?: string;
|
|
2361
|
+
/**
|
|
2362
|
+
* Domain (Mailgun)
|
|
2363
|
+
*/
|
|
2364
|
+
domain?: string;
|
|
2365
|
+
from_email: string;
|
|
2366
|
+
from_name?: string | null;
|
|
2367
|
+
provider: 'ses' | 'mailgun' | 'sendgrid' | 'smtp';
|
|
2368
|
+
/**
|
|
2369
|
+
* AWS region (SES)
|
|
2370
|
+
*/
|
|
2371
|
+
region?: string;
|
|
2372
|
+
reply_to?: string | null;
|
|
2373
|
+
secret_access_key?: string;
|
|
2374
|
+
smtp_host?: string;
|
|
2375
|
+
smtp_password?: string;
|
|
2376
|
+
smtp_port?: number;
|
|
2377
|
+
smtp_username?: string;
|
|
2378
|
+
} | {
|
|
2379
|
+
/**
|
|
2380
|
+
* Polymorphic discriminator
|
|
2381
|
+
*/
|
|
2382
|
+
__type__: 'manual_upload';
|
|
2383
|
+
};
|
|
2384
|
+
/**
|
|
2385
|
+
* Data Source ID
|
|
2386
|
+
*/
|
|
2387
|
+
data_source_id?: string | null;
|
|
2388
|
+
/**
|
|
2389
|
+
* Datalake ID
|
|
2390
|
+
*/
|
|
2391
|
+
datalake_id?: string;
|
|
2392
|
+
/**
|
|
2393
|
+
* Tool description
|
|
2394
|
+
*/
|
|
2395
|
+
description?: string | null;
|
|
2396
|
+
/**
|
|
2397
|
+
* Tool intent — what category of capability the tool provides
|
|
2398
|
+
*/
|
|
2399
|
+
intent?: 'sms' | 'email' | 'export' | 'voice' | 'data_exchange' | 'status_poller' | 'chat_completion' | 'context_extraction';
|
|
2400
|
+
/**
|
|
2401
|
+
* Tool name
|
|
2402
|
+
*/
|
|
2403
|
+
name?: string;
|
|
2404
|
+
/**
|
|
2405
|
+
* Tool status
|
|
2406
|
+
*/
|
|
2407
|
+
status?: 'draft' | 'active' | 'inactive' | 'error' | 'marked_for_deletion';
|
|
2408
|
+
};
|
|
2409
|
+
/**
|
|
2410
|
+
* SQLDatabaseBody
|
|
2411
|
+
*
|
|
2412
|
+
* SQL database connection configuration.
|
|
2413
|
+
*/
|
|
2414
|
+
export type SqlDatabaseBodyWritable = {
|
|
2415
|
+
/**
|
|
2416
|
+
* Polymorphic discriminator
|
|
2417
|
+
*/
|
|
2418
|
+
__type__: 'sql_database';
|
|
2419
|
+
db_host: string;
|
|
2420
|
+
db_name: string;
|
|
2421
|
+
db_type: 'postgres' | 'mysql' | 'mssql' | 'sqlite' | 'snowflake';
|
|
2422
|
+
password: string;
|
|
2423
|
+
pool_size?: number;
|
|
2424
|
+
port?: number;
|
|
2425
|
+
ssl?: boolean;
|
|
2426
|
+
ssl_mode?: string | null;
|
|
2427
|
+
user_name: string;
|
|
2428
|
+
};
|
|
2429
|
+
/**
|
|
2430
|
+
* S3Body
|
|
2431
|
+
*
|
|
2432
|
+
* S3-compatible storage tool configuration.
|
|
2433
|
+
*/
|
|
2434
|
+
export type S3BodyWritable = {
|
|
2435
|
+
/**
|
|
2436
|
+
* Polymorphic discriminator
|
|
2437
|
+
*/
|
|
2438
|
+
__type__: 's3';
|
|
2439
|
+
/**
|
|
2440
|
+
* Provider config — must include __type__ ("aws" or "r2")
|
|
2441
|
+
*/
|
|
2442
|
+
config: {
|
|
2443
|
+
__type__: 'aws' | 'r2';
|
|
2444
|
+
access_key_id?: string;
|
|
2445
|
+
base_path?: string | null;
|
|
2446
|
+
bucket: string;
|
|
2447
|
+
endpoint?: string | null;
|
|
2448
|
+
region?: string;
|
|
2449
|
+
secret_access_key?: string;
|
|
2450
|
+
};
|
|
2451
|
+
};
|
|
2452
|
+
/**
|
|
2453
|
+
* ActionStatusUpdaterResponse
|
|
2454
|
+
*
|
|
2455
|
+
* Action Status Updater — automated polling for delivery status updates.
|
|
2456
|
+
*/
|
|
2457
|
+
export type ActionStatusUpdaterResponseWritable = {
|
|
2458
|
+
/**
|
|
2459
|
+
* Cron schedule expression (e.g. "*30 * * * *")
|
|
2460
|
+
*/
|
|
2461
|
+
cron_expression?: string;
|
|
2462
|
+
/**
|
|
2463
|
+
* Datalake ID
|
|
2464
|
+
*/
|
|
2465
|
+
datalake_id?: string;
|
|
2466
|
+
/**
|
|
2467
|
+
* Updater name
|
|
2468
|
+
*/
|
|
2469
|
+
name?: string;
|
|
2470
|
+
/**
|
|
2471
|
+
* IDs of sender tools whose messages this updater monitors
|
|
2472
|
+
*/
|
|
2473
|
+
sender_tool_ids?: Array<string> | null;
|
|
2474
|
+
/**
|
|
2475
|
+
* Tool providing auth credentials for polling
|
|
2476
|
+
*/
|
|
2477
|
+
updater_tool_id?: string;
|
|
2478
|
+
/**
|
|
2479
|
+
* Updater type — determines the updater_body shape
|
|
2480
|
+
*/
|
|
2481
|
+
updater_type?: 'cloud_watch' | 'restapi';
|
|
2482
|
+
};
|
|
2483
|
+
/**
|
|
2484
|
+
* SNSBody
|
|
2485
|
+
*
|
|
2486
|
+
* AWS SNS tool configuration for sending SMS messages.
|
|
2487
|
+
*/
|
|
2488
|
+
export type SnsBodyWritable = {
|
|
2489
|
+
/**
|
|
2490
|
+
* Polymorphic discriminator
|
|
2491
|
+
*/
|
|
2492
|
+
__type__: 'sns';
|
|
2493
|
+
/**
|
|
2494
|
+
* AWS access key ID
|
|
2495
|
+
*/
|
|
2496
|
+
access_key_id?: string;
|
|
2497
|
+
assume_role_arn?: string | null;
|
|
2498
|
+
assume_role_external_id?: string | null;
|
|
2499
|
+
auth_method: 'access_key' | 'iam_role' | 'assume_role';
|
|
2500
|
+
/**
|
|
2501
|
+
* Custom SNS endpoint
|
|
2502
|
+
*/
|
|
2503
|
+
endpoint_url?: string | null;
|
|
2504
|
+
/**
|
|
2505
|
+
* E.164 phone number
|
|
2506
|
+
*/
|
|
2507
|
+
phone_number: string;
|
|
2508
|
+
/**
|
|
2509
|
+
* AWS region
|
|
2510
|
+
*/
|
|
2511
|
+
region: string;
|
|
2512
|
+
secret_access_key?: string;
|
|
2513
|
+
};
|
|
2514
|
+
/**
|
|
2515
|
+
* DatalakeRequest
|
|
2516
|
+
*
|
|
2517
|
+
* Datalake configuration. Secrets (DB passwords, credentials) are write-only — accepted on create but never returned in responses. Request
|
|
2518
|
+
*/
|
|
2519
|
+
export type DatalakeRequestWritable = {
|
|
2520
|
+
/**
|
|
2521
|
+
* Industry data domain
|
|
2522
|
+
*/
|
|
2523
|
+
data_domain: 'healthcare' | 'core_banking' | 'payment_risk' | 'accounts_receivable' | 'service_commerce' | 'trading';
|
|
2524
|
+
/**
|
|
2525
|
+
* IANA timezone
|
|
2526
|
+
*/
|
|
2527
|
+
timezone: string | null;
|
|
2528
|
+
/**
|
|
2529
|
+
* Regulated reader auth method
|
|
2530
|
+
*/
|
|
2531
|
+
regulated_data_db_reader_auth_method: 'password' | 'iam_role';
|
|
2532
|
+
/**
|
|
2533
|
+
* Regulated writer DB host
|
|
2534
|
+
*/
|
|
2535
|
+
regulated_data_db_writer_host: string;
|
|
2536
|
+
/**
|
|
2537
|
+
* Regulated writer auth method
|
|
2538
|
+
*/
|
|
2539
|
+
regulated_data_db_writer_auth_method: 'password' | 'iam_role';
|
|
2540
|
+
/**
|
|
2541
|
+
* Regulated writer DB schema name
|
|
2542
|
+
*/
|
|
2543
|
+
regulated_data_db_writer_schema: string;
|
|
2544
|
+
/**
|
|
2545
|
+
* Enable SSL for regulated writer
|
|
2546
|
+
*/
|
|
2547
|
+
regulated_data_db_writer_enable_ssl: boolean;
|
|
2548
|
+
/**
|
|
2549
|
+
* Unregulated reader DB schema name
|
|
2550
|
+
*/
|
|
2551
|
+
unregulated_db_reader_schema: string;
|
|
2552
|
+
/**
|
|
2553
|
+
* Enable SSL for unregulated writer
|
|
2554
|
+
*/
|
|
2555
|
+
unregulated_db_writer_enable_ssl: boolean;
|
|
2556
|
+
/**
|
|
2557
|
+
* Unregulated writer DB port
|
|
2558
|
+
*/
|
|
2559
|
+
unregulated_db_writer_port: number;
|
|
2560
|
+
/**
|
|
2561
|
+
* Regulated writer DB port
|
|
2562
|
+
*/
|
|
2563
|
+
regulated_data_db_writer_port: number;
|
|
2564
|
+
/**
|
|
2565
|
+
* Unregulated reader DB password
|
|
2566
|
+
*/
|
|
2567
|
+
unregulated_db_reader_pass?: string;
|
|
2568
|
+
/**
|
|
2569
|
+
* Enable SSL for unregulated reader
|
|
2570
|
+
*/
|
|
2571
|
+
unregulated_db_reader_enable_ssl: boolean;
|
|
2572
|
+
/**
|
|
2573
|
+
* Enable SSL for regulated reader
|
|
2574
|
+
*/
|
|
2575
|
+
regulated_data_db_reader_enable_ssl: boolean;
|
|
2576
|
+
/**
|
|
2577
|
+
* Unregulated reader DB host
|
|
2578
|
+
*/
|
|
2579
|
+
unregulated_db_reader_host: string;
|
|
2580
|
+
/**
|
|
2581
|
+
* Regulated writer DB password
|
|
2582
|
+
*/
|
|
2583
|
+
regulated_data_db_writer_pass?: string;
|
|
2584
|
+
/**
|
|
2585
|
+
* Unregulated reader DB port
|
|
2586
|
+
*/
|
|
2587
|
+
unregulated_db_reader_port: number;
|
|
2588
|
+
/**
|
|
2589
|
+
* Database connection pool size
|
|
2590
|
+
*/
|
|
2591
|
+
pool_size: number | null;
|
|
2592
|
+
/**
|
|
2593
|
+
* Datalake description
|
|
2594
|
+
*/
|
|
2595
|
+
description?: string | null;
|
|
2596
|
+
/**
|
|
2597
|
+
* Datalake name
|
|
2598
|
+
*/
|
|
2599
|
+
name: string;
|
|
2600
|
+
/**
|
|
2601
|
+
* Unregulated reader DB username
|
|
2602
|
+
*/
|
|
2603
|
+
unregulated_db_reader_user?: string;
|
|
2604
|
+
/**
|
|
2605
|
+
* Unregulated writer auth method
|
|
2606
|
+
*/
|
|
2607
|
+
unregulated_db_writer_auth_method: 'password' | 'iam_role';
|
|
2608
|
+
/**
|
|
2609
|
+
* Unregulated reader DB name
|
|
2610
|
+
*/
|
|
2611
|
+
unregulated_db_reader_name: string;
|
|
2612
|
+
/**
|
|
2613
|
+
* Regulated writer DB name
|
|
2614
|
+
*/
|
|
2615
|
+
regulated_data_db_writer_name: string;
|
|
2616
|
+
/**
|
|
2617
|
+
* Unregulated writer DB host
|
|
2618
|
+
*/
|
|
2619
|
+
unregulated_db_writer_host: string;
|
|
2620
|
+
/**
|
|
2621
|
+
* Regulated reader DB username
|
|
2622
|
+
*/
|
|
2623
|
+
regulated_data_db_reader_user?: string;
|
|
2624
|
+
/**
|
|
2625
|
+
* Regulated reader DB schema name
|
|
2626
|
+
*/
|
|
2627
|
+
regulated_data_db_reader_schema: string;
|
|
2628
|
+
/**
|
|
2629
|
+
* Unregulated writer DB name
|
|
2630
|
+
*/
|
|
2631
|
+
unregulated_db_writer_name: string;
|
|
2632
|
+
/**
|
|
2633
|
+
* Unregulated writer DB schema name
|
|
2634
|
+
*/
|
|
2635
|
+
unregulated_db_writer_schema: string;
|
|
2636
|
+
/**
|
|
2637
|
+
* Regulated reader DB port
|
|
2638
|
+
*/
|
|
2639
|
+
regulated_data_db_reader_port: number;
|
|
2640
|
+
/**
|
|
2641
|
+
* Regulated writer DB username
|
|
2642
|
+
*/
|
|
2643
|
+
regulated_data_db_writer_user?: string;
|
|
2644
|
+
/**
|
|
2645
|
+
* Regulated reader DB password
|
|
2646
|
+
*/
|
|
2647
|
+
regulated_data_db_reader_pass?: string;
|
|
2648
|
+
/**
|
|
2649
|
+
* Regulated reader DB name
|
|
2650
|
+
*/
|
|
2651
|
+
regulated_data_db_reader_name: string;
|
|
2652
|
+
/**
|
|
2653
|
+
* Regulated reader DB host
|
|
2654
|
+
*/
|
|
2655
|
+
regulated_data_db_reader_host: string;
|
|
2656
|
+
/**
|
|
2657
|
+
* Unregulated writer DB username
|
|
2658
|
+
*/
|
|
2659
|
+
unregulated_db_writer_user?: string;
|
|
2660
|
+
/**
|
|
2661
|
+
* Unregulated reader auth method
|
|
2662
|
+
*/
|
|
2663
|
+
unregulated_db_reader_auth_method: 'password' | 'iam_role';
|
|
2664
|
+
/**
|
|
2665
|
+
* URL-friendly slug
|
|
2666
|
+
*/
|
|
2667
|
+
slug?: string;
|
|
2668
|
+
/**
|
|
2669
|
+
* Unregulated writer DB password
|
|
2670
|
+
*/
|
|
2671
|
+
unregulated_db_writer_pass?: string;
|
|
2672
|
+
};
|
|
2673
|
+
export type PlatformApiPingControllerPingData = {
|
|
2674
|
+
body?: never;
|
|
2675
|
+
path?: never;
|
|
2676
|
+
query?: never;
|
|
2677
|
+
url: '/api/ping';
|
|
2678
|
+
};
|
|
2679
|
+
export type PlatformApiPingControllerPingErrors = {
|
|
2680
|
+
/**
|
|
2681
|
+
* Database connection failed
|
|
2682
|
+
*/
|
|
2683
|
+
500: ErrorResponse;
|
|
2684
|
+
};
|
|
2685
|
+
export type PlatformApiPingControllerPingError = PlatformApiPingControllerPingErrors[keyof PlatformApiPingControllerPingErrors];
|
|
2686
|
+
export type PlatformApiPingControllerPingResponses = {
|
|
2687
|
+
/**
|
|
2688
|
+
* API is healthy
|
|
2689
|
+
*/
|
|
2690
|
+
200: PingResponse;
|
|
2691
|
+
};
|
|
2692
|
+
export type PlatformApiPingControllerPingResponse = PlatformApiPingControllerPingResponses[keyof PlatformApiPingControllerPingResponses];
|
|
2693
|
+
export type PlatformApiDatasetControllerSearchData = {
|
|
2694
|
+
body?: never;
|
|
2695
|
+
path: {
|
|
2696
|
+
/**
|
|
2697
|
+
* Dataset type (e.g. patient, member)
|
|
2698
|
+
*/
|
|
2699
|
+
dataset: string;
|
|
2700
|
+
};
|
|
2701
|
+
query?: {
|
|
2702
|
+
/**
|
|
2703
|
+
* Optional datalake ID (defaults to first datalake for the org)
|
|
2704
|
+
*/
|
|
2705
|
+
datalake_id?: string;
|
|
2706
|
+
/**
|
|
2707
|
+
* Page number
|
|
2708
|
+
*/
|
|
2709
|
+
page?: number;
|
|
2710
|
+
/**
|
|
2711
|
+
* Results per page (max 100)
|
|
2712
|
+
*/
|
|
2713
|
+
page_size?: number;
|
|
2714
|
+
};
|
|
2715
|
+
url: '/api/v1/datasets/{dataset}/search';
|
|
2716
|
+
};
|
|
2717
|
+
export type PlatformApiDatasetControllerSearchErrors = {
|
|
2718
|
+
/**
|
|
2719
|
+
* Unauthorised
|
|
2720
|
+
*/
|
|
2721
|
+
401: {
|
|
2722
|
+
[key: string]: unknown;
|
|
2723
|
+
};
|
|
2724
|
+
/**
|
|
2725
|
+
* Not Found
|
|
2726
|
+
*/
|
|
2727
|
+
404: {
|
|
2728
|
+
[key: string]: unknown;
|
|
2729
|
+
};
|
|
2730
|
+
/**
|
|
2731
|
+
* Unprocessable Entity
|
|
2732
|
+
*/
|
|
2733
|
+
422: {
|
|
2734
|
+
[key: string]: unknown;
|
|
2735
|
+
};
|
|
2736
|
+
};
|
|
2737
|
+
export type PlatformApiDatasetControllerSearchError = PlatformApiDatasetControllerSearchErrors[keyof PlatformApiDatasetControllerSearchErrors];
|
|
2738
|
+
export type PlatformApiDatasetControllerSearchResponses = {
|
|
2739
|
+
/**
|
|
2740
|
+
* Dataset search results
|
|
2741
|
+
*/
|
|
2742
|
+
200: DatasetSearchResponse;
|
|
2743
|
+
};
|
|
2744
|
+
export type PlatformApiDatasetControllerSearchResponse = PlatformApiDatasetControllerSearchResponses[keyof PlatformApiDatasetControllerSearchResponses];
|
|
2745
|
+
export type PlatformApiSessionControllerDeleteData = {
|
|
2746
|
+
body?: never;
|
|
2747
|
+
path?: never;
|
|
2748
|
+
query?: never;
|
|
2749
|
+
url: '/api/v1/sessions';
|
|
2750
|
+
};
|
|
2751
|
+
export type PlatformApiSessionControllerDeleteErrors = {
|
|
2752
|
+
/**
|
|
2753
|
+
* Invalid or missing Bearer token
|
|
2754
|
+
*/
|
|
2755
|
+
401: {
|
|
2756
|
+
[key: string]: unknown;
|
|
2757
|
+
};
|
|
2758
|
+
/**
|
|
2759
|
+
* Cannot revoke non-Bearer session
|
|
2760
|
+
*/
|
|
2761
|
+
422: {
|
|
2762
|
+
[key: string]: unknown;
|
|
2763
|
+
};
|
|
2764
|
+
};
|
|
2765
|
+
export type PlatformApiSessionControllerDeleteError = PlatformApiSessionControllerDeleteErrors[keyof PlatformApiSessionControllerDeleteErrors];
|
|
2766
|
+
export type PlatformApiSessionControllerDeleteResponses = {
|
|
2767
|
+
/**
|
|
2768
|
+
* Session revoked
|
|
2769
|
+
*/
|
|
2770
|
+
204: unknown;
|
|
2771
|
+
};
|
|
2772
|
+
export type PlatformApiSessionControllerCreateData = {
|
|
2773
|
+
/**
|
|
2774
|
+
* User credentials
|
|
2775
|
+
*/
|
|
2776
|
+
body: SessionRequest;
|
|
2777
|
+
path?: never;
|
|
2778
|
+
query?: never;
|
|
2779
|
+
url: '/api/v1/sessions';
|
|
2780
|
+
};
|
|
2781
|
+
export type PlatformApiSessionControllerCreateErrors = {
|
|
2782
|
+
/**
|
|
2783
|
+
* Invalid credentials
|
|
2784
|
+
*/
|
|
2785
|
+
401: {
|
|
2786
|
+
[key: string]: unknown;
|
|
2787
|
+
};
|
|
2788
|
+
/**
|
|
2789
|
+
* Missing required fields
|
|
2790
|
+
*/
|
|
2791
|
+
422: {
|
|
2792
|
+
[key: string]: unknown;
|
|
2793
|
+
};
|
|
2794
|
+
};
|
|
2795
|
+
export type PlatformApiSessionControllerCreateError = PlatformApiSessionControllerCreateErrors[keyof PlatformApiSessionControllerCreateErrors];
|
|
2796
|
+
export type PlatformApiSessionControllerCreateResponses = {
|
|
2797
|
+
/**
|
|
2798
|
+
* Session created
|
|
2799
|
+
*/
|
|
2800
|
+
201: SessionResponse;
|
|
2801
|
+
};
|
|
2802
|
+
export type PlatformApiSessionControllerCreateResponse = PlatformApiSessionControllerCreateResponses[keyof PlatformApiSessionControllerCreateResponses];
|
|
2803
|
+
export type PlatformApiSessionControllerVerifyData = {
|
|
2804
|
+
body?: never;
|
|
2805
|
+
path?: never;
|
|
2806
|
+
query?: never;
|
|
2807
|
+
url: '/api/v1/sessions/verify';
|
|
2808
|
+
};
|
|
2809
|
+
export type PlatformApiSessionControllerVerifyErrors = {
|
|
2810
|
+
/**
|
|
2811
|
+
* Invalid or missing credentials
|
|
2812
|
+
*/
|
|
2813
|
+
401: {
|
|
2814
|
+
[key: string]: unknown;
|
|
2815
|
+
};
|
|
2816
|
+
};
|
|
2817
|
+
export type PlatformApiSessionControllerVerifyError = PlatformApiSessionControllerVerifyErrors[keyof PlatformApiSessionControllerVerifyErrors];
|
|
2818
|
+
export type PlatformApiSessionControllerVerifyResponses = {
|
|
2819
|
+
/**
|
|
2820
|
+
* Session details
|
|
2821
|
+
*/
|
|
2822
|
+
200: SessionResponse;
|
|
2823
|
+
};
|
|
2824
|
+
export type PlatformApiSessionControllerVerifyResponse = PlatformApiSessionControllerVerifyResponses[keyof PlatformApiSessionControllerVerifyResponses];
|
|
2825
|
+
export type PlatformApiActionStatusUpdaterControllerIndexData = {
|
|
2826
|
+
body?: never;
|
|
2827
|
+
path: {
|
|
2828
|
+
/**
|
|
2829
|
+
* Tenant slug
|
|
2830
|
+
*/
|
|
2831
|
+
tenant_slug: string;
|
|
2832
|
+
};
|
|
2833
|
+
query?: {
|
|
2834
|
+
/**
|
|
2835
|
+
* Page number
|
|
2836
|
+
*/
|
|
2837
|
+
page?: number;
|
|
2838
|
+
/**
|
|
2839
|
+
* Items per page
|
|
2840
|
+
*/
|
|
2841
|
+
page_size?: number;
|
|
2842
|
+
};
|
|
2843
|
+
url: '/api/v1/tenants/{tenant_slug}/action-status-updaters';
|
|
2844
|
+
};
|
|
2845
|
+
export type PlatformApiActionStatusUpdaterControllerIndexErrors = {
|
|
2846
|
+
/**
|
|
2847
|
+
* Unauthorised
|
|
2848
|
+
*/
|
|
2849
|
+
401: {
|
|
2850
|
+
[key: string]: unknown;
|
|
2851
|
+
};
|
|
2852
|
+
/**
|
|
2853
|
+
* Not Found
|
|
2854
|
+
*/
|
|
2855
|
+
404: {
|
|
2856
|
+
[key: string]: unknown;
|
|
2857
|
+
};
|
|
2858
|
+
};
|
|
2859
|
+
export type PlatformApiActionStatusUpdaterControllerIndexError = PlatformApiActionStatusUpdaterControllerIndexErrors[keyof PlatformApiActionStatusUpdaterControllerIndexErrors];
|
|
2860
|
+
export type PlatformApiActionStatusUpdaterControllerIndexResponses = {
|
|
2861
|
+
/**
|
|
2862
|
+
* Action status updater list
|
|
2863
|
+
*/
|
|
2864
|
+
200: ActionStatusUpdaterListResponse;
|
|
2865
|
+
};
|
|
2866
|
+
export type PlatformApiActionStatusUpdaterControllerIndexResponse = PlatformApiActionStatusUpdaterControllerIndexResponses[keyof PlatformApiActionStatusUpdaterControllerIndexResponses];
|
|
2867
|
+
export type PlatformApiActionStatusUpdaterControllerCreateData = {
|
|
2868
|
+
/**
|
|
2869
|
+
* Full Action Status Updater resource (PUT semantics — all fields required)
|
|
2870
|
+
*/
|
|
2871
|
+
body?: ActionStatusUpdaterRequestWritable;
|
|
2872
|
+
path: {
|
|
2873
|
+
/**
|
|
2874
|
+
* Tenant slug
|
|
2875
|
+
*/
|
|
2876
|
+
tenant_slug: string;
|
|
2877
|
+
};
|
|
2878
|
+
query?: never;
|
|
2879
|
+
url: '/api/v1/tenants/{tenant_slug}/action-status-updaters';
|
|
2880
|
+
};
|
|
2881
|
+
export type PlatformApiActionStatusUpdaterControllerCreateErrors = {
|
|
2882
|
+
/**
|
|
2883
|
+
* Unauthorised
|
|
2884
|
+
*/
|
|
2885
|
+
401: {
|
|
2886
|
+
[key: string]: unknown;
|
|
2887
|
+
};
|
|
2888
|
+
/**
|
|
2889
|
+
* Unprocessable Entity
|
|
2890
|
+
*/
|
|
2891
|
+
422: {
|
|
2892
|
+
[key: string]: unknown;
|
|
2893
|
+
};
|
|
2894
|
+
};
|
|
2895
|
+
export type PlatformApiActionStatusUpdaterControllerCreateError = PlatformApiActionStatusUpdaterControllerCreateErrors[keyof PlatformApiActionStatusUpdaterControllerCreateErrors];
|
|
2896
|
+
export type PlatformApiActionStatusUpdaterControllerCreateResponses = {
|
|
2897
|
+
/**
|
|
2898
|
+
* Action status updater created
|
|
2899
|
+
*/
|
|
2900
|
+
201: ActionStatusUpdaterResponse;
|
|
2901
|
+
};
|
|
2902
|
+
export type PlatformApiActionStatusUpdaterControllerCreateResponse = PlatformApiActionStatusUpdaterControllerCreateResponses[keyof PlatformApiActionStatusUpdaterControllerCreateResponses];
|
|
2903
|
+
export type PlatformApiActionStatusUpdaterControllerUpdateData = {
|
|
2904
|
+
/**
|
|
2905
|
+
* Full Action Status Updater resource (PUT semantics — all fields required)
|
|
2906
|
+
*/
|
|
2907
|
+
body?: ActionStatusUpdaterRequestWritable;
|
|
2908
|
+
path: {
|
|
2909
|
+
/**
|
|
2910
|
+
* Tenant slug
|
|
2911
|
+
*/
|
|
2912
|
+
tenant_slug: string;
|
|
2913
|
+
/**
|
|
2914
|
+
* Action Status Updater ID
|
|
2915
|
+
*/
|
|
2916
|
+
id: string;
|
|
2917
|
+
};
|
|
2918
|
+
query?: never;
|
|
2919
|
+
url: '/api/v1/tenants/{tenant_slug}/action-status-updaters/{id}';
|
|
2920
|
+
};
|
|
2921
|
+
export type PlatformApiActionStatusUpdaterControllerUpdateErrors = {
|
|
2922
|
+
/**
|
|
2923
|
+
* Unauthorised
|
|
2924
|
+
*/
|
|
2925
|
+
401: {
|
|
2926
|
+
[key: string]: unknown;
|
|
2927
|
+
};
|
|
2928
|
+
/**
|
|
2929
|
+
* Not Found
|
|
2930
|
+
*/
|
|
2931
|
+
404: {
|
|
2932
|
+
[key: string]: unknown;
|
|
2933
|
+
};
|
|
2934
|
+
/**
|
|
2935
|
+
* Unprocessable Entity
|
|
2936
|
+
*/
|
|
2937
|
+
422: {
|
|
2938
|
+
[key: string]: unknown;
|
|
2939
|
+
};
|
|
2940
|
+
};
|
|
2941
|
+
export type PlatformApiActionStatusUpdaterControllerUpdateError = PlatformApiActionStatusUpdaterControllerUpdateErrors[keyof PlatformApiActionStatusUpdaterControllerUpdateErrors];
|
|
2942
|
+
export type PlatformApiActionStatusUpdaterControllerUpdateResponses = {
|
|
2943
|
+
/**
|
|
2944
|
+
* Action status updater updated
|
|
2945
|
+
*/
|
|
2946
|
+
200: ActionStatusUpdaterResponse;
|
|
2947
|
+
};
|
|
2948
|
+
export type PlatformApiActionStatusUpdaterControllerUpdateResponse = PlatformApiActionStatusUpdaterControllerUpdateResponses[keyof PlatformApiActionStatusUpdaterControllerUpdateResponses];
|
|
2949
|
+
export type PlatformApiWorkflowControllerExecuteData = {
|
|
2950
|
+
/**
|
|
2951
|
+
* Execute payload
|
|
2952
|
+
*/
|
|
2953
|
+
body: ExecuteActionRequest;
|
|
2954
|
+
path: {
|
|
2955
|
+
/**
|
|
2956
|
+
* Tenant slug
|
|
2957
|
+
*/
|
|
2958
|
+
tenant_slug: string;
|
|
2959
|
+
/**
|
|
2960
|
+
* Workflow slug
|
|
2961
|
+
*/
|
|
2962
|
+
workflow_slug: string;
|
|
2963
|
+
};
|
|
2964
|
+
query?: never;
|
|
2965
|
+
url: '/api/v1/tenants/{tenant_slug}/agentic-workflows/{workflow_slug}/execute';
|
|
2966
|
+
};
|
|
2967
|
+
export type PlatformApiWorkflowControllerExecuteErrors = {
|
|
2968
|
+
/**
|
|
2969
|
+
* Unauthorised
|
|
2970
|
+
*/
|
|
2971
|
+
401: {
|
|
2972
|
+
[key: string]: unknown;
|
|
2973
|
+
};
|
|
2974
|
+
/**
|
|
2975
|
+
* Not Found
|
|
2976
|
+
*/
|
|
2977
|
+
404: {
|
|
2978
|
+
[key: string]: unknown;
|
|
2979
|
+
};
|
|
2980
|
+
/**
|
|
2981
|
+
* Unprocessable Entity
|
|
2982
|
+
*/
|
|
2983
|
+
422: {
|
|
2984
|
+
[key: string]: unknown;
|
|
2985
|
+
};
|
|
2986
|
+
};
|
|
2987
|
+
export type PlatformApiWorkflowControllerExecuteError = PlatformApiWorkflowControllerExecuteErrors[keyof PlatformApiWorkflowControllerExecuteErrors];
|
|
2988
|
+
export type PlatformApiWorkflowControllerExecuteResponses = {
|
|
2989
|
+
/**
|
|
2990
|
+
* Execution result
|
|
2991
|
+
*/
|
|
2992
|
+
200: ExecuteActionResponse;
|
|
2993
|
+
};
|
|
2994
|
+
export type PlatformApiWorkflowControllerExecuteResponse = PlatformApiWorkflowControllerExecuteResponses[keyof PlatformApiWorkflowControllerExecuteResponses];
|
|
2995
|
+
export type PlatformApiConnectedAppControllerResolvePageData = {
|
|
2996
|
+
/**
|
|
2997
|
+
* Page resolution request
|
|
2998
|
+
*/
|
|
2999
|
+
body: ResolvePageRequest;
|
|
3000
|
+
path: {
|
|
3001
|
+
/**
|
|
3002
|
+
* Tenant slug
|
|
3003
|
+
*/
|
|
3004
|
+
tenant_slug: string;
|
|
3005
|
+
/**
|
|
3006
|
+
* Connected App slug
|
|
3007
|
+
*/
|
|
3008
|
+
slug: string;
|
|
3009
|
+
};
|
|
3010
|
+
query?: never;
|
|
3011
|
+
url: '/api/v1/tenants/{tenant_slug}/connected-apps/{slug}/resolve-page';
|
|
3012
|
+
};
|
|
3013
|
+
export type PlatformApiConnectedAppControllerResolvePageErrors = {
|
|
3014
|
+
/**
|
|
3015
|
+
* Unauthorized
|
|
3016
|
+
*/
|
|
3017
|
+
401: {
|
|
3018
|
+
[key: string]: unknown;
|
|
3019
|
+
};
|
|
3020
|
+
/**
|
|
3021
|
+
* Not found
|
|
3022
|
+
*/
|
|
3023
|
+
404: {
|
|
3024
|
+
[key: string]: unknown;
|
|
3025
|
+
};
|
|
3026
|
+
/**
|
|
3027
|
+
* Token expired
|
|
3028
|
+
*/
|
|
3029
|
+
410: {
|
|
3030
|
+
[key: string]: unknown;
|
|
3031
|
+
};
|
|
3032
|
+
/**
|
|
3033
|
+
* Validation error
|
|
3034
|
+
*/
|
|
3035
|
+
422: {
|
|
3036
|
+
[key: string]: unknown;
|
|
3037
|
+
};
|
|
3038
|
+
};
|
|
3039
|
+
export type PlatformApiConnectedAppControllerResolvePageError = PlatformApiConnectedAppControllerResolvePageErrors[keyof PlatformApiConnectedAppControllerResolvePageErrors];
|
|
3040
|
+
export type PlatformApiConnectedAppControllerResolvePageResponses = {
|
|
3041
|
+
/**
|
|
3042
|
+
* Resolved page details
|
|
3043
|
+
*/
|
|
3044
|
+
200: ResolvePageResponse;
|
|
3045
|
+
};
|
|
3046
|
+
export type PlatformApiConnectedAppControllerResolvePageResponse = PlatformApiConnectedAppControllerResolvePageResponses[keyof PlatformApiConnectedAppControllerResolvePageResponses];
|
|
3047
|
+
export type PlatformApiConnectedAppControllerUpdatePageData = {
|
|
3048
|
+
/**
|
|
3049
|
+
* Page update request
|
|
3050
|
+
*/
|
|
3051
|
+
body: UpdatePageRequest;
|
|
3052
|
+
path: {
|
|
3053
|
+
/**
|
|
3054
|
+
* Tenant slug
|
|
3055
|
+
*/
|
|
3056
|
+
tenant_slug: string;
|
|
3057
|
+
/**
|
|
3058
|
+
* Connected App slug
|
|
3059
|
+
*/
|
|
3060
|
+
slug: string;
|
|
3061
|
+
};
|
|
3062
|
+
query?: never;
|
|
3063
|
+
url: '/api/v1/tenants/{tenant_slug}/connected-apps/{slug}/update-message-tracking';
|
|
3064
|
+
};
|
|
3065
|
+
export type PlatformApiConnectedAppControllerUpdatePageErrors = {
|
|
3066
|
+
/**
|
|
3067
|
+
* Unauthorized
|
|
3068
|
+
*/
|
|
3069
|
+
401: {
|
|
3070
|
+
[key: string]: unknown;
|
|
3071
|
+
};
|
|
3072
|
+
/**
|
|
3073
|
+
* Not found
|
|
3074
|
+
*/
|
|
3075
|
+
404: {
|
|
3076
|
+
[key: string]: unknown;
|
|
3077
|
+
};
|
|
3078
|
+
/**
|
|
3079
|
+
* Token expired
|
|
3080
|
+
*/
|
|
3081
|
+
410: {
|
|
3082
|
+
[key: string]: unknown;
|
|
3083
|
+
};
|
|
3084
|
+
/**
|
|
3085
|
+
* Validation error
|
|
3086
|
+
*/
|
|
3087
|
+
422: {
|
|
3088
|
+
[key: string]: unknown;
|
|
3089
|
+
};
|
|
3090
|
+
};
|
|
3091
|
+
export type PlatformApiConnectedAppControllerUpdatePageError = PlatformApiConnectedAppControllerUpdatePageErrors[keyof PlatformApiConnectedAppControllerUpdatePageErrors];
|
|
3092
|
+
export type PlatformApiConnectedAppControllerUpdatePageResponses = {
|
|
3093
|
+
/**
|
|
3094
|
+
* Updated message details
|
|
3095
|
+
*/
|
|
3096
|
+
200: UpdatePageResponse;
|
|
3097
|
+
};
|
|
3098
|
+
export type PlatformApiConnectedAppControllerUpdatePageResponse = PlatformApiConnectedAppControllerUpdatePageResponses[keyof PlatformApiConnectedAppControllerUpdatePageResponses];
|
|
3099
|
+
export type PlatformApiDataActivationClientControllerIngestData = {
|
|
3100
|
+
/**
|
|
3101
|
+
* JSON payload
|
|
3102
|
+
*/
|
|
3103
|
+
body: IngestRequest;
|
|
3104
|
+
path: {
|
|
3105
|
+
/**
|
|
3106
|
+
* Tenant slug
|
|
3107
|
+
*/
|
|
3108
|
+
tenant_slug: string;
|
|
3109
|
+
/**
|
|
3110
|
+
* Data Activation Client slug
|
|
3111
|
+
*/
|
|
3112
|
+
slug: string;
|
|
3113
|
+
};
|
|
3114
|
+
query?: never;
|
|
3115
|
+
url: '/api/v1/tenants/{tenant_slug}/data-activation-clients/{slug}/ingest';
|
|
3116
|
+
};
|
|
3117
|
+
export type PlatformApiDataActivationClientControllerIngestErrors = {
|
|
3118
|
+
/**
|
|
3119
|
+
* Unauthorised
|
|
3120
|
+
*/
|
|
3121
|
+
401: {
|
|
3122
|
+
[key: string]: unknown;
|
|
3123
|
+
};
|
|
3124
|
+
/**
|
|
3125
|
+
* Not Found
|
|
3126
|
+
*/
|
|
3127
|
+
404: {
|
|
3128
|
+
[key: string]: unknown;
|
|
3129
|
+
};
|
|
3130
|
+
/**
|
|
3131
|
+
* Unprocessable Entity
|
|
3132
|
+
*/
|
|
3133
|
+
422: {
|
|
3134
|
+
[key: string]: unknown;
|
|
3135
|
+
};
|
|
3136
|
+
};
|
|
3137
|
+
export type PlatformApiDataActivationClientControllerIngestError = PlatformApiDataActivationClientControllerIngestErrors[keyof PlatformApiDataActivationClientControllerIngestErrors];
|
|
3138
|
+
export type PlatformApiDataActivationClientControllerIngestResponses = {
|
|
3139
|
+
/**
|
|
3140
|
+
* Ingest response
|
|
3141
|
+
*/
|
|
3142
|
+
200: IngestResponse;
|
|
3143
|
+
};
|
|
3144
|
+
export type PlatformApiDataActivationClientControllerIngestResponse = PlatformApiDataActivationClientControllerIngestResponses[keyof PlatformApiDataActivationClientControllerIngestResponses];
|
|
3145
|
+
export type PlatformApiDatalakeControllerIndexData = {
|
|
3146
|
+
body?: never;
|
|
3147
|
+
path: {
|
|
3148
|
+
/**
|
|
3149
|
+
* Tenant slug
|
|
3150
|
+
*/
|
|
3151
|
+
tenant_slug: string;
|
|
3152
|
+
};
|
|
3153
|
+
query?: {
|
|
3154
|
+
/**
|
|
3155
|
+
* Page number
|
|
3156
|
+
*/
|
|
3157
|
+
page?: number;
|
|
3158
|
+
/**
|
|
3159
|
+
* Items per page
|
|
3160
|
+
*/
|
|
3161
|
+
page_size?: number;
|
|
3162
|
+
};
|
|
3163
|
+
url: '/api/v1/tenants/{tenant_slug}/datalakes';
|
|
3164
|
+
};
|
|
3165
|
+
export type PlatformApiDatalakeControllerIndexErrors = {
|
|
3166
|
+
/**
|
|
3167
|
+
* Unauthorised
|
|
3168
|
+
*/
|
|
3169
|
+
401: {
|
|
3170
|
+
[key: string]: unknown;
|
|
3171
|
+
};
|
|
3172
|
+
/**
|
|
3173
|
+
* Not Found
|
|
3174
|
+
*/
|
|
3175
|
+
404: {
|
|
3176
|
+
[key: string]: unknown;
|
|
3177
|
+
};
|
|
3178
|
+
};
|
|
3179
|
+
export type PlatformApiDatalakeControllerIndexError = PlatformApiDatalakeControllerIndexErrors[keyof PlatformApiDatalakeControllerIndexErrors];
|
|
3180
|
+
export type PlatformApiDatalakeControllerIndexResponses = {
|
|
3181
|
+
/**
|
|
3182
|
+
* Datalake list
|
|
3183
|
+
*/
|
|
3184
|
+
200: DatalakeListResponse;
|
|
3185
|
+
};
|
|
3186
|
+
export type PlatformApiDatalakeControllerIndexResponse = PlatformApiDatalakeControllerIndexResponses[keyof PlatformApiDatalakeControllerIndexResponses];
|
|
3187
|
+
export type PlatformApiDatalakeControllerCreateData = {
|
|
3188
|
+
/**
|
|
3189
|
+
* Full Datalake resource (POST semantics — all fields required)
|
|
3190
|
+
*/
|
|
3191
|
+
body?: DatalakeRequestWritable;
|
|
3192
|
+
path: {
|
|
3193
|
+
/**
|
|
3194
|
+
* Tenant slug
|
|
3195
|
+
*/
|
|
3196
|
+
tenant_slug: string;
|
|
3197
|
+
};
|
|
3198
|
+
query?: never;
|
|
3199
|
+
url: '/api/v1/tenants/{tenant_slug}/datalakes';
|
|
3200
|
+
};
|
|
3201
|
+
export type PlatformApiDatalakeControllerCreateErrors = {
|
|
3202
|
+
/**
|
|
3203
|
+
* Unauthorised
|
|
3204
|
+
*/
|
|
3205
|
+
401: {
|
|
3206
|
+
[key: string]: unknown;
|
|
3207
|
+
};
|
|
3208
|
+
/**
|
|
3209
|
+
* Unprocessable Entity
|
|
3210
|
+
*/
|
|
3211
|
+
422: {
|
|
3212
|
+
[key: string]: unknown;
|
|
3213
|
+
};
|
|
3214
|
+
};
|
|
3215
|
+
export type PlatformApiDatalakeControllerCreateError = PlatformApiDatalakeControllerCreateErrors[keyof PlatformApiDatalakeControllerCreateErrors];
|
|
3216
|
+
export type PlatformApiDatalakeControllerCreateResponses = {
|
|
3217
|
+
/**
|
|
3218
|
+
* Datalake created
|
|
3219
|
+
*/
|
|
3220
|
+
201: DatalakeResponse;
|
|
3221
|
+
};
|
|
3222
|
+
export type PlatformApiDatalakeControllerCreateResponse = PlatformApiDatalakeControllerCreateResponses[keyof PlatformApiDatalakeControllerCreateResponses];
|
|
3223
|
+
export type PlatformApiAiAgentControllerIndexData = {
|
|
3224
|
+
body?: never;
|
|
3225
|
+
path: {
|
|
3226
|
+
/**
|
|
3227
|
+
* Tenant slug
|
|
3228
|
+
*/
|
|
3229
|
+
tenant_slug: string;
|
|
3230
|
+
/**
|
|
3231
|
+
* Datalake slug
|
|
3232
|
+
*/
|
|
3233
|
+
datalake_slug: string;
|
|
3234
|
+
};
|
|
3235
|
+
query?: {
|
|
3236
|
+
/**
|
|
3237
|
+
* Page number
|
|
3238
|
+
*/
|
|
3239
|
+
page?: number;
|
|
3240
|
+
/**
|
|
3241
|
+
* Items per page
|
|
3242
|
+
*/
|
|
3243
|
+
page_size?: number;
|
|
3244
|
+
};
|
|
3245
|
+
url: '/api/v1/tenants/{tenant_slug}/datalakes/{datalake_slug}/ai-agents';
|
|
3246
|
+
};
|
|
3247
|
+
export type PlatformApiAiAgentControllerIndexErrors = {
|
|
3248
|
+
/**
|
|
3249
|
+
* Unauthorised
|
|
3250
|
+
*/
|
|
3251
|
+
401: {
|
|
3252
|
+
[key: string]: unknown;
|
|
3253
|
+
};
|
|
3254
|
+
/**
|
|
3255
|
+
* Not Found
|
|
3256
|
+
*/
|
|
3257
|
+
404: {
|
|
3258
|
+
[key: string]: unknown;
|
|
3259
|
+
};
|
|
3260
|
+
};
|
|
3261
|
+
export type PlatformApiAiAgentControllerIndexError = PlatformApiAiAgentControllerIndexErrors[keyof PlatformApiAiAgentControllerIndexErrors];
|
|
3262
|
+
export type PlatformApiAiAgentControllerIndexResponses = {
|
|
3263
|
+
/**
|
|
3264
|
+
* AI agent list
|
|
3265
|
+
*/
|
|
3266
|
+
200: AiAgentListResponse;
|
|
3267
|
+
};
|
|
3268
|
+
export type PlatformApiAiAgentControllerIndexResponse = PlatformApiAiAgentControllerIndexResponses[keyof PlatformApiAiAgentControllerIndexResponses];
|
|
3269
|
+
export type PlatformApiAiAgentControllerCreateData = {
|
|
3270
|
+
/**
|
|
3271
|
+
* Full AI Agent resource (PUT semantics — all fields required)
|
|
3272
|
+
*/
|
|
3273
|
+
body?: AiAgentRequestWritable;
|
|
3274
|
+
path: {
|
|
3275
|
+
/**
|
|
3276
|
+
* Tenant slug
|
|
3277
|
+
*/
|
|
3278
|
+
tenant_slug: string;
|
|
3279
|
+
/**
|
|
3280
|
+
* Datalake slug
|
|
3281
|
+
*/
|
|
3282
|
+
datalake_slug: string;
|
|
3283
|
+
};
|
|
3284
|
+
query?: never;
|
|
3285
|
+
url: '/api/v1/tenants/{tenant_slug}/datalakes/{datalake_slug}/ai-agents';
|
|
3286
|
+
};
|
|
3287
|
+
export type PlatformApiAiAgentControllerCreateErrors = {
|
|
3288
|
+
/**
|
|
3289
|
+
* Unauthorised
|
|
3290
|
+
*/
|
|
3291
|
+
401: {
|
|
3292
|
+
[key: string]: unknown;
|
|
3293
|
+
};
|
|
3294
|
+
/**
|
|
3295
|
+
* Unprocessable Entity
|
|
3296
|
+
*/
|
|
3297
|
+
422: {
|
|
3298
|
+
[key: string]: unknown;
|
|
3299
|
+
};
|
|
3300
|
+
};
|
|
3301
|
+
export type PlatformApiAiAgentControllerCreateError = PlatformApiAiAgentControllerCreateErrors[keyof PlatformApiAiAgentControllerCreateErrors];
|
|
3302
|
+
export type PlatformApiAiAgentControllerCreateResponses = {
|
|
3303
|
+
/**
|
|
3304
|
+
* AI agent created
|
|
3305
|
+
*/
|
|
3306
|
+
201: AiAgentResponse;
|
|
3307
|
+
};
|
|
3308
|
+
export type PlatformApiAiAgentControllerCreateResponse = PlatformApiAiAgentControllerCreateResponses[keyof PlatformApiAiAgentControllerCreateResponses];
|
|
3309
|
+
export type PlatformApiAiAgentControllerDeleteData = {
|
|
3310
|
+
body?: never;
|
|
3311
|
+
path: {
|
|
3312
|
+
/**
|
|
3313
|
+
* Tenant slug
|
|
3314
|
+
*/
|
|
3315
|
+
tenant_slug: string;
|
|
3316
|
+
/**
|
|
3317
|
+
* Datalake slug
|
|
3318
|
+
*/
|
|
3319
|
+
datalake_slug: string;
|
|
3320
|
+
/**
|
|
3321
|
+
* AI Agent ID
|
|
3322
|
+
*/
|
|
3323
|
+
id: string;
|
|
3324
|
+
};
|
|
3325
|
+
query?: never;
|
|
3326
|
+
url: '/api/v1/tenants/{tenant_slug}/datalakes/{datalake_slug}/ai-agents/{id}';
|
|
3327
|
+
};
|
|
3328
|
+
export type PlatformApiAiAgentControllerDeleteErrors = {
|
|
3329
|
+
/**
|
|
3330
|
+
* Unauthorised
|
|
3331
|
+
*/
|
|
3332
|
+
401: {
|
|
3333
|
+
[key: string]: unknown;
|
|
3334
|
+
};
|
|
3335
|
+
/**
|
|
3336
|
+
* Not Found
|
|
3337
|
+
*/
|
|
3338
|
+
404: {
|
|
3339
|
+
[key: string]: unknown;
|
|
3340
|
+
};
|
|
3341
|
+
/**
|
|
3342
|
+
* Agent is attached to a workflow and cannot be deleted
|
|
3343
|
+
*/
|
|
3344
|
+
409: {
|
|
3345
|
+
errors?: {
|
|
3346
|
+
[key: string]: unknown;
|
|
3347
|
+
};
|
|
3348
|
+
};
|
|
3349
|
+
};
|
|
3350
|
+
export type PlatformApiAiAgentControllerDeleteError = PlatformApiAiAgentControllerDeleteErrors[keyof PlatformApiAiAgentControllerDeleteErrors];
|
|
3351
|
+
export type PlatformApiAiAgentControllerDeleteResponses = {
|
|
3352
|
+
/**
|
|
3353
|
+
* No Content
|
|
3354
|
+
*/
|
|
3355
|
+
204: void;
|
|
3356
|
+
};
|
|
3357
|
+
export type PlatformApiAiAgentControllerDeleteResponse = PlatformApiAiAgentControllerDeleteResponses[keyof PlatformApiAiAgentControllerDeleteResponses];
|
|
3358
|
+
export type PlatformApiAiAgentControllerShowData = {
|
|
3359
|
+
body?: never;
|
|
3360
|
+
path: {
|
|
3361
|
+
/**
|
|
3362
|
+
* Tenant slug
|
|
3363
|
+
*/
|
|
3364
|
+
tenant_slug: string;
|
|
3365
|
+
/**
|
|
3366
|
+
* Datalake slug
|
|
3367
|
+
*/
|
|
3368
|
+
datalake_slug: string;
|
|
3369
|
+
/**
|
|
3370
|
+
* AI Agent ID
|
|
3371
|
+
*/
|
|
3372
|
+
id: string;
|
|
3373
|
+
};
|
|
3374
|
+
query?: never;
|
|
3375
|
+
url: '/api/v1/tenants/{tenant_slug}/datalakes/{datalake_slug}/ai-agents/{id}';
|
|
3376
|
+
};
|
|
3377
|
+
export type PlatformApiAiAgentControllerShowErrors = {
|
|
3378
|
+
/**
|
|
3379
|
+
* Unauthorised
|
|
3380
|
+
*/
|
|
3381
|
+
401: {
|
|
3382
|
+
[key: string]: unknown;
|
|
3383
|
+
};
|
|
3384
|
+
/**
|
|
3385
|
+
* Not Found
|
|
3386
|
+
*/
|
|
3387
|
+
404: {
|
|
3388
|
+
[key: string]: unknown;
|
|
3389
|
+
};
|
|
3390
|
+
};
|
|
3391
|
+
export type PlatformApiAiAgentControllerShowError = PlatformApiAiAgentControllerShowErrors[keyof PlatformApiAiAgentControllerShowErrors];
|
|
3392
|
+
export type PlatformApiAiAgentControllerShowResponses = {
|
|
3393
|
+
/**
|
|
3394
|
+
* AI agent
|
|
3395
|
+
*/
|
|
3396
|
+
200: AiAgentResponse;
|
|
3397
|
+
};
|
|
3398
|
+
export type PlatformApiAiAgentControllerShowResponse = PlatformApiAiAgentControllerShowResponses[keyof PlatformApiAiAgentControllerShowResponses];
|
|
3399
|
+
export type PlatformApiAiAgentControllerUpdateData = {
|
|
3400
|
+
/**
|
|
3401
|
+
* Full AI Agent resource (PUT semantics — all fields required)
|
|
3402
|
+
*/
|
|
3403
|
+
body?: AiAgentRequestWritable;
|
|
3404
|
+
path: {
|
|
3405
|
+
/**
|
|
3406
|
+
* Tenant slug
|
|
3407
|
+
*/
|
|
3408
|
+
tenant_slug: string;
|
|
3409
|
+
/**
|
|
3410
|
+
* Datalake slug
|
|
3411
|
+
*/
|
|
3412
|
+
datalake_slug: string;
|
|
3413
|
+
/**
|
|
3414
|
+
* AI Agent ID
|
|
3415
|
+
*/
|
|
3416
|
+
id: string;
|
|
3417
|
+
};
|
|
3418
|
+
query?: never;
|
|
3419
|
+
url: '/api/v1/tenants/{tenant_slug}/datalakes/{datalake_slug}/ai-agents/{id}';
|
|
3420
|
+
};
|
|
3421
|
+
export type PlatformApiAiAgentControllerUpdateErrors = {
|
|
3422
|
+
/**
|
|
3423
|
+
* Unauthorised
|
|
3424
|
+
*/
|
|
3425
|
+
401: {
|
|
3426
|
+
[key: string]: unknown;
|
|
3427
|
+
};
|
|
3428
|
+
/**
|
|
3429
|
+
* Not Found
|
|
3430
|
+
*/
|
|
3431
|
+
404: {
|
|
3432
|
+
[key: string]: unknown;
|
|
3433
|
+
};
|
|
3434
|
+
/**
|
|
3435
|
+
* Unprocessable Entity
|
|
3436
|
+
*/
|
|
3437
|
+
422: {
|
|
3438
|
+
[key: string]: unknown;
|
|
3439
|
+
};
|
|
3440
|
+
};
|
|
3441
|
+
export type PlatformApiAiAgentControllerUpdateError = PlatformApiAiAgentControllerUpdateErrors[keyof PlatformApiAiAgentControllerUpdateErrors];
|
|
3442
|
+
export type PlatformApiAiAgentControllerUpdateResponses = {
|
|
3443
|
+
/**
|
|
3444
|
+
* AI agent updated
|
|
3445
|
+
*/
|
|
3446
|
+
200: AiAgentResponse;
|
|
3447
|
+
};
|
|
3448
|
+
export type PlatformApiAiAgentControllerUpdateResponse = PlatformApiAiAgentControllerUpdateResponses[keyof PlatformApiAiAgentControllerUpdateResponses];
|
|
3449
|
+
export type PlatformApiDataSourceControllerIndexData = {
|
|
3450
|
+
body?: never;
|
|
3451
|
+
path: {
|
|
3452
|
+
/**
|
|
3453
|
+
* Tenant slug
|
|
3454
|
+
*/
|
|
3455
|
+
tenant_slug: string;
|
|
3456
|
+
/**
|
|
3457
|
+
* Datalake slug
|
|
3458
|
+
*/
|
|
3459
|
+
datalake_slug: string;
|
|
3460
|
+
};
|
|
3461
|
+
query?: {
|
|
3462
|
+
/**
|
|
3463
|
+
* Page number
|
|
3464
|
+
*/
|
|
3465
|
+
page?: number;
|
|
3466
|
+
/**
|
|
3467
|
+
* Items per page
|
|
3468
|
+
*/
|
|
3469
|
+
page_size?: number;
|
|
3470
|
+
};
|
|
3471
|
+
url: '/api/v1/tenants/{tenant_slug}/datalakes/{datalake_slug}/data-sources';
|
|
3472
|
+
};
|
|
3473
|
+
export type PlatformApiDataSourceControllerIndexErrors = {
|
|
3474
|
+
/**
|
|
3475
|
+
* Unauthorised
|
|
3476
|
+
*/
|
|
3477
|
+
401: {
|
|
3478
|
+
[key: string]: unknown;
|
|
3479
|
+
};
|
|
3480
|
+
/**
|
|
3481
|
+
* Not Found
|
|
3482
|
+
*/
|
|
3483
|
+
404: {
|
|
3484
|
+
[key: string]: unknown;
|
|
3485
|
+
};
|
|
3486
|
+
};
|
|
3487
|
+
export type PlatformApiDataSourceControllerIndexError = PlatformApiDataSourceControllerIndexErrors[keyof PlatformApiDataSourceControllerIndexErrors];
|
|
3488
|
+
export type PlatformApiDataSourceControllerIndexResponses = {
|
|
3489
|
+
/**
|
|
3490
|
+
* Data source list
|
|
3491
|
+
*/
|
|
3492
|
+
200: DataSourceListResponse;
|
|
3493
|
+
};
|
|
3494
|
+
export type PlatformApiDataSourceControllerIndexResponse = PlatformApiDataSourceControllerIndexResponses[keyof PlatformApiDataSourceControllerIndexResponses];
|
|
3495
|
+
export type PlatformApiDataSourceControllerCreateData = {
|
|
3496
|
+
/**
|
|
3497
|
+
* Full Data Source resource (PUT semantics — all fields required)
|
|
3498
|
+
*/
|
|
3499
|
+
body?: DataSourceRequest;
|
|
3500
|
+
path: {
|
|
3501
|
+
/**
|
|
3502
|
+
* Tenant slug
|
|
3503
|
+
*/
|
|
3504
|
+
tenant_slug: string;
|
|
3505
|
+
/**
|
|
3506
|
+
* Datalake slug
|
|
3507
|
+
*/
|
|
3508
|
+
datalake_slug: string;
|
|
3509
|
+
};
|
|
3510
|
+
query?: never;
|
|
3511
|
+
url: '/api/v1/tenants/{tenant_slug}/datalakes/{datalake_slug}/data-sources';
|
|
3512
|
+
};
|
|
3513
|
+
export type PlatformApiDataSourceControllerCreateErrors = {
|
|
3514
|
+
/**
|
|
3515
|
+
* Unauthorised
|
|
3516
|
+
*/
|
|
3517
|
+
401: {
|
|
3518
|
+
[key: string]: unknown;
|
|
3519
|
+
};
|
|
3520
|
+
/**
|
|
3521
|
+
* Unprocessable Entity
|
|
3522
|
+
*/
|
|
3523
|
+
422: {
|
|
3524
|
+
[key: string]: unknown;
|
|
3525
|
+
};
|
|
3526
|
+
};
|
|
3527
|
+
export type PlatformApiDataSourceControllerCreateError = PlatformApiDataSourceControllerCreateErrors[keyof PlatformApiDataSourceControllerCreateErrors];
|
|
3528
|
+
export type PlatformApiDataSourceControllerCreateResponses = {
|
|
3529
|
+
/**
|
|
3530
|
+
* Data source created
|
|
3531
|
+
*/
|
|
3532
|
+
201: DataSourceResponse;
|
|
3533
|
+
};
|
|
3534
|
+
export type PlatformApiDataSourceControllerCreateResponse = PlatformApiDataSourceControllerCreateResponses[keyof PlatformApiDataSourceControllerCreateResponses];
|
|
3535
|
+
export type PlatformApiDataSourceControllerUpdateData = {
|
|
3536
|
+
/**
|
|
3537
|
+
* Full Data Source resource (PUT semantics — all fields required)
|
|
3538
|
+
*/
|
|
3539
|
+
body?: DataSourceRequest;
|
|
3540
|
+
path: {
|
|
3541
|
+
/**
|
|
3542
|
+
* Tenant slug
|
|
3543
|
+
*/
|
|
3544
|
+
tenant_slug: string;
|
|
3545
|
+
/**
|
|
3546
|
+
* Datalake slug
|
|
3547
|
+
*/
|
|
3548
|
+
datalake_slug: string;
|
|
3549
|
+
/**
|
|
3550
|
+
* Data Source ID
|
|
3551
|
+
*/
|
|
3552
|
+
id: string;
|
|
3553
|
+
};
|
|
3554
|
+
query?: never;
|
|
3555
|
+
url: '/api/v1/tenants/{tenant_slug}/datalakes/{datalake_slug}/data-sources/{id}';
|
|
3556
|
+
};
|
|
3557
|
+
export type PlatformApiDataSourceControllerUpdateErrors = {
|
|
3558
|
+
/**
|
|
3559
|
+
* Unauthorised
|
|
3560
|
+
*/
|
|
3561
|
+
401: {
|
|
3562
|
+
[key: string]: unknown;
|
|
3563
|
+
};
|
|
3564
|
+
/**
|
|
3565
|
+
* Not Found
|
|
3566
|
+
*/
|
|
3567
|
+
404: {
|
|
3568
|
+
[key: string]: unknown;
|
|
3569
|
+
};
|
|
3570
|
+
/**
|
|
3571
|
+
* Unprocessable Entity
|
|
3572
|
+
*/
|
|
3573
|
+
422: {
|
|
3574
|
+
[key: string]: unknown;
|
|
3575
|
+
};
|
|
3576
|
+
};
|
|
3577
|
+
export type PlatformApiDataSourceControllerUpdateError = PlatformApiDataSourceControllerUpdateErrors[keyof PlatformApiDataSourceControllerUpdateErrors];
|
|
3578
|
+
export type PlatformApiDataSourceControllerUpdateResponses = {
|
|
3579
|
+
/**
|
|
3580
|
+
* Data source updated
|
|
3581
|
+
*/
|
|
3582
|
+
200: DataSourceResponse;
|
|
3583
|
+
};
|
|
3584
|
+
export type PlatformApiDataSourceControllerUpdateResponse = PlatformApiDataSourceControllerUpdateResponses[keyof PlatformApiDataSourceControllerUpdateResponses];
|
|
3585
|
+
export type PlatformApiGenericTableControllerIndexData = {
|
|
3586
|
+
body?: never;
|
|
3587
|
+
path: {
|
|
3588
|
+
/**
|
|
3589
|
+
* Tenant slug
|
|
3590
|
+
*/
|
|
3591
|
+
tenant_slug: string;
|
|
3592
|
+
/**
|
|
3593
|
+
* Datalake slug
|
|
3594
|
+
*/
|
|
3595
|
+
datalake_slug: string;
|
|
3596
|
+
};
|
|
3597
|
+
query?: {
|
|
3598
|
+
/**
|
|
3599
|
+
* Page number
|
|
3600
|
+
*/
|
|
3601
|
+
page?: number;
|
|
3602
|
+
/**
|
|
3603
|
+
* Items per page
|
|
3604
|
+
*/
|
|
3605
|
+
page_size?: number;
|
|
3606
|
+
};
|
|
3607
|
+
url: '/api/v1/tenants/{tenant_slug}/datalakes/{datalake_slug}/generic-tables';
|
|
3608
|
+
};
|
|
3609
|
+
export type PlatformApiGenericTableControllerIndexErrors = {
|
|
3610
|
+
/**
|
|
3611
|
+
* Unauthorised
|
|
3612
|
+
*/
|
|
3613
|
+
401: {
|
|
3614
|
+
[key: string]: unknown;
|
|
3615
|
+
};
|
|
3616
|
+
/**
|
|
3617
|
+
* Not Found
|
|
3618
|
+
*/
|
|
3619
|
+
404: {
|
|
3620
|
+
[key: string]: unknown;
|
|
3621
|
+
};
|
|
3622
|
+
};
|
|
3623
|
+
export type PlatformApiGenericTableControllerIndexError = PlatformApiGenericTableControllerIndexErrors[keyof PlatformApiGenericTableControllerIndexErrors];
|
|
3624
|
+
export type PlatformApiGenericTableControllerIndexResponses = {
|
|
3625
|
+
/**
|
|
3626
|
+
* Generic table list
|
|
3627
|
+
*/
|
|
3628
|
+
200: GenericTableListResponse;
|
|
3629
|
+
};
|
|
3630
|
+
export type PlatformApiGenericTableControllerIndexResponse = PlatformApiGenericTableControllerIndexResponses[keyof PlatformApiGenericTableControllerIndexResponses];
|
|
3631
|
+
export type PlatformApiGenericTableControllerCreateData = {
|
|
3632
|
+
/**
|
|
3633
|
+
* Full Generic Table resource (PUT semantics — all fields required)
|
|
3634
|
+
*/
|
|
3635
|
+
body?: GenericTableRequestWritable;
|
|
3636
|
+
path: {
|
|
3637
|
+
/**
|
|
3638
|
+
* Tenant slug
|
|
3639
|
+
*/
|
|
3640
|
+
tenant_slug: string;
|
|
3641
|
+
/**
|
|
3642
|
+
* Datalake slug
|
|
3643
|
+
*/
|
|
3644
|
+
datalake_slug: string;
|
|
3645
|
+
};
|
|
3646
|
+
query?: never;
|
|
3647
|
+
url: '/api/v1/tenants/{tenant_slug}/datalakes/{datalake_slug}/generic-tables';
|
|
3648
|
+
};
|
|
3649
|
+
export type PlatformApiGenericTableControllerCreateErrors = {
|
|
3650
|
+
/**
|
|
3651
|
+
* Unauthorised
|
|
3652
|
+
*/
|
|
3653
|
+
401: {
|
|
3654
|
+
[key: string]: unknown;
|
|
3655
|
+
};
|
|
3656
|
+
/**
|
|
3657
|
+
* Unprocessable Entity
|
|
3658
|
+
*/
|
|
3659
|
+
422: {
|
|
3660
|
+
[key: string]: unknown;
|
|
3661
|
+
};
|
|
3662
|
+
};
|
|
3663
|
+
export type PlatformApiGenericTableControllerCreateError = PlatformApiGenericTableControllerCreateErrors[keyof PlatformApiGenericTableControllerCreateErrors];
|
|
3664
|
+
export type PlatformApiGenericTableControllerCreateResponses = {
|
|
3665
|
+
/**
|
|
3666
|
+
* Generic table created
|
|
3667
|
+
*/
|
|
3668
|
+
201: GenericTableResponse;
|
|
3669
|
+
};
|
|
3670
|
+
export type PlatformApiGenericTableControllerCreateResponse = PlatformApiGenericTableControllerCreateResponses[keyof PlatformApiGenericTableControllerCreateResponses];
|
|
3671
|
+
export type PlatformApiMdmControllerVerifyData = {
|
|
3672
|
+
/**
|
|
3673
|
+
* Verification attributes
|
|
3674
|
+
*/
|
|
3675
|
+
body: MdmVerifyRequest;
|
|
3676
|
+
path: {
|
|
3677
|
+
/**
|
|
3678
|
+
* Tenant slug
|
|
3679
|
+
*/
|
|
3680
|
+
tenant_slug: string;
|
|
3681
|
+
/**
|
|
3682
|
+
* Datalake slug
|
|
3683
|
+
*/
|
|
3684
|
+
datalake_slug: string;
|
|
3685
|
+
};
|
|
3686
|
+
query?: never;
|
|
3687
|
+
url: '/api/v1/tenants/{tenant_slug}/datalakes/{datalake_slug}/mdm/verify';
|
|
3688
|
+
};
|
|
3689
|
+
export type PlatformApiMdmControllerVerifyErrors = {
|
|
3690
|
+
/**
|
|
3691
|
+
* Unauthorised
|
|
3692
|
+
*/
|
|
3693
|
+
401: {
|
|
3694
|
+
[key: string]: unknown;
|
|
3695
|
+
};
|
|
3696
|
+
/**
|
|
3697
|
+
* Not Found
|
|
3698
|
+
*/
|
|
3699
|
+
404: {
|
|
3700
|
+
[key: string]: unknown;
|
|
3701
|
+
};
|
|
3702
|
+
/**
|
|
3703
|
+
* Verification failed
|
|
3704
|
+
*/
|
|
3705
|
+
422: MdmVerifyResponse;
|
|
3706
|
+
};
|
|
3707
|
+
export type PlatformApiMdmControllerVerifyError = PlatformApiMdmControllerVerifyErrors[keyof PlatformApiMdmControllerVerifyErrors];
|
|
3708
|
+
export type PlatformApiMdmControllerVerifyResponses = {
|
|
3709
|
+
/**
|
|
3710
|
+
* Verification result
|
|
3711
|
+
*/
|
|
3712
|
+
200: MdmVerifyResponse;
|
|
3713
|
+
};
|
|
3714
|
+
export type PlatformApiMdmControllerVerifyResponse = PlatformApiMdmControllerVerifyResponses[keyof PlatformApiMdmControllerVerifyResponses];
|
|
3715
|
+
export type PlatformApiDatalakeControllerShowData = {
|
|
3716
|
+
body?: never;
|
|
3717
|
+
path: {
|
|
3718
|
+
/**
|
|
3719
|
+
* Tenant slug
|
|
3720
|
+
*/
|
|
3721
|
+
tenant_slug: string;
|
|
3722
|
+
/**
|
|
3723
|
+
* Datalake ID
|
|
3724
|
+
*/
|
|
3725
|
+
id: string;
|
|
3726
|
+
};
|
|
3727
|
+
query?: never;
|
|
3728
|
+
url: '/api/v1/tenants/{tenant_slug}/datalakes/{id}';
|
|
3729
|
+
};
|
|
3730
|
+
export type PlatformApiDatalakeControllerShowErrors = {
|
|
3731
|
+
/**
|
|
3732
|
+
* Unauthorised
|
|
3733
|
+
*/
|
|
3734
|
+
401: {
|
|
3735
|
+
[key: string]: unknown;
|
|
3736
|
+
};
|
|
3737
|
+
/**
|
|
3738
|
+
* Not Found
|
|
3739
|
+
*/
|
|
3740
|
+
404: {
|
|
3741
|
+
[key: string]: unknown;
|
|
3742
|
+
};
|
|
3743
|
+
};
|
|
3744
|
+
export type PlatformApiDatalakeControllerShowError = PlatformApiDatalakeControllerShowErrors[keyof PlatformApiDatalakeControllerShowErrors];
|
|
3745
|
+
export type PlatformApiDatalakeControllerShowResponses = {
|
|
3746
|
+
/**
|
|
3747
|
+
* Datalake
|
|
3748
|
+
*/
|
|
3749
|
+
200: DatalakeResponse;
|
|
3750
|
+
};
|
|
3751
|
+
export type PlatformApiDatalakeControllerShowResponse = PlatformApiDatalakeControllerShowResponses[keyof PlatformApiDatalakeControllerShowResponses];
|
|
3752
|
+
export type PlatformApiToolControllerIndexData = {
|
|
3753
|
+
body?: never;
|
|
3754
|
+
path: {
|
|
3755
|
+
/**
|
|
3756
|
+
* Tenant slug
|
|
3757
|
+
*/
|
|
3758
|
+
tenant_slug: string;
|
|
3759
|
+
};
|
|
3760
|
+
query?: {
|
|
3761
|
+
/**
|
|
3762
|
+
* Page number
|
|
3763
|
+
*/
|
|
3764
|
+
page?: number;
|
|
3765
|
+
/**
|
|
3766
|
+
* Items per page
|
|
3767
|
+
*/
|
|
3768
|
+
page_size?: number;
|
|
3769
|
+
};
|
|
3770
|
+
url: '/api/v1/tenants/{tenant_slug}/tools';
|
|
3771
|
+
};
|
|
3772
|
+
export type PlatformApiToolControllerIndexErrors = {
|
|
3773
|
+
/**
|
|
3774
|
+
* Unauthorised
|
|
3775
|
+
*/
|
|
3776
|
+
401: {
|
|
3777
|
+
[key: string]: unknown;
|
|
3778
|
+
};
|
|
3779
|
+
/**
|
|
3780
|
+
* Not Found
|
|
3781
|
+
*/
|
|
3782
|
+
404: {
|
|
3783
|
+
[key: string]: unknown;
|
|
3784
|
+
};
|
|
3785
|
+
};
|
|
3786
|
+
export type PlatformApiToolControllerIndexError = PlatformApiToolControllerIndexErrors[keyof PlatformApiToolControllerIndexErrors];
|
|
3787
|
+
export type PlatformApiToolControllerIndexResponses = {
|
|
3788
|
+
/**
|
|
3789
|
+
* Tool list
|
|
3790
|
+
*/
|
|
3791
|
+
200: ToolListResponse;
|
|
3792
|
+
};
|
|
3793
|
+
export type PlatformApiToolControllerIndexResponse = PlatformApiToolControllerIndexResponses[keyof PlatformApiToolControllerIndexResponses];
|
|
3794
|
+
export type PlatformApiToolControllerCreateData = {
|
|
3795
|
+
/**
|
|
3796
|
+
* Full Tool resource (PUT semantics — all fields required)
|
|
3797
|
+
*/
|
|
3798
|
+
body?: ToolRequestWritable;
|
|
3799
|
+
path: {
|
|
3800
|
+
/**
|
|
3801
|
+
* Tenant slug
|
|
3802
|
+
*/
|
|
3803
|
+
tenant_slug: string;
|
|
3804
|
+
};
|
|
3805
|
+
query?: never;
|
|
3806
|
+
url: '/api/v1/tenants/{tenant_slug}/tools';
|
|
3807
|
+
};
|
|
3808
|
+
export type PlatformApiToolControllerCreateErrors = {
|
|
3809
|
+
/**
|
|
3810
|
+
* Unauthorised
|
|
3811
|
+
*/
|
|
3812
|
+
401: {
|
|
3813
|
+
[key: string]: unknown;
|
|
3814
|
+
};
|
|
3815
|
+
/**
|
|
3816
|
+
* Unprocessable Entity
|
|
3817
|
+
*/
|
|
3818
|
+
422: {
|
|
3819
|
+
[key: string]: unknown;
|
|
3820
|
+
};
|
|
3821
|
+
};
|
|
3822
|
+
export type PlatformApiToolControllerCreateError = PlatformApiToolControllerCreateErrors[keyof PlatformApiToolControllerCreateErrors];
|
|
3823
|
+
export type PlatformApiToolControllerCreateResponses = {
|
|
3824
|
+
/**
|
|
3825
|
+
* Tool created
|
|
3826
|
+
*/
|
|
3827
|
+
201: ToolResponse;
|
|
3828
|
+
};
|
|
3829
|
+
export type PlatformApiToolControllerCreateResponse = PlatformApiToolControllerCreateResponses[keyof PlatformApiToolControllerCreateResponses];
|
|
3830
|
+
export type PlatformApiToolControllerDeleteData = {
|
|
3831
|
+
body?: never;
|
|
3832
|
+
path: {
|
|
3833
|
+
/**
|
|
3834
|
+
* Tenant slug
|
|
3835
|
+
*/
|
|
3836
|
+
tenant_slug: string;
|
|
3837
|
+
/**
|
|
3838
|
+
* Tool ID
|
|
3839
|
+
*/
|
|
3840
|
+
id: string;
|
|
3841
|
+
};
|
|
3842
|
+
query?: never;
|
|
3843
|
+
url: '/api/v1/tenants/{tenant_slug}/tools/{id}';
|
|
3844
|
+
};
|
|
3845
|
+
export type PlatformApiToolControllerDeleteErrors = {
|
|
3846
|
+
/**
|
|
3847
|
+
* Unauthorised
|
|
3848
|
+
*/
|
|
3849
|
+
401: {
|
|
3850
|
+
[key: string]: unknown;
|
|
3851
|
+
};
|
|
3852
|
+
/**
|
|
3853
|
+
* Not Found
|
|
3854
|
+
*/
|
|
3855
|
+
404: {
|
|
3856
|
+
[key: string]: unknown;
|
|
3857
|
+
};
|
|
3858
|
+
/**
|
|
3859
|
+
* Tool is referenced by another resource
|
|
3860
|
+
*/
|
|
3861
|
+
409: {
|
|
3862
|
+
errors?: {
|
|
3863
|
+
[key: string]: unknown;
|
|
3864
|
+
};
|
|
3865
|
+
};
|
|
3866
|
+
};
|
|
3867
|
+
export type PlatformApiToolControllerDeleteError = PlatformApiToolControllerDeleteErrors[keyof PlatformApiToolControllerDeleteErrors];
|
|
3868
|
+
export type PlatformApiToolControllerDeleteResponses = {
|
|
3869
|
+
/**
|
|
3870
|
+
* No Content
|
|
3871
|
+
*/
|
|
3872
|
+
204: void;
|
|
3873
|
+
};
|
|
3874
|
+
export type PlatformApiToolControllerDeleteResponse = PlatformApiToolControllerDeleteResponses[keyof PlatformApiToolControllerDeleteResponses];
|
|
3875
|
+
export type PlatformApiToolControllerShowData = {
|
|
3876
|
+
body?: never;
|
|
3877
|
+
path: {
|
|
3878
|
+
/**
|
|
3879
|
+
* Tenant slug
|
|
3880
|
+
*/
|
|
3881
|
+
tenant_slug: string;
|
|
3882
|
+
/**
|
|
3883
|
+
* Tool ID
|
|
3884
|
+
*/
|
|
3885
|
+
id: string;
|
|
3886
|
+
};
|
|
3887
|
+
query?: never;
|
|
3888
|
+
url: '/api/v1/tenants/{tenant_slug}/tools/{id}';
|
|
3889
|
+
};
|
|
3890
|
+
export type PlatformApiToolControllerShowErrors = {
|
|
3891
|
+
/**
|
|
3892
|
+
* Unauthorised
|
|
3893
|
+
*/
|
|
3894
|
+
401: {
|
|
3895
|
+
[key: string]: unknown;
|
|
3896
|
+
};
|
|
3897
|
+
/**
|
|
3898
|
+
* Not Found
|
|
3899
|
+
*/
|
|
3900
|
+
404: {
|
|
3901
|
+
[key: string]: unknown;
|
|
3902
|
+
};
|
|
3903
|
+
};
|
|
3904
|
+
export type PlatformApiToolControllerShowError = PlatformApiToolControllerShowErrors[keyof PlatformApiToolControllerShowErrors];
|
|
3905
|
+
export type PlatformApiToolControllerShowResponses = {
|
|
3906
|
+
/**
|
|
3907
|
+
* Tool
|
|
3908
|
+
*/
|
|
3909
|
+
200: ToolResponse;
|
|
3910
|
+
};
|
|
3911
|
+
export type PlatformApiToolControllerShowResponse = PlatformApiToolControllerShowResponses[keyof PlatformApiToolControllerShowResponses];
|
|
3912
|
+
export type PlatformApiToolControllerUpdateData = {
|
|
3913
|
+
/**
|
|
3914
|
+
* Full Tool resource (PUT semantics — all fields required)
|
|
3915
|
+
*/
|
|
3916
|
+
body?: ToolRequestWritable;
|
|
3917
|
+
path: {
|
|
3918
|
+
/**
|
|
3919
|
+
* Tenant slug
|
|
3920
|
+
*/
|
|
3921
|
+
tenant_slug: string;
|
|
3922
|
+
/**
|
|
3923
|
+
* Tool ID
|
|
3924
|
+
*/
|
|
3925
|
+
id: string;
|
|
3926
|
+
};
|
|
3927
|
+
query?: never;
|
|
3928
|
+
url: '/api/v1/tenants/{tenant_slug}/tools/{id}';
|
|
3929
|
+
};
|
|
3930
|
+
export type PlatformApiToolControllerUpdateErrors = {
|
|
3931
|
+
/**
|
|
3932
|
+
* Unauthorised
|
|
3933
|
+
*/
|
|
3934
|
+
401: {
|
|
3935
|
+
[key: string]: unknown;
|
|
3936
|
+
};
|
|
3937
|
+
/**
|
|
3938
|
+
* Not Found
|
|
3939
|
+
*/
|
|
3940
|
+
404: {
|
|
3941
|
+
[key: string]: unknown;
|
|
3942
|
+
};
|
|
3943
|
+
/**
|
|
3944
|
+
* Unprocessable Entity
|
|
3945
|
+
*/
|
|
3946
|
+
422: {
|
|
3947
|
+
[key: string]: unknown;
|
|
3948
|
+
};
|
|
3949
|
+
};
|
|
3950
|
+
export type PlatformApiToolControllerUpdateError = PlatformApiToolControllerUpdateErrors[keyof PlatformApiToolControllerUpdateErrors];
|
|
3951
|
+
export type PlatformApiToolControllerUpdateResponses = {
|
|
3952
|
+
/**
|
|
3953
|
+
* Tool updated
|
|
3954
|
+
*/
|
|
3955
|
+
200: ToolResponse;
|
|
3956
|
+
};
|
|
3957
|
+
export type PlatformApiToolControllerUpdateResponse = PlatformApiToolControllerUpdateResponses[keyof PlatformApiToolControllerUpdateResponses];
|
|
3958
|
+
//# sourceMappingURL=types.gen.d.ts.map
|