@robosystems/client 2.4.0 → 2.5.1
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/artifacts/LedgerClient.d.ts +34 -1
- package/artifacts/LedgerClient.js +35 -0
- package/artifacts/LedgerClient.ts +79 -0
- package/artifacts/graphql/generated/graphql.d.ts +5 -0
- package/artifacts/graphql/generated/graphql.js +14 -0
- package/artifacts/graphql/generated/graphql.ts +19 -0
- package/artifacts/graphql/queries/ledger/eventBlocks.d.ts +2 -1
- package/artifacts/graphql/queries/ledger/eventBlocks.js +4 -1
- package/artifacts/graphql/queries/ledger/eventBlocks.ts +4 -1
- package/artifacts/graphql/queries/ledger/fiscalCalendar.js +4 -0
- package/artifacts/graphql/queries/ledger/fiscalCalendar.ts +4 -0
- package/index.ts +2 -2
- package/package.json +1 -1
- package/sdk/index.d.ts +2 -2
- package/sdk/index.js +7 -4
- package/sdk/index.ts +2 -2
- package/sdk/sdk.gen.d.ts +25 -1
- package/sdk/sdk.gen.js +53 -2
- package/sdk/sdk.gen.ts +52 -1
- package/sdk/types.gen.d.ts +697 -1
- package/sdk/types.gen.ts +759 -38
- package/sdk.gen.d.ts +25 -1
- package/sdk.gen.js +53 -2
- package/sdk.gen.ts +52 -1
- package/types.gen.d.ts +697 -1
- package/types.gen.ts +759 -38
package/types.gen.ts
CHANGED
|
@@ -4291,6 +4291,107 @@ export type DeleteTaxonomyBlockResponse = {
|
|
|
4291
4291
|
cascade_applied?: boolean;
|
|
4292
4292
|
};
|
|
4293
4293
|
|
|
4294
|
+
/**
|
|
4295
|
+
* DescribeFilingRequest
|
|
4296
|
+
*
|
|
4297
|
+
* Request for the describe-filing view op — how a filing is laid out.
|
|
4298
|
+
*/
|
|
4299
|
+
export type DescribeFilingRequest = {
|
|
4300
|
+
/**
|
|
4301
|
+
* Ticker
|
|
4302
|
+
*
|
|
4303
|
+
* Company ticker. On shared-repository graphs (SEC) it resolves the latest matching filing when report_id is not given; ignored on tenant graphs.
|
|
4304
|
+
*/
|
|
4305
|
+
ticker?: string | null;
|
|
4306
|
+
/**
|
|
4307
|
+
* Report Id
|
|
4308
|
+
*
|
|
4309
|
+
* Specific report identifier. Required on tenant graphs; on SEC, optional when ticker is given.
|
|
4310
|
+
*/
|
|
4311
|
+
report_id?: string | null;
|
|
4312
|
+
/**
|
|
4313
|
+
* Fiscal Year
|
|
4314
|
+
*
|
|
4315
|
+
* Narrow auto-resolution to this fiscal year focus
|
|
4316
|
+
*/
|
|
4317
|
+
fiscal_year?: number | null;
|
|
4318
|
+
/**
|
|
4319
|
+
* Period Type
|
|
4320
|
+
*
|
|
4321
|
+
* Which forms auto-resolution considers: annual (10-K / 20-F / 40-F, the default) or quarterly (10-Q as well)
|
|
4322
|
+
*/
|
|
4323
|
+
period_type?: string | null;
|
|
4324
|
+
/**
|
|
4325
|
+
* Accession
|
|
4326
|
+
*
|
|
4327
|
+
* SEC only, with ticker: one filing by accession number — a report, or an 8-K from resolved_report.recent_releases
|
|
4328
|
+
*/
|
|
4329
|
+
accession?: string | null;
|
|
4330
|
+
/**
|
|
4331
|
+
* Form
|
|
4332
|
+
*
|
|
4333
|
+
* SEC only, with ticker: '8-K' reads the latest earnings release
|
|
4334
|
+
*/
|
|
4335
|
+
form?: string | null;
|
|
4336
|
+
};
|
|
4337
|
+
|
|
4338
|
+
/**
|
|
4339
|
+
* DescribeFilingResponse
|
|
4340
|
+
*
|
|
4341
|
+
* The describe-filing view op's result: xbrlkit's layout of the filing.
|
|
4342
|
+
*/
|
|
4343
|
+
export type DescribeFilingResponse = {
|
|
4344
|
+
/**
|
|
4345
|
+
* Graph Id
|
|
4346
|
+
*/
|
|
4347
|
+
graph_id: string;
|
|
4348
|
+
/**
|
|
4349
|
+
* Report Id
|
|
4350
|
+
*/
|
|
4351
|
+
report_id?: string | null;
|
|
4352
|
+
/**
|
|
4353
|
+
* Accession
|
|
4354
|
+
*/
|
|
4355
|
+
accession?: string | null;
|
|
4356
|
+
/**
|
|
4357
|
+
* Resolved Report
|
|
4358
|
+
*/
|
|
4359
|
+
resolved_report?: {
|
|
4360
|
+
[key: string]: unknown;
|
|
4361
|
+
} | null;
|
|
4362
|
+
/**
|
|
4363
|
+
* Profile
|
|
4364
|
+
*/
|
|
4365
|
+
profile?: {
|
|
4366
|
+
[key: string]: unknown;
|
|
4367
|
+
} | null;
|
|
4368
|
+
/**
|
|
4369
|
+
* Filing
|
|
4370
|
+
*/
|
|
4371
|
+
filing?: {
|
|
4372
|
+
[key: string]: unknown;
|
|
4373
|
+
} | null;
|
|
4374
|
+
/**
|
|
4375
|
+
* Entity
|
|
4376
|
+
*/
|
|
4377
|
+
entity?: {
|
|
4378
|
+
[key: string]: unknown;
|
|
4379
|
+
} | null;
|
|
4380
|
+
/**
|
|
4381
|
+
* Counts
|
|
4382
|
+
*/
|
|
4383
|
+
counts?: {
|
|
4384
|
+
[key: string]: unknown;
|
|
4385
|
+
} | null;
|
|
4386
|
+
/**
|
|
4387
|
+
* Sections
|
|
4388
|
+
*/
|
|
4389
|
+
sections?: {
|
|
4390
|
+
[key: string]: unknown;
|
|
4391
|
+
} | null;
|
|
4392
|
+
[key: string]: unknown;
|
|
4393
|
+
};
|
|
4394
|
+
|
|
4294
4395
|
/**
|
|
4295
4396
|
* DetailedTransactionsResponse
|
|
4296
4397
|
*
|
|
@@ -5868,6 +5969,57 @@ export type FileUploadRequest = {
|
|
|
5868
5969
|
file_size_bytes?: number | null;
|
|
5869
5970
|
};
|
|
5870
5971
|
|
|
5972
|
+
/**
|
|
5973
|
+
* FilingLinks
|
|
5974
|
+
*
|
|
5975
|
+
* Where a filing on a shared repository is served.
|
|
5976
|
+
*/
|
|
5977
|
+
export type FilingLinks = {
|
|
5978
|
+
/**
|
|
5979
|
+
* Viewer
|
|
5980
|
+
*
|
|
5981
|
+
* The xbrlkit viewer over the published holon — the link to show the filing
|
|
5982
|
+
*/
|
|
5983
|
+
viewer?: string | null;
|
|
5984
|
+
/**
|
|
5985
|
+
* Holon
|
|
5986
|
+
*/
|
|
5987
|
+
holon?: string | null;
|
|
5988
|
+
/**
|
|
5989
|
+
* Tavi
|
|
5990
|
+
*/
|
|
5991
|
+
tavi?: string | null;
|
|
5992
|
+
/**
|
|
5993
|
+
* As Filed
|
|
5994
|
+
*
|
|
5995
|
+
* The primary document as filed
|
|
5996
|
+
*/
|
|
5997
|
+
as_filed?: string | null;
|
|
5998
|
+
/**
|
|
5999
|
+
* Exhibits
|
|
6000
|
+
*
|
|
6001
|
+
* An 8-K's exhibits by exhibit number (EX-99.1)
|
|
6002
|
+
*/
|
|
6003
|
+
exhibits?: {
|
|
6004
|
+
[key: string]: string;
|
|
6005
|
+
} | null;
|
|
6006
|
+
/**
|
|
6007
|
+
* Manifest
|
|
6008
|
+
*/
|
|
6009
|
+
manifest?: string | null;
|
|
6010
|
+
/**
|
|
6011
|
+
* Folder
|
|
6012
|
+
*/
|
|
6013
|
+
folder?: string | null;
|
|
6014
|
+
/**
|
|
6015
|
+
* Edgar
|
|
6016
|
+
*
|
|
6017
|
+
* The filing's folder on EDGAR
|
|
6018
|
+
*/
|
|
6019
|
+
edgar?: string | null;
|
|
6020
|
+
[key: string]: unknown;
|
|
6021
|
+
};
|
|
6022
|
+
|
|
5871
6023
|
/**
|
|
5872
6024
|
* FinancialStatementAnalysisRequest
|
|
5873
6025
|
*
|
|
@@ -10536,6 +10688,52 @@ export type OperationEnvelopeDeleteTaxonomyBlockResponse = {
|
|
|
10536
10688
|
idempotentReplay?: boolean;
|
|
10537
10689
|
};
|
|
10538
10690
|
|
|
10691
|
+
/**
|
|
10692
|
+
* OperationEnvelope[DescribeFilingResponse]
|
|
10693
|
+
*/
|
|
10694
|
+
export type OperationEnvelopeDescribeFilingResponse = {
|
|
10695
|
+
/**
|
|
10696
|
+
* Operation
|
|
10697
|
+
*
|
|
10698
|
+
* Kebab-case operation name
|
|
10699
|
+
*/
|
|
10700
|
+
operation: string;
|
|
10701
|
+
/**
|
|
10702
|
+
* Operationid
|
|
10703
|
+
*
|
|
10704
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
10705
|
+
*/
|
|
10706
|
+
operationId: string;
|
|
10707
|
+
/**
|
|
10708
|
+
* Status
|
|
10709
|
+
*
|
|
10710
|
+
* Operation lifecycle state
|
|
10711
|
+
*/
|
|
10712
|
+
status: 'completed' | 'pending' | 'failed';
|
|
10713
|
+
/**
|
|
10714
|
+
* Command-specific result payload
|
|
10715
|
+
*/
|
|
10716
|
+
result?: DescribeFilingResponse | null;
|
|
10717
|
+
/**
|
|
10718
|
+
* At
|
|
10719
|
+
*
|
|
10720
|
+
* ISO-8601 UTC timestamp
|
|
10721
|
+
*/
|
|
10722
|
+
at: string;
|
|
10723
|
+
/**
|
|
10724
|
+
* Createdby
|
|
10725
|
+
*
|
|
10726
|
+
* User ID that initiated the operation
|
|
10727
|
+
*/
|
|
10728
|
+
createdBy?: string | null;
|
|
10729
|
+
/**
|
|
10730
|
+
* Idempotentreplay
|
|
10731
|
+
*
|
|
10732
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
10733
|
+
*/
|
|
10734
|
+
idempotentReplay?: boolean;
|
|
10735
|
+
};
|
|
10736
|
+
|
|
10539
10737
|
/**
|
|
10540
10738
|
* OperationEnvelope[DisclosuresResponse]
|
|
10541
10739
|
*/
|
|
@@ -11502,6 +11700,52 @@ export type OperationEnvelopePublishListResponse = {
|
|
|
11502
11700
|
idempotentReplay?: boolean;
|
|
11503
11701
|
};
|
|
11504
11702
|
|
|
11703
|
+
/**
|
|
11704
|
+
* OperationEnvelope[ReadTextResponse]
|
|
11705
|
+
*/
|
|
11706
|
+
export type OperationEnvelopeReadTextResponse = {
|
|
11707
|
+
/**
|
|
11708
|
+
* Operation
|
|
11709
|
+
*
|
|
11710
|
+
* Kebab-case operation name
|
|
11711
|
+
*/
|
|
11712
|
+
operation: string;
|
|
11713
|
+
/**
|
|
11714
|
+
* Operationid
|
|
11715
|
+
*
|
|
11716
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
11717
|
+
*/
|
|
11718
|
+
operationId: string;
|
|
11719
|
+
/**
|
|
11720
|
+
* Status
|
|
11721
|
+
*
|
|
11722
|
+
* Operation lifecycle state
|
|
11723
|
+
*/
|
|
11724
|
+
status: 'completed' | 'pending' | 'failed';
|
|
11725
|
+
/**
|
|
11726
|
+
* Command-specific result payload
|
|
11727
|
+
*/
|
|
11728
|
+
result?: ReadTextResponse | null;
|
|
11729
|
+
/**
|
|
11730
|
+
* At
|
|
11731
|
+
*
|
|
11732
|
+
* ISO-8601 UTC timestamp
|
|
11733
|
+
*/
|
|
11734
|
+
at: string;
|
|
11735
|
+
/**
|
|
11736
|
+
* Createdby
|
|
11737
|
+
*
|
|
11738
|
+
* User ID that initiated the operation
|
|
11739
|
+
*/
|
|
11740
|
+
createdBy?: string | null;
|
|
11741
|
+
/**
|
|
11742
|
+
* Idempotentreplay
|
|
11743
|
+
*
|
|
11744
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
11745
|
+
*/
|
|
11746
|
+
idempotentReplay?: boolean;
|
|
11747
|
+
};
|
|
11748
|
+
|
|
11505
11749
|
/**
|
|
11506
11750
|
* OperationEnvelope[ReconciliationListResponse]
|
|
11507
11751
|
*/
|
|
@@ -11916,6 +12160,52 @@ export type OperationEnvelopeScheduleCreatedResponse = {
|
|
|
11916
12160
|
idempotentReplay?: boolean;
|
|
11917
12161
|
};
|
|
11918
12162
|
|
|
12163
|
+
/**
|
|
12164
|
+
* OperationEnvelope[SearchTextResponse]
|
|
12165
|
+
*/
|
|
12166
|
+
export type OperationEnvelopeSearchTextResponse = {
|
|
12167
|
+
/**
|
|
12168
|
+
* Operation
|
|
12169
|
+
*
|
|
12170
|
+
* Kebab-case operation name
|
|
12171
|
+
*/
|
|
12172
|
+
operation: string;
|
|
12173
|
+
/**
|
|
12174
|
+
* Operationid
|
|
12175
|
+
*
|
|
12176
|
+
* op_-prefixed ULID for audit and SSE correlation
|
|
12177
|
+
*/
|
|
12178
|
+
operationId: string;
|
|
12179
|
+
/**
|
|
12180
|
+
* Status
|
|
12181
|
+
*
|
|
12182
|
+
* Operation lifecycle state
|
|
12183
|
+
*/
|
|
12184
|
+
status: 'completed' | 'pending' | 'failed';
|
|
12185
|
+
/**
|
|
12186
|
+
* Command-specific result payload
|
|
12187
|
+
*/
|
|
12188
|
+
result?: SearchTextResponse | null;
|
|
12189
|
+
/**
|
|
12190
|
+
* At
|
|
12191
|
+
*
|
|
12192
|
+
* ISO-8601 UTC timestamp
|
|
12193
|
+
*/
|
|
12194
|
+
at: string;
|
|
12195
|
+
/**
|
|
12196
|
+
* Createdby
|
|
12197
|
+
*
|
|
12198
|
+
* User ID that initiated the operation
|
|
12199
|
+
*/
|
|
12200
|
+
createdBy?: string | null;
|
|
12201
|
+
/**
|
|
12202
|
+
* Idempotentreplay
|
|
12203
|
+
*
|
|
12204
|
+
* True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
|
|
12205
|
+
*/
|
|
12206
|
+
idempotentReplay?: boolean;
|
|
12207
|
+
};
|
|
12208
|
+
|
|
11919
12209
|
/**
|
|
11920
12210
|
* OperationEnvelope[SecurityResponse]
|
|
11921
12211
|
*/
|
|
@@ -14007,6 +14297,113 @@ export type RateLimits = {
|
|
|
14007
14297
|
burst_capacity: number;
|
|
14008
14298
|
};
|
|
14009
14299
|
|
|
14300
|
+
/**
|
|
14301
|
+
* ReadTextRequest
|
|
14302
|
+
*
|
|
14303
|
+
* Request for the read-text view op — a window of one filing's text.
|
|
14304
|
+
*/
|
|
14305
|
+
export type ReadTextRequest = {
|
|
14306
|
+
/**
|
|
14307
|
+
* Ticker
|
|
14308
|
+
*
|
|
14309
|
+
* Company ticker. On shared-repository graphs (SEC) it resolves the latest matching filing when report_id is not given; ignored on tenant graphs.
|
|
14310
|
+
*/
|
|
14311
|
+
ticker?: string | null;
|
|
14312
|
+
/**
|
|
14313
|
+
* Report Id
|
|
14314
|
+
*
|
|
14315
|
+
* Specific report identifier. Required on tenant graphs; on SEC, optional when ticker is given.
|
|
14316
|
+
*/
|
|
14317
|
+
report_id?: string | null;
|
|
14318
|
+
/**
|
|
14319
|
+
* Fiscal Year
|
|
14320
|
+
*
|
|
14321
|
+
* Narrow auto-resolution to this fiscal year focus
|
|
14322
|
+
*/
|
|
14323
|
+
fiscal_year?: number | null;
|
|
14324
|
+
/**
|
|
14325
|
+
* Period Type
|
|
14326
|
+
*
|
|
14327
|
+
* Which forms auto-resolution considers: annual (10-K / 20-F / 40-F, the default) or quarterly (10-Q as well)
|
|
14328
|
+
*/
|
|
14329
|
+
period_type?: string | null;
|
|
14330
|
+
/**
|
|
14331
|
+
* Accession
|
|
14332
|
+
*
|
|
14333
|
+
* SEC only, with ticker: one filing by accession number — a report, or an 8-K from resolved_report.recent_releases
|
|
14334
|
+
*/
|
|
14335
|
+
accession?: string | null;
|
|
14336
|
+
/**
|
|
14337
|
+
* Form
|
|
14338
|
+
*
|
|
14339
|
+
* SEC only, with ticker: '8-K' reads the latest earnings release
|
|
14340
|
+
*/
|
|
14341
|
+
form?: string | null;
|
|
14342
|
+
/**
|
|
14343
|
+
* Offset
|
|
14344
|
+
*
|
|
14345
|
+
* Character offset to start from
|
|
14346
|
+
*/
|
|
14347
|
+
offset?: number;
|
|
14348
|
+
/**
|
|
14349
|
+
* Length
|
|
14350
|
+
*
|
|
14351
|
+
* Characters to return (default 4000)
|
|
14352
|
+
*/
|
|
14353
|
+
length?: number | null;
|
|
14354
|
+
};
|
|
14355
|
+
|
|
14356
|
+
/**
|
|
14357
|
+
* ReadTextResponse
|
|
14358
|
+
*
|
|
14359
|
+
* The read-text view op's result: one window of the filing's text.
|
|
14360
|
+
*/
|
|
14361
|
+
export type ReadTextResponse = {
|
|
14362
|
+
/**
|
|
14363
|
+
* Graph Id
|
|
14364
|
+
*/
|
|
14365
|
+
graph_id: string;
|
|
14366
|
+
/**
|
|
14367
|
+
* Report Id
|
|
14368
|
+
*/
|
|
14369
|
+
report_id?: string | null;
|
|
14370
|
+
/**
|
|
14371
|
+
* Accession
|
|
14372
|
+
*/
|
|
14373
|
+
accession?: string | null;
|
|
14374
|
+
/**
|
|
14375
|
+
* Resolved Report
|
|
14376
|
+
*/
|
|
14377
|
+
resolved_report?: {
|
|
14378
|
+
[key: string]: unknown;
|
|
14379
|
+
} | null;
|
|
14380
|
+
/**
|
|
14381
|
+
* Offset
|
|
14382
|
+
*/
|
|
14383
|
+
offset: number;
|
|
14384
|
+
/**
|
|
14385
|
+
* Length
|
|
14386
|
+
*/
|
|
14387
|
+
length: number;
|
|
14388
|
+
/**
|
|
14389
|
+
* Text
|
|
14390
|
+
*/
|
|
14391
|
+
text: string;
|
|
14392
|
+
/**
|
|
14393
|
+
* Text Chars
|
|
14394
|
+
*/
|
|
14395
|
+
text_chars: number;
|
|
14396
|
+
/**
|
|
14397
|
+
* Next Offset
|
|
14398
|
+
*/
|
|
14399
|
+
next_offset?: number | null;
|
|
14400
|
+
/**
|
|
14401
|
+
* Section
|
|
14402
|
+
*/
|
|
14403
|
+
section?: string | null;
|
|
14404
|
+
[key: string]: unknown;
|
|
14405
|
+
};
|
|
14406
|
+
|
|
14010
14407
|
/**
|
|
14011
14408
|
* RebuildScheduleRequest
|
|
14012
14409
|
*
|
|
@@ -15521,6 +15918,7 @@ export type ResolvedReportInfo = {
|
|
|
15521
15918
|
* Fiscal Period
|
|
15522
15919
|
*/
|
|
15523
15920
|
fiscal_period?: string | null;
|
|
15921
|
+
links?: FilingLinks | null;
|
|
15524
15922
|
};
|
|
15525
15923
|
|
|
15526
15924
|
/**
|
|
@@ -16248,85 +16646,216 @@ export type SearchRequest = {
|
|
|
16248
16646
|
*/
|
|
16249
16647
|
element?: string | null;
|
|
16250
16648
|
/**
|
|
16251
|
-
* Source Type
|
|
16649
|
+
* Source Type
|
|
16650
|
+
*
|
|
16651
|
+
* Filter by source type (xbrl_textblock, narrative_section, ixbrl_disclosure, uploaded_doc, connection_doc)
|
|
16652
|
+
*/
|
|
16653
|
+
source_type?: string | null;
|
|
16654
|
+
/**
|
|
16655
|
+
* Fiscal Year
|
|
16656
|
+
*
|
|
16657
|
+
* Filter by fiscal year
|
|
16658
|
+
*/
|
|
16659
|
+
fiscal_year?: number | null;
|
|
16660
|
+
/**
|
|
16661
|
+
* Date From
|
|
16662
|
+
*
|
|
16663
|
+
* Filter filings on or after date (YYYY-MM-DD)
|
|
16664
|
+
*/
|
|
16665
|
+
date_from?: string | null;
|
|
16666
|
+
/**
|
|
16667
|
+
* Date To
|
|
16668
|
+
*
|
|
16669
|
+
* Filter filings on or before date (YYYY-MM-DD)
|
|
16670
|
+
*/
|
|
16671
|
+
date_to?: string | null;
|
|
16672
|
+
/**
|
|
16673
|
+
* Semantic
|
|
16674
|
+
*
|
|
16675
|
+
* Enable hybrid semantic search (BM25 + KNN). Default is BM25-only for speed.
|
|
16676
|
+
*/
|
|
16677
|
+
semantic?: boolean;
|
|
16678
|
+
/**
|
|
16679
|
+
* Group
|
|
16680
|
+
*
|
|
16681
|
+
* Fold hits from successive filings of the same filer and section into the best-ranked one; also_in_filings counts the others. Ignored when entity is set, where a filer's filing history is the point. A grouped page is drawn from the first 100 hits.
|
|
16682
|
+
*/
|
|
16683
|
+
group?: boolean;
|
|
16684
|
+
/**
|
|
16685
|
+
* Size
|
|
16686
|
+
*
|
|
16687
|
+
* Max results to return
|
|
16688
|
+
*/
|
|
16689
|
+
size?: number;
|
|
16690
|
+
/**
|
|
16691
|
+
* Offset
|
|
16692
|
+
*
|
|
16693
|
+
* Pagination offset
|
|
16694
|
+
*/
|
|
16695
|
+
offset?: number;
|
|
16696
|
+
/**
|
|
16697
|
+
* Snippet Chars
|
|
16698
|
+
*
|
|
16699
|
+
* Approximate snippet budget per hit in characters; the default is three highlight fragments of about 200
|
|
16700
|
+
*/
|
|
16701
|
+
snippet_chars?: number | null;
|
|
16702
|
+
};
|
|
16703
|
+
|
|
16704
|
+
/**
|
|
16705
|
+
* SearchResponse
|
|
16706
|
+
*
|
|
16707
|
+
* Response model for document search.
|
|
16708
|
+
*/
|
|
16709
|
+
export type SearchResponse = {
|
|
16710
|
+
/**
|
|
16711
|
+
* Total
|
|
16712
|
+
*
|
|
16713
|
+
* Matching documents before any grouping, as OpenSearch counts them (it stops counting at 10,000). Not the number of distinct results a grouped search can page through.
|
|
16714
|
+
*/
|
|
16715
|
+
total: number;
|
|
16716
|
+
/**
|
|
16717
|
+
* Hits
|
|
16718
|
+
*/
|
|
16719
|
+
hits: Array<SearchHit>;
|
|
16720
|
+
/**
|
|
16721
|
+
* Query
|
|
16722
|
+
*/
|
|
16723
|
+
query: string;
|
|
16724
|
+
/**
|
|
16725
|
+
* Graph Id
|
|
16726
|
+
*/
|
|
16727
|
+
graph_id: string;
|
|
16728
|
+
};
|
|
16729
|
+
|
|
16730
|
+
/**
|
|
16731
|
+
* SearchTextRequest
|
|
16732
|
+
*
|
|
16733
|
+
* Request for the search-text view op — words inside one filing.
|
|
16734
|
+
*/
|
|
16735
|
+
export type SearchTextRequest = {
|
|
16736
|
+
/**
|
|
16737
|
+
* Ticker
|
|
16738
|
+
*
|
|
16739
|
+
* Company ticker. On shared-repository graphs (SEC) it resolves the latest matching filing when report_id is not given; ignored on tenant graphs.
|
|
16740
|
+
*/
|
|
16741
|
+
ticker?: string | null;
|
|
16742
|
+
/**
|
|
16743
|
+
* Report Id
|
|
16252
16744
|
*
|
|
16253
|
-
*
|
|
16745
|
+
* Specific report identifier. Required on tenant graphs; on SEC, optional when ticker is given.
|
|
16254
16746
|
*/
|
|
16255
|
-
|
|
16747
|
+
report_id?: string | null;
|
|
16256
16748
|
/**
|
|
16257
16749
|
* Fiscal Year
|
|
16258
16750
|
*
|
|
16259
|
-
*
|
|
16751
|
+
* Narrow auto-resolution to this fiscal year focus
|
|
16260
16752
|
*/
|
|
16261
16753
|
fiscal_year?: number | null;
|
|
16262
16754
|
/**
|
|
16263
|
-
*
|
|
16264
|
-
*
|
|
16265
|
-
* Filter filings on or after date (YYYY-MM-DD)
|
|
16266
|
-
*/
|
|
16267
|
-
date_from?: string | null;
|
|
16268
|
-
/**
|
|
16269
|
-
* Date To
|
|
16755
|
+
* Period Type
|
|
16270
16756
|
*
|
|
16271
|
-
*
|
|
16757
|
+
* Which forms auto-resolution considers: annual (10-K / 20-F / 40-F, the default) or quarterly (10-Q as well)
|
|
16272
16758
|
*/
|
|
16273
|
-
|
|
16759
|
+
period_type?: string | null;
|
|
16274
16760
|
/**
|
|
16275
|
-
*
|
|
16761
|
+
* Accession
|
|
16276
16762
|
*
|
|
16277
|
-
*
|
|
16763
|
+
* SEC only, with ticker: one filing by accession number — a report, or an 8-K from resolved_report.recent_releases
|
|
16278
16764
|
*/
|
|
16279
|
-
|
|
16765
|
+
accession?: string | null;
|
|
16280
16766
|
/**
|
|
16281
|
-
*
|
|
16767
|
+
* Form
|
|
16282
16768
|
*
|
|
16283
|
-
*
|
|
16769
|
+
* SEC only, with ticker: '8-K' reads the latest earnings release
|
|
16284
16770
|
*/
|
|
16285
|
-
|
|
16771
|
+
form?: string | null;
|
|
16286
16772
|
/**
|
|
16287
|
-
*
|
|
16773
|
+
* Query
|
|
16288
16774
|
*
|
|
16289
|
-
*
|
|
16775
|
+
* Words matched in order across any spacing, case-insensitive; `|` between alternative phrases, a trailing `*` for a stem. Not a regular expression.
|
|
16290
16776
|
*/
|
|
16291
|
-
|
|
16777
|
+
query: string;
|
|
16292
16778
|
/**
|
|
16293
|
-
*
|
|
16779
|
+
* Window
|
|
16294
16780
|
*
|
|
16295
|
-
*
|
|
16781
|
+
* Characters of context around each match (default 300)
|
|
16296
16782
|
*/
|
|
16297
|
-
|
|
16783
|
+
window?: number | null;
|
|
16298
16784
|
/**
|
|
16299
|
-
*
|
|
16785
|
+
* Max Hits
|
|
16300
16786
|
*
|
|
16301
|
-
*
|
|
16787
|
+
* Matches to return (default 10)
|
|
16302
16788
|
*/
|
|
16303
|
-
|
|
16789
|
+
max_hits?: number | null;
|
|
16304
16790
|
};
|
|
16305
16791
|
|
|
16306
16792
|
/**
|
|
16307
|
-
*
|
|
16793
|
+
* SearchTextResponse
|
|
16308
16794
|
*
|
|
16309
|
-
*
|
|
16795
|
+
* The search-text view op's result: matches in document order.
|
|
16310
16796
|
*/
|
|
16311
|
-
export type
|
|
16797
|
+
export type SearchTextResponse = {
|
|
16798
|
+
/**
|
|
16799
|
+
* Graph Id
|
|
16800
|
+
*/
|
|
16801
|
+
graph_id: string;
|
|
16802
|
+
/**
|
|
16803
|
+
* Report Id
|
|
16804
|
+
*/
|
|
16805
|
+
report_id?: string | null;
|
|
16806
|
+
/**
|
|
16807
|
+
* Accession
|
|
16808
|
+
*/
|
|
16809
|
+
accession?: string | null;
|
|
16810
|
+
/**
|
|
16811
|
+
* Resolved Report
|
|
16812
|
+
*/
|
|
16813
|
+
resolved_report?: {
|
|
16814
|
+
[key: string]: unknown;
|
|
16815
|
+
} | null;
|
|
16816
|
+
/**
|
|
16817
|
+
* Query
|
|
16818
|
+
*/
|
|
16819
|
+
query: string;
|
|
16312
16820
|
/**
|
|
16313
16821
|
* Total
|
|
16314
|
-
*
|
|
16315
|
-
* Matching documents before any grouping, as OpenSearch counts them (it stops counting at 10,000). Not the number of distinct results a grouped search can page through.
|
|
16316
16822
|
*/
|
|
16317
16823
|
total: number;
|
|
16318
16824
|
/**
|
|
16319
16825
|
* Hits
|
|
16320
16826
|
*/
|
|
16321
|
-
hits
|
|
16827
|
+
hits?: Array<{
|
|
16828
|
+
[key: string]: unknown;
|
|
16829
|
+
}>;
|
|
16322
16830
|
/**
|
|
16323
|
-
*
|
|
16831
|
+
* Text Chars
|
|
16324
16832
|
*/
|
|
16325
|
-
|
|
16833
|
+
text_chars: number;
|
|
16326
16834
|
/**
|
|
16327
|
-
*
|
|
16835
|
+
* Text
|
|
16328
16836
|
*/
|
|
16329
|
-
|
|
16837
|
+
text?: string | null;
|
|
16838
|
+
/**
|
|
16839
|
+
* Sections
|
|
16840
|
+
*/
|
|
16841
|
+
sections?: Array<{
|
|
16842
|
+
[key: string]: unknown;
|
|
16843
|
+
}> | null;
|
|
16844
|
+
/**
|
|
16845
|
+
* Sections Omitted
|
|
16846
|
+
*/
|
|
16847
|
+
sections_omitted?: number | null;
|
|
16848
|
+
/**
|
|
16849
|
+
* Terms
|
|
16850
|
+
*/
|
|
16851
|
+
terms?: Array<{
|
|
16852
|
+
[key: string]: unknown;
|
|
16853
|
+
}> | null;
|
|
16854
|
+
/**
|
|
16855
|
+
* Note
|
|
16856
|
+
*/
|
|
16857
|
+
note?: string | null;
|
|
16858
|
+
[key: string]: unknown;
|
|
16330
16859
|
};
|
|
16331
16860
|
|
|
16332
16861
|
/**
|
|
@@ -31322,6 +31851,198 @@ export type InformationBlockResponses = {
|
|
|
31322
31851
|
|
|
31323
31852
|
export type InformationBlockResponse2 = InformationBlockResponses[keyof InformationBlockResponses];
|
|
31324
31853
|
|
|
31854
|
+
export type DescribeFilingData = {
|
|
31855
|
+
body: DescribeFilingRequest;
|
|
31856
|
+
headers?: {
|
|
31857
|
+
/**
|
|
31858
|
+
* Idempotency-Key
|
|
31859
|
+
*/
|
|
31860
|
+
'Idempotency-Key'?: string | null;
|
|
31861
|
+
};
|
|
31862
|
+
path: {
|
|
31863
|
+
/**
|
|
31864
|
+
* Graph Id
|
|
31865
|
+
*/
|
|
31866
|
+
graph_id: string;
|
|
31867
|
+
};
|
|
31868
|
+
query?: never;
|
|
31869
|
+
url: '/extensions/roboledger/{graph_id}/operations/describe-filing';
|
|
31870
|
+
};
|
|
31871
|
+
|
|
31872
|
+
export type DescribeFilingErrors = {
|
|
31873
|
+
/**
|
|
31874
|
+
* Invalid request
|
|
31875
|
+
*/
|
|
31876
|
+
400: ErrorResponse;
|
|
31877
|
+
/**
|
|
31878
|
+
* Authentication required
|
|
31879
|
+
*/
|
|
31880
|
+
401: ErrorResponse;
|
|
31881
|
+
/**
|
|
31882
|
+
* Access denied
|
|
31883
|
+
*/
|
|
31884
|
+
403: ErrorResponse;
|
|
31885
|
+
/**
|
|
31886
|
+
* Resource not found
|
|
31887
|
+
*/
|
|
31888
|
+
404: ErrorResponse;
|
|
31889
|
+
/**
|
|
31890
|
+
* Idempotency-Key conflict — key reused with different body
|
|
31891
|
+
*/
|
|
31892
|
+
409: ErrorResponse;
|
|
31893
|
+
/**
|
|
31894
|
+
* Validation error
|
|
31895
|
+
*/
|
|
31896
|
+
422: ErrorResponse;
|
|
31897
|
+
/**
|
|
31898
|
+
* Rate limit exceeded
|
|
31899
|
+
*/
|
|
31900
|
+
429: ErrorResponse;
|
|
31901
|
+
/**
|
|
31902
|
+
* Internal server error
|
|
31903
|
+
*/
|
|
31904
|
+
500: ErrorResponse;
|
|
31905
|
+
};
|
|
31906
|
+
|
|
31907
|
+
export type DescribeFilingError = DescribeFilingErrors[keyof DescribeFilingErrors];
|
|
31908
|
+
|
|
31909
|
+
export type DescribeFilingResponses = {
|
|
31910
|
+
/**
|
|
31911
|
+
* Successful Response
|
|
31912
|
+
*/
|
|
31913
|
+
200: OperationEnvelopeDescribeFilingResponse;
|
|
31914
|
+
};
|
|
31915
|
+
|
|
31916
|
+
export type DescribeFilingResponse2 = DescribeFilingResponses[keyof DescribeFilingResponses];
|
|
31917
|
+
|
|
31918
|
+
export type SearchTextData = {
|
|
31919
|
+
body: SearchTextRequest;
|
|
31920
|
+
headers?: {
|
|
31921
|
+
/**
|
|
31922
|
+
* Idempotency-Key
|
|
31923
|
+
*/
|
|
31924
|
+
'Idempotency-Key'?: string | null;
|
|
31925
|
+
};
|
|
31926
|
+
path: {
|
|
31927
|
+
/**
|
|
31928
|
+
* Graph Id
|
|
31929
|
+
*/
|
|
31930
|
+
graph_id: string;
|
|
31931
|
+
};
|
|
31932
|
+
query?: never;
|
|
31933
|
+
url: '/extensions/roboledger/{graph_id}/operations/search-text';
|
|
31934
|
+
};
|
|
31935
|
+
|
|
31936
|
+
export type SearchTextErrors = {
|
|
31937
|
+
/**
|
|
31938
|
+
* Invalid request
|
|
31939
|
+
*/
|
|
31940
|
+
400: ErrorResponse;
|
|
31941
|
+
/**
|
|
31942
|
+
* Authentication required
|
|
31943
|
+
*/
|
|
31944
|
+
401: ErrorResponse;
|
|
31945
|
+
/**
|
|
31946
|
+
* Access denied
|
|
31947
|
+
*/
|
|
31948
|
+
403: ErrorResponse;
|
|
31949
|
+
/**
|
|
31950
|
+
* Resource not found
|
|
31951
|
+
*/
|
|
31952
|
+
404: ErrorResponse;
|
|
31953
|
+
/**
|
|
31954
|
+
* Idempotency-Key conflict — key reused with different body
|
|
31955
|
+
*/
|
|
31956
|
+
409: ErrorResponse;
|
|
31957
|
+
/**
|
|
31958
|
+
* Validation error
|
|
31959
|
+
*/
|
|
31960
|
+
422: ErrorResponse;
|
|
31961
|
+
/**
|
|
31962
|
+
* Rate limit exceeded
|
|
31963
|
+
*/
|
|
31964
|
+
429: ErrorResponse;
|
|
31965
|
+
/**
|
|
31966
|
+
* Internal server error
|
|
31967
|
+
*/
|
|
31968
|
+
500: ErrorResponse;
|
|
31969
|
+
};
|
|
31970
|
+
|
|
31971
|
+
export type SearchTextError = SearchTextErrors[keyof SearchTextErrors];
|
|
31972
|
+
|
|
31973
|
+
export type SearchTextResponses = {
|
|
31974
|
+
/**
|
|
31975
|
+
* Successful Response
|
|
31976
|
+
*/
|
|
31977
|
+
200: OperationEnvelopeSearchTextResponse;
|
|
31978
|
+
};
|
|
31979
|
+
|
|
31980
|
+
export type SearchTextResponse2 = SearchTextResponses[keyof SearchTextResponses];
|
|
31981
|
+
|
|
31982
|
+
export type ReadTextData = {
|
|
31983
|
+
body: ReadTextRequest;
|
|
31984
|
+
headers?: {
|
|
31985
|
+
/**
|
|
31986
|
+
* Idempotency-Key
|
|
31987
|
+
*/
|
|
31988
|
+
'Idempotency-Key'?: string | null;
|
|
31989
|
+
};
|
|
31990
|
+
path: {
|
|
31991
|
+
/**
|
|
31992
|
+
* Graph Id
|
|
31993
|
+
*/
|
|
31994
|
+
graph_id: string;
|
|
31995
|
+
};
|
|
31996
|
+
query?: never;
|
|
31997
|
+
url: '/extensions/roboledger/{graph_id}/operations/read-text';
|
|
31998
|
+
};
|
|
31999
|
+
|
|
32000
|
+
export type ReadTextErrors = {
|
|
32001
|
+
/**
|
|
32002
|
+
* Invalid request
|
|
32003
|
+
*/
|
|
32004
|
+
400: ErrorResponse;
|
|
32005
|
+
/**
|
|
32006
|
+
* Authentication required
|
|
32007
|
+
*/
|
|
32008
|
+
401: ErrorResponse;
|
|
32009
|
+
/**
|
|
32010
|
+
* Access denied
|
|
32011
|
+
*/
|
|
32012
|
+
403: ErrorResponse;
|
|
32013
|
+
/**
|
|
32014
|
+
* Resource not found
|
|
32015
|
+
*/
|
|
32016
|
+
404: ErrorResponse;
|
|
32017
|
+
/**
|
|
32018
|
+
* Idempotency-Key conflict — key reused with different body
|
|
32019
|
+
*/
|
|
32020
|
+
409: ErrorResponse;
|
|
32021
|
+
/**
|
|
32022
|
+
* Validation error
|
|
32023
|
+
*/
|
|
32024
|
+
422: ErrorResponse;
|
|
32025
|
+
/**
|
|
32026
|
+
* Rate limit exceeded
|
|
32027
|
+
*/
|
|
32028
|
+
429: ErrorResponse;
|
|
32029
|
+
/**
|
|
32030
|
+
* Internal server error
|
|
32031
|
+
*/
|
|
32032
|
+
500: ErrorResponse;
|
|
32033
|
+
};
|
|
32034
|
+
|
|
32035
|
+
export type ReadTextError = ReadTextErrors[keyof ReadTextErrors];
|
|
32036
|
+
|
|
32037
|
+
export type ReadTextResponses = {
|
|
32038
|
+
/**
|
|
32039
|
+
* Successful Response
|
|
32040
|
+
*/
|
|
32041
|
+
200: OperationEnvelopeReadTextResponse;
|
|
32042
|
+
};
|
|
32043
|
+
|
|
32044
|
+
export type ReadTextResponse2 = ReadTextResponses[keyof ReadTextResponses];
|
|
32045
|
+
|
|
31325
32046
|
export type LiveFinancialStatementData = {
|
|
31326
32047
|
body: LiveFinancialStatementRequest;
|
|
31327
32048
|
headers?: {
|