@robosystems/client 0.5.0 → 0.5.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
@@ -735,6 +735,120 @@ export type BillingCustomer = {
735
735
  created_at: string;
736
736
  };
737
737
 
738
+ /**
739
+ * BindTextBlockRequest
740
+ */
741
+ export type BindTextBlockRequest = {
742
+ /**
743
+ * Document Id
744
+ *
745
+ * Platform Document to bind (see list-documents).
746
+ */
747
+ document_id: string;
748
+ /**
749
+ * Section Id
750
+ *
751
+ * Slugified heading id of one section to bind (the section ids search-documents returns); omit to bind the whole document.
752
+ */
753
+ section_id?: string | null;
754
+ /**
755
+ * Structure Id
756
+ *
757
+ * Disclosure Structure the text block belongs to — must be block_type='regulatory_disclosure' with a text-block concept_arrangement (text_block / levelN_textblock).
758
+ */
759
+ structure_id: string;
760
+ /**
761
+ * Element Id
762
+ *
763
+ * Disclosure element to tag the text to (id form).
764
+ */
765
+ element_id?: string | null;
766
+ /**
767
+ * Element Qname
768
+ *
769
+ * Disclosure element qname (e.g. 'acme:SignificantAccountingPoliciesTextBlock') — exactly one of element_id / element_qname.
770
+ */
771
+ element_qname?: string | null;
772
+ /**
773
+ * Period Start
774
+ *
775
+ * Reporting period start the narrative covers (duration fact).
776
+ */
777
+ period_start: string;
778
+ /**
779
+ * Period End
780
+ *
781
+ * Reporting period end.
782
+ */
783
+ period_end: string;
784
+ /**
785
+ * Entity Id
786
+ *
787
+ * Entity the fact belongs to; defaults to the primary entity.
788
+ */
789
+ entity_id?: string | null;
790
+ };
791
+
792
+ /**
793
+ * BindTextBlockResponse
794
+ */
795
+ export type BindTextBlockResponse = {
796
+ /**
797
+ * Fact Id
798
+ *
799
+ * The Nonnumeric Fact created.
800
+ */
801
+ fact_id: string;
802
+ /**
803
+ * Fact Set Id
804
+ *
805
+ * Standing 'disclosure' FactSet holding the fact.
806
+ */
807
+ fact_set_id: string;
808
+ /**
809
+ * Structure Id
810
+ */
811
+ structure_id: string;
812
+ /**
813
+ * Element Id
814
+ */
815
+ element_id: string;
816
+ /**
817
+ * Document Id
818
+ */
819
+ document_id: string;
820
+ /**
821
+ * Section Id
822
+ */
823
+ section_id?: string | null;
824
+ /**
825
+ * Content Hash
826
+ *
827
+ * Full sha256 hex of the bound text (drift signal).
828
+ */
829
+ content_hash: string;
830
+ /**
831
+ * Characters
832
+ *
833
+ * Length of the bound text.
834
+ */
835
+ characters: number;
836
+ /**
837
+ * Period Start
838
+ */
839
+ period_start: string;
840
+ /**
841
+ * Period End
842
+ */
843
+ period_end: string;
844
+ /**
845
+ * Replaced
846
+ *
847
+ * True when a re-bind replaced this element's existing fact in the standing FactSet (content and provenance refreshed).
848
+ */
849
+ replaced: boolean;
850
+ };
851
+
738
852
  /**
739
853
  * CancelSubscriptionRequest
740
854
  *
@@ -1799,7 +1913,7 @@ export type CreateInformationBlockRequest = ({
1799
1913
  } & CreateScheduleArm) | ({
1800
1914
  block_type: 'rollforward';
1801
1915
  } & CreateRollforwardArm) | ({
1802
- block_type: 'balance_sheet' | 'cash_flow_statement' | 'comprehensive_income' | 'equity_statement' | 'income_statement' | 'metric';
1916
+ block_type: 'balance_sheet' | 'cash_flow_statement' | 'comprehensive_income' | 'equity_statement' | 'income_statement' | 'metric' | 'regulatory_disclosure';
1803
1917
  } & CreateLegacyArm);
1804
1918
 
1805
1919
  /**
@@ -2853,7 +2967,7 @@ export type DeleteInformationBlockRequest = ({
2853
2967
  } & DeleteScheduleArm) | ({
2854
2968
  block_type: 'rollforward';
2855
2969
  } & DeleteRollforwardArm) | ({
2856
- block_type: 'balance_sheet' | 'cash_flow_statement' | 'comprehensive_income' | 'equity_statement' | 'income_statement' | 'metric';
2970
+ block_type: 'balance_sheet' | 'cash_flow_statement' | 'comprehensive_income' | 'equity_statement' | 'income_statement' | 'metric' | 'regulatory_disclosure';
2857
2971
  } & DeleteLegacyArm);
2858
2972
 
2859
2973
  /**
@@ -4169,8 +4283,28 @@ export type FactLite = {
4169
4283
  element_qname?: string | null;
4170
4284
  /**
4171
4285
  * Value
4286
+ *
4287
+ * Numeric value; null for Nonnumeric (text-block) facts.
4288
+ */
4289
+ value?: number | null;
4290
+ /**
4291
+ * Text Value
4292
+ *
4293
+ * Text payload for Nonnumeric facts; null for numeric.
4172
4294
  */
