@robosystems/client 2.39.1 → 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.
@@ -3703,6 +3703,66 @@ export type CreateInvitationRequest = {
3703
3703
  email: string;
3704
3704
  role?: OrgRole;
3705
3705
  };
3706
+ /**
3707
+ * CreateIssuerRequest
3708
+ *
3709
+ * CQRS body for `POST /operations/create-issuer`.
3710
+ *
3711
+ * An issuer is a company the fund holds or follows that does not keep its
3712
+ * books on this platform: an entity in the fund's graph that securities and
3713
+ * received reports attach to. A company that shares a report in from its own
3714
+ * graph gets its entity from the share instead.
3715
+ */
3716
+ export type CreateIssuerRequest = {
3717
+ /**
3718
+ * Name
3719
+ *
3720
+ * The company's name.
3721
+ */
3722
+ name: string;
3723
+ /**
3724
+ * Legal Name
3725
+ *
3726
+ * Its legal name, when different.
3727
+ */
3728
+ legal_name?: string | null;
3729
+ /**
3730
+ * Lei
3731
+ *
3732
+ * Legal Entity Identifier, if it has one.
3733
+ */
3734
+ lei?: string | null;
3735
+ /**
3736
+ * Cik
3737
+ *
3738
+ * SEC Central Index Key, if it has one.
3739
+ */
3740
+ cik?: string | null;
3741
+ /**
3742
+ * Tax Id
3743
+ *
3744
+ * Tax identifier (an EIN in the United States).
3745
+ */
3746
+ tax_id?: string | null;
3747
+ /**
3748
+ * Entity Type
3749
+ *
3750
+ * Legal form, e.g. `corporation`, `llc`, `partnership`.
3751
+ */
3752
+ entity_type?: string | null;
3753
+ /**
3754
+ * Industry
3755
+ *
3756
+ * Industry, as free text.
3757
+ */
3758
+ industry?: string | null;
3759
+ /**
3760
+ * Website
3761
+ *
3762
+ * The company's website.
3763
+ */
3764
+ website?: string | null;
3765
+ };
3706
3766
  /**
3707
3767
  * CreateMappingAssociationOperation
3708
3768
  *
@@ -8873,6 +8933,156 @@ export type IngestFileOp = {
8873
8933
  */
8874
8934
  ingest_to_graph?: boolean;
8875
8935
  };
