@robosystems/client 1.12.0 → 1.12.2

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.ts CHANGED
@@ -4665,15 +4665,15 @@ export type ElementSummary = {
4665
4665
  /**
4666
4666
  * Total
4667
4667
  *
4668
- * Sum of values across the returned facts
4668
+ * Sum of values across the returned facts. Duration elements only — a balance summed across periods is not a balance, so instants omit it.
4669
4669
  */
4670
- total: number;
4670
+ total?: number | null;
4671
4671
  /**
4672
4672
  * Average
4673
4673
  *
4674
- * Mean value across the returned facts
4674
+ * Mean value across the returned facts. Duration elements only; omitted for instants.
4675
4675
  */
4676
- average: number;
4676
+ average?: number | null;
4677
4677
  /**
4678
4678
  * Min
4679
4679
  *
@@ -8537,7 +8537,7 @@ export type LiveFinancialStatementRequest = {
8537
8537
  /**
8538
8538
  * Statement Type
8539
8539
  *
8540
- * income_statement | balance_sheet | cash_flow_statement | equity_statement
8540
+ * income_statement | balance_sheet | cash_flow_statement | equity_statement. ``equity_statement`` is provisional — equity balances, not a rollforward — and is not offered on the MCP surface until it articulates.
8541
8541
  */
8542
8542
  statement_type: string;
8543
8543
  /**
@@ -8567,7 +8567,7 @@ export type LiveFinancialStatementRequest = {
8567
8567
  /**
8568
8568
  * Limit
8569
8569
  *
8570
- * Max fact rows returned
8570
+ * Max fact rows returned. Defaults to the ceiling so a statement is never cut mid-section — visible rows would stop footing to visible subtotals. Lower it only for a preview.
8571
8571
  */
8572
8572
  limit?: number;
8573
8573
  };
@@ -8588,6 +8588,8 @@ export type LiveFinancialStatementResponse = {
8588
8588
  statement_type: string;
8589
8589
  /**
8590
8590
  * Periods
8591
+ *
8592
+ * Rendered columns, aligned with each row's ``values``. Current and prior for income_statement and balance_sheet; current only for cash_flow_statement — the prior period is pivoted as the indirect-method delta basis and not rendered.
8591
8593
  */
8592
8594
  periods: Array<PeriodSpec>;
8593
8595
  /**
@@ -8598,6 +8600,10 @@ export type LiveFinancialStatementResponse = {
8598
8600
  * Fact Count
8599
8601
  */
8600
8602
  fact_count: number;
8603
+ /**
8604
+ * Guard-rail outcome for the rendered columns — accounting equation, net-income equation, totals footing, operating-plug size. Null only when no structure rendered.
8605
+ */
8606
+ validation?: ValidationCheckResponse | null;
8601
8607
  /**
8602
8608
  * Unmapped Count
8603
8609
  */
@@ -11302,6 +11308,22 @@ export type OperationEnvelopeListPublishListMemberResponse = {
11302
11308
  idempotentReplay?: boolean;
11303
11309
  };
11304
11310
 
11311
+ /**
11312
+ * OperationResumeRequest
11313
+ *
11314
+ * Answer for an operation paused at a checkpoint (`awaiting_input`).
11315
+ */
11316
+ export type OperationResumeRequest = {
11317
+ /**
11318
+ * Input
11319
+ *
11320
+ * The decision the paused run asked for, in whatever shape its prompt described. Delivered to the task as `params['resume']['input']`.
11321
+ */
11322
+ input?: {
11323
+ [key: string]: unknown;
11324
+ };
11325
+ };
11326
+
11305
11327
  /**
11306
11328
  * OperatorListResponse
11307
11329
  *
@@ -11473,6 +11495,12 @@ export type OperatorRequest = {
11473
11495
  * Enable streaming response
11474
11496
  */
11475
11497
  stream?: boolean;
11498
+ /**
11499
+ * Max Credits
11500
+ *
11501
+ * Per-question credit ceiling. Once the run's consumed credits reach this number, no further tool step starts and the operator answers from what it has (the wrap-up itself may carry the total slightly past the ceiling). Omit for the mode's default step-bounded behavior.
11502
+ */
11503
+ max_credits?: number | null;
11476
11504
  };
