@robosystems/client 0.3.27 → 0.3.28
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/artifacts/{AgentClient.d.ts → OperatorClient.d.ts} +18 -18
- package/artifacts/{AgentClient.js → OperatorClient.js} +45 -45
- package/artifacts/{AgentClient.ts → OperatorClient.ts} +74 -70
- package/artifacts/graphql/generated/graphql.d.ts +3 -0
- package/artifacts/graphql/generated/graphql.ts +4 -0
- package/artifacts/index.d.ts +7 -7
- package/artifacts/index.js +11 -11
- package/artifacts/index.ts +11 -11
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +8 -8
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +13 -13
- package/sdk/sdk.gen.js +24 -24
- package/sdk/sdk.gen.ts +19 -19
- package/sdk/types.gen.d.ts +885 -885
- package/sdk/types.gen.ts +1027 -1027
- package/sdk.gen.d.ts +13 -13
- package/sdk.gen.js +24 -24
- package/sdk.gen.ts +19 -19
- package/types.gen.d.ts +885 -885
- package/types.gen.ts +1027 -1027
package/sdk/types.gen.ts
CHANGED
|
@@ -121,798 +121,467 @@ export type AddPublishListMembersOperation = {
|
|
|
121
121
|
};
|
|
122
122
|
|
|
123
123
|
/**
|
|
124
|
-
*
|
|
124
|
+
* ArtifactResponse
|
|
125
125
|
*
|
|
126
|
-
*
|
|
126
|
+
* The block's producible-artifact envelope — topic, template, mechanics.
|
|
127
127
|
*/
|
|
128
|
-
export type
|
|
128
|
+
export type ArtifactResponse = {
|
|
129
129
|
/**
|
|
130
|
-
*
|
|
130
|
+
* Topic
|
|
131
131
|
*
|
|
132
|
-
*
|
|
132
|
+
* Structure.description — the block's human-readable topic.
|
|
133
133
|
*/
|
|
134
|
-
|
|
135
|
-
[key: string]: {
|
|
136
|
-
[key: string]: unknown;
|
|
137
|
-
};
|
|
138
|
-
};
|
|
134
|
+
topic?: string | null;
|
|
139
135
|
/**
|
|
140
|
-
*
|
|
136
|
+
* Renderer Note
|
|
141
137
|
*
|
|
142
|
-
*
|
|
138
|
+
* e.g. 'in thousands', 'except per share'.
|
|
143
139
|
*/
|
|
144
|
-
|
|
140
|
+
renderer_note?: string | null;
|
|
141
|
+
/**
|
|
142
|
+
* Template
|
|
143
|
+
*
|
|
144
|
+
* Reusable layout (ordering, subtotals, styling) when attached. First-class templates are not yet implemented; this field is always null on currently-shipped block types.
|
|
145
|
+
*/
|
|
146
|
+
template?: {
|
|
147
|
+
[key: string]: unknown;
|
|
148
|
+
} | null;
|
|
149
|
+
/**
|
|
150
|
+
* Mechanics
|
|
151
|
+
*/
|
|
152
|
+
mechanics: ({
|
|
153
|
+
kind: 'closing_entry_generator';
|
|
154
|
+
} & ScheduleMechanics) | ({
|
|
155
|
+
kind: 'statement_renderer';
|
|
156
|
+
} & StatementMechanics) | ({
|
|
157
|
+
kind: 'metric';
|
|
158
|
+
} & MetricMechanics);
|
|
145
159
|
};
|
|
146
160
|
|
|
147
161
|
/**
|
|
148
|
-
*
|
|
162
|
+
* AssociationResponse
|
|
149
163
|
*
|
|
150
|
-
*
|
|
164
|
+
* One edge between two elements within a structure (parent/child
|
|
165
|
+
* presentation, calculation rollup, mapping, equivalence).
|
|
166
|
+
*
|
|
167
|
+
* ``association_type`` discriminates the edge semantics. Mapping edges
|
|
168
|
+
* are the user-facing path (CoA → reporting concept); presentation /
|
|
169
|
+
* calculation edges express structure layout and roll-ups.
|
|
170
|
+
* ``confidence`` is set on AI-suggested mappings (≥0.90 auto-approved,
|
|
171
|
+
* 0.70-0.89 flagged for review).
|
|
151
172
|
*/
|
|
152
|
-
export type
|
|
173
|
+
export type AssociationResponse = {
|
|
153
174
|
/**
|
|
154
|
-
*
|
|
155
|
-
*
|
|
156
|
-
* Message role (user/assistant)
|
|
175
|
+
* Id
|
|
157
176
|
*/
|
|
158
|
-
|
|
177
|
+
id: string;
|
|
159
178
|
/**
|
|
160
|
-
*
|
|
161
|
-
*
|
|
162
|
-
* Message content
|
|
179
|
+
* Structure Id
|
|
163
180
|
*/
|
|
164
|
-
|
|
181
|
+
structure_id: string;
|
|
165
182
|
/**
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
* Message timestamp
|
|
183
|
+
* From Element Id
|
|
169
184
|
*/
|
|
170
|
-
|
|
171
|
-
};
|
|
172
|
-
|
|
173
|
-
/**
|
|
174
|
-
* AgentMetadataResponse
|
|
175
|
-
*
|
|
176
|
-
* Response for agent metadata.
|
|
177
|
-
*/
|
|
178
|
-
export type AgentMetadataResponse = {
|
|
185
|
+
from_element_id: string;
|
|
179
186
|
/**
|
|
180
|
-
* Name
|
|
181
|
-
*
|
|
182
|
-
* Agent name
|
|
187
|
+
* From Element Name
|
|
183
188
|
*/
|
|
184
|
-
|
|
189
|
+
from_element_name?: string | null;
|
|
185
190
|
/**
|
|
186
|
-
*
|
|
187
|
-
*
|
|
188
|
-
* Agent description
|
|
191
|
+
* From Element Qname
|
|
189
192
|
*/
|
|
190
|
-
|
|
193
|
+
from_element_qname?: string | null;
|
|
191
194
|
/**
|
|
192
|
-
*
|
|
193
|
-
*
|
|
194
|
-
* Agent version
|
|
195
|
+
* To Element Id
|
|
195
196
|
*/
|
|
196
|
-
|
|
197
|
+
to_element_id: string;
|
|
197
198
|
/**
|
|
198
|
-
*
|
|
199
|
-
*
|
|
200
|
-
* Agent capabilities
|
|
199
|
+
* To Element Name
|
|
201
200
|
*/
|
|
202
|
-
|
|
201
|
+
to_element_name?: string | null;
|
|
203
202
|
/**
|
|
204
|
-
*
|
|
205
|
-
*
|
|
206
|
-
* Supported execution modes
|
|
203
|
+
* To Element Qname
|
|
207
204
|
*/
|
|
208
|
-
|
|
205
|
+
to_element_qname?: string | null;
|
|
209
206
|
/**
|
|
210
|
-
*
|
|
211
|
-
*
|
|
212
|
-
* Whether agent requires credits
|
|
207
|
+
* Association Type
|
|
213
208
|
*/
|
|
214
|
-
|
|
209
|
+
association_type: string;
|
|
215
210
|
/**
|
|
216
|
-
*
|
|
217
|
-
*
|
|
218
|
-
* Agent author
|
|
211
|
+
* Order Value
|
|
219
212
|
*/
|
|
220
|
-
|
|
213
|
+
order_value?: number | null;
|
|
221
214
|
/**
|
|
222
|
-
*
|
|
223
|
-
*
|
|
224
|
-
* Agent tags
|
|
215
|
+
* Weight
|
|
225
216
|
*/
|
|
226
|
-
|
|
217
|
+
weight?: number | null;
|
|
218
|
+
/**
|
|
219
|
+
* Confidence
|
|
220
|
+
*/
|
|
221
|
+
confidence?: number | null;
|
|
222
|
+
/**
|
|
223
|
+
* Suggested By
|
|
224
|
+
*/
|
|
225
|
+
suggested_by?: string | null;
|
|
226
|
+
/**
|
|
227
|
+
* Approved By
|
|
228
|
+
*/
|
|
229
|
+
approved_by?: string | null;
|
|
227
230
|
};
|
|
228
231
|
|
|
229
232
|
/**
|
|
230
|
-
*
|
|
231
|
-
*
|
|
232
|
-
* Agent execution modes.
|
|
233
|
-
*/
|
|
234
|
-
export type AgentMode = 'quick' | 'standard' | 'extended' | 'streaming';
|
|
235
|
-
|
|
236
|
-
/**
|
|
237
|
-
* AgentRecommendation
|
|
233
|
+
* AuthResponse
|
|
238
234
|
*
|
|
239
|
-
*
|
|
235
|
+
* Authentication response model.
|
|
240
236
|
*/
|
|
241
|
-
export type
|
|
237
|
+
export type AuthResponse = {
|
|
242
238
|
/**
|
|
243
|
-
*
|
|
239
|
+
* User
|
|
244
240
|
*
|
|
245
|
-
*
|
|
241
|
+
* User information
|
|
246
242
|
*/
|
|
247
|
-
|
|
243
|
+
user: {
|
|
244
|
+
[key: string]: unknown;
|
|
245
|
+
};
|
|
248
246
|
/**
|
|
249
|
-
*
|
|
247
|
+
* Org
|
|
250
248
|
*
|
|
251
|
-
*
|
|
249
|
+
* Organization information (personal org created automatically on registration)
|
|
252
250
|
*/
|
|
253
|
-
|
|
251
|
+
org?: {
|
|
252
|
+
[key: string]: unknown;
|
|
253
|
+
} | null;
|
|
254
254
|
/**
|
|
255
|
-
*
|
|
255
|
+
* Message
|
|
256
256
|
*
|
|
257
|
-
*
|
|
257
|
+
* Success message
|
|
258
258
|
*/
|
|
259
|
-
|
|
259
|
+
message: string;
|
|
260
260
|
/**
|
|
261
|
-
*
|
|
261
|
+
* Token
|
|
262
262
|
*
|
|
263
|
-
*
|
|
263
|
+
* JWT authentication token (optional for cookie-based auth)
|
|
264
264
|
*/
|
|
265
|
-
|
|
265
|
+
token?: string | null;
|
|
266
266
|
/**
|
|
267
|
-
*
|
|
267
|
+
* Expires In
|
|
268
268
|
*
|
|
269
|
-
*
|
|
269
|
+
* Token expiry time in seconds from now
|
|
270
270
|
*/
|
|
271
|
-
|
|
271
|
+
expires_in?: number | null;
|
|
272
|
+
/**
|
|
273
|
+
* Refresh Threshold
|
|
274
|
+
*
|
|
275
|
+
* Recommended refresh threshold in seconds before expiry
|
|
276
|
+
*/
|
|
277
|
+
refresh_threshold?: number | null;
|
|
272
278
|
};
|
|
273
279
|
|
|
274
280
|
/**
|
|
275
|
-
*
|
|
281
|
+
* AutoMapElementsOperation
|
|
282
|
+
*
|
|
283
|
+
* Run the MappingOperator over a mapping structure (async).
|
|
276
284
|
*
|
|
277
|
-
*
|
|
285
|
+
* The MappingOperator walks every unmapped CoA element and proposes
|
|
286
|
+
* associations to reporting concepts. Confidence thresholds: ≥0.90
|
|
287
|
+
* auto-approved (association created), 0.70-0.89 flagged for review
|
|
288
|
+
* (created with `confidence` set; surface it in your UI), <0.70 skipped.
|
|
289
|
+
* Returns a `pending` envelope immediately; subscribe to the SSE stream
|
|
290
|
+
* for progress.
|
|
278
291
|
*/
|
|
279
|
-
export type
|
|
292
|
+
export type AutoMapElementsOperation = {
|
|
280
293
|
/**
|
|
281
|
-
*
|
|
294
|
+
* Mapping Id
|
|
282
295
|
*
|
|
283
|
-
*
|
|
296
|
+
* The mapping structure to populate.
|
|
284
297
|
*/
|
|
285
|
-
|
|
298
|
+
mapping_id: string;
|
|
299
|
+
};
|
|
300
|
+
|
|
301
|
+
/**
|
|
302
|
+
* AvailableExtension
|
|
303
|
+
*/
|
|
304
|
+
export type AvailableExtension = {
|
|
286
305
|
/**
|
|
287
|
-
*
|
|
288
|
-
*
|
|
289
|
-
* Additional context
|
|
306
|
+
* Name
|
|
290
307
|
*/
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
308
|
+
name: string;
|
|
309
|
+
/**
|
|
310
|
+
* Description
|
|
311
|
+
*/
|
|
312
|
+
description: string;
|
|
313
|
+
/**
|
|
314
|
+
* Enabled
|
|
315
|
+
*/
|
|
316
|
+
enabled?: boolean;
|
|
294
317
|
};
|
|
295
318
|
|
|
296
319
|
/**
|
|
297
|
-
*
|
|
298
|
-
*
|
|
299
|
-
* Response for agent recommendations.
|
|
320
|
+
* AvailableExtensionsResponse
|
|
300
321
|
*/
|
|
301
|
-
export type
|
|
322
|
+
export type AvailableExtensionsResponse = {
|
|
302
323
|
/**
|
|
303
|
-
*
|
|
304
|
-
*
|
|
305
|
-
* List of agent recommendations sorted by confidence
|
|
324
|
+
* Extensions
|
|
306
325
|
*/
|
|
307
|
-
|
|
326
|
+
extensions: Array<AvailableExtension>;
|
|
327
|
+
};
|
|
328
|
+
|
|
329
|
+
/**
|
|
330
|
+
* AvailableGraphTiersResponse
|
|
331
|
+
*
|
|
332
|
+
* Response containing available graph tiers.
|
|
333
|
+
*/
|
|
334
|
+
export type AvailableGraphTiersResponse = {
|
|
308
335
|
/**
|
|
309
|
-
*
|
|
336
|
+
* Tiers
|
|
310
337
|
*
|
|
311
|
-
*
|
|
338
|
+
* List of available tiers
|
|
312
339
|
*/
|
|
313
|
-
|
|
340
|
+
tiers: Array<GraphTierInfo>;
|
|
314
341
|
};
|
|
315
342
|
|
|
316
343
|
/**
|
|
317
|
-
*
|
|
344
|
+
* BackupCreateRequest
|
|
318
345
|
*
|
|
319
|
-
* Request model for
|
|
346
|
+
* Request model for creating a backup.
|
|
320
347
|
*/
|
|
321
|
-
export type
|
|
348
|
+
export type BackupCreateRequest = {
|
|
322
349
|
/**
|
|
323
|
-
*
|
|
350
|
+
* Backup Format
|
|
324
351
|
*
|
|
325
|
-
*
|
|
352
|
+
* Backup format - only 'full_dump' is supported (complete .lbug database file)
|
|
326
353
|
*/
|
|
327
|
-
|
|
354
|
+
backup_format?: string;
|
|
328
355
|
/**
|
|
329
|
-
*
|
|
356
|
+
* Backup Type
|
|
330
357
|
*
|
|
331
|
-
*
|
|
358
|
+
* Backup type - only 'full' is supported
|
|
332
359
|
*/
|
|
333
|
-
|
|
360
|
+
backup_type?: string;
|
|
334
361
|
/**
|
|
335
|
-
*
|
|
362
|
+
* Retention Days
|
|
336
363
|
*
|
|
337
|
-
*
|
|
338
|
-
*/
|
|
339
|
-
context?: {
|
|
340
|
-
[key: string]: unknown;
|
|
341
|
-
} | null;
|
|
342
|
-
/**
|
|
343
|
-
* Execution mode
|
|
364
|
+
* Retention period in days
|
|
344
365
|
*/
|
|
345
|
-
|
|
366
|
+
retention_days?: number;
|
|
346
367
|
/**
|
|
347
|
-
*
|
|
368
|
+
* Compression
|
|
348
369
|
*
|
|
349
|
-
*
|
|
370
|
+
* Enable compression (always enabled for optimal storage)
|
|
350
371
|
*/
|
|
351
|
-
|
|
372
|
+
compression?: boolean;
|
|
352
373
|
/**
|
|
353
|
-
*
|
|
374
|
+
* Encryption
|
|
375
|
+
*
|
|
376
|
+
* Enable encryption (encrypted backups cannot be downloaded)
|
|
354
377
|
*/
|
|
355
|
-
|
|
378
|
+
encryption?: boolean;
|
|
356
379
|
/**
|
|
357
|
-
*
|
|
380
|
+
* Schedule
|
|
358
381
|
*
|
|
359
|
-
*
|
|
360
|
-
*/
|
|
361
|
-
force_extended_analysis?: boolean;
|
|
362
|
-
/**
|
|
363
|
-
* Enable Rag
|
|
364
|
-
*
|
|
365
|
-
* Enable RAG context enrichment
|
|
366
|
-
*/
|
|
367
|
-
enable_rag?: boolean;
|
|
368
|
-
/**
|
|
369
|
-
* Stream
|
|
370
|
-
*
|
|
371
|
-
* Enable streaming response
|
|
382
|
+
* Optional cron schedule for automated backups
|
|
372
383
|
*/
|
|
373
|
-
|
|
384
|
+
schedule?: string | null;
|
|
374
385
|
};
|
|
375
386
|
|
|
376
387
|
/**
|
|
377
|
-
*
|
|
388
|
+
* BackupDownloadUrlResponse
|
|
378
389
|
*
|
|
379
|
-
* Response model for
|
|
390
|
+
* Response model for backup download URL generation.
|
|
380
391
|
*/
|
|
381
|
-
export type
|
|
382
|
-
/**
|
|
383
|
-
* Content
|
|
384
|
-
*
|
|
385
|
-
* The agent's response content
|
|
386
|
-
*/
|
|
387
|
-
content: string;
|
|
388
|
-
/**
|
|
389
|
-
* Agent Used
|
|
390
|
-
*
|
|
391
|
-
* The agent type that handled the request
|
|
392
|
-
*/
|
|
393
|
-
agent_used: string;
|
|
394
|
-
/**
|
|
395
|
-
* The execution mode used
|
|
396
|
-
*/
|
|
397
|
-
mode_used: AgentMode;
|
|
392
|
+
export type BackupDownloadUrlResponse = {
|
|
398
393
|
/**
|
|
399
|
-
*
|
|
394
|
+
* Download Url
|
|
400
395
|
*
|
|
401
|
-
*
|
|
396
|
+
* Pre-signed S3 URL for downloading the backup file
|
|
402
397
|
*/
|
|
403
|
-
|
|
404
|
-
[key: string]: unknown;
|
|
405
|
-
} | null;
|
|
398
|
+
download_url: string;
|
|
406
399
|
/**
|
|
407
|
-
*
|
|
400
|
+
* Expires In
|
|
408
401
|
*
|
|
409
|
-
*
|
|
402
|
+
* URL expiration time in seconds from now
|
|
410
403
|
*/
|
|
411
|
-
|
|
412
|
-
[key: string]: number;
|
|
413
|
-
} | null;
|
|
404
|
+
expires_in: number;
|
|
414
405
|
/**
|
|
415
|
-
*
|
|
406
|
+
* Expires At
|
|
416
407
|
*
|
|
417
|
-
*
|
|
408
|
+
* Unix timestamp when the URL expires
|
|
418
409
|
*/
|
|
419
|
-
|
|
410
|
+
expires_at: number;
|
|
420
411
|
/**
|
|
421
|
-
*
|
|
412
|
+
* Backup Id
|
|
422
413
|
*
|
|
423
|
-
*
|
|
414
|
+
* Backup identifier
|
|
424
415
|
*/
|
|
425
|
-
|
|
416
|
+
backup_id: string;
|
|
426
417
|
/**
|
|
427
|
-
*
|
|
418
|
+
* Graph Id
|
|
428
419
|
*
|
|
429
|
-
*
|
|
420
|
+
* Graph database identifier
|
|
430
421
|
*/
|
|
431
|
-
|
|
422
|
+
graph_id: string;
|
|
423
|
+
};
|
|
424
|
+
|
|
425
|
+
/**
|
|
426
|
+
* BackupLimits
|
|
427
|
+
*
|
|
428
|
+
* Backup operation limits.
|
|
429
|
+
*/
|
|
430
|
+
export type BackupLimits = {
|
|
432
431
|
/**
|
|
433
|
-
*
|
|
432
|
+
* Max Backup Size Gb
|
|
434
433
|
*
|
|
435
|
-
*
|
|
434
|
+
* Maximum backup size in GB
|
|
436
435
|
*/
|
|
437
|
-
|
|
438
|
-
[key: string]: unknown;
|
|
439
|
-
} | null;
|
|
436
|
+
max_backup_size_gb: number;
|
|
440
437
|
/**
|
|
441
|
-
*
|
|
438
|
+
* Backup Retention Days
|
|
442
439
|
*
|
|
443
|
-
*
|
|
440
|
+
* Backup retention period in days
|
|
444
441
|
*/
|
|
445
|
-
|
|
442
|
+
backup_retention_days: number;
|
|
446
443
|
/**
|
|
447
|
-
*
|
|
444
|
+
* Max Backups Per Day
|
|
448
445
|
*
|
|
449
|
-
*
|
|
446
|
+
* Maximum backups per day
|
|
450
447
|
*/
|
|
451
|
-
|
|
448
|
+
max_backups_per_day: number;
|
|
452
449
|
};
|
|
453
450
|
|
|
454
451
|
/**
|
|
455
|
-
*
|
|
452
|
+
* BackupListResponse
|
|
456
453
|
*
|
|
457
|
-
*
|
|
454
|
+
* Response model for backup list.
|
|
458
455
|
*/
|
|
459
|
-
export type
|
|
456
|
+
export type BackupListResponse = {
|
|
460
457
|
/**
|
|
461
|
-
*
|
|
462
|
-
*
|
|
463
|
-
* Structure.description — the block's human-readable topic.
|
|
458
|
+
* Backups
|
|
464
459
|
*/
|
|
465
|
-
|
|
460
|
+
backups: Array<BackupResponse>;
|
|
466
461
|
/**
|
|
467
|
-
*
|
|
468
|
-
*
|
|
469
|
-
* e.g. 'in thousands', 'except per share'.
|
|
462
|
+
* Total Count
|
|
470
463
|
*/
|
|
471
|
-
|
|
464
|
+
total_count: number;
|
|
472
465
|
/**
|
|
473
|
-
*
|
|
466
|
+
* Graph Id
|
|
467
|
+
*/
|
|
468
|
+
graph_id: string;
|
|
469
|
+
/**
|
|
470
|
+
* Is Shared Repository
|
|
474
471
|
*
|
|
475
|
-
*
|
|
472
|
+
* Whether this is a shared repository (limits apply)
|
|
476
473
|
*/
|
|
477
|
-
|
|
478
|
-
[key: string]: unknown;
|
|
479
|
-
} | null;
|
|
474
|
+
is_shared_repository?: boolean;
|
|
480
475
|
/**
|
|
481
|
-
*
|
|
476
|
+
* Download quota for shared repositories
|
|
482
477
|
*/
|
|
483
|
-
|
|
484
|
-
kind: 'closing_entry_generator';
|
|
485
|
-
} & ScheduleMechanics) | ({
|
|
486
|
-
kind: 'statement_renderer';
|
|
487
|
-
} & StatementMechanics) | ({
|
|
488
|
-
kind: 'metric';
|
|
489
|
-
} & MetricMechanics);
|
|
478
|
+
download_quota?: DownloadQuota | null;
|
|
490
479
|
};
|
|
491
480
|
|
|
492
481
|
/**
|
|
493
|
-
*
|
|
494
|
-
*
|
|
495
|
-
* One edge between two elements within a structure (parent/child
|
|
496
|
-
* presentation, calculation rollup, mapping, equivalence).
|
|
482
|
+
* BackupResponse
|
|
497
483
|
*
|
|
498
|
-
*
|
|
499
|
-
* are the user-facing path (CoA → reporting concept); presentation /
|
|
500
|
-
* calculation edges express structure layout and roll-ups.
|
|
501
|
-
* ``confidence`` is set on AI-suggested mappings (≥0.90 auto-approved,
|
|
502
|
-
* 0.70-0.89 flagged for review).
|
|
484
|
+
* Response model for backup information.
|
|
503
485
|
*/
|
|
504
|
-
export type
|
|
486
|
+
export type BackupResponse = {
|
|
505
487
|
/**
|
|
506
|
-
* Id
|
|
488
|
+
* Backup Id
|
|
507
489
|
*/
|
|
508
|
-
|
|
490
|
+
backup_id: string;
|
|
509
491
|
/**
|
|
510
|
-
*
|
|
492
|
+
* Graph Id
|
|
511
493
|
*/
|
|
512
|
-
|
|
494
|
+
graph_id: string;
|
|
513
495
|
/**
|
|
514
|
-
*
|
|
496
|
+
* Backup Format
|
|
515
497
|
*/
|
|
516
|
-
|
|
498
|
+
backup_format: string;
|
|
517
499
|
/**
|
|
518
|
-
*
|
|
500
|
+
* Backup Type
|
|
519
501
|
*/
|
|
520
|
-
|
|
502
|
+
backup_type: string;
|
|
521
503
|
/**
|
|
522
|
-
*
|
|
504
|
+
* Status
|
|
523
505
|
*/
|
|
524
|
-
|
|
506
|
+
status: string;
|
|
525
507
|
/**
|
|
526
|
-
*
|
|
508
|
+
* Original Size Bytes
|
|
527
509
|
*/
|
|
528
|
-
|
|
510
|
+
original_size_bytes: number;
|
|
529
511
|
/**
|
|
530
|
-
*
|
|
512
|
+
* Compressed Size Bytes
|
|
531
513
|
*/
|
|
532
|
-
|
|
514
|
+
compressed_size_bytes: number;
|
|
533
515
|
/**
|
|
534
|
-
*
|
|
516
|
+
* Compression Ratio
|
|
535
517
|
*/
|
|
536
|
-
|
|
518
|
+
compression_ratio: number;
|
|
537
519
|
/**
|
|
538
|
-
*
|
|
520
|
+
* Node Count
|
|
539
521
|
*/
|
|
540
|
-
|
|
522
|
+
node_count: number;
|
|
541
523
|
/**
|
|
542
|
-
*
|
|
524
|
+
* Relationship Count
|
|
543
525
|
*/
|
|
544
|
-
|
|
526
|
+
relationship_count: number;
|
|
545
527
|
/**
|
|
546
|
-
*
|
|
528
|
+
* Backup Duration Seconds
|
|
547
529
|
*/
|
|
548
|
-
|
|
530
|
+
backup_duration_seconds: number;
|
|
549
531
|
/**
|
|
550
|
-
*
|
|
532
|
+
* Encryption Enabled
|
|
551
533
|
*/
|
|
552
|
-
|
|
534
|
+
encryption_enabled: boolean;
|
|
553
535
|
/**
|
|
554
|
-
*
|
|
536
|
+
* Compression Enabled
|
|
555
537
|
*/
|
|
556
|
-
|
|
538
|
+
compression_enabled: boolean;
|
|
557
539
|
/**
|
|
558
|
-
*
|
|
540
|
+
* Allow Export
|
|
559
541
|
*/
|
|
560
|
-
|
|
542
|
+
allow_export: boolean;
|
|
543
|
+
/**
|
|
544
|
+
* Created At
|
|
545
|
+
*/
|
|
546
|
+
created_at: string;
|
|
547
|
+
/**
|
|
548
|
+
* Completed At
|
|
549
|
+
*/
|
|
550
|
+
completed_at: string | null;
|
|
551
|
+
/**
|
|
552
|
+
* Expires At
|
|
553
|
+
*/
|
|
554
|
+
expires_at: string | null;
|
|
561
555
|
};
|
|
562
556
|
|
|
563
557
|
/**
|
|
564
|
-
*
|
|
558
|
+
* BackupStatsResponse
|
|
565
559
|
*
|
|
566
|
-
*
|
|
560
|
+
* Response model for backup statistics.
|
|
567
561
|
*/
|
|
568
|
-
export type
|
|
562
|
+
export type BackupStatsResponse = {
|
|
569
563
|
/**
|
|
570
|
-
*
|
|
571
|
-
*
|
|
572
|
-
* User information
|
|
564
|
+
* Graph Id
|
|
573
565
|
*/
|
|
574
|
-
|
|
575
|
-
[key: string]: unknown;
|
|
576
|
-
};
|
|
566
|
+
graph_id: string;
|
|
577
567
|
/**
|
|
578
|
-
*
|
|
579
|
-
*
|
|
580
|
-
* Organization information (personal org created automatically on registration)
|
|
568
|
+
* Total Backups
|
|
581
569
|
*/
|
|
582
|
-
|
|
583
|
-
[key: string]: unknown;
|
|
584
|
-
} | null;
|
|
570
|
+
total_backups: number;
|
|
585
571
|
/**
|
|
586
|
-
*
|
|
587
|
-
*
|
|
588
|
-
* Success message
|
|
572
|
+
* Successful Backups
|
|
589
573
|
*/
|
|
590
|
-
|
|
574
|
+
successful_backups: number;
|
|
591
575
|
/**
|
|
592
|
-
*
|
|
593
|
-
*
|
|
594
|
-
* JWT authentication token (optional for cookie-based auth)
|
|
576
|
+
* Failed Backups
|
|
595
577
|
*/
|
|
596
|
-
|
|
578
|
+
failed_backups: number;
|
|
597
579
|
/**
|
|
598
|
-
*
|
|
599
|
-
*
|
|
600
|
-
* Token expiry time in seconds from now
|
|
580
|
+
* Success Rate
|
|
601
581
|
*/
|
|
602
|
-
|
|
582
|
+
success_rate: number;
|
|
603
583
|
/**
|
|
604
|
-
*
|
|
605
|
-
*
|
|
606
|
-
* Recommended refresh threshold in seconds before expiry
|
|
607
|
-
*/
|
|
608
|
-
refresh_threshold?: number | null;
|
|
609
|
-
};
|
|
610
|
-
|
|
611
|
-
/**
|
|
612
|
-
* AutoMapElementsOperation
|
|
613
|
-
*
|
|
614
|
-
* Run the MappingAgent over a mapping structure (async).
|
|
615
|
-
*
|
|
616
|
-
* The MappingAgent walks every unmapped CoA element and proposes
|
|
617
|
-
* associations to reporting concepts. Confidence thresholds: ≥0.90
|
|
618
|
-
* auto-approved (association created), 0.70-0.89 flagged for review
|
|
619
|
-
* (created with `confidence` set; surface it in your UI), <0.70 skipped.
|
|
620
|
-
* Returns a `pending` envelope immediately; subscribe to the SSE stream
|
|
621
|
-
* for progress.
|
|
622
|
-
*/
|
|
623
|
-
export type AutoMapElementsOperation = {
|
|
624
|
-
/**
|
|
625
|
-
* Mapping Id
|
|
626
|
-
*
|
|
627
|
-
* The mapping structure to populate.
|
|
628
|
-
*/
|
|
629
|
-
mapping_id: string;
|
|
630
|
-
};
|
|
631
|
-
|
|
632
|
-
/**
|
|
633
|
-
* AvailableExtension
|
|
634
|
-
*/
|
|
635
|
-
export type AvailableExtension = {
|
|
636
|
-
/**
|
|
637
|
-
* Name
|
|
638
|
-
*/
|
|
639
|
-
name: string;
|
|
640
|
-
/**
|
|
641
|
-
* Description
|
|
642
|
-
*/
|
|
643
|
-
description: string;
|
|
644
|
-
/**
|
|
645
|
-
* Enabled
|
|
646
|
-
*/
|
|
647
|
-
enabled?: boolean;
|
|
648
|
-
};
|
|
649
|
-
|
|
650
|
-
/**
|
|
651
|
-
* AvailableExtensionsResponse
|
|
652
|
-
*/
|
|
653
|
-
export type AvailableExtensionsResponse = {
|
|
654
|
-
/**
|
|
655
|
-
* Extensions
|
|
656
|
-
*/
|
|
657
|
-
extensions: Array<AvailableExtension>;
|
|
658
|
-
};
|
|
659
|
-
|
|
660
|
-
/**
|
|
661
|
-
* AvailableGraphTiersResponse
|
|
662
|
-
*
|
|
663
|
-
* Response containing available graph tiers.
|
|
664
|
-
*/
|
|
665
|
-
export type AvailableGraphTiersResponse = {
|
|
666
|
-
/**
|
|
667
|
-
* Tiers
|
|
668
|
-
*
|
|
669
|
-
* List of available tiers
|
|
670
|
-
*/
|
|
671
|
-
tiers: Array<GraphTierInfo>;
|
|
672
|
-
};
|
|
673
|
-
|
|
674
|
-
/**
|
|
675
|
-
* BackupCreateRequest
|
|
676
|
-
*
|
|
677
|
-
* Request model for creating a backup.
|
|
678
|
-
*/
|
|
679
|
-
export type BackupCreateRequest = {
|
|
680
|
-
/**
|
|
681
|
-
* Backup Format
|
|
682
|
-
*
|
|
683
|
-
* Backup format - only 'full_dump' is supported (complete .lbug database file)
|
|
684
|
-
*/
|
|
685
|
-
backup_format?: string;
|
|
686
|
-
/**
|
|
687
|
-
* Backup Type
|
|
688
|
-
*
|
|
689
|
-
* Backup type - only 'full' is supported
|
|
690
|
-
*/
|
|
691
|
-
backup_type?: string;
|
|
692
|
-
/**
|
|
693
|
-
* Retention Days
|
|
694
|
-
*
|
|
695
|
-
* Retention period in days
|
|
696
|
-
*/
|
|
697
|
-
retention_days?: number;
|
|
698
|
-
/**
|
|
699
|
-
* Compression
|
|
700
|
-
*
|
|
701
|
-
* Enable compression (always enabled for optimal storage)
|
|
702
|
-
*/
|
|
703
|
-
compression?: boolean;
|
|
704
|
-
/**
|
|
705
|
-
* Encryption
|
|
706
|
-
*
|
|
707
|
-
* Enable encryption (encrypted backups cannot be downloaded)
|
|
708
|
-
*/
|
|
709
|
-
encryption?: boolean;
|
|
710
|
-
/**
|
|
711
|
-
* Schedule
|
|
712
|
-
*
|
|
713
|
-
* Optional cron schedule for automated backups
|
|
714
|
-
*/
|
|
715
|
-
schedule?: string | null;
|
|
716
|
-
};
|
|
717
|
-
|
|
718
|
-
/**
|
|
719
|
-
* BackupDownloadUrlResponse
|
|
720
|
-
*
|
|
721
|
-
* Response model for backup download URL generation.
|
|
722
|
-
*/
|
|
723
|
-
export type BackupDownloadUrlResponse = {
|
|
724
|
-
/**
|
|
725
|
-
* Download Url
|
|
726
|
-
*
|
|
727
|
-
* Pre-signed S3 URL for downloading the backup file
|
|
728
|
-
*/
|
|
729
|
-
download_url: string;
|
|
730
|
-
/**
|
|
731
|
-
* Expires In
|
|
732
|
-
*
|
|
733
|
-
* URL expiration time in seconds from now
|
|
734
|
-
*/
|
|
735
|
-
expires_in: number;
|
|
736
|
-
/**
|
|
737
|
-
* Expires At
|
|
738
|
-
*
|
|
739
|
-
* Unix timestamp when the URL expires
|
|
740
|
-
*/
|
|
741
|
-
expires_at: number;
|
|
742
|
-
/**
|
|
743
|
-
* Backup Id
|
|
744
|
-
*
|
|
745
|
-
* Backup identifier
|
|
746
|
-
*/
|
|
747
|
-
backup_id: string;
|
|
748
|
-
/**
|
|
749
|
-
* Graph Id
|
|
750
|
-
*
|
|
751
|
-
* Graph database identifier
|
|
752
|
-
*/
|
|
753
|
-
graph_id: string;
|
|
754
|
-
};
|
|
755
|
-
|
|
756
|
-
/**
|
|
757
|
-
* BackupLimits
|
|
758
|
-
*
|
|
759
|
-
* Backup operation limits.
|
|
760
|
-
*/
|
|
761
|
-
export type BackupLimits = {
|
|
762
|
-
/**
|
|
763
|
-
* Max Backup Size Gb
|
|
764
|
-
*
|
|
765
|
-
* Maximum backup size in GB
|
|
766
|
-
*/
|
|
767
|
-
max_backup_size_gb: number;
|
|
768
|
-
/**
|
|
769
|
-
* Backup Retention Days
|
|
770
|
-
*
|
|
771
|
-
* Backup retention period in days
|
|
772
|
-
*/
|
|
773
|
-
backup_retention_days: number;
|
|
774
|
-
/**
|
|
775
|
-
* Max Backups Per Day
|
|
776
|
-
*
|
|
777
|
-
* Maximum backups per day
|
|
778
|
-
*/
|
|
779
|
-
max_backups_per_day: number;
|
|
780
|
-
};
|
|
781
|
-
|
|
782
|
-
/**
|
|
783
|
-
* BackupListResponse
|
|
784
|
-
*
|
|
785
|
-
* Response model for backup list.
|
|
786
|
-
*/
|
|
787
|
-
export type BackupListResponse = {
|
|
788
|
-
/**
|
|
789
|
-
* Backups
|
|
790
|
-
*/
|
|
791
|
-
backups: Array<BackupResponse>;
|
|
792
|
-
/**
|
|
793
|
-
* Total Count
|
|
794
|
-
*/
|
|
795
|
-
total_count: number;
|
|
796
|
-
/**
|
|
797
|
-
* Graph Id
|
|
798
|
-
*/
|
|
799
|
-
graph_id: string;
|
|
800
|
-
/**
|
|
801
|
-
* Is Shared Repository
|
|
802
|
-
*
|
|
803
|
-
* Whether this is a shared repository (limits apply)
|
|
804
|
-
*/
|
|
805
|
-
is_shared_repository?: boolean;
|
|
806
|
-
/**
|
|
807
|
-
* Download quota for shared repositories
|
|
808
|
-
*/
|
|
809
|
-
download_quota?: DownloadQuota | null;
|
|
810
|
-
};
|
|
811
|
-
|
|
812
|
-
/**
|
|
813
|
-
* BackupResponse
|
|
814
|
-
*
|
|
815
|
-
* Response model for backup information.
|
|
816
|
-
*/
|
|
817
|
-
export type BackupResponse = {
|
|
818
|
-
/**
|
|
819
|
-
* Backup Id
|
|
820
|
-
*/
|
|
821
|
-
backup_id: string;
|
|
822
|
-
/**
|
|
823
|
-
* Graph Id
|
|
824
|
-
*/
|
|
825
|
-
graph_id: string;
|
|
826
|
-
/**
|
|
827
|
-
* Backup Format
|
|
828
|
-
*/
|
|
829
|
-
backup_format: string;
|
|
830
|
-
/**
|
|
831
|
-
* Backup Type
|
|
832
|
-
*/
|
|
833
|
-
backup_type: string;
|
|
834
|
-
/**
|
|
835
|
-
* Status
|
|
836
|
-
*/
|
|
837
|
-
status: string;
|
|
838
|
-
/**
|
|
839
|
-
* Original Size Bytes
|
|
840
|
-
*/
|
|
841
|
-
original_size_bytes: number;
|
|
842
|
-
/**
|
|
843
|
-
* Compressed Size Bytes
|
|
844
|
-
*/
|
|
845
|
-
compressed_size_bytes: number;
|
|
846
|
-
/**
|
|
847
|
-
* Compression Ratio
|
|
848
|
-
*/
|
|
849
|
-
compression_ratio: number;
|
|
850
|
-
/**
|
|
851
|
-
* Node Count
|
|
852
|
-
*/
|
|
853
|
-
node_count: number;
|
|
854
|
-
/**
|
|
855
|
-
* Relationship Count
|
|
856
|
-
*/
|
|
857
|
-
relationship_count: number;
|
|
858
|
-
/**
|
|
859
|
-
* Backup Duration Seconds
|
|
860
|
-
*/
|
|
861
|
-
backup_duration_seconds: number;
|
|
862
|
-
/**
|
|
863
|
-
* Encryption Enabled
|
|
864
|
-
*/
|
|
865
|
-
encryption_enabled: boolean;
|
|
866
|
-
/**
|
|
867
|
-
* Compression Enabled
|
|
868
|
-
*/
|
|
869
|
-
compression_enabled: boolean;
|
|
870
|
-
/**
|
|
871
|
-
* Allow Export
|
|
872
|
-
*/
|
|
873
|
-
allow_export: boolean;
|
|
874
|
-
/**
|
|
875
|
-
* Created At
|
|
876
|
-
*/
|
|
877
|
-
created_at: string;
|
|
878
|
-
/**
|
|
879
|
-
* Completed At
|
|
880
|
-
*/
|
|
881
|
-
completed_at: string | null;
|
|
882
|
-
/**
|
|
883
|
-
* Expires At
|
|
884
|
-
*/
|
|
885
|
-
expires_at: string | null;
|
|
886
|
-
};
|
|
887
|
-
|
|
888
|
-
/**
|
|
889
|
-
* BackupStatsResponse
|
|
890
|
-
*
|
|
891
|
-
* Response model for backup statistics.
|
|
892
|
-
*/
|
|
893
|
-
export type BackupStatsResponse = {
|
|
894
|
-
/**
|
|
895
|
-
* Graph Id
|
|
896
|
-
*/
|
|
897
|
-
graph_id: string;
|
|
898
|
-
/**
|
|
899
|
-
* Total Backups
|
|
900
|
-
*/
|
|
901
|
-
total_backups: number;
|
|
902
|
-
/**
|
|
903
|
-
* Successful Backups
|
|
904
|
-
*/
|
|
905
|
-
successful_backups: number;
|
|
906
|
-
/**
|
|
907
|
-
* Failed Backups
|
|
908
|
-
*/
|
|
909
|
-
failed_backups: number;
|
|
910
|
-
/**
|
|
911
|
-
* Success Rate
|
|
912
|
-
*/
|
|
913
|
-
success_rate: number;
|
|
914
|
-
/**
|
|
915
|
-
* Total Original Size Bytes
|
|
584
|
+
* Total Original Size Bytes
|
|
916
585
|
*/
|
|
917
586
|
total_original_size_bytes: number;
|
|
918
587
|
/**
|
|
@@ -940,17 +609,17 @@ export type BackupStatsResponse = {
|
|
|
940
609
|
};
|
|
941
610
|
|
|
942
611
|
/**
|
|
943
|
-
*
|
|
612
|
+
* BatchOperatorRequest
|
|
944
613
|
*
|
|
945
614
|
* Request for batch processing multiple queries.
|
|
946
615
|
*/
|
|
947
|
-
export type
|
|
616
|
+
export type BatchOperatorRequest = {
|
|
948
617
|
/**
|
|
949
618
|
* Queries
|
|
950
619
|
*
|
|
951
620
|
* List of queries to process (max 10)
|
|
952
621
|
*/
|
|
953
|
-
queries: Array<
|
|
622
|
+
queries: Array<OperatorRequest>;
|
|
954
623
|
/**
|
|
955
624
|
* Parallel
|
|
956
625
|
*
|
|
@@ -960,17 +629,17 @@ export type BatchAgentRequest = {
|
|
|
960
629
|
};
|
|
961
630
|
|
|
962
631
|
/**
|
|
963
|
-
*
|
|
632
|
+
* BatchOperatorResponse
|
|
964
633
|
*
|
|
965
634
|
* Response for batch processing.
|
|
966
635
|
*/
|
|
967
|
-
export type
|
|
636
|
+
export type BatchOperatorResponse = {
|
|
968
637
|
/**
|
|
969
638
|
* Results
|
|
970
639
|
*
|
|
971
|
-
* List of
|
|
640
|
+
* List of operator responses (includes successes and failures)
|
|
972
641
|
*/
|
|
973
|
-
results: Array<
|
|
642
|
+
results: Array<OperatorResponse>;
|
|
974
643
|
/**
|
|
975
644
|
* Total Execution Time
|
|
976
645
|
*
|
|
@@ -2048,7 +1717,7 @@ export type CreateInformationBlockRequest = ({
|
|
|
2048
1717
|
*
|
|
2049
1718
|
* This is the iterative, AI-assisted craft path. Each call adds a single
|
|
2050
1719
|
* association to the target mapping structure. Use `auto-map-elements`
|
|
2051
|
-
* to create many at once via the
|
|
1720
|
+
* to create many at once via the MappingOperator. Reject duplicates: if
|
|
2052
1721
|
* the (from, to, type) tuple already exists, the call returns 409.
|
|
2053
1722
|
*/
|
|
2054
1723
|
export type CreateMappingAssociationOperation = {
|
|
@@ -2173,7 +1842,7 @@ export type CreateReportRequest = {
|
|
|
2173
1842
|
/**
|
|
2174
1843
|
* Taxonomy Id
|
|
2175
1844
|
*
|
|
2176
|
-
* Taxonomy that defines the structures (BS / IS / CF / Equity / Schedules) this report can render.
|
|
1845
|
+
* Taxonomy that defines the structures (BS / IS / CF / Equity / Schedules) this report can render. Accepts either an exact tenant-specific taxonomy UUID or a standard name (e.g. 'rs-gaap'). Standard names resolve to the latest reporting_standard taxonomy with that name. Defaults to 'rs-gaap', the canonical reporting vocabulary.
|
|
2177
1846
|
*/
|
|
2178
1847
|
taxonomy_id?: string;
|
|
2179
1848
|
/**
|
|
@@ -6800,299 +6469,531 @@ export type MaterializeOp = {
|
|
|
6800
6469
|
*
|
|
6801
6470
|
* Continue past non-fatal row errors
|
|
6802
6471
|
*/
|
|
6803
|
-
ignore_errors?: boolean;
|
|
6472
|
+
ignore_errors?: boolean;
|
|
6473
|
+
/**
|
|
6474
|
+
* Dry Run
|
|
6475
|
+
*
|
|
6476
|
+
* Validate tables without writing to the graph
|
|
6477
|
+
*/
|
|
6478
|
+
dry_run?: boolean;
|
|
6479
|
+
/**
|
|
6480
|
+
* Source
|
|
6481
|
+
*
|
|
6482
|
+
* Materialization source: 'extensions' for OLTP, omit for DuckDB staging tables
|
|
6483
|
+
*/
|
|
6484
|
+
source?: string | null;
|
|
6485
|
+
/**
|
|
6486
|
+
* Materialize Embeddings
|
|
6487
|
+
*
|
|
6488
|
+
* Generate vector embeddings during materialization
|
|
6489
|
+
*/
|
|
6490
|
+
materialize_embeddings?: boolean;
|
|
6491
|
+
};
|
|
6492
|
+
|
|
6493
|
+
/**
|
|
6494
|
+
* MetricMechanics
|
|
6495
|
+
*
|
|
6496
|
+
* Derivative mechanics for ``block_type='metric'``.
|
|
6497
|
+
*
|
|
6498
|
+
* A metric block composes its facts from one or more source blocks at
|
|
6499
|
+
* read time — covenant tests, ratios, KPI trend computations. The typed
|
|
6500
|
+
* arm ships today so the discriminated union covers all three
|
|
6501
|
+
* construction modes (declarative / compositional / derivative); the
|
|
6502
|
+
* derivation evaluator that actually computes facts from source-block
|
|
6503
|
+
* FactSets is not yet implemented.
|
|
6504
|
+
*
|
|
6505
|
+
* ``source_block_ids`` is the ordered list of Structure ids this metric
|
|
6506
|
+
* derives from; ``derivation_type`` names the kind of computation
|
|
6507
|
+
* (``ratio``, ``trailing_twelve_month``, ``covenant_test``, …), and
|
|
6508
|
+
* ``expression`` carries the agent-authored derivation string that the
|
|
6509
|
+
* evaluator will consume at envelope build time.
|
|
6510
|
+
*/
|
|
6511
|
+
export type MetricMechanics = {
|
|
6512
|
+
/**
|
|
6513
|
+
* Kind
|
|
6514
|
+
*/
|
|
6515
|
+
kind?: 'metric';
|
|
6516
|
+
/**
|
|
6517
|
+
* Source Block Ids
|
|
6518
|
+
*
|
|
6519
|
+
* Ordered list of Structure ids this metric sources from. Must be non-empty at evaluation time; empty lists are accepted so library scaffolding can register metric templates before source linkage is wired.
|
|
6520
|
+
*/
|
|
6521
|
+
source_block_ids?: Array<string>;
|
|
6522
|
+
/**
|
|
6523
|
+
* Derivation Type
|
|
6524
|
+
*
|
|
6525
|
+
* Free-form label for the derivation kind — 'ratio', 'trailing_twelve_month', 'covenant_test', etc. The evaluator dispatches on this tag; the set may be locked with a CHECK constraint once the derivation catalog stabilizes.
|
|
6526
|
+
*/
|
|
6527
|
+
derivation_type?: string | null;
|
|
6528
|
+
/**
|
|
6529
|
+
* Expression
|
|
6530
|
+
*
|
|
6531
|
+
* Derivation expression in the metric DSL — evaluated at envelope read time to produce the derivative fact value. Opaque string today; the metric-side parser / evaluator is not yet implemented.
|
|
6532
|
+
*/
|
|
6533
|
+
expression?: string | null;
|
|
6534
|
+
/**
|
|
6535
|
+
* Unit
|
|
6536
|
+
*
|
|
6537
|
+
* Output unit of the derived value — 'ratio', 'percent', 'USD', 'count', etc. Used by the renderer to format the metric badge.
|
|
6538
|
+
*/
|
|
6539
|
+
unit?: string;
|
|
6540
|
+
};
|
|
6541
|
+
|
|
6542
|
+
/**
|
|
6543
|
+
* OAuthCallbackRequest
|
|
6544
|
+
*
|
|
6545
|
+
* OAuth callback parameters.
|
|
6546
|
+
*/
|
|
6547
|
+
export type OAuthCallbackRequest = {
|
|
6548
|
+
/**
|
|
6549
|
+
* Code
|
|
6550
|
+
*
|
|
6551
|
+
* Authorization code from OAuth provider
|
|
6552
|
+
*/
|
|
6553
|
+
code: string;
|
|
6554
|
+
/**
|
|
6555
|
+
* State
|
|
6556
|
+
*
|
|
6557
|
+
* OAuth state for verification
|
|
6558
|
+
*/
|
|
6559
|
+
state: string;
|
|
6560
|
+
/**
|
|
6561
|
+
* Realm Id
|
|
6562
|
+
*
|
|
6563
|
+
* QuickBooks-specific realm ID
|
|
6564
|
+
*/
|
|
6565
|
+
realm_id?: string | null;
|
|
6566
|
+
/**
|
|
6567
|
+
* Error
|
|
6568
|
+
*
|
|
6569
|
+
* OAuth error if authorization failed
|
|
6570
|
+
*/
|
|
6571
|
+
error?: string | null;
|
|
6572
|
+
/**
|
|
6573
|
+
* Error Description
|
|
6574
|
+
*
|
|
6575
|
+
* OAuth error details
|
|
6576
|
+
*/
|
|
6577
|
+
error_description?: string | null;
|
|
6578
|
+
};
|
|
6579
|
+
|
|
6580
|
+
/**
|
|
6581
|
+
* OAuthInitRequest
|
|
6582
|
+
*
|
|
6583
|
+
* Request to initiate OAuth flow.
|
|
6584
|
+
*/
|
|
6585
|
+
export type OAuthInitRequest = {
|
|
6586
|
+
/**
|
|
6587
|
+
* Connection Id
|
|
6588
|
+
*
|
|
6589
|
+
* Connection ID to link OAuth to
|
|
6590
|
+
*/
|
|
6591
|
+
connection_id: string;
|
|
6592
|
+
/**
|
|
6593
|
+
* Redirect Uri
|
|
6594
|
+
*
|
|
6595
|
+
* Override default redirect URI
|
|
6596
|
+
*/
|
|
6597
|
+
redirect_uri?: string | null;
|
|
6598
|
+
/**
|
|
6599
|
+
* Additional Params
|
|
6600
|
+
*
|
|
6601
|
+
* Provider-specific parameters
|
|
6602
|
+
*/
|
|
6603
|
+
additional_params?: {
|
|
6604
|
+
[key: string]: string;
|
|
6605
|
+
} | null;
|
|
6606
|
+
};
|
|
6607
|
+
|
|
6608
|
+
/**
|
|
6609
|
+
* OAuthInitResponse
|
|
6610
|
+
*
|
|
6611
|
+
* Response with OAuth authorization URL.
|
|
6612
|
+
*/
|
|
6613
|
+
export type OAuthInitResponse = {
|
|
6614
|
+
/**
|
|
6615
|
+
* Auth Url
|
|
6616
|
+
*
|
|
6617
|
+
* URL to redirect user for authorization
|
|
6618
|
+
*/
|
|
6619
|
+
auth_url: string;
|
|
6620
|
+
/**
|
|
6621
|
+
* State
|
|
6622
|
+
*
|
|
6623
|
+
* OAuth state for security
|
|
6624
|
+
*/
|
|
6625
|
+
state: string;
|
|
6626
|
+
/**
|
|
6627
|
+
* Expires At
|
|
6628
|
+
*
|
|
6629
|
+
* When this OAuth request expires
|
|
6630
|
+
*/
|
|
6631
|
+
expires_at: string;
|
|
6632
|
+
};
|
|
6633
|
+
|
|
6634
|
+
/**
|
|
6635
|
+
* OfferingRepositoryPlan
|
|
6636
|
+
*
|
|
6637
|
+
* Information about a repository plan.
|
|
6638
|
+
*/
|
|
6639
|
+
export type OfferingRepositoryPlan = {
|
|
6640
|
+
/**
|
|
6641
|
+
* Plan
|
|
6642
|
+
*
|
|
6643
|
+
* Plan identifier
|
|
6644
|
+
*/
|
|
6645
|
+
plan: string;
|
|
6646
|
+
/**
|
|
6647
|
+
* Name
|
|
6648
|
+
*
|
|
6649
|
+
* Plan name
|
|
6650
|
+
*/
|
|
6651
|
+
name: string;
|
|
6652
|
+
/**
|
|
6653
|
+
* Monthly Price
|
|
6654
|
+
*
|
|
6655
|
+
* Monthly price in USD
|
|
6656
|
+
*/
|
|
6657
|
+
monthly_price: number;
|
|
6658
|
+
/**
|
|
6659
|
+
* Monthly Credits
|
|
6660
|
+
*
|
|
6661
|
+
* Monthly credit allocation
|
|
6662
|
+
*/
|
|
6663
|
+
monthly_credits: number;
|
|
6664
|
+
/**
|
|
6665
|
+
* Access Level
|
|
6666
|
+
*
|
|
6667
|
+
* Access level
|
|
6668
|
+
*/
|
|
6669
|
+
access_level: string;
|
|
6670
|
+
/**
|
|
6671
|
+
* Features
|
|
6672
|
+
*
|
|
6673
|
+
* List of features
|
|
6674
|
+
*/
|
|
6675
|
+
features: Array<string>;
|
|
6676
|
+
/**
|
|
6677
|
+
* Rate Limits
|
|
6678
|
+
*
|
|
6679
|
+
* Rate limits for this plan
|
|
6680
|
+
*/
|
|
6681
|
+
rate_limits?: {
|
|
6682
|
+
[key: string]: number | null;
|
|
6683
|
+
} | null;
|
|
6684
|
+
};
|
|
6685
|
+
|
|
6686
|
+
/**
|
|
6687
|
+
* OperationCosts
|
|
6688
|
+
*
|
|
6689
|
+
* Operation cost information.
|
|
6690
|
+
*/
|
|
6691
|
+
export type OperationCosts = {
|
|
6692
|
+
/**
|
|
6693
|
+
* Description
|
|
6694
|
+
*
|
|
6695
|
+
* Description of operation costs
|
|
6696
|
+
*/
|
|
6697
|
+
description: string;
|
|
6698
|
+
/**
|
|
6699
|
+
* Ai Operations
|
|
6700
|
+
*
|
|
6701
|
+
* Base costs for AI operations
|
|
6702
|
+
*/
|
|
6703
|
+
ai_operations: {
|
|
6704
|
+
[key: string]: number;
|
|
6705
|
+
};
|
|
6804
6706
|
/**
|
|
6805
|
-
*
|
|
6707
|
+
* Token Pricing
|
|
6806
6708
|
*
|
|
6807
|
-
*
|
|
6709
|
+
* Token pricing by model
|
|
6808
6710
|
*/
|
|
6809
|
-
|
|
6711
|
+
token_pricing: {
|
|
6712
|
+
[key: string]: TokenPricing;
|
|
6713
|
+
};
|
|
6810
6714
|
/**
|
|
6811
|
-
*
|
|
6715
|
+
* Included Operations
|
|
6812
6716
|
*
|
|
6813
|
-
*
|
|
6717
|
+
* Operations that don't consume credits
|
|
6814
6718
|
*/
|
|
6815
|
-
|
|
6719
|
+
included_operations: Array<string>;
|
|
6816
6720
|
/**
|
|
6817
|
-
*
|
|
6721
|
+
* Notes
|
|
6818
6722
|
*
|
|
6819
|
-
*
|
|
6723
|
+
* Important notes about costs
|
|
6820
6724
|
*/
|
|
6821
|
-
|
|
6725
|
+
notes: Array<string>;
|
|
6822
6726
|
};
|
|
6823
6727
|
|
|
6824
6728
|
/**
|
|
6825
|
-
*
|
|
6729
|
+
* OperationEnvelope
|
|
6826
6730
|
*
|
|
6827
|
-
*
|
|
6731
|
+
* Uniform response shape for every operation endpoint.
|
|
6828
6732
|
*
|
|
6829
|
-
*
|
|
6830
|
-
*
|
|
6831
|
-
*
|
|
6832
|
-
*
|
|
6833
|
-
*
|
|
6834
|
-
*
|
|
6733
|
+
* Every dispatch through an operation surface returns an envelope carrying
|
|
6734
|
+
* an ``op_<ULID>`` operation_id. That id is the bridge to the platform's
|
|
6735
|
+
* monitoring surface: pass it to
|
|
6736
|
+
* ``GET /v1/operations/{operation_id}/stream`` (see ``routers/operations.py``)
|
|
6737
|
+
* to subscribe to SSE progress events. Sync commands complete in the
|
|
6738
|
+
* envelope itself; async commands (``status: "pending"``, HTTP 202) hand
|
|
6739
|
+
* off to a background worker and stream their tail through the same SSE
|
|
6740
|
+
* endpoint until completion. Failed dispatches still mint an
|
|
6741
|
+
* ``operation_id`` so the audit log and any partial SSE events stay
|
|
6742
|
+
* correlatable.
|
|
6835
6743
|
*
|
|
6836
|
-
* ``
|
|
6837
|
-
*
|
|
6838
|
-
*
|
|
6839
|
-
* ``
|
|
6840
|
-
*
|
|
6744
|
+
* ``TResult`` parameterizes the ``result`` field so per-op response shapes
|
|
6745
|
+
* surface in OpenAPI. Operations that pin ``OperationSpec.result_type`` get
|
|
6746
|
+
* ``OperationEnvelope[YourEnvelope]`` as their response model; ops that
|
|
6747
|
+
* don't keep the default ``Any`` shape (`result: any | null` on the wire).
|
|
6748
|
+
*
|
|
6749
|
+
* Fields:
|
|
6750
|
+
* - ``operation``: kebab-case command name (e.g. ``close-period``)
|
|
6751
|
+
* - ``operation_id``: ``op_``-prefixed ULID; always present, usable for
|
|
6752
|
+
* audit correlation and — for async commands — SSE subscription via
|
|
6753
|
+
* ``/v1/operations/{operation_id}/stream``
|
|
6754
|
+
* - ``status``: ``"completed"`` (sync, HTTP 200), ``"pending"``
|
|
6755
|
+
* (async, HTTP 202), or ``"failed"`` (error responses)
|
|
6756
|
+
* - ``result``: the domain-specific payload (the original Pydantic
|
|
6757
|
+
* response) or ``None`` for async/failed cases
|
|
6758
|
+
* - ``at``: ISO-8601 UTC timestamp of when the envelope was minted
|
|
6759
|
+
* - ``created_by``: user ID of the caller who initiated this operation
|
|
6760
|
+
* - ``idempotent_replay``: ``True`` when the dispatcher returned this
|
|
6761
|
+
* envelope from the idempotency cache (the underlying command did NOT
|
|
6762
|
+
* execute again)
|
|
6841
6763
|
*/
|
|
6842
|
-
export type
|
|
6764
|
+
export type OperationEnvelope = {
|
|
6843
6765
|
/**
|
|
6844
|
-
*
|
|
6766
|
+
* Operation
|
|
6767
|
+
*
|
|
6768
|
+
* Kebab-case operation name
|
|
6845
6769
|
*/
|
|
6846
|
-
|
|
6770
|
+
operation: string;
|
|
6847
6771
|
/**
|
|
6848
|
-
*
|
|
6772
|
+
* Operationid
|
|
6849
6773
|
*
|
|
6850
|
-
*
|
|
6774
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
6851
6775
|
*/
|
|
6852
|
-
|
|
6776
|
+
operationId: string;
|
|
6853
6777
|
/**
|
|
6854
|
-
*
|
|
6778
|
+
* Status
|
|
6855
6779
|
*
|
|
6856
|
-
*
|
|
6780
|
+
* Operation lifecycle state
|
|
6857
6781
|
*/
|
|
6858
|
-
|
|
6782
|
+
status: 'completed' | 'pending' | 'failed';
|
|
6859
6783
|
/**
|
|
6860
|
-
*
|
|
6784
|
+
* Result
|
|
6861
6785
|
*
|
|
6862
|
-
*
|
|
6786
|
+
* Command-specific result payload
|
|
6863
6787
|
*/
|
|
6864
|
-
|
|
6788
|
+
result?: unknown | null;
|
|
6865
6789
|
/**
|
|
6866
|
-
*
|
|
6790
|
+
* At
|
|
6867
6791
|
*
|
|
6868
|
-
*
|
|
6792
|
+
* ISO-8601 UTC timestamp
|
|
6869
6793
|
*/
|
|
6870
|
-
|
|
6794
|
+
at: string;
|
|
6795
|
+
/**
|
|
6796
|
+
* Createdby
|
|
6797
|
+
*
|
|
6798
|
+
* User ID that initiated the operation (null for legacy callers)
|
|
6799
|
+
*/
|
|
6800
|
+
createdBy?: string | null;
|
|
6801
|
+
/**
|
|
6802
|
+
* Idempotentreplay
|
|
6803
|
+
*
|
|
6804
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
6805
|
+
*/
|
|
6806
|
+
idempotentReplay?: boolean;
|
|
6871
6807
|
};
|
|
6872
6808
|
|
|
6873
6809
|
/**
|
|
6874
|
-
*
|
|
6875
|
-
*
|
|
6876
|
-
* OAuth callback parameters.
|
|
6810
|
+
* OperationEnvelope[AssociationResponse]
|
|
6877
6811
|
*/
|
|
6878
|
-
export type
|
|
6812
|
+
export type OperationEnvelopeAssociationResponse = {
|
|
6879
6813
|
/**
|
|
6880
|
-
*
|
|
6814
|
+
* Operation
|
|
6881
6815
|
*
|
|
6882
|
-
*
|
|
6816
|
+
* Kebab-case operation name
|
|
6883
6817
|
*/
|
|
6884
|
-
|
|
6818
|
+
operation: string;
|
|
6885
6819
|
/**
|
|
6886
|
-
*
|
|
6820
|
+
* Operationid
|
|
6887
6821
|
*
|
|
6888
|
-
*
|
|
6822
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
6889
6823
|
*/
|
|
6890
|
-
|
|
6824
|
+
operationId: string;
|
|
6891
6825
|
/**
|
|
6892
|
-
*
|
|
6826
|
+
* Status
|
|
6893
6827
|
*
|
|
6894
|
-
*
|
|
6828
|
+
* Operation lifecycle state
|
|
6895
6829
|
*/
|
|
6896
|
-
|
|
6830
|
+
status: 'completed' | 'pending' | 'failed';
|
|
6897
6831
|
/**
|
|
6898
|
-
*
|
|
6832
|
+
* Command-specific result payload
|
|
6833
|
+
*/
|
|
6834
|
+
result?: AssociationResponse | null;
|
|
6835
|
+
/**
|
|
6836
|
+
* At
|
|
6899
6837
|
*
|
|
6900
|
-
*
|
|
6838
|
+
* ISO-8601 UTC timestamp
|
|
6901
6839
|
*/
|
|
6902
|
-
|
|
6840
|
+
at: string;
|
|
6903
6841
|
/**
|
|
6904
|
-
*
|
|
6842
|
+
* Createdby
|
|
6905
6843
|
*
|
|
6906
|
-
*
|
|
6844
|
+
* User ID that initiated the operation (null for legacy callers)
|
|
6907
6845
|
*/
|
|
6908
|
-
|
|
6846
|
+
createdBy?: string | null;
|
|
6847
|
+
/**
|
|
6848
|
+
* Idempotentreplay
|
|
6849
|
+
*
|
|
6850
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
6851
|
+
*/
|
|
6852
|
+
idempotentReplay?: boolean;
|
|
6909
6853
|
};
|
|
6910
6854
|
|
|
6911
6855
|
/**
|
|
6912
|
-
*
|
|
6913
|
-
*
|
|
6914
|
-
* Request to initiate OAuth flow.
|
|
6856
|
+
* OperationEnvelope[ClosePeriodResponse]
|
|
6915
6857
|
*/
|
|
6916
|
-
export type
|
|
6858
|
+
export type OperationEnvelopeClosePeriodResponse = {
|
|
6917
6859
|
/**
|
|
6918
|
-
*
|
|
6860
|
+
* Operation
|
|
6919
6861
|
*
|
|
6920
|
-
*
|
|
6862
|
+
* Kebab-case operation name
|
|
6921
6863
|
*/
|
|
6922
|
-
|
|
6864
|
+
operation: string;
|
|
6923
6865
|
/**
|
|
6924
|
-
*
|
|
6866
|
+
* Operationid
|
|
6925
6867
|
*
|
|
6926
|
-
*
|
|
6868
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
6927
6869
|
*/
|
|
6928
|
-
|
|
6870
|
+
operationId: string;
|
|
6929
6871
|
/**
|
|
6930
|
-
*
|
|
6872
|
+
* Status
|
|
6931
6873
|
*
|
|
6932
|
-
*
|
|
6874
|
+
* Operation lifecycle state
|
|
6933
6875
|
*/
|
|
6934
|
-
|
|
6935
|
-
[key: string]: string;
|
|
6936
|
-
} | null;
|
|
6937
|
-
};
|
|
6938
|
-
|
|
6939
|
-
/**
|
|
6940
|
-
* OAuthInitResponse
|
|
6941
|
-
*
|
|
6942
|
-
* Response with OAuth authorization URL.
|
|
6943
|
-
*/
|
|
6944
|
-
export type OAuthInitResponse = {
|
|
6876
|
+
status: 'completed' | 'pending' | 'failed';
|
|
6945
6877
|
/**
|
|
6946
|
-
*
|
|
6878
|
+
* Command-specific result payload
|
|
6879
|
+
*/
|
|
6880
|
+
result?: ClosePeriodResponse | null;
|
|
6881
|
+
/**
|
|
6882
|
+
* At
|
|
6947
6883
|
*
|
|
6948
|
-
*
|
|
6884
|
+
* ISO-8601 UTC timestamp
|
|
6949
6885
|
*/
|
|
6950
|
-
|
|
6886
|
+
at: string;
|
|
6951
6887
|
/**
|
|
6952
|
-
*
|
|
6888
|
+
* Createdby
|
|
6953
6889
|
*
|
|
6954
|
-
*
|
|
6890
|
+
* User ID that initiated the operation (null for legacy callers)
|
|
6955
6891
|
*/
|
|
6956
|
-
|
|
6892
|
+
createdBy?: string | null;
|
|
6957
6893
|
/**
|
|
6958
|
-
*
|
|
6894
|
+
* Idempotentreplay
|
|
6959
6895
|
*
|
|
6960
|
-
*
|
|
6896
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
6961
6897
|
*/
|
|
6962
|
-
|
|
6898
|
+
idempotentReplay?: boolean;
|
|
6963
6899
|
};
|
|
6964
6900
|
|
|
6965
6901
|
/**
|
|
6966
|
-
*
|
|
6967
|
-
*
|
|
6968
|
-
* Information about a repository plan.
|
|
6902
|
+
* OperationEnvelope[DeleteInformationBlockResponse]
|
|
6969
6903
|
*/
|
|
6970
|
-
export type
|
|
6904
|
+
export type OperationEnvelopeDeleteInformationBlockResponse = {
|
|
6971
6905
|
/**
|
|
6972
|
-
*
|
|
6906
|
+
* Operation
|
|
6973
6907
|
*
|
|
6974
|
-
*
|
|
6908
|
+
* Kebab-case operation name
|
|
6975
6909
|
*/
|
|
6976
|
-
|
|
6910
|
+
operation: string;
|
|
6977
6911
|
/**
|
|
6978
|
-
*
|
|
6912
|
+
* Operationid
|
|
6979
6913
|
*
|
|
6980
|
-
*
|
|
6914
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
6981
6915
|
*/
|
|
6982
|
-
|
|
6916
|
+
operationId: string;
|
|
6983
6917
|
/**
|
|
6984
|
-
*
|
|
6918
|
+
* Status
|
|
6985
6919
|
*
|
|
6986
|
-
*
|
|
6920
|
+
* Operation lifecycle state
|
|
6987
6921
|
*/
|
|
6988
|
-
|
|
6922
|
+
status: 'completed' | 'pending' | 'failed';
|
|
6989
6923
|
/**
|
|
6990
|
-
*
|
|
6991
|
-
*
|
|
6992
|
-
* Monthly credit allocation
|
|
6924
|
+
* Command-specific result payload
|
|
6993
6925
|
*/
|
|
6994
|
-
|
|
6926
|
+
result?: DeleteInformationBlockResponse | null;
|
|
6995
6927
|
/**
|
|
6996
|
-
*
|
|
6928
|
+
* At
|
|
6997
6929
|
*
|
|
6998
|
-
*
|
|
6930
|
+
* ISO-8601 UTC timestamp
|
|
6999
6931
|
*/
|
|
7000
|
-
|
|
6932
|
+
at: string;
|
|
7001
6933
|
/**
|
|
7002
|
-
*
|
|
6934
|
+
* Createdby
|
|
7003
6935
|
*
|
|
7004
|
-
*
|
|
6936
|
+
* User ID that initiated the operation (null for legacy callers)
|
|
7005
6937
|
*/
|
|
7006
|
-
|
|
6938
|
+
createdBy?: string | null;
|
|
7007
6939
|
/**
|
|
7008
|
-
*
|
|
6940
|
+
* Idempotentreplay
|
|
7009
6941
|
*
|
|
7010
|
-
*
|
|
6942
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
7011
6943
|
*/
|
|
7012
|
-
|
|
7013
|
-
[key: string]: number | null;
|
|
7014
|
-
} | null;
|
|
6944
|
+
idempotentReplay?: boolean;
|
|
7015
6945
|
};
|
|
7016
6946
|
|
|
7017
6947
|
/**
|
|
7018
|
-
*
|
|
7019
|
-
*
|
|
7020
|
-
* Operation cost information.
|
|
6948
|
+
* OperationEnvelope[DeletePortfolioBlockResponse]
|
|
7021
6949
|
*/
|
|
7022
|
-
export type
|
|
6950
|
+
export type OperationEnvelopeDeletePortfolioBlockResponse = {
|
|
7023
6951
|
/**
|
|
7024
|
-
*
|
|
6952
|
+
* Operation
|
|
7025
6953
|
*
|
|
7026
|
-
*
|
|
6954
|
+
* Kebab-case operation name
|
|
7027
6955
|
*/
|
|
7028
|
-
|
|
6956
|
+
operation: string;
|
|
7029
6957
|
/**
|
|
7030
|
-
*
|
|
6958
|
+
* Operationid
|
|
7031
6959
|
*
|
|
7032
|
-
*
|
|
6960
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
7033
6961
|
*/
|
|
7034
|
-
|
|
7035
|
-
[key: string]: number;
|
|
7036
|
-
};
|
|
6962
|
+
operationId: string;
|
|
7037
6963
|
/**
|
|
7038
|
-
*
|
|
6964
|
+
* Status
|
|
7039
6965
|
*
|
|
7040
|
-
*
|
|
6966
|
+
* Operation lifecycle state
|
|
7041
6967
|
*/
|
|
7042
|
-
|
|
7043
|
-
[key: string]: TokenPricing;
|
|
7044
|
-
};
|
|
6968
|
+
status: 'completed' | 'pending' | 'failed';
|
|
7045
6969
|
/**
|
|
7046
|
-
*
|
|
6970
|
+
* Command-specific result payload
|
|
6971
|
+
*/
|
|
6972
|
+
result?: DeletePortfolioBlockResponse | null;
|
|
6973
|
+
/**
|
|
6974
|
+
* At
|
|
7047
6975
|
*
|
|
7048
|
-
*
|
|
6976
|
+
* ISO-8601 UTC timestamp
|
|
7049
6977
|
*/
|
|
7050
|
-
|
|
6978
|
+
at: string;
|
|
7051
6979
|
/**
|
|
7052
|
-
*
|
|
6980
|
+
* Createdby
|
|
7053
6981
|
*
|
|
7054
|
-
*
|
|
6982
|
+
* User ID that initiated the operation (null for legacy callers)
|
|
7055
6983
|
*/
|
|
7056
|
-
|
|
6984
|
+
createdBy?: string | null;
|
|
6985
|
+
/**
|
|
6986
|
+
* Idempotentreplay
|
|
6987
|
+
*
|
|
6988
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
6989
|
+
*/
|
|
6990
|
+
idempotentReplay?: boolean;
|
|
7057
6991
|
};
|
|
7058
6992
|
|
|
7059
6993
|
/**
|
|
7060
|
-
* OperationEnvelope
|
|
7061
|
-
*
|
|
7062
|
-
* Uniform response shape for every operation endpoint.
|
|
7063
|
-
*
|
|
7064
|
-
* Every dispatch through an operation surface returns an envelope carrying
|
|
7065
|
-
* an ``op_<ULID>`` operation_id. That id is the bridge to the platform's
|
|
7066
|
-
* monitoring surface: pass it to
|
|
7067
|
-
* ``GET /v1/operations/{operation_id}/stream`` (see ``routers/operations.py``)
|
|
7068
|
-
* to subscribe to SSE progress events. Sync commands complete in the
|
|
7069
|
-
* envelope itself; async commands (``status: "pending"``, HTTP 202) hand
|
|
7070
|
-
* off to a background worker and stream their tail through the same SSE
|
|
7071
|
-
* endpoint until completion. Failed dispatches still mint an
|
|
7072
|
-
* ``operation_id`` so the audit log and any partial SSE events stay
|
|
7073
|
-
* correlatable.
|
|
7074
|
-
*
|
|
7075
|
-
* ``TResult`` parameterizes the ``result`` field so per-op response shapes
|
|
7076
|
-
* surface in OpenAPI. Operations that pin ``OperationSpec.result_type`` get
|
|
7077
|
-
* ``OperationEnvelope[YourEnvelope]`` as their response model; ops that
|
|
7078
|
-
* don't keep the default ``Any`` shape (`result: any | null` on the wire).
|
|
7079
|
-
*
|
|
7080
|
-
* Fields:
|
|
7081
|
-
* - ``operation``: kebab-case command name (e.g. ``close-period``)
|
|
7082
|
-
* - ``operation_id``: ``op_``-prefixed ULID; always present, usable for
|
|
7083
|
-
* audit correlation and — for async commands — SSE subscription via
|
|
7084
|
-
* ``/v1/operations/{operation_id}/stream``
|
|
7085
|
-
* - ``status``: ``"completed"`` (sync, HTTP 200), ``"pending"``
|
|
7086
|
-
* (async, HTTP 202), or ``"failed"`` (error responses)
|
|
7087
|
-
* - ``result``: the domain-specific payload (the original Pydantic
|
|
7088
|
-
* response) or ``None`` for async/failed cases
|
|
7089
|
-
* - ``at``: ISO-8601 UTC timestamp of when the envelope was minted
|
|
7090
|
-
* - ``created_by``: user ID of the caller who initiated this operation
|
|
7091
|
-
* - ``idempotent_replay``: ``True`` when the dispatcher returned this
|
|
7092
|
-
* envelope from the idempotency cache (the underlying command did NOT
|
|
7093
|
-
* execute again)
|
|
6994
|
+
* OperationEnvelope[DeleteResult]
|
|
7094
6995
|
*/
|
|
7095
|
-
export type
|
|
6996
|
+
export type OperationEnvelopeDeleteResult = {
|
|
7096
6997
|
/**
|
|
7097
6998
|
* Operation
|
|
7098
6999
|
*
|
|
@@ -7112,11 +7013,9 @@ export type OperationEnvelope = {
|
|
|
7112
7013
|
*/
|
|
7113
7014
|
status: 'completed' | 'pending' | 'failed';
|
|
7114
7015
|
/**
|
|
7115
|
-
* Result
|
|
7116
|
-
*
|
|
7117
7016
|
* Command-specific result payload
|
|
7118
7017
|
*/
|
|
7119
|
-
result?:
|
|
7018
|
+
result?: DeleteResult | null;
|
|
7120
7019
|
/**
|
|
7121
7020
|
* At
|
|
7122
7021
|
*
|
|
@@ -7138,9 +7037,9 @@ export type OperationEnvelope = {
|
|
|
7138
7037
|
};
|
|
7139
7038
|
|
|
7140
7039
|
/**
|
|
7141
|
-
* OperationEnvelope[
|
|
7040
|
+
* OperationEnvelope[DeleteTaxonomyBlockResponse]
|
|
7142
7041
|
*/
|
|
7143
|
-
export type
|
|
7042
|
+
export type OperationEnvelopeDeleteTaxonomyBlockResponse = {
|
|
7144
7043
|
/**
|
|
7145
7044
|
* Operation
|
|
7146
7045
|
*
|
|
@@ -7162,7 +7061,7 @@ export type OperationEnvelopeAssociationResponse = {
|
|
|
7162
7061
|
/**
|
|
7163
7062
|
* Command-specific result payload
|
|
7164
7063
|
*/
|
|
7165
|
-
result?:
|
|
7064
|
+
result?: DeleteTaxonomyBlockResponse | null;
|
|
7166
7065
|
/**
|
|
7167
7066
|
* At
|
|
7168
7067
|
*
|
|
@@ -7184,9 +7083,9 @@ export type OperationEnvelopeAssociationResponse = {
|
|
|
7184
7083
|
};
|
|
7185
7084
|
|
|
7186
7085
|
/**
|
|
7187
|
-
* OperationEnvelope[
|
|
7086
|
+
* OperationEnvelope[EntityTaxonomyResponse]
|
|
7188
7087
|
*/
|
|
7189
|
-
export type
|
|
7088
|
+
export type OperationEnvelopeEntityTaxonomyResponse = {
|
|
7190
7089
|
/**
|
|
7191
7090
|
* Operation
|
|
7192
7091
|
*
|
|
@@ -7208,7 +7107,7 @@ export type OperationEnvelopeClosePeriodResponse = {
|
|
|
7208
7107
|
/**
|
|
7209
7108
|
* Command-specific result payload
|
|
7210
7109
|
*/
|
|
7211
|
-
result?:
|
|
7110
|
+
result?: EntityTaxonomyResponse | null;
|
|
7212
7111
|
/**
|
|
7213
7112
|
* At
|
|
7214
7113
|
*
|
|
@@ -7230,9 +7129,9 @@ export type OperationEnvelopeClosePeriodResponse = {
|
|
|
7230
7129
|
};
|
|
7231
7130
|
|
|
7232
7131
|
/**
|
|
7233
|
-
* OperationEnvelope[
|
|
7132
|
+
* OperationEnvelope[EvaluateRulesResponse]
|
|
7234
7133
|
*/
|
|
7235
|
-
export type
|
|
7134
|
+
export type OperationEnvelopeEvaluateRulesResponse = {
|
|
7236
7135
|
/**
|
|
7237
7136
|
* Operation
|
|
7238
7137
|
*
|
|
@@ -7254,7 +7153,7 @@ export type OperationEnvelopeDeleteInformationBlockResponse = {
|
|
|
7254
7153
|
/**
|
|
7255
7154
|
* Command-specific result payload
|
|
7256
7155
|
*/
|
|
7257
|
-
result?:
|
|
7156
|
+
result?: EvaluateRulesResponse | null;
|
|
7258
7157
|
/**
|
|
7259
7158
|
* At
|
|
7260
7159
|
*
|
|
@@ -7276,9 +7175,9 @@ export type OperationEnvelopeDeleteInformationBlockResponse = {
|
|
|
7276
7175
|
};
|
|
7277
7176
|
|
|
7278
7177
|
/**
|
|
7279
|
-
* OperationEnvelope[
|
|
7178
|
+
* OperationEnvelope[EventBlockEnvelope]
|
|
7280
7179
|
*/
|
|
7281
|
-
export type
|
|
7180
|
+
export type OperationEnvelopeEventBlockEnvelope = {
|
|
7282
7181
|
/**
|
|
7283
7182
|
* Operation
|
|
7284
7183
|
*
|
|
@@ -7300,7 +7199,7 @@ export type OperationEnvelopeDeletePortfolioBlockResponse = {
|
|
|
7300
7199
|
/**
|
|
7301
7200
|
* Command-specific result payload
|
|
7302
7201
|
*/
|
|
7303
|
-
result?:
|
|
7202
|
+
result?: EventBlockEnvelope | null;
|
|
7304
7203
|
/**
|
|
7305
7204
|
* At
|
|
7306
7205
|
*
|
|
@@ -7322,9 +7221,9 @@ export type OperationEnvelopeDeletePortfolioBlockResponse = {
|
|
|
7322
7221
|
};
|
|
7323
7222
|
|
|
7324
7223
|
/**
|
|
7325
|
-
* OperationEnvelope[
|
|
7224
|
+
* OperationEnvelope[EventHandlerResponse]
|
|
7326
7225
|
*/
|
|
7327
|
-
export type
|
|
7226
|
+
export type OperationEnvelopeEventHandlerResponse = {
|
|
7328
7227
|
/**
|
|
7329
7228
|
* Operation
|
|
7330
7229
|
*
|
|
@@ -7346,7 +7245,7 @@ export type OperationEnvelopeDeleteResult = {
|
|
|
7346
7245
|
/**
|
|
7347
7246
|
* Command-specific result payload
|
|
7348
7247
|
*/
|
|
7349
|
-
result?:
|
|
7248
|
+
result?: EventHandlerResponse | null;
|
|
7350
7249
|
/**
|
|
7351
7250
|
* At
|
|
7352
7251
|
*
|
|
@@ -7368,9 +7267,9 @@ export type OperationEnvelopeDeleteResult = {
|
|
|
7368
7267
|
};
|
|
7369
7268
|
|
|
7370
7269
|
/**
|
|
7371
|
-
* OperationEnvelope[
|
|
7270
|
+
* OperationEnvelope[FiscalCalendarResponse]
|
|
7372
7271
|
*/
|
|
7373
|
-
export type
|
|
7272
|
+
export type OperationEnvelopeFiscalCalendarResponse = {
|
|
7374
7273
|
/**
|
|
7375
7274
|
* Operation
|
|
7376
7275
|
*
|
|
@@ -7392,7 +7291,7 @@ export type OperationEnvelopeDeleteTaxonomyBlockResponse = {
|
|
|
7392
7291
|
/**
|
|
7393
7292
|
* Command-specific result payload
|
|
7394
7293
|
*/
|
|
7395
|
-
result?:
|
|
7294
|
+
result?: FiscalCalendarResponse | null;
|
|
7396
7295
|
/**
|
|
7397
7296
|
* At
|
|
7398
7297
|
*
|
|
@@ -7414,9 +7313,9 @@ export type OperationEnvelopeDeleteTaxonomyBlockResponse = {
|
|
|
7414
7313
|
};
|
|
7415
7314
|
|
|
7416
7315
|
/**
|
|
7417
|
-
* OperationEnvelope[
|
|
7316
|
+
* OperationEnvelope[InformationBlockEnvelope]
|
|
7418
7317
|
*/
|
|
7419
|
-
export type
|
|
7318
|
+
export type OperationEnvelopeInformationBlockEnvelope = {
|
|
7420
7319
|
/**
|
|
7421
7320
|
* Operation
|
|
7422
7321
|
*
|
|
@@ -7438,7 +7337,7 @@ export type OperationEnvelopeEntityTaxonomyResponse = {
|
|
|
7438
7337
|
/**
|
|
7439
7338
|
* Command-specific result payload
|
|
7440
7339
|
*/
|
|
7441
|
-
result?:
|
|
7340
|
+
result?: InformationBlockEnvelope | null;
|
|
7442
7341
|
/**
|
|
7443
7342
|
* At
|
|
7444
7343
|
*
|
|
@@ -7460,9 +7359,9 @@ export type OperationEnvelopeEntityTaxonomyResponse = {
|
|
|
7460
7359
|
};
|
|
7461
7360
|
|
|
7462
7361
|
/**
|
|
7463
|
-
* OperationEnvelope[
|
|
7362
|
+
* OperationEnvelope[InitializeLedgerResponse]
|
|
7464
7363
|
*/
|
|
7465
|
-
export type
|
|
7364
|
+
export type OperationEnvelopeInitializeLedgerResponse = {
|
|
7466
7365
|
/**
|
|
7467
7366
|
* Operation
|
|
7468
7367
|
*
|
|
@@ -7484,7 +7383,7 @@ export type OperationEnvelopeEvaluateRulesResponse = {
|
|
|
7484
7383
|
/**
|
|
7485
7384
|
* Command-specific result payload
|
|
7486
7385
|
*/
|
|
7487
|
-
result?:
|
|
7386
|
+
result?: InitializeLedgerResponse | null;
|
|
7488
7387
|
/**
|
|
7489
7388
|
* At
|
|
7490
7389
|
*
|
|
@@ -7506,9 +7405,9 @@ export type OperationEnvelopeEvaluateRulesResponse = {
|
|
|
7506
7405
|
};
|
|
7507
7406
|
|
|
7508
7407
|
/**
|
|
7509
|
-
* OperationEnvelope[
|
|
7408
|
+
* OperationEnvelope[JournalEntryResponse]
|
|
7510
7409
|
*/
|
|
7511
|
-
export type
|
|
7410
|
+
export type OperationEnvelopeJournalEntryResponse = {
|
|
7512
7411
|
/**
|
|
7513
7412
|
* Operation
|
|
7514
7413
|
*
|
|
@@ -7530,7 +7429,7 @@ export type OperationEnvelopeEventBlockEnvelope = {
|
|
|
7530
7429
|
/**
|
|
7531
7430
|
* Command-specific result payload
|
|
7532
7431
|
*/
|
|
7533
|
-
result?:
|
|
7432
|
+
result?: JournalEntryResponse | null;
|
|
7534
7433
|
/**
|
|
7535
7434
|
* At
|
|
7536
7435
|
*
|
|
@@ -7552,9 +7451,9 @@ export type OperationEnvelopeEventBlockEnvelope = {
|
|
|
7552
7451
|
};
|
|
7553
7452
|
|
|
7554
7453
|
/**
|
|
7555
|
-
* OperationEnvelope[
|
|
7454
|
+
* OperationEnvelope[LedgerAgentResponse]
|
|
7556
7455
|
*/
|
|
7557
|
-
export type
|
|
7456
|
+
export type OperationEnvelopeLedgerAgentResponse = {
|
|
7558
7457
|
/**
|
|
7559
7458
|
* Operation
|
|
7560
7459
|
*
|
|
@@ -7576,7 +7475,7 @@ export type OperationEnvelopeEventHandlerResponse = {
|
|
|
7576
7475
|
/**
|
|
7577
7476
|
* Command-specific result payload
|
|
7578
7477
|
*/
|
|
7579
|
-
result?:
|
|
7478
|
+
result?: LedgerAgentResponse | null;
|
|
7580
7479
|
/**
|
|
7581
7480
|
* At
|
|
7582
7481
|
*
|
|
@@ -7598,9 +7497,9 @@ export type OperationEnvelopeEventHandlerResponse = {
|
|
|
7598
7497
|
};
|
|
7599
7498
|
|
|
7600
7499
|
/**
|
|
7601
|
-
* OperationEnvelope[
|
|
7500
|
+
* OperationEnvelope[LedgerEntityResponse]
|
|
7602
7501
|
*/
|
|
7603
|
-
export type
|
|
7502
|
+
export type OperationEnvelopeLedgerEntityResponse = {
|
|
7604
7503
|
/**
|
|
7605
7504
|
* Operation
|
|
7606
7505
|
*
|
|
@@ -7622,7 +7521,7 @@ export type OperationEnvelopeFiscalCalendarResponse = {
|
|
|
7622
7521
|
/**
|
|
7623
7522
|
* Command-specific result payload
|
|
7624
7523
|
*/
|
|
7625
|
-
result?:
|
|
7524
|
+
result?: LedgerEntityResponse | null;
|
|
7626
7525
|
/**
|
|
7627
7526
|
* At
|
|
7628
7527
|
*
|
|
@@ -7644,9 +7543,9 @@ export type OperationEnvelopeFiscalCalendarResponse = {
|
|
|
7644
7543
|
};
|
|
7645
7544
|
|
|
7646
7545
|
/**
|
|
7647
|
-
* OperationEnvelope[
|
|
7546
|
+
* OperationEnvelope[PortfolioBlockEnvelope]
|
|
7648
7547
|
*/
|
|
7649
|
-
export type
|
|
7548
|
+
export type OperationEnvelopePortfolioBlockEnvelope = {
|
|
7650
7549
|
/**
|
|
7651
7550
|
* Operation
|
|
7652
7551
|
*
|
|
@@ -7668,7 +7567,7 @@ export type OperationEnvelopeInformationBlockEnvelope = {
|
|
|
7668
7567
|
/**
|
|
7669
7568
|
* Command-specific result payload
|
|
7670
7569
|
*/
|
|
7671
|
-
result?:
|
|
7570
|
+
result?: PortfolioBlockEnvelope | null;
|
|
7672
7571
|
/**
|
|
7673
7572
|
* At
|
|
7674
7573
|
*
|
|
@@ -7690,9 +7589,9 @@ export type OperationEnvelopeInformationBlockEnvelope = {
|
|
|
7690
7589
|
};
|
|
7691
7590
|
|
|
7692
7591
|
/**
|
|
7693
|
-
* OperationEnvelope[
|
|
7592
|
+
* OperationEnvelope[PreviewEventBlockResponse]
|
|
7694
7593
|
*/
|
|
7695
|
-
export type
|
|
7594
|
+
export type OperationEnvelopePreviewEventBlockResponse = {
|
|
7696
7595
|
/**
|
|
7697
7596
|
* Operation
|
|
7698
7597
|
*
|
|
@@ -7714,7 +7613,7 @@ export type OperationEnvelopeInitializeLedgerResponse = {
|
|
|
7714
7613
|
/**
|
|
7715
7614
|
* Command-specific result payload
|
|
7716
7615
|
*/
|
|
7717
|
-
result?:
|
|
7616
|
+
result?: PreviewEventBlockResponse | null;
|
|
7718
7617
|
/**
|
|
7719
7618
|
* At
|
|
7720
7619
|
*
|
|
@@ -7736,9 +7635,9 @@ export type OperationEnvelopeInitializeLedgerResponse = {
|
|
|
7736
7635
|
};
|
|
7737
7636
|
|
|
7738
7637
|
/**
|
|
7739
|
-
* OperationEnvelope[
|
|
7638
|
+
* OperationEnvelope[PublishListResponse]
|
|
7740
7639
|
*/
|
|
7741
|
-
export type
|
|
7640
|
+
export type OperationEnvelopePublishListResponse = {
|
|
7742
7641
|
/**
|
|
7743
7642
|
* Operation
|
|
7744
7643
|
*
|
|
@@ -7760,7 +7659,7 @@ export type OperationEnvelopeJournalEntryResponse = {
|
|
|
7760
7659
|
/**
|
|
7761
7660
|
* Command-specific result payload
|
|
7762
7661
|
*/
|
|
7763
|
-
result?:
|
|
7662
|
+
result?: PublishListResponse | null;
|
|
7764
7663
|
/**
|
|
7765
7664
|
* At
|
|
7766
7665
|
*
|
|
@@ -7782,9 +7681,9 @@ export type OperationEnvelopeJournalEntryResponse = {
|
|
|
7782
7681
|
};
|
|
7783
7682
|
|
|
7784
7683
|
/**
|
|
7785
|
-
* OperationEnvelope[
|
|
7684
|
+
* OperationEnvelope[ReportResponse]
|
|
7786
7685
|
*/
|
|
7787
|
-
export type
|
|
7686
|
+
export type OperationEnvelopeReportResponse = {
|
|
7788
7687
|
/**
|
|
7789
7688
|
* Operation
|
|
7790
7689
|
*
|
|
@@ -7806,7 +7705,7 @@ export type OperationEnvelopeLedgerAgentResponse = {
|
|
|
7806
7705
|
/**
|
|
7807
7706
|
* Command-specific result payload
|
|
7808
7707
|
*/
|
|
7809
|
-
result?:
|
|
7708
|
+
result?: ReportResponse | null;
|
|
7810
7709
|
/**
|
|
7811
7710
|
* At
|
|
7812
7711
|
*
|
|
@@ -7828,9 +7727,9 @@ export type OperationEnvelopeLedgerAgentResponse = {
|
|
|
7828
7727
|
};
|
|
7829
7728
|
|
|
7830
7729
|
/**
|
|
7831
|
-
* OperationEnvelope[
|
|
7730
|
+
* OperationEnvelope[SecurityResponse]
|
|
7832
7731
|
*/
|
|
7833
|
-
export type
|
|
7732
|
+
export type OperationEnvelopeSecurityResponse = {
|
|
7834
7733
|
/**
|
|
7835
7734
|
* Operation
|
|
7836
7735
|
*
|
|
@@ -7852,7 +7751,7 @@ export type OperationEnvelopeLedgerEntityResponse = {
|
|
|
7852
7751
|
/**
|
|
7853
7752
|
* Command-specific result payload
|
|
7854
7753
|
*/
|
|
7855
|
-
result?:
|
|
7754
|
+
result?: SecurityResponse | null;
|
|
7856
7755
|
/**
|
|
7857
7756
|
* At
|
|
7858
7757
|
*
|
|
@@ -7874,9 +7773,9 @@ export type OperationEnvelopeLedgerEntityResponse = {
|
|
|
7874
7773
|
};
|
|
7875
7774
|
|
|
7876
7775
|
/**
|
|
7877
|
-
* OperationEnvelope[
|
|
7776
|
+
* OperationEnvelope[ShareReportResponse]
|
|
7878
7777
|
*/
|
|
7879
|
-
export type
|
|
7778
|
+
export type OperationEnvelopeShareReportResponse = {
|
|
7880
7779
|
/**
|
|
7881
7780
|
* Operation
|
|
7882
7781
|
*
|
|
@@ -7898,7 +7797,7 @@ export type OperationEnvelopePortfolioBlockEnvelope = {
|
|
|
7898
7797
|
/**
|
|
7899
7798
|
* Command-specific result payload
|
|
7900
7799
|
*/
|
|
7901
|
-
result?:
|
|
7800
|
+
result?: ShareReportResponse | null;
|
|
7902
7801
|
/**
|
|
7903
7802
|
* At
|
|
7904
7803
|
*
|
|
@@ -7920,9 +7819,9 @@ export type OperationEnvelopePortfolioBlockEnvelope = {
|
|
|
7920
7819
|
};
|
|
7921
7820
|
|
|
7922
7821
|
/**
|
|
7923
|
-
* OperationEnvelope[
|
|
7822
|
+
* OperationEnvelope[TaxonomyBlockEnvelope]
|
|
7924
7823
|
*/
|
|
7925
|
-
export type
|
|
7824
|
+
export type OperationEnvelopeTaxonomyBlockEnvelope = {
|
|
7926
7825
|
/**
|
|
7927
7826
|
* Operation
|
|
7928
7827
|
*
|
|
@@ -7944,7 +7843,7 @@ export type OperationEnvelopePreviewEventBlockResponse = {
|
|
|
7944
7843
|
/**
|
|
7945
7844
|
* Command-specific result payload
|
|
7946
7845
|
*/
|
|
7947
|
-
result?:
|
|
7846
|
+
result?: TaxonomyBlockEnvelope | null;
|
|
7948
7847
|
/**
|
|
7949
7848
|
* At
|
|
7950
7849
|
*
|
|
@@ -7966,9 +7865,9 @@ export type OperationEnvelopePreviewEventBlockResponse = {
|
|
|
7966
7865
|
};
|
|
7967
7866
|
|
|
7968
7867
|
/**
|
|
7969
|
-
* OperationEnvelope[
|
|
7868
|
+
* OperationEnvelope[list[PublishListMemberResponse]]
|
|
7970
7869
|
*/
|
|
7971
|
-
export type
|
|
7870
|
+
export type OperationEnvelopeListPublishListMemberResponse = {
|
|
7972
7871
|
/**
|
|
7973
7872
|
* Operation
|
|
7974
7873
|
*
|
|
@@ -7988,9 +7887,11 @@ export type OperationEnvelopePublishListResponse = {
|
|
|
7988
7887
|
*/
|
|
7989
7888
|
status: 'completed' | 'pending' | 'failed';
|
|
7990
7889
|
/**
|
|
7890
|
+
* Result
|
|
7891
|
+
*
|
|
7991
7892
|
* Command-specific result payload
|
|
7992
7893
|
*/
|
|
7993
|
-
result?:
|
|
7894
|
+
result?: Array<PublishListMemberResponse> | null;
|
|
7994
7895
|
/**
|
|
7995
7896
|
* At
|
|
7996
7897
|
*
|
|
@@ -7998,249 +7899,348 @@ export type OperationEnvelopePublishListResponse = {
|
|
|
7998
7899
|
*/
|
|
7999
7900
|
at: string;
|
|
8000
7901
|
/**
|
|
8001
|
-
* Createdby
|
|
7902
|
+
* Createdby
|
|
7903
|
+
*
|
|
7904
|
+
* User ID that initiated the operation (null for legacy callers)
|
|
7905
|
+
*/
|
|
7906
|
+
createdBy?: string | null;
|
|
7907
|
+
/**
|
|
7908
|
+
* Idempotentreplay
|
|
7909
|
+
*
|
|
7910
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
7911
|
+
*/
|
|
7912
|
+
idempotentReplay?: boolean;
|
|
7913
|
+
};
|
|
7914
|
+
|
|
7915
|
+
/**
|
|
7916
|
+
* OperatorListResponse
|
|
7917
|
+
*
|
|
7918
|
+
* Response for listing available operators.
|
|
7919
|
+
*/
|
|
7920
|
+
export type OperatorListResponse = {
|
|
7921
|
+
/**
|
|
7922
|
+
* Operators
|
|
7923
|
+
*
|
|
7924
|
+
* Dictionary of available operators with metadata
|
|
7925
|
+
*/
|
|
7926
|
+
operators: {
|
|
7927
|
+
[key: string]: {
|
|
7928
|
+
[key: string]: unknown;
|
|
7929
|
+
};
|
|
7930
|
+
};
|
|
7931
|
+
/**
|
|
7932
|
+
* Total
|
|
7933
|
+
*
|
|
7934
|
+
* Total number of operators
|
|
7935
|
+
*/
|
|
7936
|
+
total: number;
|
|
7937
|
+
};
|
|
7938
|
+
|
|
7939
|
+
/**
|
|
7940
|
+
* OperatorMessage
|
|
7941
|
+
*
|
|
7942
|
+
* Message in conversation history.
|
|
7943
|
+
*/
|
|
7944
|
+
export type OperatorMessage = {
|
|
7945
|
+
/**
|
|
7946
|
+
* Role
|
|
7947
|
+
*
|
|
7948
|
+
* Message role (user/assistant)
|
|
7949
|
+
*/
|
|
7950
|
+
role: string;
|
|
7951
|
+
/**
|
|
7952
|
+
* Content
|
|
8002
7953
|
*
|
|
8003
|
-
*
|
|
7954
|
+
* Message content
|
|
8004
7955
|
*/
|
|
8005
|
-
|
|
7956
|
+
content: string;
|
|
8006
7957
|
/**
|
|
8007
|
-
*
|
|
7958
|
+
* Timestamp
|
|
8008
7959
|
*
|
|
8009
|
-
*
|
|
7960
|
+
* Message timestamp
|
|
8010
7961
|
*/
|
|
8011
|
-
|
|
7962
|
+
timestamp?: string | null;
|
|
8012
7963
|
};
|
|
8013
7964
|
|
|
8014
7965
|
/**
|
|
8015
|
-
*
|
|
7966
|
+
* OperatorMetadataResponse
|
|
7967
|
+
*
|
|
7968
|
+
* Response for operator metadata.
|
|
8016
7969
|
*/
|
|
8017
|
-
export type
|
|
7970
|
+
export type OperatorMetadataResponse = {
|
|
8018
7971
|
/**
|
|
8019
|
-
*
|
|
7972
|
+
* Name
|
|
8020
7973
|
*
|
|
8021
|
-
*
|
|
7974
|
+
* Operator name
|
|
8022
7975
|
*/
|
|
8023
|
-
|
|
7976
|
+
name: string;
|
|
8024
7977
|
/**
|
|
8025
|
-
*
|
|
7978
|
+
* Description
|
|
8026
7979
|
*
|
|
8027
|
-
*
|
|
7980
|
+
* Operator description
|
|
8028
7981
|
*/
|
|
8029
|
-
|
|
7982
|
+
description: string;
|
|
8030
7983
|
/**
|
|
8031
|
-
*
|
|
7984
|
+
* Version
|
|
8032
7985
|
*
|
|
8033
|
-
*
|
|
7986
|
+
* Operator version
|
|
8034
7987
|
*/
|
|
8035
|
-
|
|
7988
|
+
version: string;
|
|
8036
7989
|
/**
|
|
8037
|
-
*
|
|
7990
|
+
* Capabilities
|
|
7991
|
+
*
|
|
7992
|
+
* Operator capabilities
|
|
8038
7993
|
*/
|
|
8039
|
-
|
|
7994
|
+
capabilities: Array<string>;
|
|
8040
7995
|
/**
|
|
8041
|
-
*
|
|
7996
|
+
* Supported Modes
|
|
8042
7997
|
*
|
|
8043
|
-
*
|
|
7998
|
+
* Supported execution modes
|
|
8044
7999
|
*/
|
|
8045
|
-
|
|
8000
|
+
supported_modes: Array<string>;
|
|
8046
8001
|
/**
|
|
8047
|
-
*
|
|
8002
|
+
* Requires Credits
|
|
8048
8003
|
*
|
|
8049
|
-
*
|
|
8004
|
+
* Whether operator requires credits
|
|
8050
8005
|
*/
|
|
8051
|
-
|
|
8006
|
+
requires_credits: boolean;
|
|
8052
8007
|
/**
|
|
8053
|
-
*
|
|
8008
|
+
* Author
|
|
8054
8009
|
*
|
|
8055
|
-
*
|
|
8010
|
+
* Operator author
|
|
8056
8011
|
*/
|
|
8057
|
-
|
|
8012
|
+
author?: string | null;
|
|
8013
|
+
/**
|
|
8014
|
+
* Tags
|
|
8015
|
+
*
|
|
8016
|
+
* Operator tags
|
|
8017
|
+
*/
|
|
8018
|
+
tags?: Array<string>;
|
|
8058
8019
|
};
|
|
8059
8020
|
|
|
8060
8021
|
/**
|
|
8061
|
-
*
|
|
8022
|
+
* OperatorMode
|
|
8023
|
+
*
|
|
8024
|
+
* Operator execution modes.
|
|
8062
8025
|
*/
|
|
8063
|
-
export type
|
|
8026
|
+
export type OperatorMode = 'quick' | 'standard' | 'extended' | 'streaming';
|
|
8027
|
+
|
|
8028
|
+
/**
|
|
8029
|
+
* OperatorRecommendation
|
|
8030
|
+
*
|
|
8031
|
+
* Single operator recommendation.
|
|
8032
|
+
*/
|
|
8033
|
+
export type OperatorRecommendation = {
|
|
8064
8034
|
/**
|
|
8065
|
-
*
|
|
8035
|
+
* Operator Type
|
|
8066
8036
|
*
|
|
8067
|
-
*
|
|
8037
|
+
* Operator type identifier
|
|
8068
8038
|
*/
|
|
8069
|
-
|
|
8039
|
+
operator_type: string;
|
|
8070
8040
|
/**
|
|
8071
|
-
*
|
|
8041
|
+
* Operator Name
|
|
8072
8042
|
*
|
|
8073
|
-
*
|
|
8043
|
+
* Operator display name
|
|
8074
8044
|
*/
|
|
8075
|
-
|
|
8045
|
+
operator_name: string;
|
|
8076
8046
|
/**
|
|
8077
|
-
*
|
|
8047
|
+
* Confidence
|
|
8078
8048
|
*
|
|
8079
|
-
*
|
|
8049
|
+
* Confidence score (0-1)
|
|
8080
8050
|
*/
|
|
8081
|
-
|
|
8051
|
+
confidence: number;
|
|
8082
8052
|
/**
|
|
8083
|
-
*
|
|
8053
|
+
* Capabilities
|
|
8054
|
+
*
|
|
8055
|
+
* Operator capabilities
|
|
8084
8056
|
*/
|
|
8085
|
-
|
|
8057
|
+
capabilities: Array<string>;
|
|
8086
8058
|
/**
|
|
8087
|
-
*
|
|
8059
|
+
* Reason
|
|
8088
8060
|
*
|
|
8089
|
-
*
|
|
8061
|
+
* Reason for recommendation
|
|
8090
8062
|
*/
|
|
8091
|
-
|
|
8063
|
+
reason?: string | null;
|
|
8064
|
+
};
|
|
8065
|
+
|
|
8066
|
+
/**
|
|
8067
|
+
* OperatorRecommendationRequest
|
|
8068
|
+
*
|
|
8069
|
+
* Request for operator recommendations.
|
|
8070
|
+
*/
|
|
8071
|
+
export type OperatorRecommendationRequest = {
|
|
8092
8072
|
/**
|
|
8093
|
-
*
|
|
8073
|
+
* Query
|
|
8094
8074
|
*
|
|
8095
|
-
*
|
|
8075
|
+
* Query to analyze
|
|
8096
8076
|
*/
|
|
8097
|
-
|
|
8077
|
+
query: string;
|
|
8098
8078
|
/**
|
|
8099
|
-
*
|
|
8079
|
+
* Context
|
|
8100
8080
|
*
|
|
8101
|
-
*
|
|
8081
|
+
* Additional context
|
|
8102
8082
|
*/
|
|
8103
|
-
|
|
8083
|
+
context?: {
|
|
8084
|
+
[key: string]: unknown;
|
|
8085
|
+
} | null;
|
|
8104
8086
|
};
|
|
8105
8087
|
|
|
8106
8088
|
/**
|
|
8107
|
-
*
|
|
8089
|
+
* OperatorRecommendationResponse
|
|
8090
|
+
*
|
|
8091
|
+
* Response for operator recommendations.
|
|
8108
8092
|
*/
|
|
8109
|
-
export type
|
|
8093
|
+
export type OperatorRecommendationResponse = {
|
|
8110
8094
|
/**
|
|
8111
|
-
*
|
|
8095
|
+
* Recommendations
|
|
8112
8096
|
*
|
|
8113
|
-
*
|
|
8097
|
+
* List of operator recommendations sorted by confidence
|
|
8114
8098
|
*/
|
|
8115
|
-
|
|
8099
|
+
recommendations: Array<OperatorRecommendation>;
|
|
8116
8100
|
/**
|
|
8117
|
-
*
|
|
8101
|
+
* Query
|
|
8118
8102
|
*
|
|
8119
|
-
*
|
|
8103
|
+
* The analyzed query
|
|
8120
8104
|
*/
|
|
8121
|
-
|
|
8105
|
+
query: string;
|
|
8106
|
+
};
|
|
8107
|
+
|
|
8108
|
+
/**
|
|
8109
|
+
* OperatorRequest
|
|
8110
|
+
*
|
|
8111
|
+
* Request model for operator interactions.
|
|
8112
|
+
*/
|
|
8113
|
+
export type OperatorRequest = {
|
|
8122
8114
|
/**
|
|
8123
|
-
*
|
|
8115
|
+
* Message
|
|
8124
8116
|
*
|
|
8125
|
-
*
|
|
8117
|
+
* The query or message to process
|
|
8126
8118
|
*/
|
|
8127
|
-
|
|
8119
|
+
message: string;
|
|
8128
8120
|
/**
|
|
8129
|
-
*
|
|
8121
|
+
* History
|
|
8122
|
+
*
|
|
8123
|
+
* Conversation history
|
|
8130
8124
|
*/
|
|
8131
|
-
|
|
8125
|
+
history?: Array<OperatorMessage>;
|
|
8132
8126
|
/**
|
|
8133
|
-
*
|
|
8127
|
+
* Context
|
|
8134
8128
|
*
|
|
8135
|
-
*
|
|
8129
|
+
* Additional context for analysis (e.g., enable_rag, include_schema)
|
|
8136
8130
|
*/
|
|
8137
|
-
|
|
8131
|
+
context?: {
|
|
8132
|
+
[key: string]: unknown;
|
|
8133
|
+
} | null;
|
|
8138
8134
|
/**
|
|
8139
|
-
*
|
|
8140
|
-
*
|
|
8141
|
-
* User ID that initiated the operation (null for legacy callers)
|
|
8135
|
+
* Execution mode
|
|
8142
8136
|
*/
|
|
8143
|
-
|
|
8137
|
+
mode?: OperatorMode | null;
|
|
8144
8138
|
/**
|
|
8145
|
-
*
|
|
8139
|
+
* Operator Type
|
|
8146
8140
|
*
|
|
8147
|
-
*
|
|
8141
|
+
* Specific operator type to use (optional)
|
|
8148
8142
|
*/
|
|
8149
|
-
|
|
8150
|
-
};
|
|
8151
|
-
|
|
8152
|
-
/**
|
|
8153
|
-
* OperationEnvelope[TaxonomyBlockEnvelope]
|
|
8154
|
-
*/
|
|
8155
|
-
export type OperationEnvelopeTaxonomyBlockEnvelope = {
|
|
8143
|
+
operator_type?: string | null;
|
|
8156
8144
|
/**
|
|
8157
|
-
*
|
|
8158
|
-
*
|
|
8159
|
-
* Kebab-case operation name
|
|
8145
|
+
* Criteria for operator selection
|
|
8160
8146
|
*/
|
|
8161
|
-
|
|
8147
|
+
selection_criteria?: SelectionCriteria | null;
|
|
8162
8148
|
/**
|
|
8163
|
-
*
|
|
8149
|
+
* Force Extended Analysis
|
|
8164
8150
|
*
|
|
8165
|
-
*
|
|
8151
|
+
* Force extended analysis mode with comprehensive research
|
|
8166
8152
|
*/
|
|
8167
|
-
|
|
8153
|
+
force_extended_analysis?: boolean;
|
|
8168
8154
|
/**
|
|
8169
|
-
*
|
|
8155
|
+
* Enable Rag
|
|
8170
8156
|
*
|
|
8171
|
-
*
|
|
8157
|
+
* Enable RAG context enrichment
|
|
8172
8158
|
*/
|
|
8173
|
-
|
|
8159
|
+
enable_rag?: boolean;
|
|
8174
8160
|
/**
|
|
8175
|
-
*
|
|
8161
|
+
* Stream
|
|
8162
|
+
*
|
|
8163
|
+
* Enable streaming response
|
|
8176
8164
|
*/
|
|
8177
|
-
|
|
8165
|
+
stream?: boolean;
|
|
8166
|
+
};
|
|
8167
|
+
|
|
8168
|
+
/**
|
|
8169
|
+
* OperatorResponse
|
|
8170
|
+
*
|
|
8171
|
+
* Response model for operator interactions.
|
|
8172
|
+
*/
|
|
8173
|
+
export type OperatorResponse = {
|
|
8178
8174
|
/**
|
|
8179
|
-
*
|
|
8175
|
+
* Content
|
|
8180
8176
|
*
|
|
8181
|
-
*
|
|
8177
|
+
* The operator's response content
|
|
8182
8178
|
*/
|
|
8183
|
-
|
|
8179
|
+
content: string;
|
|
8184
8180
|
/**
|
|
8185
|
-
*
|
|
8181
|
+
* Operator Used
|
|
8186
8182
|
*
|
|
8187
|
-
*
|
|
8183
|
+
* The operator type that handled the request
|
|
8188
8184
|
*/
|
|
8189
|
-
|
|
8185
|
+
operator_used: string;
|
|
8190
8186
|
/**
|
|
8191
|
-
*
|
|
8187
|
+
* The execution mode used
|
|
8188
|
+
*/
|
|
8189
|
+
mode_used: OperatorMode;
|
|
8190
|
+
/**
|
|
8191
|
+
* Metadata
|
|
8192
8192
|
*
|
|
8193
|
-
*
|
|
8193
|
+
* Response metadata including routing info
|
|
8194
8194
|
*/
|
|
8195
|
-
|
|
8196
|
-
|
|
8197
|
-
|
|
8198
|
-
/**
|
|
8199
|
-
* OperationEnvelope[list[PublishListMemberResponse]]
|
|
8200
|
-
*/
|
|
8201
|
-
export type OperationEnvelopeListPublishListMemberResponse = {
|
|
8195
|
+
metadata?: {
|
|
8196
|
+
[key: string]: unknown;
|
|
8197
|
+
} | null;
|
|
8202
8198
|
/**
|
|
8203
|
-
*
|
|
8199
|
+
* Tokens Used
|
|
8204
8200
|
*
|
|
8205
|
-
*
|
|
8201
|
+
* Token usage statistics
|
|
8206
8202
|
*/
|
|
8207
|
-
|
|
8203
|
+
tokens_used?: {
|
|
8204
|
+
[key: string]: number;
|
|
8205
|
+
} | null;
|
|
8208
8206
|
/**
|
|
8209
|
-
*
|
|
8207
|
+
* Confidence Score
|
|
8210
8208
|
*
|
|
8211
|
-
*
|
|
8209
|
+
* Confidence score of the response (0.0-1.0 scale)
|
|
8212
8210
|
*/
|
|
8213
|
-
|
|
8211
|
+
confidence_score?: number | null;
|
|
8214
8212
|
/**
|
|
8215
|
-
*
|
|
8213
|
+
* Operation Id
|
|
8216
8214
|
*
|
|
8217
|
-
* Operation
|
|
8215
|
+
* Operation ID for SSE monitoring
|
|
8218
8216
|
*/
|
|
8219
|
-
|
|
8217
|
+
operation_id?: string | null;
|
|
8220
8218
|
/**
|
|
8221
|
-
*
|
|
8219
|
+
* Is Partial
|
|
8222
8220
|
*
|
|
8223
|
-
*
|
|
8221
|
+
* Whether this is a partial response
|
|
8224
8222
|
*/
|
|
8225
|
-
|
|
8223
|
+
is_partial?: boolean;
|
|
8226
8224
|
/**
|
|
8227
|
-
*
|
|
8225
|
+
* Error Details
|
|
8228
8226
|
*
|
|
8229
|
-
*
|
|
8227
|
+
* Error details if any
|
|
8230
8228
|
*/
|
|
8231
|
-
|
|
8229
|
+
error_details?: {
|
|
8230
|
+
[key: string]: unknown;
|
|
8231
|
+
} | null;
|
|
8232
8232
|
/**
|
|
8233
|
-
*
|
|
8233
|
+
* Execution Time
|
|
8234
8234
|
*
|
|
8235
|
-
*
|
|
8235
|
+
* Execution time in seconds
|
|
8236
8236
|
*/
|
|
8237
|
-
|
|
8237
|
+
execution_time?: number | null;
|
|
8238
8238
|
/**
|
|
8239
|
-
*
|
|
8239
|
+
* Timestamp
|
|
8240
8240
|
*
|
|
8241
|
-
*
|
|
8241
|
+
* Response timestamp
|
|
8242
8242
|
*/
|
|
8243
|
-
|
|
8243
|
+
timestamp?: string;
|
|
8244
8244
|
};
|
|
8245
8245
|
|
|
8246
8246
|
/**
|
|
@@ -10677,7 +10677,7 @@ export type SecurityResponse = {
|
|
|
10677
10677
|
/**
|
|
10678
10678
|
* SelectionCriteria
|
|
10679
10679
|
*
|
|
10680
|
-
* Criteria for
|
|
10680
|
+
* Criteria for operator selection.
|
|
10681
10681
|
*/
|
|
10682
10682
|
export type SelectionCriteria = {
|
|
10683
10683
|
/**
|
|
@@ -10689,13 +10689,13 @@ export type SelectionCriteria = {
|
|
|
10689
10689
|
/**
|
|
10690
10690
|
* Required Capabilities
|
|
10691
10691
|
*
|
|
10692
|
-
* Required
|
|
10692
|
+
* Required operator capabilities
|
|
10693
10693
|
*/
|
|
10694
10694
|
required_capabilities?: Array<string>;
|
|
10695
10695
|
/**
|
|
10696
10696
|
* Preferred execution mode
|
|
10697
10697
|
*/
|
|
10698
|
-
preferred_mode?:
|
|
10698
|
+
preferred_mode?: OperatorMode | null;
|
|
10699
10699
|
/**
|
|
10700
10700
|
* Max Response Time
|
|
10701
10701
|
*
|
|
@@ -10703,11 +10703,11 @@ export type SelectionCriteria = {
|
|
|
10703
10703
|
*/
|
|
10704
10704
|
max_response_time?: number;
|
|
10705
10705
|
/**
|
|
10706
|
-
* Excluded
|
|
10706
|
+
* Excluded Operators
|
|
10707
10707
|
*
|
|
10708
|
-
*
|
|
10708
|
+
* Operators to exclude from selection
|
|
10709
10709
|
*/
|
|
10710
|
-
|
|
10710
|
+
excluded_operators?: Array<string>;
|
|
10711
10711
|
};
|
|
10712
10712
|
|
|
10713
10713
|
/**
|
|
@@ -15317,7 +15317,7 @@ export type SyncConnectionResponses = {
|
|
|
15317
15317
|
|
|
15318
15318
|
export type SyncConnectionResponse = SyncConnectionResponses[keyof SyncConnectionResponses];
|
|
15319
15319
|
|
|
15320
|
-
export type
|
|
15320
|
+
export type ListOperatorsData = {
|
|
15321
15321
|
body?: never;
|
|
15322
15322
|
path: {
|
|
15323
15323
|
/**
|
|
@@ -15333,10 +15333,10 @@ export type ListAgentsData = {
|
|
|
15333
15333
|
*/
|
|
15334
15334
|
capability?: string | null;
|
|
15335
15335
|
};
|
|
15336
|
-
url: '/v1/graphs/{graph_id}/
|
|
15336
|
+
url: '/v1/graphs/{graph_id}/operator';
|
|
15337
15337
|
};
|
|
15338
15338
|
|
|
15339
|
-
export type
|
|
15339
|
+
export type ListOperatorsErrors = {
|
|
15340
15340
|
/**
|
|
15341
15341
|
* Invalid request
|
|
15342
15342
|
*/
|
|
@@ -15367,19 +15367,19 @@ export type ListAgentsErrors = {
|
|
|
15367
15367
|
500: ErrorResponse;
|
|
15368
15368
|
};
|
|
15369
15369
|
|
|
15370
|
-
export type
|
|
15370
|
+
export type ListOperatorsError = ListOperatorsErrors[keyof ListOperatorsErrors];
|
|
15371
15371
|
|
|
15372
|
-
export type
|
|
15372
|
+
export type ListOperatorsResponses = {
|
|
15373
15373
|
/**
|
|
15374
15374
|
* Successful Response
|
|
15375
15375
|
*/
|
|
15376
|
-
200:
|
|
15376
|
+
200: OperatorListResponse;
|
|
15377
15377
|
};
|
|
15378
15378
|
|
|
15379
|
-
export type
|
|
15379
|
+
export type ListOperatorsResponse = ListOperatorsResponses[keyof ListOperatorsResponses];
|
|
15380
15380
|
|
|
15381
|
-
export type
|
|
15382
|
-
body:
|
|
15381
|
+
export type AutoSelectOperatorData = {
|
|
15382
|
+
body: OperatorRequest;
|
|
15383
15383
|
path: {
|
|
15384
15384
|
/**
|
|
15385
15385
|
* Graph Id
|
|
@@ -15394,10 +15394,10 @@ export type AutoSelectAgentData = {
|
|
|
15394
15394
|
*/
|
|
15395
15395
|
mode?: ResponseMode | null;
|
|
15396
15396
|
};
|
|
15397
|
-
url: '/v1/graphs/{graph_id}/
|
|
15397
|
+
url: '/v1/graphs/{graph_id}/operator';
|
|
15398
15398
|
};
|
|
15399
15399
|
|
|
15400
|
-
export type
|
|
15400
|
+
export type AutoSelectOperatorErrors = {
|
|
15401
15401
|
/**
|
|
15402
15402
|
* Invalid request
|
|
15403
15403
|
*/
|
|
@@ -15432,22 +15432,22 @@ export type AutoSelectAgentErrors = {
|
|
|
15432
15432
|
500: ErrorResponse;
|
|
15433
15433
|
};
|
|
15434
15434
|
|
|
15435
|
-
export type
|
|
15435
|
+
export type AutoSelectOperatorError = AutoSelectOperatorErrors[keyof AutoSelectOperatorErrors];
|
|
15436
15436
|
|
|
15437
|
-
export type
|
|
15437
|
+
export type AutoSelectOperatorResponses = {
|
|
15438
15438
|
/**
|
|
15439
15439
|
* Successful Response
|
|
15440
15440
|
*/
|
|
15441
|
-
200:
|
|
15441
|
+
200: OperatorResponse;
|
|
15442
15442
|
/**
|
|
15443
15443
|
* Query queued for async processing
|
|
15444
15444
|
*/
|
|
15445
15445
|
202: unknown;
|
|
15446
15446
|
};
|
|
15447
15447
|
|
|
15448
|
-
export type
|
|
15448
|
+
export type AutoSelectOperatorResponse = AutoSelectOperatorResponses[keyof AutoSelectOperatorResponses];
|
|
15449
15449
|
|
|
15450
|
-
export type
|
|
15450
|
+
export type GetOperatorMetadataData = {
|
|
15451
15451
|
body?: never;
|
|
15452
15452
|
path: {
|
|
15453
15453
|
/**
|
|
@@ -15455,17 +15455,17 @@ export type GetAgentMetadataData = {
|
|
|
15455
15455
|
*/
|
|
15456
15456
|
graph_id: string;
|
|
15457
15457
|
/**
|
|
15458
|
-
*
|
|
15458
|
+
* Operator Type
|
|
15459
15459
|
*
|
|
15460
|
-
*
|
|
15460
|
+
* Operator type identifier (e.g., 'financial', 'research', 'rag')
|
|
15461
15461
|
*/
|
|
15462
|
-
|
|
15462
|
+
operator_type: string;
|
|
15463
15463
|
};
|
|
15464
15464
|
query?: never;
|
|
15465
|
-
url: '/v1/graphs/{graph_id}/
|
|
15465
|
+
url: '/v1/graphs/{graph_id}/operator/{operator_type}';
|
|
15466
15466
|
};
|
|
15467
15467
|
|
|
15468
|
-
export type
|
|
15468
|
+
export type GetOperatorMetadataErrors = {
|
|
15469
15469
|
/**
|
|
15470
15470
|
* Invalid request
|
|
15471
15471
|
*/
|
|
@@ -15496,24 +15496,24 @@ export type GetAgentMetadataErrors = {
|
|
|
15496
15496
|
500: ErrorResponse;
|
|
15497
15497
|
};
|
|
15498
15498
|
|
|
15499
|
-
export type
|
|
15499
|
+
export type GetOperatorMetadataError = GetOperatorMetadataErrors[keyof GetOperatorMetadataErrors];
|
|
15500
15500
|
|
|
15501
|
-
export type
|
|
15501
|
+
export type GetOperatorMetadataResponses = {
|
|
15502
15502
|
/**
|
|
15503
15503
|
* Successful Response
|
|
15504
15504
|
*/
|
|
15505
|
-
200:
|
|
15505
|
+
200: OperatorMetadataResponse;
|
|
15506
15506
|
};
|
|
15507
15507
|
|
|
15508
|
-
export type
|
|
15508
|
+
export type GetOperatorMetadataResponse = GetOperatorMetadataResponses[keyof GetOperatorMetadataResponses];
|
|
15509
15509
|
|
|
15510
|
-
export type
|
|
15511
|
-
body:
|
|
15510
|
+
export type ExecuteSpecificOperatorData = {
|
|
15511
|
+
body: OperatorRequest;
|
|
15512
15512
|
path: {
|
|
15513
15513
|
/**
|
|
15514
|
-
*
|
|
15514
|
+
* Operator Type
|
|
15515
15515
|
*/
|
|
15516
|
-
|
|
15516
|
+
operator_type: string;
|
|
15517
15517
|
/**
|
|
15518
15518
|
* Graph Id
|
|
15519
15519
|
*/
|
|
@@ -15527,10 +15527,10 @@ export type ExecuteSpecificAgentData = {
|
|
|
15527
15527
|
*/
|
|
15528
15528
|
mode?: ResponseMode | null;
|
|
15529
15529
|
};
|
|
15530
|
-
url: '/v1/graphs/{graph_id}/
|
|
15530
|
+
url: '/v1/graphs/{graph_id}/operator/{operator_type}';
|
|
15531
15531
|
};
|
|
15532
15532
|
|
|
15533
|
-
export type
|
|
15533
|
+
export type ExecuteSpecificOperatorErrors = {
|
|
15534
15534
|
/**
|
|
15535
15535
|
* Invalid request
|
|
15536
15536
|
*/
|
|
@@ -15565,23 +15565,23 @@ export type ExecuteSpecificAgentErrors = {
|
|
|
15565
15565
|
500: ErrorResponse;
|
|
15566
15566
|
};
|
|
15567
15567
|
|
|
15568
|
-
export type
|
|
15568
|
+
export type ExecuteSpecificOperatorError = ExecuteSpecificOperatorErrors[keyof ExecuteSpecificOperatorErrors];
|
|
15569
15569
|
|
|
15570
|
-
export type
|
|
15570
|
+
export type ExecuteSpecificOperatorResponses = {
|
|
15571
15571
|
/**
|
|
15572
15572
|
* Successful Response
|
|
15573
15573
|
*/
|
|
15574
|
-
200:
|
|
15574
|
+
200: OperatorResponse;
|
|
15575
15575
|
/**
|
|
15576
15576
|
* Query queued for async processing
|
|
15577
15577
|
*/
|
|
15578
15578
|
202: unknown;
|
|
15579
15579
|
};
|
|
15580
15580
|
|
|
15581
|
-
export type
|
|
15581
|
+
export type ExecuteSpecificOperatorResponse = ExecuteSpecificOperatorResponses[keyof ExecuteSpecificOperatorResponses];
|
|
15582
15582
|
|
|
15583
15583
|
export type BatchProcessQueriesData = {
|
|
15584
|
-
body:
|
|
15584
|
+
body: BatchOperatorRequest;
|
|
15585
15585
|
path: {
|
|
15586
15586
|
/**
|
|
15587
15587
|
* Graph Id
|
|
@@ -15589,7 +15589,7 @@ export type BatchProcessQueriesData = {
|
|
|
15589
15589
|
graph_id: string;
|
|
15590
15590
|
};
|
|
15591
15591
|
query?: never;
|
|
15592
|
-
url: '/v1/graphs/{graph_id}/
|
|
15592
|
+
url: '/v1/graphs/{graph_id}/operator/batch';
|
|
15593
15593
|
};
|
|
15594
15594
|
|
|
15595
15595
|
export type BatchProcessQueriesErrors = {
|
|
@@ -15633,13 +15633,13 @@ export type BatchProcessQueriesResponses = {
|
|
|
15633
15633
|
/**
|
|
15634
15634
|
* Successful Response
|
|
15635
15635
|
*/
|
|
15636
|
-
200:
|
|
15636
|
+
200: BatchOperatorResponse;
|
|
15637
15637
|
};
|
|
15638
15638
|
|
|
15639
15639
|
export type BatchProcessQueriesResponse = BatchProcessQueriesResponses[keyof BatchProcessQueriesResponses];
|
|
15640
15640
|
|
|
15641
|
-
export type
|
|
15642
|
-
body:
|
|
15641
|
+
export type RecommendOperatorData = {
|
|
15642
|
+
body: OperatorRecommendationRequest;
|
|
15643
15643
|
path: {
|
|
15644
15644
|
/**
|
|
15645
15645
|
* Graph Id
|
|
@@ -15647,10 +15647,10 @@ export type RecommendAgentData = {
|
|
|
15647
15647
|
graph_id: string;
|
|
15648
15648
|
};
|
|
15649
15649
|
query?: never;
|
|
15650
|
-
url: '/v1/graphs/{graph_id}/
|
|
15650
|
+
url: '/v1/graphs/{graph_id}/operator/recommend';
|
|
15651
15651
|
};
|
|
15652
15652
|
|
|
15653
|
-
export type
|
|
15653
|
+
export type RecommendOperatorErrors = {
|
|
15654
15654
|
/**
|
|
15655
15655
|
* Invalid request
|
|
15656
15656
|
*/
|
|
@@ -15681,16 +15681,16 @@ export type RecommendAgentErrors = {
|
|
|
15681
15681
|
500: ErrorResponse;
|
|
15682
15682
|
};
|
|
15683
15683
|
|
|
15684
|
-
export type
|
|
15684
|
+
export type RecommendOperatorError = RecommendOperatorErrors[keyof RecommendOperatorErrors];
|
|
15685
15685
|
|
|
15686
|
-
export type
|
|
15686
|
+
export type RecommendOperatorResponses = {
|
|
15687
15687
|
/**
|
|
15688
15688
|
* Successful Response
|
|
15689
15689
|
*/
|
|
15690
|
-
200:
|
|
15690
|
+
200: OperatorRecommendationResponse;
|
|
15691
15691
|
};
|
|
15692
15692
|
|
|
15693
|
-
export type
|
|
15693
|
+
export type RecommendOperatorResponse = RecommendOperatorResponses[keyof RecommendOperatorResponses];
|
|
15694
15694
|
|
|
15695
15695
|
export type ListMcpToolsData = {
|
|
15696
15696
|
body?: never;
|