@robosystems/client 2.39.0 → 2.40.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.ts CHANGED
@@ -3790,6 +3790,67 @@ export type CreateInvitationRequest = {
3790
3790
  role?: OrgRole;
3791
3791
  };
3792
3792
 
3793
+ /**
3794
+ * CreateIssuerRequest
3795
+ *
3796
+ * CQRS body for `POST /operations/create-issuer`.
3797
+ *
3798
+ * An issuer is a company the fund holds or follows that does not keep its
3799
+ * books on this platform: an entity in the fund's graph that securities and
3800
+ * received reports attach to. A company that shares a report in from its own
3801
+ * graph gets its entity from the share instead.
3802
+ */
3803
+ export type CreateIssuerRequest = {
3804
+ /**
3805
+ * Name
3806
+ *
3807
+ * The company's name.
3808
+ */
3809
+ name: string;
3810
+ /**
3811
+ * Legal Name
3812
+ *
3813
+ * Its legal name, when different.
3814
+ */
3815
+ legal_name?: string | null;
3816
+ /**
3817
+ * Lei
3818
+ *
3819
+ * Legal Entity Identifier, if it has one.
3820
+ */
3821
+ lei?: string | null;
3822
+ /**
3823
+ * Cik
3824
+ *
3825
+ * SEC Central Index Key, if it has one.
3826
+ */
3827
+ cik?: string | null;
3828
+ /**
3829
+ * Tax Id
3830
+ *
3831
+ * Tax identifier (an EIN in the United States).
3832
+ */
3833
+ tax_id?: string | null;
3834
+ /**
3835
+ * Entity Type
3836
+ *
3837
+ * Legal form, e.g. `corporation`, `llc`, `partnership`.
3838
+ */
3839
+ entity_type?: string | null;
3840
+ /**
3841
+ * Industry
3842
+ *
3843
+ * Industry, as free text.
3844
+ */
3845
+ industry?: string | null;
3846
+ /**
3847
+ * Website
3848
+ *
3849
+ * The company's website.
3850
+ */
3851
+ website?: string | null;
3852
+ };
3853
+
3793
3854
  /**
3794
3855
  * CreateMappingAssociationOperation
3795
3856
  *
@@ -8326,7 +8387,7 @@ export type GraphSubscriptionResponse = {
8326
8387
  /**
8327
8388
  * Trial Ends At
8328
8389
  *
8329
- * When the free trial ends and the first charge is made. Null for a subscription that opened without a trial; kept after the trial is over.
8390
+ * When the free trial ends: the first charge is made then to a card on file, and with none the subscription ends. Null for a subscription that opened without a trial; kept after the trial is over.
8330
8391
  */
8331
8392
  trial_ends_at?: string | null;