11477
11505
 
11478
11506
  /**
@@ -17628,6 +17656,48 @@ export type UserResponse = {
17628
17656
  accounts?: Array<AccountInfo>;
17629
17657
  };
17630
17658
 
17659
+ /**
17660
+ * ValidationCheckResponse
17661
+ *
17662
+ * Aggregate result of running reporting rules over a structure.
17663
+ *
17664
+ * Every rule runs once per rendered period column; on a multi-column
17665
+ * statement each failure and warning is prefixed with the column it was
17666
+ * found in (``[Prior] …``).
17667
+ */
17668
+ export type ValidationCheckResponse = {
17669
+ /**
17670
+ * Passed
17671
+ *
17672
+ * True iff at least one rule ran and every rule produced zero failures on every rendered column. False when nothing was checked (`status == 'inconclusive'`).
17673
+ */
17674
+ passed: boolean;
17675
+ /**
17676
+ * Status
17677
+ *
17678
+ * `passed` — every rule ran on every column with zero failures; `failed` — at least one rule failed; `inconclusive` — no validation rules exist for this block type, so nothing was checked.
17679
+ */
17680
+ status: string;
17681
+ /**
17682
+ * Checks
17683
+ *
17684
+ * Names of rules that were evaluated.
17685
+ */
17686
+ checks: Array<string>;
17687
+ /**
17688
+ * Failures
17689
+ *
17690
+ * Human-readable descriptions of rule failures.
17691
+ */
17692
+ failures: Array<string>;
17693
+ /**
17694
+ * Warnings
17695
+ *
17696
+ * Non-blocking advisories from rule evaluation.
17697
+ */
17698
+ warnings: Array<string>;
17699
+ };
17700
+
17631
17701
  /**
17632
17702
  * ValidationError
17633
17703
  */