8936
+ /**
8937
+ * IngestReportRequest
8938
+ *
8939
+ * CQRS body for `POST /operations/ingest-report`.
8940
+ *
8941
+ * Give exactly one of `holon` (a report file already in the holon format),
8942
+ * `tavi` (a Tavi compiled model) or `report` (rows read from a PDF or a
8943
+ * workbook, which the server assembles into a holon). Every route ends in a
8944
+ * holon that is checked, stored as the record of what was received, and
8945
+ * loaded onto the entity.
8946
+ */
8947
+ export type IngestReportRequest = {
8948
+ /**
8949
+ * Entity Id
8950
+ *
8951
+ * The entity the report is about (see `create-issuer`).
8952
+ */
8953
+ entity_id: string;
8954
+ /**
8955
+ * Holon
8956
+ *
8957
+ * The text of a `.holon.jsonld` report file.
8958
+ */
8959
+ holon?: string | null;
8960
+ /**
8961
+ * Tavi
8962
+ *
8963
+ * The text of a `.tavi.json` compiled model. It is converted to a holon, which is what is stored.
8964
+ */
8965
+ tavi?: string | null;
8966
+ /**
8967
+ * The report as rows.
8968
+ */
8969
+ report?: ReportRowsInput | null;
8970
+ /**
8971
+ * Name
8972
+ *
8973
+ * A display name for the report.
8974
+ */
8975
+ name?: string | null;
8976
+ /**
8977
+ * Require Source
8978
+ *
8979
+ * Refuse the report unless every value names its source.
8980
+ */
8981
+ require_source?: boolean;
8982
+ /**
8983
+ * Dry Run
8984
+ *
8985
+ * Check the report and say what would load, without writing anything.
8986
+ */
8987
+ dry_run?: boolean;
8988
+ };
8989
+ /**
8990
+ * IngestReportResponse
8991
+ *
8992
+ * What an ingest loaded, or on a dry run what it would load.
8993
+ */
8994
+ export type IngestReportResponse = {
8995
+ /**
8996
+ * Dry Run
8997
+ *
8998
+ * True when nothing was written.
8999
+ */
9000
+ dry_run: boolean;
9001
+ /**
9002
+ * Report Id
9003
+ *
9004
+ * The report's ID in this graph; null on a dry run.
9005
+ */
9006
+ report_id?: string | null;
9007
+ /**
9008
+ * Entity Id
9009
+ *
9010
+ * The entity the report hangs on.
9011
+ */
9012
+ entity_id: string;
9013
+ /**
9014
+ * Period End
9015
+ *
9016
+ * The last day the report covers.
9017
+ */
9018
+ period_end: string;
9019
+ /**
9020
+ * Kind
9021
+ *
9022
+ * What the report is.
9023
+ */
9024
+ kind: string;
9025
+ /**
9026
+ * Fact Count
9027
+ *
9028
+ * Values loaded as facts.
9029
+ */
9030
+ fact_count: number;
9031
+ /**
9032
+ * Section Count
9033
+ *
9034
+ * Statements and tables loaded.
9035
+ */
9036
+ section_count: number;
9037
+ /**
9038
+ * Calculations Checked
9039
+ *
9040
+ * Totals that were compared with their terms; all agreed.
9041
+ */
9042
+ calculations_checked: number;
9043
+ /**
9044
+ * Balance Checked
9045
+ *
9046
+ * Whether total assets were compared with liabilities and equity.
9047
+ */
9048
+ balance_checked: boolean;
9049
+ /**
9050
+ * Concepts Added
9051
+ *
9052
+ * Concepts the graph did not have, added to its received-reports vocabulary.
9053
+ */
9054
+ concepts_added?: Array<string>;
9055
+ /**
9056
+ * Dimensional Facts Not Loaded
9057
+ *
9058
+ * Values broken out by a dimension. They stay in the stored file; the graph holds the report's totals.
9059
+ */
9060
+ dimensional_facts_not_loaded?: number;
9061
+ /**
9062
+ * Replaced Report Ids
9063
+ *
9064
+ * Earlier ingests for the same entity, period end and kind, now replaced.
9065
+ */
9066
+ replaced_report_ids?: Array<string>;
9067
+ /**
9068
+ * Unplaced Concepts
9069
+ *
9070
+ * 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.
9071
+ */
9072
+ unplaced_concepts?: Array<string>;
9073
+ /**
9074
+ * Conforms To Library
9075
+ *
9076
+ * 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.
9077
+ */
9078
+ conforms_to_library?: boolean | null;
9079
+ /**
9080
+ * Departures
9081
+ *
9082
+ * Each place the report departs from the library's arrangement. The report still loads; the list is kept with it.
9083
+ */
9084
+ departures?: Array<ReportDeparture>;
9085
+ };
8876
9086
  /**
8877
9087
  * InitialEntityData
8878
9088
  *
@@ -9330,6 +9540,55 @@ export type InvoicesResponse = {
9330
9540
  */
9331
9541
  has_more: boolean;
9332
9542
  };