4173
- value: number;
4295
+ text_value?: string | null;
4296
+ /**
4297
+ * Fact Type
4298
+ *
4299
+ * Numeric | Nonnumeric
4300
+ */
4301
+ fact_type?: string;
4302
+ /**
4303
+ * Content Type
4304
+ *
4305
+ * MIME type of text_value (e.g. 'text/markdown').
4306
+ */
4307
+ content_type?: string | null;
4174
4308
  /**
4175
4309
  * Period Start
4176
4310
  */
@@ -4229,7 +4363,7 @@ export type FactSetLite = {
4229
4363
  /**
4230
4364
  * Factset Type
4231
4365
  *
4232
- * 'report' | 'schedule' | 'custom'. Enum closure enforced by the ``public.fact_sets`` CHECK constraint.
4366
+ * 'report' | 'schedule' | 'custom' | 'disclosure'. Enum closure enforced by the ``public.fact_sets`` CHECK constraint.
4233
4367
  */
4234
4368
  factset_type: string;
4235
4369
  /**
@@ -6711,12 +6845,6 @@ export type MaterializeOp = {
6711
6845
  * Rebuild the graph from scratch, dropping existing data
6712
6846
  */
6713
6847
  rebuild?: boolean;
6714
- /**
6715
- * Ignore Errors
6716
- *
6717
- * Continue past non-fatal row errors
6718
- */
6719
- ignore_errors?: boolean;
6720
6848
  /**
6721
6849
  * Dry Run
6722
6850
  *
@@ -7201,6 +7329,52 @@ export type OperationEnvelopeAssociationResponse = {
7201
7329
  idempotentReplay?: boolean;
7202
7330
  };
7203
7331
 
7332
+ /**
7333
+ * OperationEnvelope[BindTextBlockResponse]
7334
+ */
7335
+ export type OperationEnvelopeBindTextBlockResponse = {
7336
+ /**
7337
+ * Operation
7338
+ *
7339
+ * Kebab-case operation name
7340
+ */
7341
+ operation: string;
7342
+ /**
7343
+ * Operationid
7344
+ *
7345
+ * op_-prefixed ULID for audit and SSE correlation
7346
+ */
7347
+ operationId: string;
7348
+ /**
7349
+ * Status
7350
+ *
7351
+ * Operation lifecycle state
7352
+ */
7353
+ status: 'completed' | 'pending' | 'failed';
7354
+ /**
7355
+ * Command-specific result payload
7356
+ */
7357
+ result?: BindTextBlockResponse | null;
7358
+ /**
7359
+ * At
7360
+ *
7361
+ * ISO-8601 UTC timestamp
7362
+ */
7363
+ at: string;
7364
+ /**
7365
+ * Createdby
7366
+ *
7367
+ * User ID that initiated the operation (null for legacy callers)
7368
+ */
7369
+ createdBy?: string | null;
7370
+ /**
7371
+ * Idempotentreplay
7372
+ *
7373
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
7374
+ */
7375
+ idempotentReplay?: boolean;
7376
+ };
7377
+
7204
7378
  /**
7205
7379
  * OperationEnvelope[ChangeReportingStyleResponse]
7206
7380
  */
@@ -10242,6 +10416,12 @@ export type RenderingRowLite = {
10242
10416
  * Values
10243
10417
  */
10244
10418
  values?: Array<number | null>;
10419
+ /**
10420
+ * Text Value
10421
+ *
10422
+ * Narrative payload for text-block disclosure rows (markdown); numeric rows carry values instead.
10423
+ */
10424
+ text_value?: string | null;
10245
10425
  /**
10246
10426
  * Is Subtotal
10247
10427
  */
@@ -12701,9 +12881,15 @@ export type TaxonomyBlockStructureRequest = {
12701
12881
  /**
12702
12882
  * Block Type
12703
12883
  *
12704
- * DB ``structures.block_type`` enum. CoA blocks use ``chart_of_accounts``; reporting extensions use the statement family or ``custom``; custom ontology uses ``custom``.
12884
+ * DB ``structures.block_type`` enum. CoA blocks use ``chart_of_accounts``; reporting extensions use the statement family, ``regulatory_disclosure`` (disclosure notes), or ``custom``; custom ontology uses ``custom``.
12705
12885
  */
12706
- block_type: 'chart_of_accounts' | 'custom' | 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'coa_mapping' | 'schedule' | 'rollforward' | 'reconciliation' | 'policy' | 'metric';
12886
+ block_type: 'chart_of_accounts' | 'custom' | 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'coa_mapping' | 'schedule' | 'rollforward' | 'reconciliation' | 'policy' | 'metric' | 'regulatory_disclosure';
12887
+ /**
12888
+ * Concept Arrangement
12889
+ *
12890
+ * Concept Arrangement Pattern (CAP) — how the structure's concepts relate (mirrors the ``structures.concept_arrangement`` CHECK vocabulary). A disclosure note footing members to a total is ``roll_up``. Null leaves the pattern unset.
12891
+ */
12892
+ concept_arrangement?: 'set' | 'roll_up' | 'roll_forward' | 'roll_forward_info' | 'adjustment' | 'variance' | 'arithmetic' | 'text_block' | 'level1_textblock' | 'level2_textblock' | 'level3_textblock' | 'level4_detail' | 'table_equivalent_textblock' | 'grid' | 'compound_fact' | null;
12707
12893
  /**
12708
12894
  * Description
12709
12895
  */
@@ -13327,7 +13513,7 @@ export type UpdateInformationBlockRequest = ({
13327
13513
  } & UpdateScheduleArm) | ({
13328
13514
  block_type: 'rollforward';
13329
13515
  } & UpdateRollforwardArm) | ({
13330
- block_type: 'balance_sheet' | 'cash_flow_statement' | 'comprehensive_income' | 'equity_statement' | 'income_statement' | 'metric';
13516
+ block_type: 'balance_sheet' | 'cash_flow_statement' | 'comprehensive_income' | 'equity_statement' | 'income_statement' | 'metric' | 'regulatory_disclosure';
13331
13517
  } & UpdateLegacyArm);
13332
13518
 
13333
13519
  /**
@@ -14144,10 +14330,13 @@ export type ViewProjections = {
14144
14330
  *
14145
14331
  * Statement-family blocks (balance_sheet, income_statement,
14146
14332
  * cash_flow_statement, equity_statement, comprehensive_income) are
14147
- * constructed via `create-report`, not this endpoint. Metric blocks
14148
- * are recognized but their evaluator has not shipped. Calling this
14149
- * endpoint with one of these block types returns HTTP 501 with a hint
14150
- * pointing to the correct construction path.
14333
+ * constructed via `create-report`, not this endpoint. Disclosure
14334
+ * structures (regulatory_disclosure) are vocabulary, authored via
14335
+ * `create-taxonomy-block`; their facts land when `create-report`
14336
+ * picks them. Metric blocks are recognized but their evaluator has
14337
+ * not shipped. Calling this endpoint with one of these block types
14338
+ * returns HTTP 501 with a hint pointing to the correct construction
14339
+ * path.
14151
14340
  */
14152
14341
  export type CreateLegacyArm = {
14153
14342
  /**
@@ -14155,7 +14344,7 @@ export type CreateLegacyArm = {
14155
14344
  *
14156
14345
  * Statement-family or metric block type. The endpoint returns 501 for these values — statements are constructed via `create-report`; metric construction is pending.
14157
14346
  */
14158
- block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'metric';
14347
+ block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'regulatory_disclosure' | 'metric';
14159
14348
  /**
14160
14349
  * Payload
14161
14350
  *
@@ -14225,7 +14414,7 @@ export type DeleteLegacyArm = {
14225
14414
  *
14226
14415
  * Statement-family or metric block type. Deletion returns 501 — statements are library-seeded (archive the underlying Report instead); metric deletion is pending.
14227
14416
  */
14228
- block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'metric';
14417
+ block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'regulatory_disclosure' | 'metric';
14229
14418
  /**
14230
14419
  * Payload
14231
14420
  *
@@ -14293,7 +14482,7 @@ export type UpdateLegacyArm = {
14293
14482
  *
14294
14483
  * Statement-family or metric block type. Updates return 501 — statement Structures are library-seeded; metric updates are pending.
14295
14484
  */
14296
- block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'metric';
14485
+ block_type: 'balance_sheet' | 'income_statement' | 'cash_flow_statement' | 'equity_statement' | 'comprehensive_income' | 'regulatory_disclosure' | 'metric';
14297
14486
  /**
14298
14487
  * Payload
14299
14488
  *
@@ -21833,6 +22022,70 @@ export type EvaluateRulesResponses = {
21833
22022
 
21834
22023
  export type EvaluateRulesResponse2 = EvaluateRulesResponses[keyof EvaluateRulesResponses];
21835
22024
 
22025
+ export type BindTextBlockData = {
22026
+ body: BindTextBlockRequest;
22027
+ headers?: {
22028
+ /**
22029
+ * Idempotency-Key
22030
+ */
22031
+ 'Idempotency-Key'?: string | null;
22032
+ };
22033
+ path: {
22034
+ /**
22035
+ * Graph Id
22036
+ */
22037
+ graph_id: string;
22038
+ };
22039
+ query?: never;
22040
+ url: '/extensions/roboledger/{graph_id}/operations/bind-text-block';
22041
+ };
22042
+
22043
+ export type BindTextBlockErrors = {
22044
+ /**
22045
+ * Invalid request
22046
+ */
22047
+ 400: ErrorResponse;
22048
+ /**
22049
+ * Authentication required
22050
+ */
22051
+ 401: ErrorResponse;
22052
+ /**
22053
+ * Access denied
22054
+ */
22055
+ 403: ErrorResponse;
22056
+ /**
22057
+ * Resource not found
22058
+ */
22059
+ 404: ErrorResponse;
22060
+ /**
22061
+ * Idempotency-Key conflict — key reused with different body
22062
+ */
22063
+ 409: ErrorResponse;
22064
+ /**
22065
+ * Validation error
22066
+ */
22067
+ 422: ErrorResponse;
22068
+ /**
22069
+ * Rate limit exceeded
22070
+ */
22071
+ 429: ErrorResponse;
22072
+ /**
22073
+ * Internal server error
22074
+ */
22075
+ 500: ErrorResponse;
22076
+ };
22077
+
22078
+ export type BindTextBlockError = BindTextBlockErrors[keyof BindTextBlockErrors];
22079
+
22080
+ export type BindTextBlockResponses = {
22081
+ /**
22082
+ * Successful Response
22083
+ */
22084
+ 200: OperationEnvelopeBindTextBlockResponse;
22085
+ };
22086
+
22087
+ export type BindTextBlockResponse2 = BindTextBlockResponses[keyof BindTextBlockResponses];
22088
+
21836
22089
  export type CreateAgentData = {
21837
22090
  body: CreateAgentRequest;
21838
22091
  headers?: {