@robosystems/client 2.27.0 → 2.28.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/types.gen.d.ts CHANGED
@@ -487,8 +487,6 @@ export type ArtifactResponse = {
487
487
  } & StatementMechanics) | ({
488
488
  kind: 'metric';
489
489
  } & MetricMechanics) | ({
490
- kind: 'rollforward';
491
- } & RollforwardMechanics) | ({
492
490
  kind: 'forecast';
493
491
  } & ForecastMechanics) | ({
494
492
  kind: 'reconciliation';
@@ -721,40 +719,6 @@ export type AssociationResponse = {
721
719
  */
722
720
  reclassified_periods?: Array<string>;
723
721
  };
724
- /**
725
- * AttributionFilter
726
- *
727
- * One flow-concept attribution rule on a rollforward IB.
728
- *
729
- * Pairs a target concept (the flow leaf the matched amount counts
730
- * toward) with a predicate (which LineItems match). The rollforward's
731
- * `attribution_filters: list[AttributionFilter]` declares every flow
732
- * the BS source decomposes into; the renderer evaluates them all per
733
- * period.
734
- *
735
- * `target_element_id` is resolved at create time from `target_qname`
736
- * via the rs-gaap library + tenant taxonomy lookup. Authors only need
737
- * to provide the qname; the element_id is filled in by the create
738
- * handler and the resolved value is what the envelope round-trips.
739
- */
740
- export type AttributionFilter = {
741
- /**
742
- * Target Qname
743
- *
744
- * QName of the flow concept this filter produces facts for — e.g. `rs-gaap:ProceedsFromIssuanceOfCommonStock`. Resolved to `target_element_id` at create time.
745
- */
746
- target_qname: string;
747
- /**
748
- * Target Element Id
749
- *
750
- * Resolved element id for `target_qname`. Null at create time; populated by the handler before persistence. Round-tripped in the envelope.
751
- */
752
- target_element_id?: string | null;
753
- /**
754
- * Predicate that determines which LineItems match this filter.
755
- */
756
- predicate: LineItemMetadataPredicate;
757
- };
758
722
  /**
759
723
  * AuthProvidersResponse
760
724
  *
@@ -3614,8 +3578,6 @@ export type CreateGraphRequest = {
3614
3578
  export type CreateInformationBlockRequest = ({
3615
3579
  block_type: 'schedule';
3616
3580
  } & CreateScheduleArm) | ({
3617
- block_type: 'rollforward';
3618
- } & CreateRollforwardArm) | ({
3619
3581
  block_type: 'forecast';
3620
3582
  } & CreateForecastArm) | ({
3621
3583
  block_type: 'balance_sheet' | 'cash_flow_statement' | 'comprehensive_income' | 'equity_statement' | 'income_statement' | 'metric' | 'reconciliation' | 'regulatory_disclosure';
@@ -3838,55 +3800,6 @@ export type CreateRepositorySubscriptionRequest = {
3838
3800
  */
3839
3801
  user_id?: string | null;
3840
3802
  };
3841
- /**
3842
- * CreateRollforwardRequest
3843
- *
3844
- * Create a rollforward Information Block.
3845
- *
3846
- * Mirrors :class:`CreateScheduleRequest` in shape. The block decomposes
3847
- * the period change in `bs_source_qname` across the declared
3848
- * attribution filters. Residual (Δ BS - Σ filter matches) falls back to
3849
- * the default change tag — or, if no default is declared, surfaces as
3850
- * an unattributed fact tagged with a synthetic residual concept.
3851
- */
3852
- export type CreateRollforwardRequest = {
3853
- /**
3854
- * Name
3855
- *
3856
- * Human-readable block name.
3857
- */
3858
- name: string;
3859
- /**
3860
- * Bs Source Qname
3861
- *
3862
- * QName of the balance-sheet element whose period delta this block decomposes. Resolved to `bs_source_element_id` at create time.
3863
- */
3864
- bs_source_qname: string;
3865
- /**
3866
- * Default Change Tag Qname
3867
- *
3868
- * QName of the fallback flow concept (Tier 1 default change tag). Residual amount — Δ BS minus the sum of filter-matched amounts — is attributed to this concept. When omitted, residual surfaces unattributed; the validation_mode setting governs whether that's a hard error.
3869
- */
3870
- default_change_tag_qname?: string | null;
3871
- /**
3872
- * Attribution Filters
3873
- *
3874
- * Filter predicates routing LineItems to flow concepts.
3875
- */
3876
- attribution_filters?: Array<AttributionFilter>;
3877
- /**
3878
- * Validation Mode
3879
- *
3880
- * How the renderer arbitrates when Σ filter matches != Δ BS. `strict` raises; `residual_as_default` emits the residual as a default-tag fact (the common case); `warn_only` logs and lets the imbalance pass.
3881
- */
3882
- validation_mode?: 'strict' | 'residual_as_default' | 'warn_only';
3883
- /**
3884
- * Taxonomy Id
3885
- *
3886
- * Owning taxonomy id (auto-resolved from `bs_source_qname` when omitted).
3887
- */
3888
- taxonomy_id?: string | null;
3889
- };
3890
3803
  /**
3891
3804
  * CreateScheduleRequest
3892
3805
  */
@@ -4735,8 +4648,6 @@ export type DeleteGraphOp = {
4735
4648
  export type DeleteInformationBlockRequest = ({
4736
4649
  block_type: 'schedule';
4737
4650
  } & DeleteScheduleArm) | ({
4738
- block_type: 'rollforward';
4739
- } & DeleteRollforwardArm) | ({
4740
4651
  block_type: 'forecast';
4741
4652
  } & DeleteForecastArm) | ({
4742
4653
  block_type: 'balance_sheet' | 'cash_flow_statement' | 'comprehensive_income' | 'equity_statement' | 'income_statement' | 'metric' | 'reconciliation' | 'regulatory_disclosure';
@@ -4899,23 +4810,6 @@ export type DeleteResult = {
4899
4810
  */
4900
4811
  deleted: boolean;
4901
4812
  };
4902
- /**
4903
- * DeleteRollforwardRequest
4904
- *
4905
- * Delete a rollforward block.
4906
- *
4907
- * Cascades through any synthetic facts produced by this block's filter
4908
- * evaluations. The underlying ledger LineItems are not touched — only
4909
- * the rollforward IB's projection of them.
4910
- */
4911
- export type DeleteRollforwardRequest = {
4912
- /**
4913
- * Structure Id
4914
- *
4915
- * Structure ID of the rollforward block.
4916
- */
4917
- structure_id: string;
4918
- };
4919
4813
  /**
4920
4814
  * DeleteScheduleRequest
4921
4815
  *
@@ -6347,90 +6241,138 @@ export type EventBlockEnvelope = {
6347
6241
  };
6348
6242
  /**
6349
6243
  * EventHandlerResponse
6244
+ *
6245
+ * A rule that turns a matching event into GL rows.
6350
6246
  */
6351
6247
  export type EventHandlerResponse = {
6352
6248
  /**
6353
6249
  * Id
6250
+ *
6251
+ * Handler id (`hdl_`-prefixed).
6354
6252
  */
6355
6253
  id: string;
6356
6254
  /**
6357
6255
  * Name
6256
+ *
6257
+ * Human-readable handler name.
6358
6258
  */
6359
6259
  name: string;
6360
6260
  /**
6361
6261
  * Description
6262
+ *
6263
+ * What the handler is for.
6362
6264
  */
6363
6265
  description?: string | null;
6364
6266
  /**
6365
6267
  * Event Type
6268
+ *
6269
+ * The event type the handler matches.
6366
6270
  */
6367
6271
  event_type: string;
6368
6272
  /**
6369
6273
  * Event Category
6274
+ *
6275
+ * Match on the event's category; null matches any.
6370
6276
  */
6371
6277
  event_category?: string | null;
6372
6278
  /**
6373
6279
  * Match Source
6280
+ *
6281
+ * Match on the event's source system; null matches any.
6374
6282
  */
6375
6283
  match_source?: string | null;
6376
6284
  /**
6377
6285
  * Match Agent Type
6286
+ *
6287
+ * Match on the counterparty's role; null matches any.
6378
6288
  */
6379
6289
  match_agent_type?: string | null;
6380
6290
  /**
6381
6291
  * Match Resource Type
6292
+ *
6293
+ * Match on the resource type; null matches any.
6382
6294
  */
6383
6295
  match_resource_type?: string | null;
6384
6296
  /**
6385
6297
  * Match Metadata Expression
6298
+ *
6299
+ * Equality matches against the event's metadata.
6386
6300
  */
6387
6301
  match_metadata_expression?: {
6388
6302
  [key: string]: unknown;
6389
6303
  } | null;
6390
6304
  /**
6391
6305
  * Transaction Template
6306
+ *
6307
+ * The GL rows the handler books: its DSL template, as JSON.
6392
6308
  */
6393
6309
  transaction_template: {
6394
6310
  [key: string]: unknown;
6395
6311
  };
6396
6312
  /**
6397
6313
  * Priority
6314
+ *
6315
+ * Among handlers that match, the highest priority wins.
6398
6316
  */
6399
6317
  priority: number;
6400
6318
  /**
6401
6319
  * Is Active
6320
+ *
6321
+ * Whether the handler takes part in matching at all.
6402
6322
  */
6403
6323
  is_active: boolean;
6404
6324
  /**
6405
6325
  * Origin
6326
+ *
6327
+ * `hub` for a platform-shipped handler, `tenant` otherwise.
6406
6328
  */
6407
6329
  origin: string;
6408
6330
  /**
6409
6331
  * Suggested By
6332
+ *
6333
+ * `ai` when an AI client created the handler or last changed what it matches or books; null when a person did.
6410
6334
  */
6411
6335
  suggested_by?: string | null;
6412
6336
  /**
6413
6337
  * Confidence
6338
+ *
6339
+ * The suggesting AI's confidence, when it gave one.
6414
6340
  */
6415
6341
  confidence?: number | null;
6416
6342
  /**
6417
6343
  * Approved By
6344
+ *
6345
+ * The user who approved an AI-suggested handler.
6418
6346
  */
6419
6347
  approved_by?: string | null;
6420
6348
  /**
6421
6349
  * Approved At
6350
+ *
6351
+ * When it was approved.
6422
6352
  */
6423
6353
  approved_at?: string | null;
6354
+ /**
6355
+ * Awaiting Approval
6356
+ *
6357
+ * True for an AI-suggested handler no one has approved: it takes no part in matching until a person approves it.
6358
+ */
6359
+ awaiting_approval?: boolean;
6424
6360
  /**
6425
6361
  * Created At
6362
+ *
6363
+ * When it was created.
6426
6364
  */
6427
6365
  created_at?: string | null;
6428
6366
  /**
6429
6367
  * Updated At
6368
+ *
6369
+ * When it last changed.
6430
6370
  */
6431
6371
  updated_at?: string | null;
6432
6372
  /**
6433
6373
  * Created By
6374
+ *
6375
+ * The user who created it.
6434
6376
  */
6435
6377
  created_by?: string | null;
6436
6378
  };
@@ -9961,43 +9903,6 @@ export type LineGrowthRequest = {
9961
9903
  [key: string]: number;
9962
9904
  } | null;
9963
9905
  };
9964
- /**
9965
- * LineItemMetadataPredicate
9966
- *
9967
- * Filter ledger LineItems by flow concept.
9968
- *
9969
- * The single predicate kind shipped to date. `values` are flow-concept
9970
- * qnames — mini's `TransactionDescriptionCode` values, rs-gaap flow
9971
- * concepts (what the enrichment classifier emits for QuickBooks data),
9972
- * future XBRL GL `GenericFlowCategory` codes. The engine resolves them
9973
- * to element_ids and matches the first-class `LineItem.flow_element_id`
9974
- * FK; matched lines aggregate signed into the attributed fact for the
9975
- * period.
9976
- *
9977
- * `field` is accepted but ignored: the flow tag lives in the typed
9978
- * `flow_element_id` FK, not in JSONB metadata. It stays on the wire so
9979
- * existing request bodies keep validating.
9980
- */
9981
- export type LineItemMetadataPredicate = {
9982
- /**
9983
- * Kind
9984
- *
9985
- * Discriminator value selecting this predicate shape.
9986
- */
9987
- kind?: 'line_item_metadata_field';
9988
- /**
9989
- * Field
9990
- *
9991
- * Accepted but ignored. The flow tag lives in the typed `flow_element_id` FK, not JSONB metadata. Retained for wire-compatibility.
9992
- */
9993
- field?: string;
9994
- /**
9995
- * Values
9996
- *
9997
- * Flow-concept qnames that route to this filter's target concept. A LineItem matches when its `flow_element_id` is one of the elements named here AND the line falls within the rollforward's period.
9998
- */
9999
- values: Array<string>;
10000
- };
10001
9906
  /**
10002
9907
  * LinkBankAccountRequest
10003
9908
  *
@@ -17794,65 +17699,6 @@ export type RevokeReportShareResponse = {
17794
17699
  */
17795
17700
  copy_deleted: boolean;
17796
17701
  };
17797
- /**
17798
- * RollforwardMechanics
17799
- *
17800
- * Filter-based attribution mechanics for `block_type='rollforward'`.
17801
- *
17802
- * Filter-based attribution: each block decomposes one BS source
17803
- * element's period delta into a list of flow concepts via declared
17804
- * :class:`AttributionFilter` predicates. The renderer evaluates the
17805
- * filters against ledger LineItems at envelope-build time, emits one
17806
- * attributed fact per filter per period, and arbitrates any residual
17807
- * against the default change tag fallback.
17808
- *
17809
- * Reads directly from the typed `structures.artifact_mechanics` JSONB
17810
- * column. `attribution_filters` rides as nested JSON; the predicate
17811
- * union widens as new predicate shapes are added — currently only
17812
- * `line_item_metadata_field` is carried.
17813
- */
17814
- export type RollforwardMechanics = {
17815
- /**
17816
- * Kind
17817
- */
17818
- kind?: 'rollforward';
17819
- /**
17820
- * Bs Source Element Id
17821
- *
17822
- * Element id of the balance-sheet source whose period delta this block decomposes. Resolved from `bs_source_qname` at create time.
17823
- */
17824
- bs_source_element_id: string;
17825
- /**
17826
- * Bs Source Qname
17827
- *
17828
- * QName of the BS source element (e.g. `mini:CashAndCashEquivalents`). Round-tripped for caller convenience; `bs_source_element_id` is authoritative.
17829
- */
17830
- bs_source_qname: string;
17831
- /**
17832
- * Default Change Tag Element Id
17833
- *
17834
- * Element id of the default change tag — the fallback flow concept that receives any residual (Δ BS − Σ filter matches). Null when no default is declared; behavior on residual then follows `validation_mode`.
17835
- */
17836
- default_change_tag_element_id?: string | null;
17837
- /**
17838
- * Default Change Tag Qname
17839
- *
17840
- * QName of the default change tag (e.g. `rs-gaap:IncreaseDecreaseInCashAndCashEquivalents`). Round-tripped for caller convenience and operator-readable envelopes; `default_change_tag_element_id` is authoritative. Null iff `default_change_tag_element_id` is null.
17841
- */
17842
- default_change_tag_qname?: string | null;
17843
- /**
17844
- * Attribution Filters
17845
- *
17846
- * Filter predicates routing LineItems to flow concepts. The renderer evaluates each filter against the period's LineItems, aggregates signed amounts, and emits one fact per filter per period.
17847
- */
17848
- attribution_filters?: Array<AttributionFilter>;
17849
- /**
17850
- * Validation Mode
17851
- *
17852
- * Renderer arbitration policy when Σ filter matches != Δ BS. `strict` raises; `residual_as_default` emits the residual as a default-tag fact (the common case); `warn_only` logs and lets the imbalance pass.
17853
- */
17854
- validation_mode?: 'strict' | 'residual_as_default' | 'warn_only';
17855
- };
17856
17702
  /**
17857
17703
  * RuleLite
17858
17704
  *
@@ -21274,8 +21120,6 @@ export type UpdateGraphMetadataOp = {
21274
21120
  export type UpdateInformationBlockRequest = ({
21275
21121
  block_type: 'schedule';
21276
21122
  } & UpdateScheduleArm) | ({
21277
- block_type: 'rollforward';
21278
- } & UpdateRollforwardArm) | ({
21279
21123
  block_type: 'forecast';
21280
21124
  } & UpdateForecastArm) | ({
21281
21125
  block_type: 'balance_sheet' | 'cash_flow_statement' | 'comprehensive_income' | 'equity_statement' | 'income_statement' | 'metric' | 'reconciliation' | 'regulatory_disclosure';
@@ -21481,49 +21325,6 @@ export type UpdatePublishListOperation = {
21481
21325
  */
21482
21326
  list_id: string;
21483
21327
  };
21484
- /**
21485
- * UpdateRollforwardRequest
21486
- *
21487
- * Update mutable fields on a rollforward block.
21488
- *
21489
- * Editable: name, default_change_tag_qname, attribution_filters,
21490
- * validation_mode. The BS source is fixed at creation — changing it would
21491
- * invalidate every period already rendered — so switching BS source means
21492
- * delete and re-create.
21493
- *
21494
- * **Partial-update semantics**: an omitted (`None`) field means "leave
21495
- * unchanged". There is no wire-level way to *clear* the default change tag or
21496
- * empty the attribution_filters list; delete and re-create the block instead.
21497
- * The asymmetry is deliberate — a clear-sentinel costs wire-shape complexity
21498
- * for a case that rarely arises, since default tags get swapped rather than
21499
- * removed.
21500
- */
21501
- export type UpdateRollforwardRequest = {
21502
- /**
21503
- * Structure Id
21504
- *
21505
- * Structure ID of the rollforward block.
21506
- */
21507
- structure_id: string;
21508
- /**
21509
- * Name
21510
- */
21511
- name?: string | null;
21512
- /**
21513
- * Default Change Tag Qname
21514
- *
21515
- * New default change tag qname. Pass a value to *change* the default; omit (`None`) to leave unchanged. There is no wire-level way to clear the default — see the class docstring.
21516
- */
21517
- default_change_tag_qname?: string | null;
21518
- /**
21519
- * Attribution Filters
21520
- */
21521
- attribution_filters?: Array<AttributionFilter> | null;
21522
- /**
21523
- * Validation Mode
21524
- */
21525
- validation_mode?: 'strict' | 'residual_as_default' | 'warn_only' | null;
21526
- };
21527
21328
  /**
21528
21329
  * UpdateScheduleRequest
21529
21330
  *
@@ -22337,27 +22138,6 @@ export type CreateLegacyArm = {
22337
22138
  [key: string]: unknown;
22338
22139
  };
22339
22140
  };
22340
- /**
22341
- * _CreateRollforwardArm
22342
- *
22343
- * Create-information-block body for `block_type="rollforward"`.
22344
- *
22345
- * Carries a typed rollforward payload. The block decomposes the period
22346
- * change in a BS source element across the declared attribution
22347
- * filters.
22348
- */
22349
- export type CreateRollforwardArm = {
22350
- /**
22351
- * Block Type
22352
- *
22353
- * Discriminator value selecting this arm.
22354
- */
22355
- block_type: 'rollforward';
22356
- /**
22357
- * Rollforward creation payload.
22358
- */
22359
- payload: CreateRollforwardRequest;
22360
- };
22361
22141
  /**
22362
22142
  * _CreateScheduleArm
22363
22143
  *
@@ -22424,26 +22204,6 @@ export type DeleteLegacyArm = {
22424
22204
  [key: string]: unknown;
22425
22205
  };
22426
22206
  };
22427
- /**
22428
- * _DeleteRollforwardArm
22429
- *
22430
- * Delete-information-block body for `block_type="rollforward"`.
22431
- *
22432
- * Cascades through any synthetic facts produced by this block's filter
22433
- * evaluations. The underlying ledger LineItems are not touched.
22434
- */
22435
- export type DeleteRollforwardArm = {
22436
- /**
22437
- * Block Type
22438
- *
22439
- * Discriminator value selecting this arm.
22440
- */
22441
- block_type: 'rollforward';
22442
- /**
22443
- * Rollforward delete payload.
22444
- */
22445
- payload: DeleteRollforwardRequest;
22446
- };
22447
22207
  /**
22448
22208
  * _DeleteScheduleArm
22449
22209
  *
@@ -22510,26 +22270,6 @@ export type UpdateLegacyArm = {
22510
22270
  [key: string]: unknown;
22511
22271
  };
22512
22272
  };
22513
- /**
22514
- * _UpdateRollforwardArm
22515
- *
22516
- * Update-information-block body for `block_type="rollforward"`.
22517
- *
22518
- * Carries a typed rollforward update payload. Mutable fields: name,
22519
- * default_change_tag_qname, attribution_filters, validation_mode.
22520
- */
22521
- export type UpdateRollforwardArm = {
22522
- /**
22523
- * Block Type
22524
- *
22525
- * Discriminator value selecting this arm.
22526
- */
22527
- block_type: 'rollforward';
22528
- /**
22529
- * Rollforward update payload.
22530
- */
22531
- payload: UpdateRollforwardRequest;
22532
- };
22533
22273
  /**
22534
22274
  * _UpdateScheduleArm
22535
22275
  *