9543
+ /**
9544
+ * IssuerResponse
9545
+ *
9546
+ * An issuer entity in the fund's graph.
9547
+ */
9548
+ export type IssuerResponse = {
9549
+ /**
9550
+ * Id
9551
+ *
9552
+ * Entity ID; pass it to `ingest-report`.
9553
+ */
9554
+ id: string;
9555
+ /**
9556
+ * Name
9557
+ *
9558
+ * The company's name.
9559
+ */
9560
+ name: string;
9561
+ /**
9562
+ * Legal Name
9563
+ *
9564
+ * Its legal name.
9565
+ */
9566
+ legal_name?: string | null;
9567
+ /**
9568
+ * Lei
9569
+ *
9570
+ * Legal Entity Identifier.
9571
+ */
9572
+ lei?: string | null;
9573
+ /**
9574
+ * Cik
9575
+ *
9576
+ * SEC Central Index Key.
9577
+ */
9578
+ cik?: string | null;
9579
+ /**
9580
+ * Tax Id
9581
+ *
9582
+ * Tax identifier.
9583
+ */
9584
+ tax_id?: string | null;
9585
+ /**
9586
+ * Entity Type
9587
+ *
9588
+ * Legal form.
9589
+ */
9590
+ entity_type?: string | null;
9591
+ };
9333
9592
  /**
9334
9593
  * JournalEntryLineDimensions
9335
9594
  *
@@ -12986,6 +13245,51 @@ export type OperationEnvelopeInformationBlockResponse = {
12986
13245
  */
12987
13246
  idempotentReplay?: boolean;
12988
13247
  };
13248
+ /**
13249
+ * OperationEnvelope[IngestReportResponse]
13250
+ */
13251
+ export type OperationEnvelopeIngestReportResponse = {
13252
+ /**
13253
+ * Operation
13254
+ *
13255
+ * Kebab-case operation name
13256
+ */
13257
+ operation: string;
13258
+ /**
13259
+ * Operationid
13260
+ *
13261
+ * op_-prefixed ULID for audit and SSE correlation
13262
+ */
13263
+ operationId: string;
13264
+ /**
13265
+ * Status
13266
+ *
13267
+ * Operation lifecycle state
13268
+ */
13269
+ status: 'completed' | 'pending' | 'failed';
13270
+ /**
13271
+ * Command-specific result payload
13272
+ */
13273
+ result?: IngestReportResponse | null;
13274
+ /**
13275
+ * At
13276
+ *
13277
+ * ISO-8601 UTC timestamp
13278
+ */
13279
+ at: string;
13280
+ /**
13281
+ * Createdby
13282
+ *
13283
+ * User ID that initiated the operation
13284
+ */
13285
+ createdBy?: string | null;
13286
+ /**
13287
+ * Idempotentreplay
13288
+ *
13289
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
13290
+ */
13291
+ idempotentReplay?: boolean;
13292
+ };
12989
13293
  /**
12990
13294
  * OperationEnvelope[InitializeChartOfAccountsResponse]
12991
13295
  */
@@ -13076,6 +13380,51 @@ export type OperationEnvelopeInitializeLedgerResponse = {
13076
13380
  */
13077
13381
  idempotentReplay?: boolean;
13078
13382
  };
13383
+ /**
13384
+ * OperationEnvelope[IssuerResponse]
13385
+ */
13386
+ export type OperationEnvelopeIssuerResponse = {
13387
+ /**
13388
+ * Operation
13389
+ *
13390
+ * Kebab-case operation name
13391
+ */
13392
+ operation: string;
13393
+ /**
13394
+ * Operationid
13395
+ *
13396
+ * op_-prefixed ULID for audit and SSE correlation
13397
+ */
13398
+ operationId: string;
13399
+ /**
13400
+ * Status
13401
+ *
13402
+ * Operation lifecycle state
13403
+ */
13404
+ status: 'completed' | 'pending' | 'failed';
13405
+ /**
13406
+ * Command-specific result payload
13407
+ */
13408
+ result?: IssuerResponse | null;
13409
+ /**
13410
+ * At
13411
+ *
13412
+ * ISO-8601 UTC timestamp
13413
+ */
13414
+ at: string;
13415
+ /**
13416
+ * Createdby
13417
+ *
13418
+ * User ID that initiated the operation
13419
+ */
13420
+ createdBy?: string | null;
13421
+ /**
13422
+ * Idempotentreplay
13423
+ *
13424
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
13425
+ */
13426
+ idempotentReplay?: boolean;
13427
+ };
13079
13428
  /**
13080
13429
  * OperationEnvelope[JournalEntryResponse]
13081
13430
  */