@@ -17671,6 +17741,10 @@ export type ValidationLite = {
17671
17741
  * Passed
17672
17742
  */
17673
17743
  passed?: boolean;
17744
+ /**
17745
+ * Status
17746
+ */
17747
+ status?: string;
17674
17748
  /**
17675
17749
  * Checks
17676
17750
  */
@@ -17962,7 +18036,7 @@ export type ViewResponse = {
17962
18036
  /**
17963
18037
  * Summary
17964
18038
  *
17965
- * Per-element aggregates, only when include_summary=true. Note that `total` sums across every returned period, which is meaningful for duration facts and not for instants. Overlapping duration windows sharing a period_end (quarter + year-to-date) contribute only the narrowest window, so a quarter is never double-counted inside its own YTD figure.
18039
+ * Per-element aggregates, only when include_summary=true. `total` and `average` span every returned period, so they are present for duration elements only — instants omit both (a balance summed across periods is not a balance). Overlapping duration windows sharing a period_end (quarter + year-to-date) contribute only the narrowest window, so a quarter is never double-counted inside its own YTD figure.
17966
18040
  */
17967
18041
  summary?: {
17968
18042
  [key: string]: ElementSummary;
@@ -21160,7 +21234,7 @@ export type AutoSelectOperatorData = {
21160
21234
  /**
21161
21235
  * Mode
21162
21236
  *
21163
- * Override execution mode: sync, async, stream, or auto
21237
+ * `sync` waits up to 50s for the answer and returns 200 with it (202 with the operation links if the worker is still busy). Anything else — `async`, `stream`, `auto` or unset — queues the run and returns 202; follow `_links.stream` for progress and the result.
21164
21238
  */
21165
21239
  mode?: ResponseMode | null;
21166
21240
  };
@@ -21210,7 +21284,7 @@ export type AutoSelectOperatorResponses = {
21210
21284
  */
21211
21285
  200: OperatorResponse;
21212
21286
  /**
21213
- * Query queued for async processing
21287
+ * Run queued on the worker — follow `_links.stream`
21214
21288
  */
21215
21289
  202: unknown;
21216
21290
  };
@@ -21227,7 +21301,7 @@ export type GetOperatorMetadataData = {
21227
21301
  /**
21228
21302
  * Operator Type
21229
21303
  *
21230
- * Operator type identifier (e.g., 'financial', 'research', 'rag')
21304
+ * Operator type identifier (e.g., 'analyst', 'mapping')
21231
21305
  */
21232
21306
  operator_type: string;
21233
21307
  };
@@ -21293,7 +21367,7 @@ export type ExecuteSpecificOperatorData = {
21293
21367
  /**
21294
21368
  * Mode
21295
21369
  *
21296
- * Override execution mode: sync, async, stream, or auto
21370
+ * `sync` waits up to 50s for the answer and returns 200 with it (202 with the operation links if the worker is still busy). Anything else — `async`, `stream`, `auto` or unset — queues the run and returns 202; follow `_links.stream` for progress and the result.
21297
21371
  */
21298
21372
  mode?: ResponseMode | null;
21299
21373
  };
@@ -21343,7 +21417,7 @@ export type ExecuteSpecificOperatorResponses = {
21343
21417
  */
21344
21418
  200: OperatorResponse;
21345
21419
  /**
21346
- * Query queued for async processing
21420
+ * Run queued on the worker — follow `_links.stream`
21347
21421
  */
21348
21422
  202: unknown;
21349
21423
  };
@@ -24968,6 +25042,70 @@ export type CancelOperationResponses = {
24968
25042
 
24969
25043
  export type CancelOperationResponse = CancelOperationResponses[keyof CancelOperationResponses];
24970
25044
 
25045
+ export type ResumeOperationData = {
25046
+ body: OperationResumeRequest;
25047
+ path: {
25048
+ /**
25049
+ * Operation Id
25050
+ *
25051
+ * Operation identifier
25052
+ */
25053
+ operation_id: string;
25054
+ };
25055
+ query?: never;
25056
+ url: '/v1/operations/{operation_id}/resume';
25057
+ };
25058
+
25059
+ export type ResumeOperationErrors = {
25060
+ /**
25061
+ * Invalid request
25062
+ */
25063
+ 400: ErrorResponse;
25064
+ /**
25065
+ * Authentication required
25066
+ */
25067
+ 401: ErrorResponse;
25068
+ /**
25069
+ * Access denied
25070
+ */
25071
+ 403: ErrorResponse;
25072
+ /**
25073
+ * Resource not found
25074
+ */
25075
+ 404: ErrorResponse;
25076
+ /**
25077
+ * Operation is not waiting for input
25078
+ */
25079
+ 409: unknown;
25080
+ /**
25081
+ * Validation Error
25082
+ */
25083
+ 422: HttpValidationError;
25084
+ /**
25085
+ * Rate limit exceeded
25086
+ */
25087
+ 429: ErrorResponse;
25088
+ /**
25089
+ * Internal server error
25090
+ */
25091
+ 500: ErrorResponse;
25092
+ };
25093
+
25094
+ export type ResumeOperationError = ResumeOperationErrors[keyof ResumeOperationErrors];
25095
+
25096
+ export type ResumeOperationResponses = {
25097
+ /**
25098
+ * Response Resumeoperation
25099
+ *
25100
+ * Successful Response
25101
+ */
25102
+ 202: {
25103
+ [key: string]: unknown;
25104
+ };
25105
+ };
25106
+
25107
+ export type ResumeOperationResponse = ResumeOperationResponses[keyof ResumeOperationResponses];
25108
+
24971
25109
  export type GetOrgBillingCustomerData = {
24972
25110
  body?: never;
24973
25111
  path: {