8332
8393
  /**
@@ -9077,6 +9138,158 @@ export type IngestFileOp = {
9077
9138
  ingest_to_graph?: boolean;
9078
9139
  };
9079
9140
 
9141
+ /**
9142
+ * IngestReportRequest
9143
+ *
9144
+ * CQRS body for `POST /operations/ingest-report`.
9145
+ *
9146
+ * Give exactly one of `holon` (a report file already in the holon format),
9147
+ * `tavi` (a Tavi compiled model) or `report` (rows read from a PDF or a
9148
+ * workbook, which the server assembles into a holon). Every route ends in a
9149
+ * holon that is checked, stored as the record of what was received, and
9150
+ * loaded onto the entity.
9151
+ */
9152
+ export type IngestReportRequest = {
9153
+ /**
9154
+ * Entity Id
9155
+ *
9156
+ * The entity the report is about (see `create-issuer`).
9157
+ */
9158
+ entity_id: string;
9159
+ /**
9160
+ * Holon
9161
+ *
9162
+ * The text of a `.holon.jsonld` report file.
9163
+ */
9164
+ holon?: string | null;
9165
+ /**
9166
+ * Tavi
9167
+ *
9168
+ * The text of a `.tavi.json` compiled model. It is converted to a holon, which is what is stored.
9169
+ */
9170
+ tavi?: string | null;
9171
+ /**
9172
+ * The report as rows.
9173
+ */
9174
+ report?: ReportRowsInput | null;
9175
+ /**
9176
+ * Name
9177
+ *
9178
+ * A display name for the report.
9179
+ */
9180
+ name?: string | null;
9181
+ /**
9182
+ * Require Source
9183
+ *
9184
+ * Refuse the report unless every value names its source.
9185
+ */
9186
+ require_source?: boolean;
9187
+ /**
9188
+ * Dry Run
9189
+ *
9190
+ * Check the report and say what would load, without writing anything.
9191
+ */
9192
+ dry_run?: boolean;
9193
+ };
9194
+
9195
+ /**
9196
+ * IngestReportResponse
9197
+ *
9198
+ * What an ingest loaded, or on a dry run what it would load.
9199
+ */
9200
+ export type IngestReportResponse = {
9201
+ /**
9202
+ * Dry Run
9203
+ *
9204
+ * True when nothing was written.
9205
+ */
9206
+ dry_run: boolean;
9207
+ /**
9208
+ * Report Id
9209
+ *
9210
+ * The report's ID in this graph; null on a dry run.
9211
+ */
9212
+ report_id?: string | null;
9213
+ /**
9214
+ * Entity Id
9215
+ *
9216
+ * The entity the report hangs on.
9217
+ */
9218
+ entity_id: string;
9219
+ /**
9220
+ * Period End
9221
+ *
9222
+ * The last day the report covers.
9223
+ */
9224
+ period_end: string;
9225
+ /**
9226
+ * Kind
9227
+ *
9228
+ * What the report is.
9229
+ */
9230
+ kind: string;
9231
+ /**
9232
+ * Fact Count
9233
+ *
9234
+ * Values loaded as facts.
9235
+ */
9236
+ fact_count: number;
9237
+ /**
9238
+ * Section Count
9239
+ *
9240
+ * Statements and tables loaded.
9241
+ */
9242
+ section_count: number;
9243
+ /**
9244
+ * Calculations Checked
9245
+ *
9246
+ * Totals that were compared with their terms; all agreed.
9247
+ */
9248
+ calculations_checked: number;
9249
+ /**
9250
+ * Balance Checked
9251
+ *
9252
+ * Whether total assets were compared with liabilities and equity.
9253
+ */
9254
+ balance_checked: boolean;
9255
+ /**
9256
+ * Concepts Added
9257
+ *
9258
+ * Concepts the graph did not have, added to its received-reports vocabulary.
9259
+ */
9260
+ concepts_added?: Array<string>;
9261
+ /**
9262
+ * Dimensional Facts Not Loaded
9263
+ *
9264
+ * Values broken out by a dimension. They stay in the stored file; the graph holds the report's totals.
9265
+ */
9266
+ dimensional_facts_not_loaded?: number;
9267
+ /**
9268
+ * Replaced Report Ids
9269
+ *
9270
+ * Earlier ingests for the same entity, period end and kind, now replaced.
9271
+ */
9272
+ replaced_report_ids?: Array<string>;
9273
+ /**
9274
+ * Unplaced Concepts
9275
+ *
9276
+ * Library concepts with a value that no section places, for a report sent as rows. Their values load, but appear on no statement or table.
9277
+ */
9278
+ unplaced_concepts?: Array<string>;
9279
+ /**
9280
+ * Conforms To Library
9281
+ *
9282
+ * For a report sent as rows: true when its balance sheet and income statement are arranged as the library arranges them, so their lines mean what the same lines mean in any other report. Null for a holon or a Tavi model, which is not compared.
9283
+ */
9284
+ conforms_to_library?: boolean | null;
9285
+ /**
9286
+ * Departures
9287
+ *
9288
+ * Each place the report departs from the library's arrangement. The report still loads; the list is kept with it.
9289
+ */
9290
+ departures?: Array<ReportDeparture>;
9291
+ };
9292
+
9080
9293
  /**
9081
9294
  * InitialEntityData
9082
9295
  *
@@ -9544,6 +9757,56 @@ export type InvoicesResponse = {
9544
9757
  has_more: boolean;
9545
9758
  };
9546
9759
 
9760
+ /**
9761
+ * IssuerResponse
9762
+ *
9763
+ * An issuer entity in the fund's graph.
9764
+ */
9765
+ export type IssuerResponse = {
9766
+ /**
9767
+ * Id
9768
+ *
9769
+ * Entity ID; pass it to `ingest-report`.
9770
+ */
9771
+ id: string;
9772
+ /**
9773
+ * Name
9774
+ *
9775
+ * The company's name.
9776
+ */
9777
+ name: string;
9778
+ /**
9779
+ * Legal Name
9780
+ *
9781
+ * Its legal name.
9782
+ */
9783
+ legal_name?: string | null;
9784
+ /**
9785
+ * Lei
9786
+ *
9787
+ * Legal Entity Identifier.
9788
+ */
9789
+ lei?: string | null;
9790
+ /**
9791
+ * Cik
9792
+ *
9793
+ * SEC Central Index Key.
9794
+ */
9795
+ cik?: string | null;
9796
+ /**
9797
+ * Tax Id
9798
+ *
9799
+ * Tax identifier.
9800
+ */
9801
+ tax_id?: string | null;
9802
+ /**
9803
+ * Entity Type
9804
+ *
9805
+ * Legal form.
9806
+ */
9807
+ entity_type?: string | null;
9808
+ };
9809
+
9547
9810
  /**
9548
9811
  * JournalEntryLineDimensions
9549
9812
  *
@@ -13281,9 +13544,9 @@ export type OperationEnvelopeInformationBlockResponse = {
13281
13544
  };
13282
13545
 
13283
13546
  /**
13284
- * OperationEnvelope[InitializeChartOfAccountsResponse]
13547
+ * OperationEnvelope[IngestReportResponse]
13285
13548
  */