@@ -18317,116 +18666,277 @@ export type RenderingPeriodLite = {
18317
18666
  /**
18318
18667
  * Label
18319
18668
  */
18320
- label?: string | null;
18669
+ label?: string | null;
18670
+ /**
18671
+ * Forecast
18672
+ *
18673
+ * True when this column comes from a forecast scenario's FactSet — the machine-readable seam marker (labels also carry a '(forecast)' suffix, but consumers should key styling off this flag, not label parsing). None/absent = an actuals column.
18674
+ */
18675
+ forecast?: boolean | null;
18676
+ /**
18677
+ * Presentation
18678
+ *
18679
+ * 'as_closed' when the column's figures are the ones its month's close stamped, kept as the month closed; a live read of the books (live-financial-statement) can differ from them once a mapping is reclassified after the close. None for a report's own snapshot or a forecast column.
18680
+ */
18681
+ presentation?: string | null;
18682
+ /**
18683
+ * Stamped At
18684
+ *
18685
+ * When the close stamped the column; set with 'as_closed'.
18686
+ */
18687
+ stamped_at?: string | null;
18688
+ };
18689
+ /**
18690
+ * RenderingRowLite
18691
+ *
18692
+ * One row of a server-side rendered statement.
18693
+ *
18694
+ * Drawn from :class:`FactRow` in
18695
+ * :mod:`robosystems.operations.roboledger.reports.fact_grid`, restated at the
18696
+ * API boundary so envelope consumers don't depend on that module. It does not
18697
+ * carry FactRow's `is_abstract`, `position` or `period_role` (the start/end
18698
+ * role that tells a roll-forward's two balance rows apart).
18699
+ * `values` holds one entry per period column in :class:`RenderingLite.periods`.
18700
+ */
18701
+ export type RenderingRowLite = {
18702
+ /**
18703
+ * Element Id
18704
+ */
18705
+ element_id: string;
18706
+ /**
18707
+ * Element Qname
18708
+ */
18709
+ element_qname?: string | null;
18710
+ /**
18711
+ * Element Name
18712
+ */
18713
+ element_name: string;
18714
+ /**
18715
+ * Classification
18716
+ *
18717
+ * FASB elementsOfFinancialStatements trait identifier — 'asset', 'liability', 'equity', 'revenue', 'expense'. Surfaced so the viewer can color-code or group rows without a follow-up trait lookup.
18718
+ */
18719
+ classification?: string | null;
18720
+ /**
18721
+ * Balance Type
18722
+ */
18723
+ balance_type?: string | null;
18724
+ /**
18725
+ * Item Type
18726
+ *
18727
+ * Value-domain format family from the element (monetary | ratio | percent | multiple | days | …). Drives per-row value formatting; None falls back to is_monetary on the element.
18728
+ */
18729
+ item_type?: string | null;
18730
+ /**
18731
+ * Values
18732
+ */
18733
+ values?: Array<number | null>;
18734
+ /**
18735
+ * Text Value
18736
+ *
18737
+ * Narrative payload for text-block disclosure rows (markdown); numeric rows carry values instead.
18738
+ */
18739
+ text_value?: string | null;
18740
+ /**
18741
+ * Is Subtotal
18742
+ */
18743
+ is_subtotal?: boolean;
18744
+ /**
18745
+ * Depth
18746
+ */
18747
+ depth?: number;
18748
+ };
18749
+ /**
18750
+ * ReopenPeriodOperation
18751
+ *
18752
+ * Reopen a closed fiscal period.
18753
+ */
18754
+ export type ReopenPeriodOperation = {
18755
+ /**
18756
+ * Entity Id
18757
+ *
18758
+ * The entity whose books this acts on, by id. Omit for the group parent — the single-entity default.
18759
+ */
18760
+ entity_id?: string | null;
18761
+ /**
18762
+ * Reason
18763
+ *
18764
+ * Required reason for the reopen (captured in audit log)
18765
+ */
18766
+ reason: string;
18767
+ /**
18768
+ * Note
18769
+ *
18770
+ * Additional free-form note
18771
+ */
18772
+ note?: string | null;
18773
+ /**
18774
+ * Period
18775
+ *
18776
+ * Period to reopen, in YYYY-MM. Only the latest closed period (the current `closed_through`) can be reopened, and reopening it retreats `closed_through` by one month. To reach an earlier period, reopen the later ones first, latest to earliest.
18777
+ */
18778
+ period: string;
18779
+ };
18780
+ /**
18781
+ * ReportConceptRow
18782
+ *
18783
+ * A concept the report uses that the library may not have.
18784
+ */
18785
+ export type ReportConceptRow = {
18786
+ /**
18787
+ * Qname
18788
+ *
18789
+ * 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`.
18790
+ */
18791
+ qname: string;
18792
+ /**
18793
+ * Label
18794
+ *
18795
+ * The line's wording in the report.
18796
+ */
18797
+ label?: string | null;
18798
+ /**
18799
+ * Kind
18800
+ *
18801
+ * The value's type: `monetary`, `shares`, `percent`, `pure`, `decimal`, `integer`, `string`, `text_block`, `date` or `boolean`.
18802
+ */
18803
+ kind?: string;
18804
+ /**
18805
+ * Period Type
18806
+ *
18807
+ * `instant` for a balance at a date, `duration` for a flow over a period.
18808
+ */
18809
+ period_type?: string | null;
18810
+ /**
18811
+ * Balance
18812
+ *
18813
+ * `debit` or `credit`, when monetary.
18814
+ */
18815
+ balance?: string | null;
18816
+ /**
18817
+ * Abstract
18818
+ *
18819
+ * True for a heading that carries no value of its own.
18820
+ */
18821
+ abstract?: boolean;
18822
+ };
18823
+ /**
18824
+ * ReportDeparture
18825
+ *
18826
+ * One place a report sent as rows arranges a primary statement differently
18827
+ * than the library does.
18828
+ */
18829
+ export type ReportDeparture = {
18830
+ /**
18831
+ * Section
18832
+ *
18833
+ * The section it is in.
18834
+ */
18835
+ section: string;
18836
+ /**
18837
+ * Kind
18838
+ *
18839
+ * 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.
18840
+ */
18841
+ kind: 'moved' | 'placed' | 'own_subtotal' | 'own_layout';
18842
+ /**
18843
+ * Concept
18844
+ *
18845
+ * The concept, when it is about one.
18846
+ */
18847
+ concept?: string | null;
18321
18848
  /**
18322
- * Forecast
18849
+ * Library Parent
18323
18850
  *
18324
- * True when this column comes from a forecast scenario's FactSet — the machine-readable seam marker (labels also carry a '(forecast)' suffix, but consumers should key styling off this flag, not label parsing). None/absent = an actuals column.
18851
+ * For `moved`: the line the library puts it under.
18325
18852
  */
18326
- forecast?: boolean | null;
18853
+ library_parent?: string | null;
18327
18854
  /**
18328
- * Presentation
18855
+ * Parent
18329
18856
  *
18330
- * 'as_closed' when the column's figures are the ones its month's close stamped, kept as the month closed; a live read of the books (live-financial-statement) can differ from them once a mapping is reclassified after the close. None for a report's own snapshot or a forecast column.
18857
+ * The line the report puts it under.
18331
18858
  */
18332
- presentation?: string | null;
18859
+ parent?: string | null;
18333
18860
  /**
18334
- * Stamped At
18861
+ * Detail
18335
18862
  *
18336
- * When the close stamped the column; set with 'as_closed'.
18863
+ * The departure as a sentence.
18337
18864
  */
18338
- stamped_at?: string | null;
18865
+ detail: string;
18339
18866
  };
