@robosystems/client 0.3.26 → 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/types.gen.d.ts CHANGED
@@ -114,558 +114,236 @@ export type AddPublishListMembersOperation = {
114
114
  list_id: string;
115
115
  };
116
116
  /**
117
- * AgentListResponse
117
+ * ArtifactResponse
118
118
  *
119
- * Response for listing available agents.
119
+ * The block's producible-artifact envelope — topic, template, mechanics.
120
120
  */
121
- export type AgentListResponse = {
122
- /**
123
- * Agents
124
- *
125
- * Dictionary of available agents with metadata
126
- */
127
- agents: {
128
- [key: string]: {
129
- [key: string]: unknown;
130
- };
131
- };
121
+ export type ArtifactResponse = {
132
122
  /**
133
- * Total
123
+ * Topic
134
124
  *
135
- * Total number of agents
125
+ * Structure.description the block's human-readable topic.
136
126
  */
137
- total: number;
138
- };
139
- /**
140
- * AgentMessage
141
- *
142
- * Message in conversation history.
143
- */
144
- export type AgentMessage = {
127
+ topic?: string | null;
145
128
  /**
146
- * Role
129
+ * Renderer Note
147
130
  *
148
- * Message role (user/assistant)
131
+ * e.g. 'in thousands', 'except per share'.
149
132
  */
150
- role: string;
133
+ renderer_note?: string | null;
151
134
  /**
152
- * Content
135
+ * Template
153
136
  *
154
- * Message content
137
+ * Reusable layout (ordering, subtotals, styling) when attached. First-class templates are not yet implemented; this field is always null on currently-shipped block types.
155
138
  */
156
- content: string;
139
+ template?: {
140
+ [key: string]: unknown;
141
+ } | null;
157
142
  /**
158
- * Timestamp
159
- *
160
- * Message timestamp
143
+ * Mechanics
161
144
  */
162
- timestamp?: string | null;
145
+ mechanics: ({
146
+ kind: 'closing_entry_generator';
147
+ } & ScheduleMechanics) | ({
148
+ kind: 'statement_renderer';
149
+ } & StatementMechanics) | ({
150
+ kind: 'metric';
151
+ } & MetricMechanics);
163
152
  };
164
153
  /**
165
- * AgentMetadataResponse
154
+ * AssociationResponse
155
+ *
156
+ * One edge between two elements within a structure (parent/child
157
+ * presentation, calculation rollup, mapping, equivalence).
166
158
  *
167
- * Response for agent metadata.
159
+ * ``association_type`` discriminates the edge semantics. Mapping edges
160
+ * are the user-facing path (CoA → reporting concept); presentation /
161
+ * calculation edges express structure layout and roll-ups.
162
+ * ``confidence`` is set on AI-suggested mappings (≥0.90 auto-approved,
163
+ * 0.70-0.89 flagged for review).
168
164
  */
169
- export type AgentMetadataResponse = {
165
+ export type AssociationResponse = {
170
166
  /**
171
- * Name
172
- *
173
- * Agent name
167
+ * Id
174
168
  */
175
- name: string;
169
+ id: string;
176
170
  /**
177
- * Description
178
- *
179
- * Agent description
171
+ * Structure Id
180
172
  */
181
- description: string;
173
+ structure_id: string;
182
174
  /**
183
- * Version
184
- *
185
- * Agent version
175
+ * From Element Id
186
176
  */
187
- version: string;
177
+ from_element_id: string;
188
178
  /**
189
- * Capabilities
190
- *
191
- * Agent capabilities
179
+ * From Element Name
192
180
  */
193
- capabilities: Array<string>;
181
+ from_element_name?: string | null;
194
182
  /**
195
- * Supported Modes
196
- *
197
- * Supported execution modes
183
+ * From Element Qname
198
184
  */
199
- supported_modes: Array<string>;
185
+ from_element_qname?: string | null;
200
186
  /**
201
- * Requires Credits
202
- *
203
- * Whether agent requires credits
187
+ * To Element Id
204
188
  */
205
- requires_credits: boolean;
189
+ to_element_id: string;
206
190
  /**
207
- * Author
208
- *
209
- * Agent author
191
+ * To Element Name
210
192
  */
211
- author?: string | null;
193
+ to_element_name?: string | null;
212
194
  /**
213
- * Tags
214
- *
215
- * Agent tags
195
+ * To Element Qname
216
196
  */
217
- tags?: Array<string>;
218
- };
219
- /**
220
- * AgentMode
221
- *
222
- * Agent execution modes.
223
- */
224
- export type AgentMode = 'quick' | 'standard' | 'extended' | 'streaming';
225
- /**
226
- * AgentRecommendation
227
- *
228
- * Single agent recommendation.
229
- */
230
- export type AgentRecommendation = {
197
+ to_element_qname?: string | null;
231
198
  /**
232
- * Agent Type
233
- *
234
- * Agent type identifier
199
+ * Association Type
235
200
  */
236
- agent_type: string;
201
+ association_type: string;
237
202
  /**
238
- * Agent Name
239
- *
240
- * Agent display name
203
+ * Order Value
204
+ */
205
+ order_value?: number | null;
206
+ /**
207
+ * Weight
241
208
  */
242
- agent_name: string;
209
+ weight?: number | null;
243
210
  /**
244
211
  * Confidence
245
- *
246
- * Confidence score (0-1)
247
212
  */
248
- confidence: number;
213
+ confidence?: number | null;
249
214
  /**
250
- * Capabilities
251
- *
252
- * Agent capabilities
215
+ * Suggested By
253
216
  */
254
- capabilities: Array<string>;
217
+ suggested_by?: string | null;
255
218
  /**
256
- * Reason
257
- *
258
- * Reason for recommendation
219
+ * Approved By
259
220
  */
260
- reason?: string | null;
221
+ approved_by?: string | null;
261
222
  };
262
223
  /**
263
- * AgentRecommendationRequest
224
+ * AuthResponse
264
225
  *
265
- * Request for agent recommendations.
226
+ * Authentication response model.
266
227
  */
267
- export type AgentRecommendationRequest = {
228
+ export type AuthResponse = {
268
229
  /**
269
- * Query
230
+ * User
270
231
  *
271
- * Query to analyze
232
+ * User information
272
233
  */
273
- query: string;
234
+ user: {
235
+ [key: string]: unknown;
236
+ };
274
237
  /**
275
- * Context
238
+ * Org
276
239
  *
277
- * Additional context
240
+ * Organization information (personal org created automatically on registration)
278
241
  */
279
- context?: {
242
+ org?: {
280
243
  [key: string]: unknown;
281
244
  } | null;
282
- };
283
- /**
284
- * AgentRecommendationResponse
285
- *
286
- * Response for agent recommendations.
287
- */
288
- export type AgentRecommendationResponse = {
289
- /**
290
- * Recommendations
291
- *
292
- * List of agent recommendations sorted by confidence
293
- */
294
- recommendations: Array<AgentRecommendation>;
295
- /**
296
- * Query
297
- *
298
- * The analyzed query
299
- */
300
- query: string;
301
- };
302
- /**
303
- * AgentRequest
304
- *
305
- * Request model for agent interactions.
306
- */
307
- export type AgentRequest = {
308
245
  /**
309
246
  * Message
310
247
  *
311
- * The query or message to process
248
+ * Success message
312
249
  */
313
250
  message: string;
314
251
  /**
315
- * History
252
+ * Token
316
253
  *
317
- * Conversation history
254
+ * JWT authentication token (optional for cookie-based auth)
318
255
  */
319
- history?: Array<AgentMessage>;
256
+ token?: string | null;
320
257
  /**
321
- * Context
258
+ * Expires In
322
259
  *
323
- * Additional context for analysis (e.g., enable_rag, include_schema)
260
+ * Token expiry time in seconds from now
324
261
  */
325
- context?: {
326
- [key: string]: unknown;
327
- } | null;
262
+ expires_in?: number | null;
328
263
  /**
329
- * Execution mode
264
+ * Refresh Threshold
265
+ *
266
+ * Recommended refresh threshold in seconds before expiry
330
267
  */
331
- mode?: AgentMode | null;
268
+ refresh_threshold?: number | null;
269
+ };
270
+ /**
271
+ * AutoMapElementsOperation
272
+ *
273
+ * Run the MappingOperator over a mapping structure (async).
274
+ *
275
+ * The MappingOperator walks every unmapped CoA element and proposes
276
+ * associations to reporting concepts. Confidence thresholds: ≥0.90
277
+ * auto-approved (association created), 0.70-0.89 flagged for review
278
+ * (created with `confidence` set; surface it in your UI), <0.70 skipped.
279
+ * Returns a `pending` envelope immediately; subscribe to the SSE stream
280
+ * for progress.
281
+ */
282
+ export type AutoMapElementsOperation = {
332
283
  /**
333
- * Agent Type
284
+ * Mapping Id
334
285
  *
335
- * Specific agent type to use (optional)
286
+ * The mapping structure to populate.
336
287
  */
337
- agent_type?: string | null;
288
+ mapping_id: string;
289
+ };
290
+ /**
291
+ * AvailableExtension
292
+ */
293
+ export type AvailableExtension = {
338
294
  /**
339
- * Criteria for agent selection
295
+ * Name
340
296
  */
341
- selection_criteria?: SelectionCriteria | null;
297
+ name: string;
342
298
  /**
343
- * Force Extended Analysis
344
- *
345
- * Force extended analysis mode with comprehensive research
299
+ * Description
346
300
  */
347
- force_extended_analysis?: boolean;
301
+ description: string;
348
302
  /**
349
- * Enable Rag
350
- *
351
- * Enable RAG context enrichment
303
+ * Enabled
352
304
  */
353
- enable_rag?: boolean;
305
+ enabled?: boolean;
306
+ };
307
+ /**
308
+ * AvailableExtensionsResponse
309
+ */
310
+ export type AvailableExtensionsResponse = {
354
311
  /**
355
- * Stream
356
- *
357
- * Enable streaming response
312
+ * Extensions
358
313
  */
359
- stream?: boolean;
314
+ extensions: Array<AvailableExtension>;
360
315
  };
361
316
  /**
362
- * AgentResponse
317
+ * AvailableGraphTiersResponse
363
318
  *
364
- * Response model for agent interactions.
319
+ * Response containing available graph tiers.
365
320
  */
366
- export type AgentResponse = {
321
+ export type AvailableGraphTiersResponse = {
367
322
  /**
368
- * Content
323
+ * Tiers
369
324
  *
370
- * The agent's response content
325
+ * List of available tiers
371
326
  */
372
- content: string;
327
+ tiers: Array<GraphTierInfo>;
328
+ };
329
+ /**
330
+ * BackupCreateRequest
331
+ *
332
+ * Request model for creating a backup.
333
+ */
334
+ export type BackupCreateRequest = {
373
335
  /**
374
- * Agent Used
336
+ * Backup Format
375
337
  *
376
- * The agent type that handled the request
338
+ * Backup format - only 'full_dump' is supported (complete .lbug database file)
377
339
  */
378
- agent_used: string;
340
+ backup_format?: string;
379
341
  /**
380
- * The execution mode used
342
+ * Backup Type
343
+ *
344
+ * Backup type - only 'full' is supported
381
345
  */
382
- mode_used: AgentMode;
383
- /**
384
- * Metadata
385
- *
386
- * Response metadata including routing info
387
- */
388
- metadata?: {
389
- [key: string]: unknown;
390
- } | null;
391
- /**
392
- * Tokens Used
393
- *
394
- * Token usage statistics
395
- */
396
- tokens_used?: {
397
- [key: string]: number;
398
- } | null;
399
- /**
400
- * Confidence Score
401
- *
402
- * Confidence score of the response (0.0-1.0 scale)
403
- */
404
- confidence_score?: number | null;
405
- /**
406
- * Operation Id
407
- *
408
- * Operation ID for SSE monitoring
409
- */
410
- operation_id?: string | null;
411
- /**
412
- * Is Partial
413
- *
414
- * Whether this is a partial response
415
- */
416
- is_partial?: boolean;
417
- /**
418
- * Error Details
419
- *
420
- * Error details if any
421
- */
422
- error_details?: {
423
- [key: string]: unknown;
424
- } | null;
425
- /**
426
- * Execution Time
427
- *
428
- * Execution time in seconds
429
- */
430
- execution_time?: number | null;
431
- /**
432
- * Timestamp
433
- *
434
- * Response timestamp
435
- */
436
- timestamp?: string;
437
- };
438
- /**
439
- * ArtifactResponse
440
- *
441
- * The block's producible-artifact envelope — topic, template, mechanics.
442
- */
443
- export type ArtifactResponse = {
444
- /**
445
- * Topic
446
- *
447
- * Structure.description — the block's human-readable topic.
448
- */
449
- topic?: string | null;
450
- /**
451
- * Renderer Note
452
- *
453
- * e.g. 'in thousands', 'except per share'.
454
- */
455
- renderer_note?: string | null;
456
- /**
457
- * Template
458
- *
459
- * Reusable layout (ordering, subtotals, styling) when attached. First-class templates are not yet implemented; this field is always null on currently-shipped block types.
460
- */
461
- template?: {
462
- [key: string]: unknown;
463
- } | null;
464
- /**
465
- * Mechanics
466
- */
467
- mechanics: ({
468
- kind: 'closing_entry_generator';
469
- } & ScheduleMechanics) | ({
470
- kind: 'statement_renderer';
471
- } & StatementMechanics) | ({
472
- kind: 'metric';
473
- } & MetricMechanics);
474
- };
475
- /**
476
- * AssociationResponse
477
- *
478
- * One edge between two elements within a structure (parent/child
479
- * presentation, calculation rollup, mapping, equivalence).
480
- *
481
- * ``association_type`` discriminates the edge semantics. Mapping edges
482
- * are the user-facing path (CoA → reporting concept); presentation /
483
- * calculation edges express structure layout and roll-ups.
484
- * ``confidence`` is set on AI-suggested mappings (≥0.90 auto-approved,
485
- * 0.70-0.89 flagged for review).
486
- */
487
- export type AssociationResponse = {
488
- /**
489
- * Id
490
- */
491
- id: string;
492
- /**
493
- * Structure Id
494
- */
495
- structure_id: string;
496
- /**
497
- * From Element Id
498
- */
499
- from_element_id: string;
500
- /**
501
- * From Element Name
502
- */
503
- from_element_name?: string | null;
504
- /**
505
- * From Element Qname
506
- */
507
- from_element_qname?: string | null;
508
- /**
509
- * To Element Id
510
- */
511
- to_element_id: string;
512
- /**
513
- * To Element Name
514
- */
515
- to_element_name?: string | null;
516
- /**
517
- * To Element Qname
518
- */
519
- to_element_qname?: string | null;
520
- /**
521
- * Association Type
522
- */
523
- association_type: string;
524
- /**
525
- * Order Value
526
- */
527
- order_value?: number | null;
528
- /**
529
- * Weight
530
- */
531
- weight?: number | null;
532
- /**
533
- * Confidence
534
- */
535
- confidence?: number | null;
536
- /**
537
- * Suggested By
538
- */
539
- suggested_by?: string | null;
540
- /**
541
- * Approved By
542
- */
543
- approved_by?: string | null;
544
- };
545
- /**
546
- * AuthResponse
547
- *
548
- * Authentication response model.
549
- */
550
- export type AuthResponse = {
551
- /**
552
- * User
553
- *
554
- * User information
555
- */
556
- user: {
557
- [key: string]: unknown;
558
- };
559
- /**
560
- * Org
561
- *
562
- * Organization information (personal org created automatically on registration)
563
- */
564
- org?: {
565
- [key: string]: unknown;
566
- } | null;
567
- /**
568
- * Message
569
- *
570
- * Success message
571
- */
572
- message: string;
573
- /**
574
- * Token
575
- *
576
- * JWT authentication token (optional for cookie-based auth)
577
- */
578
- token?: string | null;
579
- /**
580
- * Expires In
581
- *
582
- * Token expiry time in seconds from now
583
- */
584
- expires_in?: number | null;
585
- /**
586
- * Refresh Threshold
587
- *
588
- * Recommended refresh threshold in seconds before expiry
589
- */
590
- refresh_threshold?: number | null;
591
- };
592
- /**
593
- * AutoMapElementsOperation
594
- *
595
- * Run the MappingAgent over a mapping structure (async).
596
- *
597
- * The MappingAgent walks every unmapped CoA element and proposes
598
- * associations to reporting concepts. Confidence thresholds: ≥0.90
599
- * auto-approved (association created), 0.70-0.89 flagged for review
600
- * (created with `confidence` set; surface it in your UI), <0.70 skipped.
601
- * Returns a `pending` envelope immediately; subscribe to the SSE stream
602
- * for progress.
603
- */
604
- export type AutoMapElementsOperation = {
605
- /**
606
- * Mapping Id
607
- *
608
- * The mapping structure to populate.
609
- */
610
- mapping_id: string;
611
- };
612
- /**
613
- * AvailableExtension
614
- */
615
- export type AvailableExtension = {
616
- /**
617
- * Name
618
- */
619
- name: string;
620
- /**
621
- * Description
622
- */
623
- description: string;
624
- /**
625
- * Enabled
626
- */
627
- enabled?: boolean;
628
- };
629
- /**
630
- * AvailableExtensionsResponse
631
- */
632
- export type AvailableExtensionsResponse = {
633
- /**
634
- * Extensions
635
- */
636
- extensions: Array<AvailableExtension>;
637
- };
638
- /**
639
- * AvailableGraphTiersResponse
640
- *
641
- * Response containing available graph tiers.
642
- */
643
- export type AvailableGraphTiersResponse = {
644
- /**
645
- * Tiers
646
- *
647
- * List of available tiers
648
- */
649
- tiers: Array<GraphTierInfo>;
650
- };
651
- /**
652
- * BackupCreateRequest
653
- *
654
- * Request model for creating a backup.
655
- */
656
- export type BackupCreateRequest = {
657
- /**
658
- * Backup Format
659
- *
660
- * Backup format - only 'full_dump' is supported (complete .lbug database file)
661
- */
662
- backup_format?: string;
663
- /**
664
- * Backup Type
665
- *
666
- * Backup type - only 'full' is supported
667
- */
668
- backup_type?: string;
346
+ backup_type?: string;
669
347
  /**
670
348
  * Retention Days
671
349
  *
@@ -911,17 +589,17 @@ export type BackupStatsResponse = {
911
589
  };
912
590
  };
913
591
  /**
914
- * BatchAgentRequest
592
+ * BatchOperatorRequest
915
593
  *
916
594
  * Request for batch processing multiple queries.
917
595
  */
918
- export type BatchAgentRequest = {
596
+ export type BatchOperatorRequest = {
919
597
  /**
920
598
  * Queries
921
599
  *
922
600
  * List of queries to process (max 10)
923
601
  */
924
- queries: Array<AgentRequest>;
602
+ queries: Array<OperatorRequest>;
925
603
  /**
926
604
  * Parallel
927
605
  *
@@ -930,17 +608,17 @@ export type BatchAgentRequest = {
930
608
  parallel?: boolean;
931
609
  };
932
610
  /**
933
- * BatchAgentResponse
611
+ * BatchOperatorResponse
934
612
  *
935
613
  * Response for batch processing.
936
614
  */
937
- export type BatchAgentResponse = {
615
+ export type BatchOperatorResponse = {
938
616
  /**
939
617
  * Results
940
618
  *
941
- * List of agent responses (includes successes and failures)
619
+ * List of operator responses (includes successes and failures)
942
620
  */
943
- results: Array<AgentResponse>;
621
+ results: Array<OperatorResponse>;
944
622
  /**
945
623
  * Total Execution Time
946
624
  *
@@ -1993,7 +1671,7 @@ export type CreateInformationBlockRequest = ({
1993
1671
  *
1994
1672
  * This is the iterative, AI-assisted craft path. Each call adds a single
1995
1673
  * association to the target mapping structure. Use `auto-map-elements`
1996
- * to create many at once via the MappingAgent. Reject duplicates: if
1674
+ * to create many at once via the MappingOperator. Reject duplicates: if
1997
1675
  * the (from, to, type) tuple already exists, the call returns 409.
1998
1676
  */
1999
1677
  export type CreateMappingAssociationOperation = {
@@ -2115,7 +1793,7 @@ export type CreateReportRequest = {
2115
1793
  /**
2116
1794
  * Taxonomy Id
2117
1795
  *
2118
- * Taxonomy that defines the structures (BS / IS / CF / Equity / Schedules) this report can render. Defaults to the platform US GAAP reporting taxonomy.
1796
+ * 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.
2119
1797
  */
2120
1798
  taxonomy_id?: string;
2121
1799
  /**
@@ -6636,294 +6314,521 @@ export type MaterializeOp = {
6636
6314
  /**
6637
6315
  * Ignore Errors
6638
6316
  *
6639
- * Continue past non-fatal row errors
6317
+ * Continue past non-fatal row errors
6318
+ */
6319
+ ignore_errors?: boolean;
6320
+ /**
6321
+ * Dry Run
6322
+ *
6323
+ * Validate tables without writing to the graph
6324
+ */
6325
+ dry_run?: boolean;
6326
+ /**
6327
+ * Source
6328
+ *
6329
+ * Materialization source: 'extensions' for OLTP, omit for DuckDB staging tables
6330
+ */
6331
+ source?: string | null;
6332
+ /**
6333
+ * Materialize Embeddings
6334
+ *
6335
+ * Generate vector embeddings during materialization
6336
+ */
6337
+ materialize_embeddings?: boolean;
6338
+ };
6339
+ /**
6340
+ * MetricMechanics
6341
+ *
6342
+ * Derivative mechanics for ``block_type='metric'``.
6343
+ *
6344
+ * A metric block composes its facts from one or more source blocks at
6345
+ * read time — covenant tests, ratios, KPI trend computations. The typed
6346
+ * arm ships today so the discriminated union covers all three
6347
+ * construction modes (declarative / compositional / derivative); the
6348
+ * derivation evaluator that actually computes facts from source-block
6349
+ * FactSets is not yet implemented.
6350
+ *
6351
+ * ``source_block_ids`` is the ordered list of Structure ids this metric
6352
+ * derives from; ``derivation_type`` names the kind of computation
6353
+ * (``ratio``, ``trailing_twelve_month``, ``covenant_test``, …), and
6354
+ * ``expression`` carries the agent-authored derivation string that the
6355
+ * evaluator will consume at envelope build time.
6356
+ */
6357
+ export type MetricMechanics = {
6358
+ /**
6359
+ * Kind
6360
+ */
6361
+ kind?: 'metric';
6362
+ /**
6363
+ * Source Block Ids
6364
+ *
6365
+ * 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.
6366
+ */
6367
+ source_block_ids?: Array<string>;
6368
+ /**
6369
+ * Derivation Type
6370
+ *
6371
+ * 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.
6372
+ */
6373
+ derivation_type?: string | null;
6374
+ /**
6375
+ * Expression
6376
+ *
6377
+ * 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.
6378
+ */
6379
+ expression?: string | null;
6380
+ /**
6381
+ * Unit
6382
+ *
6383
+ * Output unit of the derived value — 'ratio', 'percent', 'USD', 'count', etc. Used by the renderer to format the metric badge.
6384
+ */
6385
+ unit?: string;
6386
+ };
6387
+ /**
6388
+ * OAuthCallbackRequest
6389
+ *
6390
+ * OAuth callback parameters.
6391
+ */
6392
+ export type OAuthCallbackRequest = {
6393
+ /**
6394
+ * Code
6395
+ *
6396
+ * Authorization code from OAuth provider
6397
+ */
6398
+ code: string;
6399
+ /**
6400
+ * State
6401
+ *
6402
+ * OAuth state for verification
6403
+ */
6404
+ state: string;
6405
+ /**
6406
+ * Realm Id
6407
+ *
6408
+ * QuickBooks-specific realm ID
6409
+ */
6410
+ realm_id?: string | null;
6411
+ /**
6412
+ * Error
6413
+ *
6414
+ * OAuth error if authorization failed
6415
+ */
6416
+ error?: string | null;
6417
+ /**
6418
+ * Error Description
6419
+ *
6420
+ * OAuth error details
6421
+ */
6422
+ error_description?: string | null;
6423
+ };
6424
+ /**
6425
+ * OAuthInitRequest
6426
+ *
6427
+ * Request to initiate OAuth flow.
6428
+ */
6429
+ export type OAuthInitRequest = {
6430
+ /**
6431
+ * Connection Id
6432
+ *
6433
+ * Connection ID to link OAuth to
6434
+ */
6435
+ connection_id: string;
6436
+ /**
6437
+ * Redirect Uri
6438
+ *
6439
+ * Override default redirect URI
6440
+ */
6441
+ redirect_uri?: string | null;
6442
+ /**
6443
+ * Additional Params
6444
+ *
6445
+ * Provider-specific parameters
6446
+ */
6447
+ additional_params?: {
6448
+ [key: string]: string;
6449
+ } | null;
6450
+ };
6451
+ /**
6452
+ * OAuthInitResponse
6453
+ *
6454
+ * Response with OAuth authorization URL.
6455
+ */
6456
+ export type OAuthInitResponse = {
6457
+ /**
6458
+ * Auth Url
6459
+ *
6460
+ * URL to redirect user for authorization
6461
+ */
6462
+ auth_url: string;
6463
+ /**
6464
+ * State
6465
+ *
6466
+ * OAuth state for security
6467
+ */
6468
+ state: string;
6469
+ /**
6470
+ * Expires At
6471
+ *
6472
+ * When this OAuth request expires
6473
+ */
6474
+ expires_at: string;
6475
+ };
6476
+ /**
6477
+ * OfferingRepositoryPlan
6478
+ *
6479
+ * Information about a repository plan.
6480
+ */
6481
+ export type OfferingRepositoryPlan = {
6482
+ /**
6483
+ * Plan
6484
+ *
6485
+ * Plan identifier
6486
+ */
6487
+ plan: string;
6488
+ /**
6489
+ * Name
6490
+ *
6491
+ * Plan name
6492
+ */
6493
+ name: string;
6494
+ /**
6495
+ * Monthly Price
6496
+ *
6497
+ * Monthly price in USD
6498
+ */
6499
+ monthly_price: number;
6500
+ /**
6501
+ * Monthly Credits
6502
+ *
6503
+ * Monthly credit allocation
6504
+ */
6505
+ monthly_credits: number;
6506
+ /**
6507
+ * Access Level
6508
+ *
6509
+ * Access level
6510
+ */
6511
+ access_level: string;
6512
+ /**
6513
+ * Features
6514
+ *
6515
+ * List of features
6516
+ */
6517
+ features: Array<string>;
6518
+ /**
6519
+ * Rate Limits
6520
+ *
6521
+ * Rate limits for this plan
6522
+ */
6523
+ rate_limits?: {
6524
+ [key: string]: number | null;
6525
+ } | null;
6526
+ };
6527
+ /**
6528
+ * OperationCosts
6529
+ *
6530
+ * Operation cost information.
6531
+ */
6532
+ export type OperationCosts = {
6533
+ /**
6534
+ * Description
6535
+ *
6536
+ * Description of operation costs
6537
+ */
6538
+ description: string;
6539
+ /**
6540
+ * Ai Operations
6541
+ *
6542
+ * Base costs for AI operations
6640
6543
  */
6641
- ignore_errors?: boolean;
6544
+ ai_operations: {
6545
+ [key: string]: number;
6546
+ };
6642
6547
  /**
6643
- * Dry Run
6548
+ * Token Pricing
6644
6549
  *
6645
- * Validate tables without writing to the graph
6550
+ * Token pricing by model
6646
6551
  */
6647
- dry_run?: boolean;
6552
+ token_pricing: {
6553
+ [key: string]: TokenPricing;
6554
+ };
6648
6555
  /**
6649
- * Source
6556
+ * Included Operations
6650
6557
  *
6651
- * Materialization source: 'extensions' for OLTP, omit for DuckDB staging tables
6558
+ * Operations that don't consume credits
6652
6559
  */
6653
- source?: string | null;
6560
+ included_operations: Array<string>;
6654
6561
  /**
6655
- * Materialize Embeddings
6562
+ * Notes
6656
6563
  *
6657
- * Generate vector embeddings during materialization
6564
+ * Important notes about costs
6658
6565
  */
6659
- materialize_embeddings?: boolean;
6566
+ notes: Array<string>;
6660
6567
  };
6661
6568
  /**
6662
- * MetricMechanics
6569
+ * OperationEnvelope
6663
6570
  *
6664
- * Derivative mechanics for ``block_type='metric'``.
6571
+ * Uniform response shape for every operation endpoint.
6665
6572
  *
6666
- * A metric block composes its facts from one or more source blocks at
6667
- * read time covenant tests, ratios, KPI trend computations. The typed
6668
- * arm ships today so the discriminated union covers all three
6669
- * construction modes (declarative / compositional / derivative); the
6670
- * derivation evaluator that actually computes facts from source-block
6671
- * FactSets is not yet implemented.
6573
+ * Every dispatch through an operation surface returns an envelope carrying
6574
+ * an ``op_<ULID>`` operation_id. That id is the bridge to the platform's
6575
+ * monitoring surface: pass it to
6576
+ * ``GET /v1/operations/{operation_id}/stream`` (see ``routers/operations.py``)
6577
+ * to subscribe to SSE progress events. Sync commands complete in the
6578
+ * envelope itself; async commands (``status: "pending"``, HTTP 202) hand
6579
+ * off to a background worker and stream their tail through the same SSE
6580
+ * endpoint until completion. Failed dispatches still mint an
6581
+ * ``operation_id`` so the audit log and any partial SSE events stay
6582
+ * correlatable.
6672
6583
  *
6673
- * ``source_block_ids`` is the ordered list of Structure ids this metric
6674
- * derives from; ``derivation_type`` names the kind of computation
6675
- * (``ratio``, ``trailing_twelve_month``, ``covenant_test``, …), and
6676
- * ``expression`` carries the agent-authored derivation string that the
6677
- * evaluator will consume at envelope build time.
6584
+ * ``TResult`` parameterizes the ``result`` field so per-op response shapes
6585
+ * surface in OpenAPI. Operations that pin ``OperationSpec.result_type`` get
6586
+ * ``OperationEnvelope[YourEnvelope]`` as their response model; ops that
6587
+ * don't keep the default ``Any`` shape (`result: any | null` on the wire).
6588
+ *
6589
+ * Fields:
6590
+ * - ``operation``: kebab-case command name (e.g. ``close-period``)
6591
+ * - ``operation_id``: ``op_``-prefixed ULID; always present, usable for
6592
+ * audit correlation and — for async commands — SSE subscription via
6593
+ * ``/v1/operations/{operation_id}/stream``
6594
+ * - ``status``: ``"completed"`` (sync, HTTP 200), ``"pending"``
6595
+ * (async, HTTP 202), or ``"failed"`` (error responses)
6596
+ * - ``result``: the domain-specific payload (the original Pydantic
6597
+ * response) or ``None`` for async/failed cases
6598
+ * - ``at``: ISO-8601 UTC timestamp of when the envelope was minted
6599
+ * - ``created_by``: user ID of the caller who initiated this operation
6600
+ * - ``idempotent_replay``: ``True`` when the dispatcher returned this
6601
+ * envelope from the idempotency cache (the underlying command did NOT
6602
+ * execute again)
6678
6603
  */
6679
- export type MetricMechanics = {
6604
+ export type OperationEnvelope = {
6680
6605
  /**
6681
- * Kind
6606
+ * Operation
6607
+ *
6608
+ * Kebab-case operation name
6682
6609
  */
6683
- kind?: 'metric';
6610
+ operation: string;
6684
6611
  /**
6685
- * Source Block Ids
6612
+ * Operationid
6686
6613
  *
6687
- * 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.
6614
+ * op_-prefixed ULID for audit and SSE correlation
6688
6615
  */
6689
- source_block_ids?: Array<string>;
6616
+ operationId: string;
6690
6617
  /**
6691
- * Derivation Type
6618
+ * Status
6692
6619
  *
6693
- * 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.
6620
+ * Operation lifecycle state
6694
6621
  */
6695
- derivation_type?: string | null;
6622
+ status: 'completed' | 'pending' | 'failed';
6696
6623
  /**
6697
- * Expression
6624
+ * Result
6698
6625
  *
6699
- * 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.
6626
+ * Command-specific result payload
6700
6627
  */
6701
- expression?: string | null;
6628
+ result?: unknown | null;
6702
6629
  /**
6703
- * Unit
6630
+ * At
6704
6631
  *
6705
- * Output unit of the derived value — 'ratio', 'percent', 'USD', 'count', etc. Used by the renderer to format the metric badge.
6632
+ * ISO-8601 UTC timestamp
6706
6633
  */
6707
- unit?: string;
6634
+ at: string;
6635
+ /**
6636
+ * Createdby
6637
+ *
6638
+ * User ID that initiated the operation (null for legacy callers)
6639
+ */
6640
+ createdBy?: string | null;
6641
+ /**
6642
+ * Idempotentreplay
6643
+ *
6644
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
6645
+ */
6646
+ idempotentReplay?: boolean;
6708
6647
  };
6709
6648
  /**
6710
- * OAuthCallbackRequest
6711
- *
6712
- * OAuth callback parameters.
6649
+ * OperationEnvelope[AssociationResponse]
6713
6650
  */
6714
- export type OAuthCallbackRequest = {
6651
+ export type OperationEnvelopeAssociationResponse = {
6715
6652
  /**
6716
- * Code
6653
+ * Operation
6717
6654
  *
6718
- * Authorization code from OAuth provider
6655
+ * Kebab-case operation name
6719
6656
  */
6720
- code: string;
6657
+ operation: string;
6721
6658
  /**
6722
- * State
6659
+ * Operationid
6723
6660
  *
6724
- * OAuth state for verification
6661
+ * op_-prefixed ULID for audit and SSE correlation
6725
6662
  */
6726
- state: string;
6663
+ operationId: string;
6727
6664
  /**
6728
- * Realm Id
6665
+ * Status
6729
6666
  *
6730
- * QuickBooks-specific realm ID
6667
+ * Operation lifecycle state
6731
6668
  */
6732
- realm_id?: string | null;
6669
+ status: 'completed' | 'pending' | 'failed';
6733
6670
  /**
6734
- * Error
6671
+ * Command-specific result payload
6672
+ */
6673
+ result?: AssociationResponse | null;
6674
+ /**
6675
+ * At
6735
6676
  *
6736
- * OAuth error if authorization failed
6677
+ * ISO-8601 UTC timestamp
6737
6678
  */
6738
- error?: string | null;
6679
+ at: string;
6739
6680
  /**
6740
- * Error Description
6681
+ * Createdby
6741
6682
  *
6742
- * OAuth error details
6683
+ * User ID that initiated the operation (null for legacy callers)
6743
6684
  */
6744
- error_description?: string | null;
6685
+ createdBy?: string | null;
6686
+ /**
6687
+ * Idempotentreplay
6688
+ *
6689
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
6690
+ */
6691
+ idempotentReplay?: boolean;
6745
6692
  };
6746
6693
  /**
6747
- * OAuthInitRequest
6748
- *
6749
- * Request to initiate OAuth flow.
6694
+ * OperationEnvelope[ClosePeriodResponse]
6750
6695
  */
6751
- export type OAuthInitRequest = {
6696
+ export type OperationEnvelopeClosePeriodResponse = {
6752
6697
  /**
6753
- * Connection Id
6698
+ * Operation
6754
6699
  *
6755
- * Connection ID to link OAuth to
6700
+ * Kebab-case operation name
6756
6701
  */
6757
- connection_id: string;
6702
+ operation: string;
6758
6703
  /**
6759
- * Redirect Uri
6704
+ * Operationid
6760
6705
  *
6761
- * Override default redirect URI
6706
+ * op_-prefixed ULID for audit and SSE correlation
6762
6707
  */
6763
- redirect_uri?: string | null;
6708
+ operationId: string;
6764
6709
  /**
6765
- * Additional Params
6710
+ * Status
6766
6711
  *
6767
- * Provider-specific parameters
6712
+ * Operation lifecycle state
6768
6713
  */
6769
- additional_params?: {
6770
- [key: string]: string;
6771
- } | null;
6772
- };
6773
- /**
6774
- * OAuthInitResponse
6775
- *
6776
- * Response with OAuth authorization URL.
6777
- */
6778
- export type OAuthInitResponse = {
6714
+ status: 'completed' | 'pending' | 'failed';
6779
6715
  /**
6780
- * Auth Url
6716
+ * Command-specific result payload
6717
+ */
6718
+ result?: ClosePeriodResponse | null;
6719
+ /**
6720
+ * At
6781
6721
  *
6782
- * URL to redirect user for authorization
6722
+ * ISO-8601 UTC timestamp
6783
6723
  */
6784
- auth_url: string;
6724
+ at: string;
6785
6725
  /**
6786
- * State
6726
+ * Createdby
6787
6727
  *
6788
- * OAuth state for security
6728
+ * User ID that initiated the operation (null for legacy callers)
6789
6729
  */
6790
- state: string;
6730
+ createdBy?: string | null;
6791
6731
  /**
6792
- * Expires At
6732
+ * Idempotentreplay
6793
6733
  *
6794
- * When this OAuth request expires
6734
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
6795
6735
  */
6796
- expires_at: string;
6736
+ idempotentReplay?: boolean;
6797
6737
  };
6798
6738
  /**
6799
- * OfferingRepositoryPlan
6800
- *
6801
- * Information about a repository plan.
6739
+ * OperationEnvelope[DeleteInformationBlockResponse]
6802
6740
  */
6803
- export type OfferingRepositoryPlan = {
6741
+ export type OperationEnvelopeDeleteInformationBlockResponse = {
6804
6742
  /**
6805
- * Plan
6743
+ * Operation
6806
6744
  *
6807
- * Plan identifier
6745
+ * Kebab-case operation name
6808
6746
  */
6809
- plan: string;
6747
+ operation: string;
6810
6748
  /**
6811
- * Name
6749
+ * Operationid
6812
6750
  *
6813
- * Plan name
6751
+ * op_-prefixed ULID for audit and SSE correlation
6814
6752
  */
6815
- name: string;
6753
+ operationId: string;
6816
6754
  /**
6817
- * Monthly Price
6755
+ * Status
6818
6756
  *
6819
- * Monthly price in USD
6757
+ * Operation lifecycle state
6820
6758
  */
6821
- monthly_price: number;
6759
+ status: 'completed' | 'pending' | 'failed';
6822
6760
  /**
6823
- * Monthly Credits
6824
- *
6825
- * Monthly credit allocation
6761
+ * Command-specific result payload
6826
6762
  */
6827
- monthly_credits: number;
6763
+ result?: DeleteInformationBlockResponse | null;
6828
6764
  /**
6829
- * Access Level
6765
+ * At
6830
6766
  *
6831
- * Access level
6767
+ * ISO-8601 UTC timestamp
6832
6768
  */
6833
- access_level: string;
6769
+ at: string;
6834
6770
  /**
6835
- * Features
6771
+ * Createdby
6836
6772
  *
6837
- * List of features
6773
+ * User ID that initiated the operation (null for legacy callers)
6838
6774
  */
6839
- features: Array<string>;
6775
+ createdBy?: string | null;
6840
6776
  /**
6841
- * Rate Limits
6777
+ * Idempotentreplay
6842
6778
  *
6843
- * Rate limits for this plan
6779
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
6844
6780
  */
6845
- rate_limits?: {
6846
- [key: string]: number | null;
6847
- } | null;
6781
+ idempotentReplay?: boolean;
6848
6782
  };
6849
6783
  /**
6850
- * OperationCosts
6851
- *
6852
- * Operation cost information.
6784
+ * OperationEnvelope[DeletePortfolioBlockResponse]
6853
6785
  */
6854
- export type OperationCosts = {
6786
+ export type OperationEnvelopeDeletePortfolioBlockResponse = {
6855
6787
  /**
6856
- * Description
6788
+ * Operation
6857
6789
  *
6858
- * Description of operation costs
6790
+ * Kebab-case operation name
6859
6791
  */
6860
- description: string;
6792
+ operation: string;
6861
6793
  /**
6862
- * Ai Operations
6794
+ * Operationid
6863
6795
  *
6864
- * Base costs for AI operations
6796
+ * op_-prefixed ULID for audit and SSE correlation
6865
6797
  */
6866
- ai_operations: {
6867
- [key: string]: number;
6868
- };
6798
+ operationId: string;
6869
6799
  /**
6870
- * Token Pricing
6800
+ * Status
6871
6801
  *
6872
- * Token pricing by model
6802
+ * Operation lifecycle state
6873
6803
  */
6874
- token_pricing: {
6875
- [key: string]: TokenPricing;
6876
- };
6804
+ status: 'completed' | 'pending' | 'failed';
6877
6805
  /**
6878
- * Included Operations
6806
+ * Command-specific result payload
6807
+ */
6808
+ result?: DeletePortfolioBlockResponse | null;
6809
+ /**
6810
+ * At
6879
6811
  *
6880
- * Operations that don't consume credits
6812
+ * ISO-8601 UTC timestamp
6881
6813
  */
6882
- included_operations: Array<string>;
6814
+ at: string;
6883
6815
  /**
6884
- * Notes
6816
+ * Createdby
6885
6817
  *
6886
- * Important notes about costs
6818
+ * User ID that initiated the operation (null for legacy callers)
6887
6819
  */
6888
- notes: Array<string>;
6820
+ createdBy?: string | null;
6821
+ /**
6822
+ * Idempotentreplay
6823
+ *
6824
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
6825
+ */
6826
+ idempotentReplay?: boolean;
6889
6827
  };
6890
6828
  /**
6891
- * OperationEnvelope
6892
- *
6893
- * Uniform response shape for every operation endpoint.
6894
- *
6895
- * Every dispatch through an operation surface returns an envelope carrying
6896
- * an ``op_<ULID>`` operation_id. That id is the bridge to the platform's
6897
- * monitoring surface: pass it to
6898
- * ``GET /v1/operations/{operation_id}/stream`` (see ``routers/operations.py``)
6899
- * to subscribe to SSE progress events. Sync commands complete in the
6900
- * envelope itself; async commands (``status: "pending"``, HTTP 202) hand
6901
- * off to a background worker and stream their tail through the same SSE
6902
- * endpoint until completion. Failed dispatches still mint an
6903
- * ``operation_id`` so the audit log and any partial SSE events stay
6904
- * correlatable.
6905
- *
6906
- * ``TResult`` parameterizes the ``result`` field so per-op response shapes
6907
- * surface in OpenAPI. Operations that pin ``OperationSpec.result_type`` get
6908
- * ``OperationEnvelope[YourEnvelope]`` as their response model; ops that
6909
- * don't keep the default ``Any`` shape (`result: any | null` on the wire).
6910
- *
6911
- * Fields:
6912
- * - ``operation``: kebab-case command name (e.g. ``close-period``)
6913
- * - ``operation_id``: ``op_``-prefixed ULID; always present, usable for
6914
- * audit correlation and — for async commands — SSE subscription via
6915
- * ``/v1/operations/{operation_id}/stream``
6916
- * - ``status``: ``"completed"`` (sync, HTTP 200), ``"pending"``
6917
- * (async, HTTP 202), or ``"failed"`` (error responses)
6918
- * - ``result``: the domain-specific payload (the original Pydantic
6919
- * response) or ``None`` for async/failed cases
6920
- * - ``at``: ISO-8601 UTC timestamp of when the envelope was minted
6921
- * - ``created_by``: user ID of the caller who initiated this operation
6922
- * - ``idempotent_replay``: ``True`` when the dispatcher returned this
6923
- * envelope from the idempotency cache (the underlying command did NOT
6924
- * execute again)
6829
+ * OperationEnvelope[DeleteResult]
6925
6830
  */
6926
- export type OperationEnvelope = {
6831
+ export type OperationEnvelopeDeleteResult = {
6927
6832
  /**
6928
6833
  * Operation
6929
6834
  *
@@ -6943,11 +6848,9 @@ export type OperationEnvelope = {
6943
6848
  */
6944
6849
  status: 'completed' | 'pending' | 'failed';
6945
6850
  /**
6946
- * Result
6947
- *
6948
6851
  * Command-specific result payload
6949
6852
  */
6950
- result?: unknown | null;
6853
+ result?: DeleteResult | null;
6951
6854
  /**
6952
6855
  * At
6953
6856
  *
@@ -6968,9 +6871,9 @@ export type OperationEnvelope = {
6968
6871
  idempotentReplay?: boolean;
6969
6872
  };
6970
6873
  /**
6971
- * OperationEnvelope[AssociationResponse]
6874
+ * OperationEnvelope[DeleteTaxonomyBlockResponse]
6972
6875
  */
6973
- export type OperationEnvelopeAssociationResponse = {
6876
+ export type OperationEnvelopeDeleteTaxonomyBlockResponse = {
6974
6877
  /**
6975
6878
  * Operation
6976
6879
  *
@@ -6992,7 +6895,7 @@ export type OperationEnvelopeAssociationResponse = {
6992
6895
  /**
6993
6896
  * Command-specific result payload
6994
6897
  */
6995
- result?: AssociationResponse | null;
6898
+ result?: DeleteTaxonomyBlockResponse | null;
6996
6899
  /**
6997
6900
  * At
6998
6901
  *
@@ -7013,9 +6916,9 @@ export type OperationEnvelopeAssociationResponse = {
7013
6916
  idempotentReplay?: boolean;
7014
6917
  };
7015
6918
  /**
7016
- * OperationEnvelope[ClosePeriodResponse]
6919
+ * OperationEnvelope[EntityTaxonomyResponse]
7017
6920
  */
7018
- export type OperationEnvelopeClosePeriodResponse = {
6921
+ export type OperationEnvelopeEntityTaxonomyResponse = {
7019
6922
  /**
7020
6923
  * Operation
7021
6924
  *
@@ -7037,7 +6940,7 @@ export type OperationEnvelopeClosePeriodResponse = {
7037
6940
  /**
7038
6941
  * Command-specific result payload
7039
6942
  */
7040
- result?: ClosePeriodResponse | null;
6943
+ result?: EntityTaxonomyResponse | null;
7041
6944
  /**
7042
6945
  * At
7043
6946
  *
@@ -7058,9 +6961,9 @@ export type OperationEnvelopeClosePeriodResponse = {
7058
6961
  idempotentReplay?: boolean;
7059
6962
  };
7060
6963
  /**
7061
- * OperationEnvelope[DeleteInformationBlockResponse]
6964
+ * OperationEnvelope[EvaluateRulesResponse]
7062
6965
  */
7063
- export type OperationEnvelopeDeleteInformationBlockResponse = {
6966
+ export type OperationEnvelopeEvaluateRulesResponse = {
7064
6967
  /**
7065
6968
  * Operation
7066
6969
  *
@@ -7082,7 +6985,7 @@ export type OperationEnvelopeDeleteInformationBlockResponse = {
7082
6985
  /**
7083
6986
  * Command-specific result payload
7084
6987
  */
7085
- result?: DeleteInformationBlockResponse | null;
6988
+ result?: EvaluateRulesResponse | null;
7086
6989
  /**
7087
6990
  * At
7088
6991
  *
@@ -7103,9 +7006,9 @@ export type OperationEnvelopeDeleteInformationBlockResponse = {
7103
7006
  idempotentReplay?: boolean;
7104
7007
  };
7105
7008
  /**
7106
- * OperationEnvelope[DeletePortfolioBlockResponse]
7009
+ * OperationEnvelope[EventBlockEnvelope]
7107
7010
  */
7108
- export type OperationEnvelopeDeletePortfolioBlockResponse = {
7011
+ export type OperationEnvelopeEventBlockEnvelope = {
7109
7012
  /**
7110
7013
  * Operation
7111
7014
  *
@@ -7127,7 +7030,7 @@ export type OperationEnvelopeDeletePortfolioBlockResponse = {
7127
7030
  /**
7128
7031
  * Command-specific result payload
7129
7032
  */
7130
- result?: DeletePortfolioBlockResponse | null;
7033
+ result?: EventBlockEnvelope | null;
7131
7034
  /**
7132
7035
  * At
7133
7036
  *
@@ -7148,9 +7051,9 @@ export type OperationEnvelopeDeletePortfolioBlockResponse = {
7148
7051
  idempotentReplay?: boolean;
7149
7052
  };
7150
7053
  /**
7151
- * OperationEnvelope[DeleteResult]
7054
+ * OperationEnvelope[EventHandlerResponse]
7152
7055
  */
7153
- export type OperationEnvelopeDeleteResult = {
7056
+ export type OperationEnvelopeEventHandlerResponse = {
7154
7057
  /**
7155
7058
  * Operation
7156
7059
  *
@@ -7172,7 +7075,7 @@ export type OperationEnvelopeDeleteResult = {
7172
7075
  /**
7173
7076
  * Command-specific result payload
7174
7077
  */
7175
- result?: DeleteResult | null;
7078
+ result?: EventHandlerResponse | null;
7176
7079
  /**
7177
7080
  * At
7178
7081
  *
@@ -7193,9 +7096,9 @@ export type OperationEnvelopeDeleteResult = {
7193
7096
  idempotentReplay?: boolean;
7194
7097
  };
7195
7098
  /**
7196
- * OperationEnvelope[DeleteTaxonomyBlockResponse]
7099
+ * OperationEnvelope[FiscalCalendarResponse]
7197
7100
  */
7198
- export type OperationEnvelopeDeleteTaxonomyBlockResponse = {
7101
+ export type OperationEnvelopeFiscalCalendarResponse = {
7199
7102
  /**
7200
7103
  * Operation
7201
7104
  *
@@ -7217,7 +7120,7 @@ export type OperationEnvelopeDeleteTaxonomyBlockResponse = {
7217
7120
  /**
7218
7121
  * Command-specific result payload
7219
7122
  */
7220
- result?: DeleteTaxonomyBlockResponse | null;
7123
+ result?: FiscalCalendarResponse | null;
7221
7124
  /**
7222
7125
  * At
7223
7126
  *
@@ -7238,9 +7141,9 @@ export type OperationEnvelopeDeleteTaxonomyBlockResponse = {
7238
7141
  idempotentReplay?: boolean;
7239
7142
  };
7240
7143
  /**
7241
- * OperationEnvelope[EntityTaxonomyResponse]
7144
+ * OperationEnvelope[InformationBlockEnvelope]
7242
7145
  */
7243
- export type OperationEnvelopeEntityTaxonomyResponse = {
7146
+ export type OperationEnvelopeInformationBlockEnvelope = {
7244
7147
  /**
7245
7148
  * Operation
7246
7149
  *
@@ -7262,7 +7165,7 @@ export type OperationEnvelopeEntityTaxonomyResponse = {
7262
7165
  /**
7263
7166
  * Command-specific result payload
7264
7167
  */
7265
- result?: EntityTaxonomyResponse | null;
7168
+ result?: InformationBlockEnvelope | null;
7266
7169
  /**
7267
7170
  * At
7268
7171
  *
@@ -7283,9 +7186,9 @@ export type OperationEnvelopeEntityTaxonomyResponse = {
7283
7186
  idempotentReplay?: boolean;
7284
7187
  };
7285
7188
  /**
7286
- * OperationEnvelope[EvaluateRulesResponse]
7189
+ * OperationEnvelope[InitializeLedgerResponse]
7287
7190
  */
7288
- export type OperationEnvelopeEvaluateRulesResponse = {
7191
+ export type OperationEnvelopeInitializeLedgerResponse = {
7289
7192
  /**
7290
7193
  * Operation
7291
7194
  *
@@ -7307,7 +7210,7 @@ export type OperationEnvelopeEvaluateRulesResponse = {
7307
7210
  /**
7308
7211
  * Command-specific result payload
7309
7212
  */
7310
- result?: EvaluateRulesResponse | null;
7213
+ result?: InitializeLedgerResponse | null;
7311
7214
  /**
7312
7215
  * At
7313
7216
  *
@@ -7328,9 +7231,9 @@ export type OperationEnvelopeEvaluateRulesResponse = {
7328
7231
  idempotentReplay?: boolean;
7329
7232
  };
7330
7233
  /**
7331
- * OperationEnvelope[EventBlockEnvelope]
7234
+ * OperationEnvelope[JournalEntryResponse]
7332
7235
  */
7333
- export type OperationEnvelopeEventBlockEnvelope = {
7236
+ export type OperationEnvelopeJournalEntryResponse = {
7334
7237
  /**
7335
7238
  * Operation
7336
7239
  *
@@ -7352,7 +7255,7 @@ export type OperationEnvelopeEventBlockEnvelope = {
7352
7255
  /**
7353
7256
  * Command-specific result payload
7354
7257
  */
7355
- result?: EventBlockEnvelope | null;
7258
+ result?: JournalEntryResponse | null;
7356
7259
  /**
7357
7260
  * At
7358
7261
  *
@@ -7373,9 +7276,9 @@ export type OperationEnvelopeEventBlockEnvelope = {
7373
7276
  idempotentReplay?: boolean;
7374
7277
  };
7375
7278
  /**
7376
- * OperationEnvelope[EventHandlerResponse]
7279
+ * OperationEnvelope[LedgerAgentResponse]
7377
7280
  */
7378
- export type OperationEnvelopeEventHandlerResponse = {
7281
+ export type OperationEnvelopeLedgerAgentResponse = {
7379
7282
  /**
7380
7283
  * Operation
7381
7284
  *
@@ -7397,7 +7300,7 @@ export type OperationEnvelopeEventHandlerResponse = {
7397
7300
  /**
7398
7301
  * Command-specific result payload
7399
7302
  */
7400
- result?: EventHandlerResponse | null;
7303
+ result?: LedgerAgentResponse | null;
7401
7304
  /**
7402
7305
  * At
7403
7306
  *
@@ -7418,9 +7321,9 @@ export type OperationEnvelopeEventHandlerResponse = {
7418
7321
  idempotentReplay?: boolean;
7419
7322
  };
7420
7323
  /**
7421
- * OperationEnvelope[FiscalCalendarResponse]
7324
+ * OperationEnvelope[LedgerEntityResponse]
7422
7325
  */
7423
- export type OperationEnvelopeFiscalCalendarResponse = {
7326
+ export type OperationEnvelopeLedgerEntityResponse = {
7424
7327
  /**
7425
7328
  * Operation
7426
7329
  *
@@ -7442,7 +7345,7 @@ export type OperationEnvelopeFiscalCalendarResponse = {
7442
7345
  /**
7443
7346
  * Command-specific result payload
7444
7347
  */
7445
- result?: FiscalCalendarResponse | null;
7348
+ result?: LedgerEntityResponse | null;
7446
7349
  /**
7447
7350
  * At
7448
7351
  *
@@ -7463,9 +7366,9 @@ export type OperationEnvelopeFiscalCalendarResponse = {
7463
7366
  idempotentReplay?: boolean;
7464
7367
  };
7465
7368
  /**
7466
- * OperationEnvelope[InformationBlockEnvelope]
7369
+ * OperationEnvelope[PortfolioBlockEnvelope]
7467
7370
  */
7468
- export type OperationEnvelopeInformationBlockEnvelope = {
7371
+ export type OperationEnvelopePortfolioBlockEnvelope = {
7469
7372
  /**
7470
7373
  * Operation
7471
7374
  *
@@ -7487,7 +7390,7 @@ export type OperationEnvelopeInformationBlockEnvelope = {
7487
7390
  /**
7488
7391
  * Command-specific result payload
7489
7392
  */
7490
- result?: InformationBlockEnvelope | null;
7393
+ result?: PortfolioBlockEnvelope | null;
7491
7394
  /**
7492
7395
  * At
7493
7396
  *
@@ -7508,9 +7411,9 @@ export type OperationEnvelopeInformationBlockEnvelope = {
7508
7411
  idempotentReplay?: boolean;
7509
7412
  };
7510
7413
  /**
7511
- * OperationEnvelope[InitializeLedgerResponse]
7414
+ * OperationEnvelope[PreviewEventBlockResponse]
7512
7415
  */
7513
- export type OperationEnvelopeInitializeLedgerResponse = {
7416
+ export type OperationEnvelopePreviewEventBlockResponse = {
7514
7417
  /**
7515
7418
  * Operation
7516
7419
  *
@@ -7532,7 +7435,7 @@ export type OperationEnvelopeInitializeLedgerResponse = {
7532
7435
  /**
7533
7436
  * Command-specific result payload
7534
7437
  */
7535
- result?: InitializeLedgerResponse | null;
7438
+ result?: PreviewEventBlockResponse | null;
7536
7439
  /**
7537
7440
  * At
7538
7441
  *
@@ -7553,9 +7456,9 @@ export type OperationEnvelopeInitializeLedgerResponse = {
7553
7456
  idempotentReplay?: boolean;
7554
7457
  };
7555
7458
  /**
7556
- * OperationEnvelope[JournalEntryResponse]
7459
+ * OperationEnvelope[PublishListResponse]
7557
7460
  */
7558
- export type OperationEnvelopeJournalEntryResponse = {
7461
+ export type OperationEnvelopePublishListResponse = {
7559
7462
  /**
7560
7463
  * Operation
7561
7464
  *
@@ -7577,7 +7480,7 @@ export type OperationEnvelopeJournalEntryResponse = {
7577
7480
  /**
7578
7481
  * Command-specific result payload
7579
7482
  */
7580
- result?: JournalEntryResponse | null;
7483
+ result?: PublishListResponse | null;
7581
7484
  /**
7582
7485
  * At
7583
7486
  *
@@ -7598,9 +7501,9 @@ export type OperationEnvelopeJournalEntryResponse = {
7598
7501
  idempotentReplay?: boolean;
7599
7502
  };
7600
7503
  /**
7601
- * OperationEnvelope[LedgerAgentResponse]
7504
+ * OperationEnvelope[ReportResponse]
7602
7505
  */
7603
- export type OperationEnvelopeLedgerAgentResponse = {
7506
+ export type OperationEnvelopeReportResponse = {
7604
7507
  /**
7605
7508
  * Operation
7606
7509
  *
@@ -7622,7 +7525,7 @@ export type OperationEnvelopeLedgerAgentResponse = {
7622
7525
  /**
7623
7526
  * Command-specific result payload
7624
7527
  */
7625
- result?: LedgerAgentResponse | null;
7528
+ result?: ReportResponse | null;
7626
7529
  /**
7627
7530
  * At
7628
7531
  *
@@ -7643,9 +7546,9 @@ export type OperationEnvelopeLedgerAgentResponse = {
7643
7546
  idempotentReplay?: boolean;
7644
7547
  };
7645
7548
  /**
7646
- * OperationEnvelope[LedgerEntityResponse]
7549
+ * OperationEnvelope[SecurityResponse]
7647
7550
  */
7648
- export type OperationEnvelopeLedgerEntityResponse = {
7551
+ export type OperationEnvelopeSecurityResponse = {
7649
7552
  /**
7650
7553
  * Operation
7651
7554
  *
@@ -7667,7 +7570,7 @@ export type OperationEnvelopeLedgerEntityResponse = {
7667
7570
  /**
7668
7571
  * Command-specific result payload
7669
7572
  */
7670
- result?: LedgerEntityResponse | null;
7573
+ result?: SecurityResponse | null;
7671
7574
  /**
7672
7575
  * At
7673
7576
  *
@@ -7688,9 +7591,9 @@ export type OperationEnvelopeLedgerEntityResponse = {
7688
7591
  idempotentReplay?: boolean;
7689
7592
  };
7690
7593
  /**
7691
- * OperationEnvelope[PortfolioBlockEnvelope]
7594
+ * OperationEnvelope[ShareReportResponse]
7692
7595
  */
7693
- export type OperationEnvelopePortfolioBlockEnvelope = {
7596
+ export type OperationEnvelopeShareReportResponse = {
7694
7597
  /**
7695
7598
  * Operation
7696
7599
  *
@@ -7712,7 +7615,7 @@ export type OperationEnvelopePortfolioBlockEnvelope = {
7712
7615
  /**
7713
7616
  * Command-specific result payload
7714
7617
  */
7715
- result?: PortfolioBlockEnvelope | null;
7618
+ result?: ShareReportResponse | null;
7716
7619
  /**
7717
7620
  * At
7718
7621
  *
@@ -7733,9 +7636,9 @@ export type OperationEnvelopePortfolioBlockEnvelope = {
7733
7636
  idempotentReplay?: boolean;
7734
7637
  };
7735
7638
  /**
7736
- * OperationEnvelope[PreviewEventBlockResponse]
7639
+ * OperationEnvelope[TaxonomyBlockEnvelope]
7737
7640
  */
7738
- export type OperationEnvelopePreviewEventBlockResponse = {
7641
+ export type OperationEnvelopeTaxonomyBlockEnvelope = {
7739
7642
  /**
7740
7643
  * Operation
7741
7644
  *
@@ -7757,7 +7660,7 @@ export type OperationEnvelopePreviewEventBlockResponse = {
7757
7660
  /**
7758
7661
  * Command-specific result payload
7759
7662
  */
7760
- result?: PreviewEventBlockResponse | null;
7663
+ result?: TaxonomyBlockEnvelope | null;
7761
7664
  /**
7762
7665
  * At
7763
7666
  *
@@ -7778,9 +7681,9 @@ export type OperationEnvelopePreviewEventBlockResponse = {
7778
7681
  idempotentReplay?: boolean;
7779
7682
  };
7780
7683
  /**
7781
- * OperationEnvelope[PublishListResponse]
7684
+ * OperationEnvelope[list[PublishListMemberResponse]]
7782
7685
  */
7783
- export type OperationEnvelopePublishListResponse = {
7686
+ export type OperationEnvelopeListPublishListMemberResponse = {
7784
7687
  /**
7785
7688
  * Operation
7786
7689
  *
@@ -7800,9 +7703,11 @@ export type OperationEnvelopePublishListResponse = {
7800
7703
  */
7801
7704
  status: 'completed' | 'pending' | 'failed';
7802
7705
  /**
7706
+ * Result
7707
+ *
7803
7708
  * Command-specific result payload
7804
7709
  */
7805
- result?: PublishListResponse | null;
7710
+ result?: Array<PublishListMemberResponse> | null;
7806
7711
  /**
7807
7712
  * At
7808
7713
  *
@@ -7810,244 +7715,339 @@ export type OperationEnvelopePublishListResponse = {
7810
7715
  */
7811
7716
  at: string;
7812
7717
  /**
7813
- * Createdby
7718
+ * Createdby
7719
+ *
7720
+ * User ID that initiated the operation (null for legacy callers)
7721
+ */
7722
+ createdBy?: string | null;
7723
+ /**
7724
+ * Idempotentreplay
7725
+ *
7726
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
7727
+ */
7728
+ idempotentReplay?: boolean;
7729
+ };
7730
+ /**
7731
+ * OperatorListResponse
7732
+ *
7733
+ * Response for listing available operators.
7734
+ */
7735
+ export type OperatorListResponse = {
7736
+ /**
7737
+ * Operators
7738
+ *
7739
+ * Dictionary of available operators with metadata
7740
+ */
7741
+ operators: {
7742
+ [key: string]: {
7743
+ [key: string]: unknown;
7744
+ };
7745
+ };
7746
+ /**
7747
+ * Total
7748
+ *
7749
+ * Total number of operators
7750
+ */
7751
+ total: number;
7752
+ };
7753
+ /**
7754
+ * OperatorMessage
7755
+ *
7756
+ * Message in conversation history.
7757
+ */
7758
+ export type OperatorMessage = {
7759
+ /**
7760
+ * Role
7761
+ *
7762
+ * Message role (user/assistant)
7763
+ */
7764
+ role: string;
7765
+ /**
7766
+ * Content
7814
7767
  *
7815
- * User ID that initiated the operation (null for legacy callers)
7768
+ * Message content
7816
7769
  */
7817
- createdBy?: string | null;
7770
+ content: string;
7818
7771
  /**
7819
- * Idempotentreplay
7772
+ * Timestamp
7820
7773
  *
7821
- * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
7774
+ * Message timestamp
7822
7775
  */
7823
- idempotentReplay?: boolean;
7776
+ timestamp?: string | null;
7824
7777
  };
7825
7778
  /**
7826
- * OperationEnvelope[ReportResponse]
7779
+ * OperatorMetadataResponse
7780
+ *
7781
+ * Response for operator metadata.
7827
7782
  */
7828
- export type OperationEnvelopeReportResponse = {
7783
+ export type OperatorMetadataResponse = {
7829
7784
  /**
7830
- * Operation
7785
+ * Name
7831
7786
  *
7832
- * Kebab-case operation name
7787
+ * Operator name
7833
7788
  */
7834
- operation: string;
7789
+ name: string;
7835
7790
  /**
7836
- * Operationid
7791
+ * Description
7837
7792
  *
7838
- * op_-prefixed ULID for audit and SSE correlation
7793
+ * Operator description
7839
7794
  */
7840
- operationId: string;
7795
+ description: string;
7841
7796
  /**
7842
- * Status
7797
+ * Version
7843
7798
  *
7844
- * Operation lifecycle state
7799
+ * Operator version
7845
7800
  */
7846
- status: 'completed' | 'pending' | 'failed';
7801
+ version: string;
7847
7802
  /**
7848
- * Command-specific result payload
7803
+ * Capabilities
7804
+ *
7805
+ * Operator capabilities
7849
7806
  */
7850
- result?: ReportResponse | null;
7807
+ capabilities: Array<string>;
7851
7808
  /**
7852
- * At
7809
+ * Supported Modes
7853
7810
  *
7854
- * ISO-8601 UTC timestamp
7811
+ * Supported execution modes
7855
7812
  */
7856
- at: string;
7813
+ supported_modes: Array<string>;
7857
7814
  /**
7858
- * Createdby
7815
+ * Requires Credits
7859
7816
  *
7860
- * User ID that initiated the operation (null for legacy callers)
7817
+ * Whether operator requires credits
7861
7818
  */
7862
- createdBy?: string | null;
7819
+ requires_credits: boolean;
7863
7820
  /**
7864
- * Idempotentreplay
7821
+ * Author
7865
7822
  *
7866
- * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
7823
+ * Operator author
7867
7824
  */
7868
- idempotentReplay?: boolean;
7825
+ author?: string | null;
7826
+ /**
7827
+ * Tags
7828
+ *
7829
+ * Operator tags
7830
+ */
7831
+ tags?: Array<string>;
7869
7832
  };
7870
7833
  /**
7871
- * OperationEnvelope[SecurityResponse]
7834
+ * OperatorMode
7835
+ *
7836
+ * Operator execution modes.
7872
7837
  */
7873
- export type OperationEnvelopeSecurityResponse = {
7838
+ export type OperatorMode = 'quick' | 'standard' | 'extended' | 'streaming';
7839
+ /**
7840
+ * OperatorRecommendation
7841
+ *
7842
+ * Single operator recommendation.
7843
+ */
7844
+ export type OperatorRecommendation = {
7874
7845
  /**
7875
- * Operation
7846
+ * Operator Type
7876
7847
  *
7877
- * Kebab-case operation name
7848
+ * Operator type identifier
7878
7849
  */
7879
- operation: string;
7850
+ operator_type: string;
7880
7851
  /**
7881
- * Operationid
7852
+ * Operator Name
7882
7853
  *
7883
- * op_-prefixed ULID for audit and SSE correlation
7854
+ * Operator display name
7884
7855
  */
7885
- operationId: string;
7856
+ operator_name: string;
7886
7857
  /**
7887
- * Status
7858
+ * Confidence
7888
7859
  *
7889
- * Operation lifecycle state
7860
+ * Confidence score (0-1)
7890
7861
  */
7891
- status: 'completed' | 'pending' | 'failed';
7862
+ confidence: number;
7892
7863
  /**
7893
- * Command-specific result payload
7864
+ * Capabilities
7865
+ *
7866
+ * Operator capabilities
7894
7867
  */
7895
- result?: SecurityResponse | null;
7868
+ capabilities: Array<string>;
7896
7869
  /**
7897
- * At
7870
+ * Reason
7898
7871
  *
7899
- * ISO-8601 UTC timestamp
7872
+ * Reason for recommendation
7900
7873
  */
7901
- at: string;
7874
+ reason?: string | null;
7875
+ };
7876
+ /**
7877
+ * OperatorRecommendationRequest
7878
+ *
7879
+ * Request for operator recommendations.
7880
+ */
7881
+ export type OperatorRecommendationRequest = {
7902
7882
  /**
7903
- * Createdby
7883
+ * Query
7904
7884
  *
7905
- * User ID that initiated the operation (null for legacy callers)
7885
+ * Query to analyze
7906
7886
  */
7907
- createdBy?: string | null;
7887
+ query: string;
7908
7888
  /**
7909
- * Idempotentreplay
7889
+ * Context
7910
7890
  *
7911
- * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
7891
+ * Additional context
7912
7892
  */
7913
- idempotentReplay?: boolean;
7893
+ context?: {
7894
+ [key: string]: unknown;
7895
+ } | null;
7914
7896
  };
7915
7897
  /**
7916
- * OperationEnvelope[ShareReportResponse]
7898
+ * OperatorRecommendationResponse
7899
+ *
7900
+ * Response for operator recommendations.
7917
7901
  */
7918
- export type OperationEnvelopeShareReportResponse = {
7902
+ export type OperatorRecommendationResponse = {
7919
7903
  /**
7920
- * Operation
7904
+ * Recommendations
7921
7905
  *
7922
- * Kebab-case operation name
7906
+ * List of operator recommendations sorted by confidence
7923
7907
  */
7924
- operation: string;
7908
+ recommendations: Array<OperatorRecommendation>;
7925
7909
  /**
7926
- * Operationid
7910
+ * Query
7927
7911
  *
7928
- * op_-prefixed ULID for audit and SSE correlation
7912
+ * The analyzed query
7929
7913
  */
7930
- operationId: string;
7914
+ query: string;
7915
+ };
7916
+ /**
7917
+ * OperatorRequest
7918
+ *
7919
+ * Request model for operator interactions.
7920
+ */
7921
+ export type OperatorRequest = {
7931
7922
  /**
7932
- * Status
7923
+ * Message
7933
7924
  *
7934
- * Operation lifecycle state
7925
+ * The query or message to process
7935
7926
  */
7936
- status: 'completed' | 'pending' | 'failed';
7927
+ message: string;
7937
7928
  /**
7938
- * Command-specific result payload
7929
+ * History
7930
+ *
7931
+ * Conversation history
7939
7932
  */
7940
- result?: ShareReportResponse | null;
7933
+ history?: Array<OperatorMessage>;
7941
7934
  /**
7942
- * At
7935
+ * Context
7943
7936
  *
7944
- * ISO-8601 UTC timestamp
7937
+ * Additional context for analysis (e.g., enable_rag, include_schema)
7945
7938
  */
7946
- at: string;
7939
+ context?: {
7940
+ [key: string]: unknown;
7941
+ } | null;
7947
7942
  /**
7948
- * Createdby
7949
- *
7950
- * User ID that initiated the operation (null for legacy callers)
7943
+ * Execution mode
7951
7944
  */
7952
- createdBy?: string | null;
7945
+ mode?: OperatorMode | null;
7953
7946
  /**
7954
- * Idempotentreplay
7947
+ * Operator Type
7955
7948
  *
7956
- * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
7949
+ * Specific operator type to use (optional)
7957
7950
  */
7958
- idempotentReplay?: boolean;
7959
- };
7960
- /**
7961
- * OperationEnvelope[TaxonomyBlockEnvelope]
7962
- */
7963
- export type OperationEnvelopeTaxonomyBlockEnvelope = {
7951
+ operator_type?: string | null;
7964
7952
  /**
7965
- * Operation
7966
- *
7967
- * Kebab-case operation name
7953
+ * Criteria for operator selection
7968
7954
  */
7969
- operation: string;
7955
+ selection_criteria?: SelectionCriteria | null;
7970
7956
  /**
7971
- * Operationid
7957
+ * Force Extended Analysis
7972
7958
  *
7973
- * op_-prefixed ULID for audit and SSE correlation
7959
+ * Force extended analysis mode with comprehensive research
7974
7960
  */
7975
- operationId: string;
7961
+ force_extended_analysis?: boolean;
7976
7962
  /**
7977
- * Status
7963
+ * Enable Rag
7978
7964
  *
7979
- * Operation lifecycle state
7965
+ * Enable RAG context enrichment
7980
7966
  */
7981
- status: 'completed' | 'pending' | 'failed';
7967
+ enable_rag?: boolean;
7982
7968
  /**
7983
- * Command-specific result payload
7969
+ * Stream
7970
+ *
7971
+ * Enable streaming response
7984
7972
  */
7985
- result?: TaxonomyBlockEnvelope | null;
7973
+ stream?: boolean;
7974
+ };
7975
+ /**
7976
+ * OperatorResponse
7977
+ *
7978
+ * Response model for operator interactions.
7979
+ */
7980
+ export type OperatorResponse = {
7986
7981
  /**
7987
- * At
7982
+ * Content
7988
7983
  *
7989
- * ISO-8601 UTC timestamp
7984
+ * The operator's response content
7990
7985
  */
7991
- at: string;
7986
+ content: string;
7992
7987
  /**
7993
- * Createdby
7988
+ * Operator Used
7994
7989
  *
7995
- * User ID that initiated the operation (null for legacy callers)
7990
+ * The operator type that handled the request
7996
7991
  */
7997
- createdBy?: string | null;
7992
+ operator_used: string;
7998
7993
  /**
7999
- * Idempotentreplay
7994
+ * The execution mode used
7995
+ */
7996
+ mode_used: OperatorMode;
7997
+ /**
7998
+ * Metadata
8000
7999
  *
8001
- * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
8000
+ * Response metadata including routing info
8002
8001
  */
8003
- idempotentReplay?: boolean;
8004
- };
8005
- /**
8006
- * OperationEnvelope[list[PublishListMemberResponse]]
8007
- */
8008
- export type OperationEnvelopeListPublishListMemberResponse = {
8002
+ metadata?: {
8003
+ [key: string]: unknown;
8004
+ } | null;
8009
8005
  /**
8010
- * Operation
8006
+ * Tokens Used
8011
8007
  *
8012
- * Kebab-case operation name
8008
+ * Token usage statistics
8013
8009
  */
8014
- operation: string;
8010
+ tokens_used?: {
8011
+ [key: string]: number;
8012
+ } | null;
8015
8013
  /**
8016
- * Operationid
8014
+ * Confidence Score
8017
8015
  *
8018
- * op_-prefixed ULID for audit and SSE correlation
8016
+ * Confidence score of the response (0.0-1.0 scale)
8019
8017
  */
8020
- operationId: string;
8018
+ confidence_score?: number | null;
8021
8019
  /**
8022
- * Status
8020
+ * Operation Id
8023
8021
  *
8024
- * Operation lifecycle state
8022
+ * Operation ID for SSE monitoring
8025
8023
  */
8026
- status: 'completed' | 'pending' | 'failed';
8024
+ operation_id?: string | null;
8027
8025
  /**
8028
- * Result
8026
+ * Is Partial
8029
8027
  *
8030
- * Command-specific result payload
8028
+ * Whether this is a partial response
8031
8029
  */
8032
- result?: Array<PublishListMemberResponse> | null;
8030
+ is_partial?: boolean;
8033
8031
  /**
8034
- * At
8032
+ * Error Details
8035
8033
  *
8036
- * ISO-8601 UTC timestamp
8034
+ * Error details if any
8037
8035
  */
8038
- at: string;
8036
+ error_details?: {
8037
+ [key: string]: unknown;
8038
+ } | null;
8039
8039
  /**
8040
- * Createdby
8040
+ * Execution Time
8041
8041
  *
8042
- * User ID that initiated the operation (null for legacy callers)
8042
+ * Execution time in seconds
8043
8043
  */
8044
- createdBy?: string | null;
8044
+ execution_time?: number | null;
8045
8045
  /**
8046
- * Idempotentreplay
8046
+ * Timestamp
8047
8047
  *
8048
- * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
8048
+ * Response timestamp
8049
8049
  */
8050
- idempotentReplay?: boolean;
8050
+ timestamp?: string;
8051
8051
  };
8052
8052
  /**
8053
8053
  * OrgDetailResponse
@@ -10418,7 +10418,7 @@ export type SecurityResponse = {
10418
10418
  /**
10419
10419
  * SelectionCriteria
10420
10420
  *
10421
- * Criteria for agent selection.
10421
+ * Criteria for operator selection.
10422
10422
  */
10423
10423
  export type SelectionCriteria = {
10424
10424
  /**
@@ -10430,13 +10430,13 @@ export type SelectionCriteria = {
10430
10430
  /**
10431
10431
  * Required Capabilities
10432
10432
  *
10433
- * Required agent capabilities
10433
+ * Required operator capabilities
10434
10434
  */
10435
10435
  required_capabilities?: Array<string>;
10436
10436
  /**
10437
10437
  * Preferred execution mode
10438
10438
  */
10439
- preferred_mode?: AgentMode | null;
10439
+ preferred_mode?: OperatorMode | null;
10440
10440
  /**
10441
10441
  * Max Response Time
10442
10442
  *
@@ -10444,11 +10444,11 @@ export type SelectionCriteria = {
10444
10444
  */
10445
10445
  max_response_time?: number;
10446
10446
  /**
10447
- * Excluded Agents
10447
+ * Excluded Operators
10448
10448
  *
10449
- * Agents to exclude from selection
10449
+ * Operators to exclude from selection
10450
10450
  */
10451
- excluded_agents?: Array<string>;
10451
+ excluded_operators?: Array<string>;
10452
10452
  };
10453
10453
  /**
10454
10454
  * ServiceOfferingSummary
@@ -11443,6 +11443,11 @@ export type TaxonomyBlockEnvelope = {
11443
11443
  * TaxonomyBlockRule
11444
11444
  *
11445
11445
  * Rule projection for the Taxonomy Block envelope.
11446
+ *
11447
+ * Exactly one of ``rule_pattern`` (arithmetic) or ``rule_check_kind``
11448
+ * (model-structure) is non-null per row, enforced by the
11449
+ * ``check_rule_pattern_kind_xor`` DB constraint. See
11450
+ * information-block.md §5.2.2.
11446
11451
  */
11447
11452
  export type TaxonomyBlockRule = {
11448
11453
  /**
@@ -11460,7 +11465,11 @@ export type TaxonomyBlockRule = {
11460
11465
  /**
11461
11466
  * Rule Pattern
11462
11467
  */
11463
- rule_pattern: string;
11468
+ rule_pattern?: string | null;
11469
+ /**
11470
+ * Rule Check Kind
11471
+ */
11472
+ rule_check_kind?: string | null;
11464
11473
  /**
11465
11474
  * Rule Expression
11466
11475
  */
@@ -11494,6 +11503,15 @@ export type TaxonomyBlockRule = {
11494
11503
  * Exactly one of ``target_structure_ref``, ``target_element_qname``, or
11495
11504
  * ``target_taxonomy_self`` must be set (or all null for a global rule).
11496
11505
  * The ``model_validator`` enforces this contract at the Pydantic layer.
11506
+ *
11507
+ * Only **arithmetic** rule patterns are user-creatable via this API
11508
+ * (the ``rule_pattern`` Literal below). The 6 model-structure check
11509
+ * kinds (``NoCycles``, ``NoOrphanArcs``, ``ParentBeforeChild``,
11510
+ * ``LeafHasClassification``, ``LibraryOriginImmutability``,
11511
+ * ``UniqueQNameInTaxonomy``) are system-managed — they're auto-emitted
11512
+ * by :func:`emit_auto_rules` at taxonomy-block creation time and
11513
+ * populate ``rules.rule_check_kind`` instead of ``rule_pattern``. See
11514
+ * information-block.md §5.2.2 for the axis split.
11497
11515
  */
11498
11516
  export type TaxonomyBlockRuleRequest = {
11499
11517
  /**
@@ -14761,7 +14779,7 @@ export type SyncConnectionResponses = {
14761
14779
  202: OperationEnvelope;
14762
14780
  };
14763
14781
  export type SyncConnectionResponse = SyncConnectionResponses[keyof SyncConnectionResponses];
14764
- export type ListAgentsData = {
14782
+ export type ListOperatorsData = {
14765
14783
  body?: never;
14766
14784
  path: {
14767
14785
  /**
@@ -14777,9 +14795,9 @@ export type ListAgentsData = {
14777
14795
  */
14778
14796
  capability?: string | null;
14779
14797
  };
14780
- url: '/v1/graphs/{graph_id}/agent';
14798
+ url: '/v1/graphs/{graph_id}/operator';
14781
14799
  };
14782
- export type ListAgentsErrors = {
14800
+ export type ListOperatorsErrors = {
14783
14801
  /**
14784
14802
  * Invalid request
14785
14803
  */
@@ -14809,16 +14827,16 @@ export type ListAgentsErrors = {
14809
14827
  */
14810
14828
  500: ErrorResponse;
14811
14829
  };
14812
- export type ListAgentsError = ListAgentsErrors[keyof ListAgentsErrors];
14813
- export type ListAgentsResponses = {
14830
+ export type ListOperatorsError = ListOperatorsErrors[keyof ListOperatorsErrors];
14831
+ export type ListOperatorsResponses = {
14814
14832
  /**
14815
14833
  * Successful Response
14816
14834
  */
14817
- 200: AgentListResponse;
14835
+ 200: OperatorListResponse;
14818
14836
  };
14819
- export type ListAgentsResponse = ListAgentsResponses[keyof ListAgentsResponses];
14820
- export type AutoSelectAgentData = {
14821
- body: AgentRequest;
14837
+ export type ListOperatorsResponse = ListOperatorsResponses[keyof ListOperatorsResponses];
14838
+ export type AutoSelectOperatorData = {
14839
+ body: OperatorRequest;
14822
14840
  path: {
14823
14841
  /**
14824
14842
  * Graph Id
@@ -14833,9 +14851,9 @@ export type AutoSelectAgentData = {
14833
14851
  */
14834
14852
  mode?: ResponseMode | null;
14835
14853
  };
14836
- url: '/v1/graphs/{graph_id}/agent';
14854
+ url: '/v1/graphs/{graph_id}/operator';
14837
14855
  };
14838
- export type AutoSelectAgentErrors = {
14856
+ export type AutoSelectOperatorErrors = {
14839
14857
  /**
14840
14858
  * Invalid request
14841
14859
  */
@@ -14869,19 +14887,19 @@ export type AutoSelectAgentErrors = {
14869
14887
  */
14870
14888
  500: ErrorResponse;
14871
14889
  };
14872
- export type AutoSelectAgentError = AutoSelectAgentErrors[keyof AutoSelectAgentErrors];
14873
- export type AutoSelectAgentResponses = {
14890
+ export type AutoSelectOperatorError = AutoSelectOperatorErrors[keyof AutoSelectOperatorErrors];
14891
+ export type AutoSelectOperatorResponses = {
14874
14892
  /**
14875
14893
  * Successful Response
14876
14894
  */
14877
- 200: AgentResponse;
14895
+ 200: OperatorResponse;
14878
14896
  /**
14879
14897
  * Query queued for async processing
14880
14898
  */
14881
14899
  202: unknown;
14882
14900
  };
14883
- export type AutoSelectAgentResponse = AutoSelectAgentResponses[keyof AutoSelectAgentResponses];
14884
- export type GetAgentMetadataData = {
14901
+ export type AutoSelectOperatorResponse = AutoSelectOperatorResponses[keyof AutoSelectOperatorResponses];
14902
+ export type GetOperatorMetadataData = {
14885
14903
  body?: never;
14886
14904
  path: {
14887
14905
  /**
@@ -14889,16 +14907,16 @@ export type GetAgentMetadataData = {
14889
14907
  */
14890
14908
  graph_id: string;
14891
14909
  /**
14892
- * Agent Type
14910
+ * Operator Type
14893
14911
  *
14894
- * Agent type identifier (e.g., 'financial', 'research', 'rag')
14912
+ * Operator type identifier (e.g., 'financial', 'research', 'rag')
14895
14913
  */
14896
- agent_type: string;
14914
+ operator_type: string;
14897
14915
  };
14898
14916
  query?: never;
14899
- url: '/v1/graphs/{graph_id}/agent/{agent_type}';
14917
+ url: '/v1/graphs/{graph_id}/operator/{operator_type}';
14900
14918
  };
14901
- export type GetAgentMetadataErrors = {
14919
+ export type GetOperatorMetadataErrors = {
14902
14920
  /**
14903
14921
  * Invalid request
14904
14922
  */
@@ -14928,21 +14946,21 @@ export type GetAgentMetadataErrors = {
14928
14946
  */
14929
14947
  500: ErrorResponse;
14930
14948
  };
14931
- export type GetAgentMetadataError = GetAgentMetadataErrors[keyof GetAgentMetadataErrors];
14932
- export type GetAgentMetadataResponses = {
14949
+ export type GetOperatorMetadataError = GetOperatorMetadataErrors[keyof GetOperatorMetadataErrors];
14950
+ export type GetOperatorMetadataResponses = {
14933
14951
  /**
14934
14952
  * Successful Response
14935
14953
  */
14936
- 200: AgentMetadataResponse;
14954
+ 200: OperatorMetadataResponse;
14937
14955
  };
14938
- export type GetAgentMetadataResponse = GetAgentMetadataResponses[keyof GetAgentMetadataResponses];
14939
- export type ExecuteSpecificAgentData = {
14940
- body: AgentRequest;
14956
+ export type GetOperatorMetadataResponse = GetOperatorMetadataResponses[keyof GetOperatorMetadataResponses];
14957
+ export type ExecuteSpecificOperatorData = {
14958
+ body: OperatorRequest;
14941
14959
  path: {
14942
14960
  /**
14943
- * Agent Type
14961
+ * Operator Type
14944
14962
  */
14945
- agent_type: string;
14963
+ operator_type: string;
14946
14964
  /**
14947
14965
  * Graph Id
14948
14966
  */
@@ -14956,9 +14974,9 @@ export type ExecuteSpecificAgentData = {
14956
14974
  */
14957
14975
  mode?: ResponseMode | null;
14958
14976
  };
14959
- url: '/v1/graphs/{graph_id}/agent/{agent_type}';
14977
+ url: '/v1/graphs/{graph_id}/operator/{operator_type}';
14960
14978
  };
14961
- export type ExecuteSpecificAgentErrors = {
14979
+ export type ExecuteSpecificOperatorErrors = {
14962
14980
  /**
14963
14981
  * Invalid request
14964
14982
  */
@@ -14992,20 +15010,20 @@ export type ExecuteSpecificAgentErrors = {
14992
15010
  */
14993
15011
  500: ErrorResponse;
14994
15012
  };
14995
- export type ExecuteSpecificAgentError = ExecuteSpecificAgentErrors[keyof ExecuteSpecificAgentErrors];
14996
- export type ExecuteSpecificAgentResponses = {
15013
+ export type ExecuteSpecificOperatorError = ExecuteSpecificOperatorErrors[keyof ExecuteSpecificOperatorErrors];
15014
+ export type ExecuteSpecificOperatorResponses = {
14997
15015
  /**
14998
15016
  * Successful Response
14999
15017
  */
15000
- 200: AgentResponse;
15018
+ 200: OperatorResponse;
15001
15019
  /**
15002
15020
  * Query queued for async processing
15003
15021
  */
15004
15022
  202: unknown;
15005
15023
  };
15006
- export type ExecuteSpecificAgentResponse = ExecuteSpecificAgentResponses[keyof ExecuteSpecificAgentResponses];
15024
+ export type ExecuteSpecificOperatorResponse = ExecuteSpecificOperatorResponses[keyof ExecuteSpecificOperatorResponses];
15007
15025
  export type BatchProcessQueriesData = {
15008
- body: BatchAgentRequest;
15026
+ body: BatchOperatorRequest;
15009
15027
  path: {
15010
15028
  /**
15011
15029
  * Graph Id
@@ -15013,7 +15031,7 @@ export type BatchProcessQueriesData = {
15013
15031
  graph_id: string;
15014
15032
  };
15015
15033
  query?: never;
15016
- url: '/v1/graphs/{graph_id}/agent/batch';
15034
+ url: '/v1/graphs/{graph_id}/operator/batch';
15017
15035
  };
15018
15036
  export type BatchProcessQueriesErrors = {
15019
15037
  /**
@@ -15054,11 +15072,11 @@ export type BatchProcessQueriesResponses = {
15054
15072
  /**
15055
15073
  * Successful Response
15056
15074
  */
15057
- 200: BatchAgentResponse;
15075
+ 200: BatchOperatorResponse;
15058
15076
  };
15059
15077
  export type BatchProcessQueriesResponse = BatchProcessQueriesResponses[keyof BatchProcessQueriesResponses];
15060
- export type RecommendAgentData = {
15061
- body: AgentRecommendationRequest;
15078
+ export type RecommendOperatorData = {
15079
+ body: OperatorRecommendationRequest;
15062
15080
  path: {
15063
15081
  /**
15064
15082
  * Graph Id
@@ -15066,9 +15084,9 @@ export type RecommendAgentData = {
15066
15084
  graph_id: string;
15067
15085
  };
15068
15086
  query?: never;
15069
- url: '/v1/graphs/{graph_id}/agent/recommend';
15087
+ url: '/v1/graphs/{graph_id}/operator/recommend';
15070
15088
  };
15071
- export type RecommendAgentErrors = {
15089
+ export type RecommendOperatorErrors = {
15072
15090
  /**
15073
15091
  * Invalid request
15074
15092
  */
@@ -15098,14 +15116,14 @@ export type RecommendAgentErrors = {
15098
15116
  */
15099
15117
  500: ErrorResponse;
15100
15118
  };
15101
- export type RecommendAgentError = RecommendAgentErrors[keyof RecommendAgentErrors];
15102
- export type RecommendAgentResponses = {
15119
+ export type RecommendOperatorError = RecommendOperatorErrors[keyof RecommendOperatorErrors];
15120
+ export type RecommendOperatorResponses = {
15103
15121
  /**
15104
15122
  * Successful Response
15105
15123
  */
15106
- 200: AgentRecommendationResponse;
15124
+ 200: OperatorRecommendationResponse;
15107
15125
  };
15108
- export type RecommendAgentResponse = RecommendAgentResponses[keyof RecommendAgentResponses];
15126
+ export type RecommendOperatorResponse = RecommendOperatorResponses[keyof RecommendOperatorResponses];
15109
15127
  export type ListMcpToolsData = {
15110
15128
  body?: never;
15111
15129
  path: {