13286
- export type OperationEnvelopeInitializeChartOfAccountsResponse = {
13549
+ export type OperationEnvelopeIngestReportResponse = {
13287
13550
  /**
13288
13551
  * Operation
13289
13552
  *
@@ -13305,7 +13568,7 @@ export type OperationEnvelopeInitializeChartOfAccountsResponse = {
13305
13568
  /**
13306
13569
  * Command-specific result payload
13307
13570
  */
13308
- result?: InitializeChartOfAccountsResponse | null;
13571
+ result?: IngestReportResponse | null;
13309
13572
  /**
13310
13573
  * At
13311
13574
  *
@@ -13327,9 +13590,9 @@ export type OperationEnvelopeInitializeChartOfAccountsResponse = {
13327
13590
  };
13328
13591
 
13329
13592
  /**
13330
- * OperationEnvelope[InitializeLedgerResponse]
13593
+ * OperationEnvelope[InitializeChartOfAccountsResponse]
13331
13594
  */
13332
- export type OperationEnvelopeInitializeLedgerResponse = {
13595
+ export type OperationEnvelopeInitializeChartOfAccountsResponse = {
13333
13596
  /**
13334
13597
  * Operation
13335
13598
  *
@@ -13351,7 +13614,7 @@ export type OperationEnvelopeInitializeLedgerResponse = {
13351
13614
  /**
13352
13615
  * Command-specific result payload
13353
13616
  */
13354
- result?: InitializeLedgerResponse | null;
13617
+ result?: InitializeChartOfAccountsResponse | null;
13355
13618
  /**
13356
13619
  * At
13357
13620
  *
@@ -13373,9 +13636,9 @@ export type OperationEnvelopeInitializeLedgerResponse = {
13373
13636
  };
13374
13637
 
13375
13638
  /**
13376
- * OperationEnvelope[JournalEntryResponse]
13639
+ * OperationEnvelope[InitializeLedgerResponse]
13377
13640
  */
13378
- export type OperationEnvelopeJournalEntryResponse = {
13641
+ export type OperationEnvelopeInitializeLedgerResponse = {
13379
13642
  /**
13380
13643
  * Operation
13381
13644
  *
@@ -13397,7 +13660,7 @@ export type OperationEnvelopeJournalEntryResponse = {
13397
13660
  /**
13398
13661
  * Command-specific result payload
13399
13662
  */
13400
- result?: JournalEntryResponse | null;
13663
+ result?: InitializeLedgerResponse | null;
13401
13664
  /**
13402
13665
  * At
13403
13666
  *
@@ -13419,9 +13682,9 @@ export type OperationEnvelopeJournalEntryResponse = {
13419
13682
  };
13420
13683
 
13421
13684
  /**
13422
- * OperationEnvelope[LearnClassificationDefaultsResponse]
13685
+ * OperationEnvelope[IssuerResponse]
13423
13686
  */
13424
- export type OperationEnvelopeLearnClassificationDefaultsResponse = {
13687
+ export type OperationEnvelopeIssuerResponse = {
13425
13688
  /**
13426
13689
  * Operation
13427
13690
  *
@@ -13443,7 +13706,7 @@ export type OperationEnvelopeLearnClassificationDefaultsResponse = {
13443
13706
  /**
13444
13707
  * Command-specific result payload
13445
13708
  */
13446
- result?: LearnClassificationDefaultsResponse | null;
13709
+ result?: IssuerResponse | null;
13447
13710
  /**
13448
13711
  * At
13449
13712
  *
@@ -13465,9 +13728,9 @@ export type OperationEnvelopeLearnClassificationDefaultsResponse = {
13465
13728
  };
13466
13729
 
13467
13730
  /**
13468
- * OperationEnvelope[LedgerAgentResponse]
13731
+ * OperationEnvelope[JournalEntryResponse]
13469
13732
  */
13470
- export type OperationEnvelopeLedgerAgentResponse = {
13733
+ export type OperationEnvelopeJournalEntryResponse = {
13471
13734
  /**
13472
13735
  * Operation
13473
13736
  *
@@ -13489,7 +13752,7 @@ export type OperationEnvelopeLedgerAgentResponse = {
13489
13752
  /**
13490
13753
  * Command-specific result payload
13491
13754
  */
13492
- result?: LedgerAgentResponse | null;
13755
+ result?: JournalEntryResponse | null;
13493
13756
  /**
13494
13757
  * At
13495
13758
  *
@@ -13511,9 +13774,9 @@ export type OperationEnvelopeLedgerAgentResponse = {
13511
13774
  };
13512
13775
 
13513
13776
  /**
13514
- * OperationEnvelope[LedgerEntityResponse]
13777
+ * OperationEnvelope[LearnClassificationDefaultsResponse]
13515
13778
  */
13516
- export type OperationEnvelopeLedgerEntityResponse = {
13779
+ export type OperationEnvelopeLearnClassificationDefaultsResponse = {
13517
13780
  /**
13518
13781
  * Operation
13519
13782
  *
@@ -13535,7 +13798,7 @@ export type OperationEnvelopeLedgerEntityResponse = {
13535
13798
  /**
13536
13799
  * Command-specific result payload
13537
13800
  */
13538
- result?: LedgerEntityResponse | null;
13801
+ result?: LearnClassificationDefaultsResponse | null;
13539
13802
  /**
13540
13803
  * At
13541
13804
  *
@@ -13557,9 +13820,9 @@ export type OperationEnvelopeLedgerEntityResponse = {
13557
13820
  };
13558
13821
 
13559
13822
  /**
13560
- * OperationEnvelope[LinkBankAccountResponse]
13823
+ * OperationEnvelope[LedgerAgentResponse]
13561
13824
  */
13562
- export type OperationEnvelopeLinkBankAccountResponse = {
13825
+ export type OperationEnvelopeLedgerAgentResponse = {
13563
13826
  /**
13564
13827
  * Operation
13565
13828
  *
@@ -13581,7 +13844,7 @@ export type OperationEnvelopeLinkBankAccountResponse = {
13581
13844
  /**
13582
13845
  * Command-specific result payload
13583
13846
  */
13584
- result?: LinkBankAccountResponse | null;
13847
+ result?: LedgerAgentResponse | null;
13585
13848
  /**
13586
13849
  * At
13587
13850
  *
@@ -13603,9 +13866,9 @@ export type OperationEnvelopeLinkBankAccountResponse = {
13603
13866
  };
13604
13867
 
13605
13868
  /**
13606
- * OperationEnvelope[LiveFinancialStatementResponse]
13869
+ * OperationEnvelope[LedgerEntityResponse]
13607
13870
  */
13608
- export type OperationEnvelopeLiveFinancialStatementResponse = {
13871
+ export type OperationEnvelopeLedgerEntityResponse = {
13609
13872
  /**
13610
13873
  * Operation
13611
13874
  *
@@ -13627,7 +13890,7 @@ export type OperationEnvelopeLiveFinancialStatementResponse = {
13627
13890
  /**
13628
13891
  * Command-specific result payload
13629
13892
  */
13630
- result?: LiveFinancialStatementResponse | null;
13893
+ result?: LedgerEntityResponse | null;
13631
13894
  /**
13632
13895
  * At
13633
13896
  *
@@ -13649,9 +13912,9 @@ export type OperationEnvelopeLiveFinancialStatementResponse = {
13649
13912
  };
13650
13913
 
13651
13914
  /**
13652
- * OperationEnvelope[OwnershipChangeResponse]
13915
+ * OperationEnvelope[LinkBankAccountResponse]
13653
13916
  */
13654
- export type OperationEnvelopeOwnershipChangeResponse = {
13917
+ export type OperationEnvelopeLinkBankAccountResponse = {
13655
13918
  /**
13656
13919
  * Operation
13657
13920
  *
@@ -13673,7 +13936,7 @@ export type OperationEnvelopeOwnershipChangeResponse = {
13673
13936
  /**
13674
13937
  * Command-specific result payload
13675
13938
  */
13676
- result?: OwnershipChangeResponse | null;
13939
+ result?: LinkBankAccountResponse | null;
13677
13940
  /**
13678
13941
  * At
13679
13942
  *
@@ -13695,9 +13958,9 @@ export type OperationEnvelopeOwnershipChangeResponse = {
13695
13958
  };
13696
13959
 
13697
13960
  /**
13698
- * OperationEnvelope[PortfolioBlockEnvelope]
13961
+ * OperationEnvelope[LiveFinancialStatementResponse]
13699
13962
  */
13700
- export type OperationEnvelopePortfolioBlockEnvelope = {
13963
+ export type OperationEnvelopeLiveFinancialStatementResponse = {
13701
13964
  /**
13702
13965
  * Operation
13703
13966
  *
@@ -13719,7 +13982,7 @@ export type OperationEnvelopePortfolioBlockEnvelope = {
13719
13982
  /**
13720
13983
  * Command-specific result payload
13721
13984
  */
13722
- result?: PortfolioBlockEnvelope | null;
13985
+ result?: LiveFinancialStatementResponse | null;
13723
13986
  /**
13724
13987
  * At
13725
13988
  *
@@ -13741,9 +14004,9 @@ export type OperationEnvelopePortfolioBlockEnvelope = {
13741
14004
  };
13742
14005
 
13743
14006
  /**
13744
- * OperationEnvelope[PreviewConsolidationEntriesResponse]
14007
+ * OperationEnvelope[OwnershipChangeResponse]
13745
14008
  */
13746
- export type OperationEnvelopePreviewConsolidationEntriesResponse = {
14009
+ export type OperationEnvelopeOwnershipChangeResponse = {
13747
14010
  /**
13748
14011
  * Operation
13749
14012
  *
@@ -13765,7 +14028,7 @@ export type OperationEnvelopePreviewConsolidationEntriesResponse = {
13765
14028
  /**
13766
14029
  * Command-specific result payload
13767
14030
  */
13768
- result?: PreviewConsolidationEntriesResponse | null;
14031
+ result?: OwnershipChangeResponse | null;
13769
14032
  /**
13770
14033
  * At
13771
14034
  *
@@ -13787,9 +14050,9 @@ export type OperationEnvelopePreviewConsolidationEntriesResponse = {
13787
14050
  };
13788
14051
 
13789
14052
  /**
13790
- * OperationEnvelope[PreviewEventBlockResponse]
14053
+ * OperationEnvelope[PortfolioBlockEnvelope]
13791
14054
  */
13792
- export type OperationEnvelopePreviewEventBlockResponse = {
14055
+ export type OperationEnvelopePortfolioBlockEnvelope = {
13793
14056
  /**
13794
14057
  * Operation
13795
14058
  *
@@ -13811,7 +14074,7 @@ export type OperationEnvelopePreviewEventBlockResponse = {
13811
14074
  /**
13812
14075
  * Command-specific result payload
13813
14076
  */
13814
- result?: PreviewEventBlockResponse | null;
14077
+ result?: PortfolioBlockEnvelope | null;
13815
14078
  /**
13816
14079
  * At
13817
14080
  *
@@ -13833,9 +14096,9 @@ export type OperationEnvelopePreviewEventBlockResponse = {
13833
14096
  };
13834
14097
 
13835
14098
  /**
13836
- * OperationEnvelope[PreviewScheduleResponse]
14099
+ * OperationEnvelope[PreviewConsolidationEntriesResponse]
13837
14100
  */
13838
- export type OperationEnvelopePreviewScheduleResponse = {
14101
+ export type OperationEnvelopePreviewConsolidationEntriesResponse = {
13839
14102
  /**
13840
14103
  * Operation
13841
14104
  *
@@ -13857,7 +14120,99 @@ export type OperationEnvelopePreviewScheduleResponse = {
13857
14120
  /**
13858
14121
  * Command-specific result payload
13859
14122
  */
13860
- result?: PreviewScheduleResponse | null;
14123
+ result?: PreviewConsolidationEntriesResponse | null;
14124
+ /**
14125
+ * At
14126
+ *
14127
+ * ISO-8601 UTC timestamp
14128
+ */
14129
+ at: string;
14130
+ /**
14131
+ * Createdby
14132
+ *
14133
+ * User ID that initiated the operation
14134
+ */
14135
+ createdBy?: string | null;
14136
+ /**
14137
+ * Idempotentreplay
14138
+ *
14139
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
14140
+ */
14141
+ idempotentReplay?: boolean;
14142
+ };
14143
+
14144
+ /**
14145
+ * OperationEnvelope[PreviewEventBlockResponse]
14146
+ */
14147
+ export type OperationEnvelopePreviewEventBlockResponse = {
14148
+ /**
14149
+ * Operation
14150
+ *
14151
+ * Kebab-case operation name
14152
+ */
14153
+ operation: string;
14154
+ /**
14155
+ * Operationid
14156
+ *
14157
+ * op_-prefixed ULID for audit and SSE correlation
14158
+ */
14159
+ operationId: string;
14160
+ /**
14161
+ * Status
14162
+ *
14163
+ * Operation lifecycle state
14164
+ */
14165
+ status: 'completed' | 'pending' | 'failed';
14166
+ /**
14167
+ * Command-specific result payload
14168
+ */
14169
+ result?: PreviewEventBlockResponse | null;
14170
+ /**
14171
+ * At
14172
+ *
14173
+ * ISO-8601 UTC timestamp
14174
+ */
14175
+ at: string;
14176
+ /**
14177
+ * Createdby
14178
+ *
14179
+ * User ID that initiated the operation
14180
+ */
14181
+ createdBy?: string | null;
14182
+ /**
14183
+ * Idempotentreplay
14184
+ *
14185
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
14186
+ */
14187
+ idempotentReplay?: boolean;
14188
+ };
14189
+
14190
+ /**
14191
+ * OperationEnvelope[PreviewScheduleResponse]
14192
+ */
14193
+ export type OperationEnvelopePreviewScheduleResponse = {
14194
+ /**
14195
+ * Operation
14196
+ *
14197
+ * Kebab-case operation name
14198
+ */
14199
+ operation: string;
14200
+ /**
14201
+ * Operationid
14202
+ *
14203
+ * op_-prefixed ULID for audit and SSE correlation
14204
+ */
14205
+ operationId: string;
14206
+ /**
14207
+ * Status
14208
+ *
14209
+ * Operation lifecycle state
14210
+ */
14211
+ status: 'completed' | 'pending' | 'failed';
14212
+ /**
14213
+ * Command-specific result payload
14214
+ */
14215
+ result?: PreviewScheduleResponse | null;
13861
14216
  /**
13862
14217
  * At
13863
14218
  *
@@ -18852,6 +19207,171 @@ export type ReopenPeriodOperation = {
18852
19207
  period: string;
18853
19208
  };
18854
19209
 
19210
+ /**
19211
+ * ReportConceptRow
19212
+ *
19213
+ * A concept the report uses that the library may not have.
19214
+ */
19215
+ export type ReportConceptRow = {
19216
+ /**
19217
+ * Qname
19218
+ *
19219
+ * Prefixed name, e.g. `rs-gaap:Assets` for a library concept or `kpi:Headcount` for one of the firm's own. A prefix other than a library's must be bound in `namespaces`.
19220
+ */
19221
+ qname: string;
19222
+ /**
19223
+ * Label
19224
+ *
19225
+ * The line's wording in the report.
19226
+ */
19227
+ label?: string | null;
19228
+ /**
19229
+ * Kind
19230
+ *
19231
+ * The value's type: `monetary`, `shares`, `percent`, `pure`, `decimal`, `integer`, `string`, `text_block`, `date` or `boolean`.
19232
+ */
19233
+ kind?: string;
19234
+ /**
19235
+ * Period Type
19236
+ *
19237
+ * `instant` for a balance at a date, `duration` for a flow over a period.
19238
+ */
19239
+ period_type?: string | null;
19240
+ /**
19241
+ * Balance
19242
+ *
19243
+ * `debit` or `credit`, when monetary.
19244
+ */
19245
+ balance?: string | null;
19246
+ /**
19247
+ * Abstract
19248
+ *
19249
+ * True for a heading that carries no value of its own.
19250
+ */
19251
+ abstract?: boolean;
19252
+ };
19253
+
19254
+ /**
19255
+ * ReportDeparture
19256
+ *
19257
+ * One place a report sent as rows arranges a primary statement differently
19258
+ * than the library does.
19259
+ */
19260
+ export type ReportDeparture = {
19261
+ /**
19262
+ * Section
19263
+ *
19264
+ * The section it is in.
19265
+ */
19266
+ section: string;
19267
+ /**
19268
+ * Kind
19269
+ *
19270
+ * moved: a library concept sits under a different line, or with a different sign, than the library gives it. placed: a library concept the library does not put on this statement was given a line. own_subtotal: a concept of the firm's own has library concepts beneath it. own_layout: the whole statement came with its own lines.
19271
+ */
19272
+ kind: 'moved' | 'placed' | 'own_subtotal' | 'own_layout';
19273
+ /**
19274
+ * Concept
19275
+ *
19276
+ * The concept, when it is about one.
19277
+ */
19278
+ concept?: string | null;
19279
+ /**
19280
+ * Library Parent
19281
+ *
19282
+ * For `moved`: the line the library puts it under.
19283
+ */
19284
+ library_parent?: string | null;
19285
+ /**
19286
+ * Parent
19287
+ *
19288
+ * The line the report puts it under.
19289
+ */
19290
+ parent?: string | null;
19291
+ /**
19292
+ * Detail
19293
+ *
19294
+ * The departure as a sentence.
19295
+ */
19296
+ detail: string;
19297
+ };
19298
+
19299
+ /**
19300
+ * ReportFactRow
19301
+ *
19302
+ * One value read from the report.
19303
+ */
19304
+ export type ReportFactRow = {
19305
+ /**
19306
+ * Concept
19307
+ *
19308
+ * The concept qname the value is for.
19309
+ */
19310
+ concept: string;
19311
+ /**
19312
+ * Value
19313
+ *
19314
+ * The number, or the text for a non-numeric concept.
19315
+ */
19316
+ value: number | string | null;
19317
+ /**
19318
+ * End
19319
+ *
19320
+ * The date the value is as of, or the last day of its period.
19321
+ */
19322
+ end: string;
19323
+ /**
19324
+ * Start
19325
+ *
19326
+ * The first day of the period; omit for a balance at a date.
19327
+ */
19328
+ start?: string | null;
19329
+ /**
19330
+ * Unit
19331
+ *
19332
+ * A currency code (`USD`), `shares` or `pure`. Required for a number.
19333
+ */
19334
+ unit?: string | null;
19335
+ /**
19336
+ * Decimals
19337
+ *
19338
+ * Precision of the number: `0` to the unit, `-3` to the thousand, `2` to the cent. Totals are checked to this precision.
19339
+ */
19340
+ decimals?: number | null;
19341
+ /**
19342
+ * Source
19343
+ *
19344
+ * Where the value was read from: the document, then `#page=3` for a PDF or `#sheet=BS&cell=B10` for a workbook, with `&label=` and the line's wording when useful. Kept on the fact.
19345
+ */
19346
+ source?: string | null;
19347
+ };
19348
+
19349
+ /**
19350
+ * ReportLineRow
19351
+ *
19352
+ * One line of a section, top to bottom.
19353
+ */
19354
+ export type ReportLineRow = {
19355
+ /**
19356
+ * Concept
19357
+ *
19358
+ * The line's concept qname.
19359
+ */
19360
+ concept: string;
19361
+ /**
19362
+ * Parent
19363
+ *
19364
+ * The qname of the line this one sits under; omit for a top line.
19365
+ */
19366
+ parent?: string | null;
19367
+ /**
19368
+ * Weight
19369
+ *
19370
+ * Set to make the line a term of its parent's total: `1` adds, `-1` subtracts. The total is then checked against its terms.
19371
+ */
19372
+ weight?: number | null;
19373
+ };
19374
+
18855
19375
  /**
18856
19376
  * ReportResponse
18857
19377
  *
@@ -18989,6 +19509,12 @@ export type ReportResponse = {
18989
19509
  * When this report has been restated, the successor's report ID.
18990
19510
  */
18991
19511
  superseded_by_id?: string | null;
19512
+ /**
19513
+ * Origin
19514
+ *
19515
+ * How the report came to be in this graph: `authored` from its own books, `shared` in from another graph, or `uploaded` as a file. Anything but `authored` is a received report: read-only, and served as the artifact that arrived.
19516
+ */
19517
+ origin?: string;
18992
19518
  /**
18993
19519
  * Source Graph Id
18994
19520
  *
@@ -19017,6 +19543,104 @@ export type ReportResponse = {
19017
19543
  } | null;
19018
19544
  };
19019
19545
 
19546
+ /**
19547
+ * ReportRowsInput
19548
+ *
19549
+ * A report as rows, for the server to assemble into a holon.
19550
+ */
19551
+ export type ReportRowsInput = {
19552
+ /**
19553
+ * Period End
19554
+ *
19555
+ * The last day the report covers.
19556
+ */
19557
+ period_end: string;
19558
+ /**
19559
+ * Kind
19560
+ *
19561
+ * What the report is, e.g. `monthly-package`, `quarterly-financials`. A later ingest for the same entity, period end and kind replaces this one.
19562
+ */
19563
+ kind?: string;
19564
+ /**
19565
+ * Attributed To
19566
+ *
19567
+ * Who or what read the values out of the source document.
19568
+ */
19569
+ attributed_to?: string | null;
19570
+ /**
19571
+ * Namespaces
19572
+ *
19573
+ * Prefix to namespace URI, for concept prefixes that are not a library's.
19574
+ */
19575
+ namespaces?: {
19576
+ [key: string]: string;
19577
+ };
19578
+ /**
19579
+ * Concepts
19580
+ *
19581
+ * The concepts the library does not have, each declared once. A library concept (`rs-gaap:Assets`) needs no entry unless the report words it differently.
19582
+ */
19583
+ concepts?: Array<ReportConceptRow>;
19584
+ /**
19585
+ * Labels
19586
+ *
19587
+ * The document's own wording for a line, by library concept (`rs-gaap:LaborAndRelatedExpense`: `Personnel Expense`). The report reads back with this wording; the concept stays the library's.
19588
+ */
19589
+ labels?: {
19590
+ [key: string]: string;
19591
+ };
19592
+ /**
19593
+ * Sections
19594
+ *
19595
+ * The report's statements and tables.
19596
+ */
19597
+ sections?: Array<ReportSectionRow>;
19598
+ /**
19599
+ * Facts
19600
+ *
19601
+ * The values.
19602
+ */
19603
+ facts: Array<ReportFactRow>;
19604
+ };
19605
+
19606
+ /**
19607
+ * ReportSectionRow
19608
+ *
19609
+ * A statement or a table of the report.
19610
+ */
19611
+ export type ReportSectionRow = {
19612
+ /**
19613
+ * Name
19614
+ *
19615
+ * The section's title, e.g. `Balance Sheet`.
19616
+ */
19617
+ name: string;
19618
+ /**
19619
+ * Block Type
19620
+ *
19621
+ * `balance_sheet`, `income_statement`, `cash_flow_statement` or `equity_statement` for a primary statement; omit for any other table.
19622
+ */
19623
+ block_type?: string | null;
19624
+ /**
19625
+ * Head
19626
+ *
19627
+ * An abstract concept the section's top lines hang from. Required when a top line has nothing beneath it, as in a flat KPI table.
19628
+ */
19629
+ head?: string | null;
19630
+ /**
19631
+ * Layout
19632
+ *
19633
+ * `library` lays a `balance_sheet` or an `income_statement` out from the library: every value sent for a concept the statement places becomes a line under the nearest line above it that also has a value, and each total is checked against the lines beneath it. `given` uses `lines` exactly as sent. Omitted, it is `library` when there are no `lines` and `given` when there are.
19634
+ */
19635
+ layout?: 'library' | 'given' | null;
19636
+ /**
19637
+ * Lines
19638
+ *
19639
+ * The lines, in order. With `layout: library` these are only the lines the library cannot place, or places differently than the document: a concept of the firm's own, each with the `parent` it sits under (a line of the statement that has a value) and its `weight`. A line given here replaces the library's placement of that concept.
19640
+ */
19641
+ lines?: Array<ReportLineRow>;
19642
+ };
19643
+
19020
19644
  /**
19021
19645
  * RepositoryInfo
19022
19646
  *
@@ -37786,3 +38410,131 @@ export type DeleteSecurityResponses = {
37786
38410
  };
37787
38411
 
37788
38412
  export type DeleteSecurityResponse = DeleteSecurityResponses[keyof DeleteSecurityResponses];
38413
+
38414
+ export type CreateIssuerData = {
38415
+ body: CreateIssuerRequest;
38416
+ headers?: {
38417
+ /**
38418
+ * Idempotency-Key
38419
+ */
38420
+ 'Idempotency-Key'?: string | null;
38421
+ };
38422
+ path: {
38423
+ /**
38424
+ * Graph Id
38425
+ */
38426
+ graph_id: string;
38427
+ };
38428
+ query?: never;
38429
+ url: '/extensions/roboinvestor/{graph_id}/operations/create-issuer';
38430
+ };
38431
+
38432
+ export type CreateIssuerErrors = {
38433
+ /**
38434
+ * Invalid request
38435
+ */
38436
+ 400: ErrorResponse;
38437
+ /**
38438
+ * Authentication required
38439
+ */
38440
+ 401: ErrorResponse;
38441
+ /**
38442
+ * Access denied
38443
+ */
38444
+ 403: ErrorResponse;
38445
+ /**
38446
+ * Resource not found
38447
+ */
38448
+ 404: ErrorResponse;
38449
+ /**
38450
+ * Idempotency-Key conflict — key reused with different body
38451
+ */
38452
+ 409: ErrorResponse;
38453
+ /**
38454
+ * Validation error
38455
+ */
38456
+ 422: ErrorResponse;
38457
+ /**
38458
+ * Rate limit exceeded
38459
+ */
38460
+ 429: ErrorResponse;
38461
+ /**
38462
+ * Internal server error
38463
+ */
38464
+ 500: ErrorResponse;
38465
+ };
38466
+
38467
+ export type CreateIssuerError = CreateIssuerErrors[keyof CreateIssuerErrors];
38468
+
38469
+ export type CreateIssuerResponses = {
38470
+ /**
38471
+ * Successful Response
38472
+ */
38473
+ 200: OperationEnvelopeIssuerResponse;
38474
+ };
38475
+
38476
+ export type CreateIssuerResponse = CreateIssuerResponses[keyof CreateIssuerResponses];
38477
+
38478
+ export type IngestReportData = {
38479
+ body: IngestReportRequest;
38480
+ headers?: {
38481
+ /**
38482
+ * Idempotency-Key
38483
+ */
38484
+ 'Idempotency-Key'?: string | null;
38485
+ };
38486
+ path: {
38487
+ /**
38488
+ * Graph Id
38489
+ */
38490
+ graph_id: string;
38491
+ };
38492
+ query?: never;
38493
+ url: '/extensions/roboinvestor/{graph_id}/operations/ingest-report';
38494
+ };
38495
+
38496
+ export type IngestReportErrors = {
38497
+ /**
38498
+ * Invalid request
38499
+ */
38500
+ 400: ErrorResponse;
38501
+ /**
38502
+ * Authentication required
38503
+ */
38504
+ 401: ErrorResponse;
38505
+ /**
38506
+ * Access denied
38507
+ */
38508
+ 403: ErrorResponse;
38509
+ /**
38510
+ * Resource not found
38511
+ */
38512
+ 404: ErrorResponse;
38513
+ /**
38514
+ * Idempotency-Key conflict — key reused with different body
38515
+ */
38516
+ 409: ErrorResponse;
38517
+ /**
38518
+ * Validation error
38519
+ */
38520
+ 422: ErrorResponse;
38521
+ /**
38522
+ * Rate limit exceeded
38523
+ */
38524
+ 429: ErrorResponse;
38525
+ /**
38526
+ * Internal server error
38527
+ */
38528
+ 500: ErrorResponse;
38529
+ };
38530
+
38531
+ export type IngestReportError = IngestReportErrors[keyof IngestReportErrors];
38532
+
38533
+ export type IngestReportResponses = {
38534
+ /**
38535
+ * Successful Response
38536
+ */
38537
+ 200: OperationEnvelopeIngestReportResponse;
38538
+ };
38539
+
38540
+ export type IngestReportResponse2 = IngestReportResponses[keyof IngestReportResponses];