18340
18867
  /**
18341
- * RenderingRowLite
18342
- *
18343
- * One row of a server-side rendered statement.
18868
+ * ReportFactRow
18344
18869
  *
18345
- * Drawn from :class:`FactRow` in
18346
- * :mod:`robosystems.operations.roboledger.reports.fact_grid`, restated at the
18347
- * API boundary so envelope consumers don't depend on that module. It does not
18348
- * carry FactRow's `is_abstract`, `position` or `period_role` (the start/end
18349
- * role that tells a roll-forward's two balance rows apart).
18350
- * `values` holds one entry per period column in :class:`RenderingLite.periods`.
18870
+ * One value read from the report.
18351
18871
  */
18352
- export type RenderingRowLite = {
18353
- /**
18354
- * Element Id
18355
- */
18356
- element_id: string;
18357
- /**
18358
- * Element Qname
18359
- */
18360
- element_qname?: string | null;
18361
- /**
18362
- * Element Name
18363
- */
18364
- element_name: string;
18872
+ export type ReportFactRow = {
18365
18873
  /**
18366
- * Classification
18874
+ * Concept
18367
18875
  *
18368
- * FASB elementsOfFinancialStatements trait identifier — 'asset', 'liability', 'equity', 'revenue', 'expense'. Surfaced so the viewer can color-code or group rows without a follow-up trait lookup.
18876
+ * The concept qname the value is for.
18369
18877
  */
18370
- classification?: string | null;
18878
+ concept: string;
18371
18879
  /**
18372
- * Balance Type
18880
+ * Value
18881
+ *
18882
+ * The number, or the text for a non-numeric concept.
18373
18883
  */
18374
- balance_type?: string | null;
18884
+ value: number | string | null;
18375
18885
  /**
18376
- * Item Type
18886
+ * End
18377
18887
  *
18378
- * Value-domain format family from the element (monetary | ratio | percent | multiple | days | …). Drives per-row value formatting; None falls back to is_monetary on the element.
18888
+ * The date the value is as of, or the last day of its period.
18379
18889
  */
18380
- item_type?: string | null;
18890
+ end: string;
18381
18891
  /**
18382
- * Values
18892
+ * Start
18893
+ *
18894
+ * The first day of the period; omit for a balance at a date.
18383
18895
  */
18384
- values?: Array<number | null>;
18896
+ start?: string | null;
18385
18897
  /**
18386
- * Text Value
18898
+ * Unit
18387
18899
  *
18388
- * Narrative payload for text-block disclosure rows (markdown); numeric rows carry values instead.
18900
+ * A currency code (`USD`), `shares` or `pure`. Required for a number.
18389
18901
  */
18390
- text_value?: string | null;
18902
+ unit?: string | null;
18391
18903
  /**
18392
- * Is Subtotal
18904
+ * Decimals
18905
+ *
18906
+ * Precision of the number: `0` to the unit, `-3` to the thousand, `2` to the cent. Totals are checked to this precision.
18393
18907
  */
18394
- is_subtotal?: boolean;
18908
+ decimals?: number | null;
18395
18909
  /**
18396
- * Depth
18910
+ * Source
18911
+ *
18912
+ * 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.
18397
18913
  */
18398
- depth?: number;
18914
+ source?: string | null;
18399
18915
  };
18400
18916
  /**
18401
- * ReopenPeriodOperation
18917
+ * ReportLineRow
18402
18918
  *
18403
- * Reopen a closed fiscal period.
18919
+ * One line of a section, top to bottom.
18404
18920
  */
18405
- export type ReopenPeriodOperation = {
18406
- /**
18407
- * Entity Id
18408
- *
18409
- * The entity whose books this acts on, by id. Omit for the group parent — the single-entity default.
18410
- */
18411
- entity_id?: string | null;
18921
+ export type ReportLineRow = {
18412
18922
  /**
18413
- * Reason
18923
+ * Concept
18414
18924
  *
18415
- * Required reason for the reopen (captured in audit log)
18925
+ * The line's concept qname.
18416
18926
  */
18417
- reason: string;
18927
+ concept: string;
18418
18928
  /**
18419
- * Note
18929
+ * Parent
18420
18930
  *
18421
- * Additional free-form note
18931
+ * The qname of the line this one sits under; omit for a top line.
18422
18932
  */
18423
- note?: string | null;
18933
+ parent?: string | null;
18424
18934
  /**
18425
- * Period
18935
+ * Weight
18426
18936
  *
18427
- * Period to reopen, in YYYY-MM. Only the latest closed period (the current `closed_through`) can be reopened, and reopening it retreats `closed_through` by one month. To reach an earlier period, reopen the later ones first, latest to earliest.
18937
+ * Set to make the line a term of its parent's total: `1` adds, `-1` subtracts. The total is then checked against its terms.
18428
18938
  */
18429
- period: string;
18939
+ weight?: number | null;
18430
18940
  };
18431
18941
  /**
18432
18942
  * ReportResponse
@@ -18565,6 +19075,12 @@ export type ReportResponse = {
18565
19075
  * When this report has been restated, the successor's report ID.
18566
19076
  */
18567
19077
  superseded_by_id?: string | null;
19078
+ /**
19079
+ * Origin
19080
+ *
19081
+ * 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.
19082
+ */
19083
+ origin?: string;
18568
19084
  /**
18569
19085
  * Source Graph Id
18570
19086
  *
@@ -18592,6 +19108,102 @@ export type ReportResponse = {
18592
19108
  [key: string]: number;
18593
19109
  } | null;
18594
19110
  };
19111
+ /**
19112
+ * ReportRowsInput
19113
+ *
19114
+ * A report as rows, for the server to assemble into a holon.
19115
+ */
19116
+ export type ReportRowsInput = {
19117
+ /**
19118
+ * Period End
19119
+ *
19120
+ * The last day the report covers.
19121
+ */
19122
+ period_end: string;
19123
+ /**
19124
+ * Kind
19125
+ *
19126
+ * What the report is, e.g. `monthly-package`, `quarterly-financials`. A later ingest for the same entity, period end and kind replaces this one.
19127
+ */
19128
+ kind?: string;
19129
+ /**
19130
+ * Attributed To
19131
+ *
19132
+ * Who or what read the values out of the source document.
19133
+ */
19134
+ attributed_to?: string | null;
19135
+ /**
19136
+ * Namespaces
19137
+ *
19138
+ * Prefix to namespace URI, for concept prefixes that are not a library's.
19139
+ */
19140
+ namespaces?: {
19141
+ [key: string]: string;
19142
+ };
19143
+ /**
19144
+ * Concepts
19145
+ *
19146
+ * 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.
19147
+ */
19148
+ concepts?: Array<ReportConceptRow>;
19149
+ /**
19150
+ * Labels
19151
+ *
19152
+ * 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.
19153
+ */
19154
+ labels?: {
19155
+ [key: string]: string;
19156
+ };
19157
+ /**
19158
+ * Sections
19159
+ *
19160
+ * The report's statements and tables.
19161
+ */
19162
+ sections?: Array<ReportSectionRow>;
19163
+ /**
19164
+ * Facts
19165
+ *
19166
+ * The values.
19167
+ */
19168
+ facts: Array<ReportFactRow>;
19169
+ };
19170
+ /**
19171
+ * ReportSectionRow
19172
+ *
19173
+ * A statement or a table of the report.
19174
+ */
19175
+ export type ReportSectionRow = {
19176
+ /**
19177
+ * Name
19178
+ *
19179
+ * The section's title, e.g. `Balance Sheet`.
19180
+ */
19181
+ name: string;
19182
+ /**
19183
+ * Block Type
19184
+ *
19185
+ * `balance_sheet`, `income_statement`, `cash_flow_statement` or `equity_statement` for a primary statement; omit for any other table.
19186
+ */
19187
+ block_type?: string | null;
19188
+ /**
19189
+ * Head
19190
+ *
19191
+ * 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.
19192
+ */
19193
+ head?: string | null;
19194
+ /**
19195
+ * Layout
19196
+ *
19197
+ * `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.
19198
+ */
19199
+ layout?: 'library' | 'given' | null;
19200
+ /**
19201
+ * Lines
19202
+ *
19203
+ * 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.
19204
+ */
19205
+ lines?: Array<ReportLineRow>;
19206
+ };
18595
19207
  /**
18596
19208
  * RepositoryInfo
18597
19209
  *
@@ -36072,3 +36684,121 @@ export type DeleteSecurityResponses = {
36072
36684
  200: OperationEnvelopeDeleteResult;
36073
36685
  };
36074
36686
  export type DeleteSecurityResponse = DeleteSecurityResponses[keyof DeleteSecurityResponses];
36687
+ export type CreateIssuerData = {
36688
+ body: CreateIssuerRequest;
36689
+ headers?: {
36690
+ /**
36691
+ * Idempotency-Key
36692
+ */
36693
+ 'Idempotency-Key'?: string | null;
36694
+ };
36695
+ path: {
36696
+ /**
36697
+ * Graph Id
36698
+ */
36699
+ graph_id: string;
36700
+ };
36701
+ query?: never;
36702
+ url: '/extensions/roboinvestor/{graph_id}/operations/create-issuer';
36703
+ };
36704
+ export type CreateIssuerErrors = {
36705
+ /**
36706
+ * Invalid request
36707
+ */
36708
+ 400: ErrorResponse;
36709
+ /**
36710
+ * Authentication required
36711
+ */
36712
+ 401: ErrorResponse;
36713
+ /**
36714
+ * Access denied
36715
+ */
36716
+ 403: ErrorResponse;
36717
+ /**
36718
+ * Resource not found
36719
+ */
36720
+ 404: ErrorResponse;
36721
+ /**
36722
+ * Idempotency-Key conflict — key reused with different body
36723
+ */
36724
+ 409: ErrorResponse;
36725
+ /**
36726
+ * Validation error
36727
+ */
36728
+ 422: ErrorResponse;
36729
+ /**
36730
+ * Rate limit exceeded
36731
+ */
36732
+ 429: ErrorResponse;
36733
+ /**
36734
+ * Internal server error
36735
+ */
36736
+ 500: ErrorResponse;
36737
+ };
36738
+ export type CreateIssuerError = CreateIssuerErrors[keyof CreateIssuerErrors];
36739
+ export type CreateIssuerResponses = {
36740
+ /**
36741
+ * Successful Response
36742
+ */
36743
+ 200: OperationEnvelopeIssuerResponse;
36744
+ };
36745
+ export type CreateIssuerResponse = CreateIssuerResponses[keyof CreateIssuerResponses];
36746
+ export type IngestReportData = {
36747
+ body: IngestReportRequest;
36748
+ headers?: {
36749
+ /**
36750
+ * Idempotency-Key
36751
+ */
36752
+ 'Idempotency-Key'?: string | null;
36753
+ };
36754
+ path: {
36755
+ /**
36756
+ * Graph Id
36757
+ */
36758
+ graph_id: string;
36759
+ };
36760
+ query?: never;
36761
+ url: '/extensions/roboinvestor/{graph_id}/operations/ingest-report';
36762
+ };
36763
+ export type IngestReportErrors = {
36764
+ /**
36765
+ * Invalid request
36766
+ */
36767
+ 400: ErrorResponse;
36768
+ /**
36769
+ * Authentication required
36770
+ */
36771
+ 401: ErrorResponse;
36772
+ /**
36773
+ * Access denied
36774
+ */
36775
+ 403: ErrorResponse;
36776
+ /**
36777
+ * Resource not found
36778
+ */
36779
+ 404: ErrorResponse;
36780
+ /**
36781
+ * Idempotency-Key conflict — key reused with different body
36782
+ */
36783
+ 409: ErrorResponse;
36784
+ /**
36785
+ * Validation error
36786
+ */
36787
+ 422: ErrorResponse;
36788
+ /**
36789
+ * Rate limit exceeded
36790
+ */
36791
+ 429: ErrorResponse;
36792
+ /**
36793
+ * Internal server error
36794
+ */
36795
+ 500: ErrorResponse;
36796
+ };
36797
+ export type IngestReportError = IngestReportErrors[keyof IngestReportErrors];
36798
+ export type IngestReportResponses = {
36799
+ /**
36800
+ * Successful Response
36801
+ */
36802
+ 200: OperationEnvelopeIngestReportResponse;
36803
+ };
36804
+ export type IngestReportResponse2 = IngestReportResponses[keyof IngestReportResponses];