@robosystems/client 2.5.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/types.gen.d.ts CHANGED
@@ -4182,6 +4182,105 @@ export type DeleteTaxonomyBlockResponse = {
4182
4182
  */
4183
4183
  cascade_applied?: boolean;
4184
4184
  };
4185
+ /**
4186
+ * DescribeFilingRequest
4187
+ *
4188
+ * Request for the describe-filing view op — how a filing is laid out.
4189
+ */
4190
+ export type DescribeFilingRequest = {
4191
+ /**
4192
+ * Ticker
4193
+ *
4194
+ * Company ticker. On shared-repository graphs (SEC) it resolves the latest matching filing when report_id is not given; ignored on tenant graphs.
4195
+ */
4196
+ ticker?: string | null;
4197
+ /**
4198
+ * Report Id
4199
+ *
4200
+ * Specific report identifier. Required on tenant graphs; on SEC, optional when ticker is given.
4201
+ */
4202
+ report_id?: string | null;
4203
+ /**
4204
+ * Fiscal Year
4205
+ *
4206
+ * Narrow auto-resolution to this fiscal year focus
4207
+ */
4208
+ fiscal_year?: number | null;
4209
+ /**
4210
+ * Period Type
4211
+ *
4212
+ * Which forms auto-resolution considers: annual (10-K / 20-F / 40-F, the default) or quarterly (10-Q as well)
4213
+ */
4214
+ period_type?: string | null;
4215
+ /**
4216
+ * Accession
4217
+ *
4218
+ * SEC only, with ticker: one filing by accession number — a report, or an 8-K from resolved_report.recent_releases
4219
+ */
4220
+ accession?: string | null;
4221
+ /**
4222
+ * Form
4223
+ *
4224
+ * SEC only, with ticker: '8-K' reads the latest earnings release
4225
+ */
4226
+ form?: string | null;
4227
+ };
4228
+ /**
4229
+ * DescribeFilingResponse
4230
+ *
4231
+ * The describe-filing view op's result: xbrlkit's layout of the filing.
4232
+ */
4233
+ export type DescribeFilingResponse = {
4234
+ /**
4235
+ * Graph Id
4236
+ */
4237
+ graph_id: string;
4238
+ /**
4239
+ * Report Id
4240
+ */
4241
+ report_id?: string | null;
4242
+ /**
4243
+ * Accession
4244
+ */
4245
+ accession?: string | null;
4246
+ /**
4247
+ * Resolved Report
4248
+ */
4249
+ resolved_report?: {
4250
+ [key: string]: unknown;
4251
+ } | null;
4252
+ /**
4253
+ * Profile
4254
+ */
4255
+ profile?: {
4256
+ [key: string]: unknown;
4257
+ } | null;
4258
+ /**
4259
+ * Filing
4260
+ */
4261
+ filing?: {
4262
+ [key: string]: unknown;
4263
+ } | null;
4264
+ /**
4265
+ * Entity
4266
+ */
4267
+ entity?: {
4268
+ [key: string]: unknown;
4269
+ } | null;
4270
+ /**
4271
+ * Counts
4272
+ */
4273
+ counts?: {
4274
+ [key: string]: unknown;
4275
+ } | null;
4276
+ /**
4277
+ * Sections
4278
+ */
4279
+ sections?: {
4280
+ [key: string]: unknown;
4281
+ } | null;
4282
+ [key: string]: unknown;
4283
+ };
4185
4284
  /**
4186
4285
  * DetailedTransactionsResponse
4187
4286
  *
@@ -5724,6 +5823,56 @@ export type FileUploadRequest = {
5724
5823
  */
5725
5824
  file_size_bytes?: number | null;
5726
5825
  };
5826
+ /**
5827
+ * FilingLinks
5828
+ *
5829
+ * Where a filing on a shared repository is served.
5830
+ */
5831
+ export type FilingLinks = {
5832
+ /**
5833
+ * Viewer
5834
+ *
5835
+ * The xbrlkit viewer over the published holon — the link to show the filing
5836
+ */
5837
+ viewer?: string | null;
5838
+ /**
5839
+ * Holon
5840
+ */
5841
+ holon?: string | null;
5842
+ /**
5843
+ * Tavi
5844
+ */
5845
+ tavi?: string | null;
5846
+ /**
5847
+ * As Filed
5848
+ *
5849
+ * The primary document as filed
5850
+ */
5851
+ as_filed?: string | null;
5852
+ /**
5853
+ * Exhibits
5854
+ *
5855
+ * An 8-K's exhibits by exhibit number (EX-99.1)
5856
+ */
5857
+ exhibits?: {
5858
+ [key: string]: string;
5859
+ } | null;
5860
+ /**
5861
+ * Manifest
5862
+ */
5863
+ manifest?: string | null;
5864
+ /**
5865
+ * Folder
5866
+ */
5867
+ folder?: string | null;
5868
+ /**
5869
+ * Edgar
5870
+ *
5871
+ * The filing's folder on EDGAR
5872
+ */
5873
+ edgar?: string | null;
5874
+ [key: string]: unknown;
5875
+ };
5727
5876
  /**
5728
5877
  * FinancialStatementAnalysisRequest
5729
5878
  *
@@ -10292,6 +10441,51 @@ export type OperationEnvelopeDeleteTaxonomyBlockResponse = {
10292
10441
  */
10293
10442
  idempotentReplay?: boolean;
10294
10443
  };
10444
+ /**
10445
+ * OperationEnvelope[DescribeFilingResponse]
10446
+ */
10447
+ export type OperationEnvelopeDescribeFilingResponse = {
10448
+ /**
10449
+ * Operation
10450
+ *
10451
+ * Kebab-case operation name
10452
+ */
10453
+ operation: string;
10454
+ /**
10455
+ * Operationid
10456
+ *
10457
+ * op_-prefixed ULID for audit and SSE correlation
10458
+ */
10459
+ operationId: string;
10460
+ /**
10461
+ * Status
10462
+ *
10463
+ * Operation lifecycle state
10464
+ */
10465
+ status: 'completed' | 'pending' | 'failed';
10466
+ /**
10467
+ * Command-specific result payload
10468
+ */
10469
+ result?: DescribeFilingResponse | null;
10470
+ /**
10471
+ * At
10472
+ *
10473
+ * ISO-8601 UTC timestamp
10474
+ */
10475
+ at: string;
10476
+ /**
10477
+ * Createdby
10478
+ *
10479
+ * User ID that initiated the operation
10480
+ */
10481
+ createdBy?: string | null;
10482
+ /**
10483
+ * Idempotentreplay
10484
+ *
10485
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
10486
+ */
10487
+ idempotentReplay?: boolean;
10488
+ };
10295
10489
  /**
10296
10490
  * OperationEnvelope[DisclosuresResponse]
10297
10491
  */
@@ -11237,6 +11431,51 @@ export type OperationEnvelopePublishListResponse = {
11237
11431
  */
11238
11432
  idempotentReplay?: boolean;
11239
11433
  };
11434
+ /**
11435
+ * OperationEnvelope[ReadTextResponse]
11436
+ */
11437
+ export type OperationEnvelopeReadTextResponse = {
11438
+ /**
11439
+ * Operation
11440
+ *
11441
+ * Kebab-case operation name
11442
+ */
11443
+ operation: string;
11444
+ /**
11445
+ * Operationid
11446
+ *
11447
+ * op_-prefixed ULID for audit and SSE correlation
11448
+ */
11449
+ operationId: string;
11450
+ /**
11451
+ * Status
11452
+ *
11453
+ * Operation lifecycle state
11454
+ */
11455
+ status: 'completed' | 'pending' | 'failed';
11456
+ /**
11457
+ * Command-specific result payload
11458
+ */
11459
+ result?: ReadTextResponse | null;
11460
+ /**
11461
+ * At
11462
+ *
11463
+ * ISO-8601 UTC timestamp
11464
+ */
11465
+ at: string;
11466
+ /**
11467
+ * Createdby
11468
+ *
11469
+ * User ID that initiated the operation
11470
+ */
11471
+ createdBy?: string | null;
11472
+ /**
11473
+ * Idempotentreplay
11474
+ *
11475
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
11476
+ */
11477
+ idempotentReplay?: boolean;
11478
+ };
11240
11479
  /**
11241
11480
  * OperationEnvelope[ReconciliationListResponse]
11242
11481
  */
@@ -11642,6 +11881,51 @@ export type OperationEnvelopeScheduleCreatedResponse = {
11642
11881
  */
11643
11882
  idempotentReplay?: boolean;
11644
11883
  };
11884
+ /**
11885
+ * OperationEnvelope[SearchTextResponse]
11886
+ */
11887
+ export type OperationEnvelopeSearchTextResponse = {
11888
+ /**
11889
+ * Operation
11890
+ *
11891
+ * Kebab-case operation name
11892
+ */
11893
+ operation: string;
11894
+ /**
11895
+ * Operationid
11896
+ *
11897
+ * op_-prefixed ULID for audit and SSE correlation
11898
+ */
11899
+ operationId: string;
11900
+ /**
11901
+ * Status
11902
+ *
11903
+ * Operation lifecycle state
11904
+ */
11905
+ status: 'completed' | 'pending' | 'failed';
11906
+ /**
11907
+ * Command-specific result payload
11908
+ */
11909
+ result?: SearchTextResponse | null;
11910
+ /**
11911
+ * At
11912
+ *
11913
+ * ISO-8601 UTC timestamp
11914
+ */
11915
+ at: string;
11916
+ /**
11917
+ * Createdby
11918
+ *
11919
+ * User ID that initiated the operation
11920
+ */
11921
+ createdBy?: string | null;
11922
+ /**
11923
+ * Idempotentreplay
11924
+ *
11925
+ * True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.
11926
+ */
11927
+ idempotentReplay?: boolean;
11928
+ };
11645
11929
  /**
11646
11930
  * OperationEnvelope[SecurityResponse]
11647
11931
  */
@@ -13672,7 +13956,112 @@ export type RateLimits = {
13672
13956
  *
13673
13957
  * Burst capacity for short spikes
13674
13958
  */
13675
- burst_capacity: number;
13959
+ burst_capacity: number;
13960
+ };
13961
+ /**
13962
+ * ReadTextRequest
13963
+ *
13964
+ * Request for the read-text view op — a window of one filing's text.
13965
+ */
13966
+ export type ReadTextRequest = {
13967
+ /**
13968
+ * Ticker
13969
+ *
13970
+ * Company ticker. On shared-repository graphs (SEC) it resolves the latest matching filing when report_id is not given; ignored on tenant graphs.
13971
+ */
13972
+ ticker?: string | null;
13973
+ /**
13974
+ * Report Id
13975
+ *
13976
+ * Specific report identifier. Required on tenant graphs; on SEC, optional when ticker is given.
13977
+ */
13978
+ report_id?: string | null;
13979
+ /**
13980
+ * Fiscal Year
13981
+ *
13982
+ * Narrow auto-resolution to this fiscal year focus
13983
+ */
13984
+ fiscal_year?: number | null;
13985
+ /**
13986
+ * Period Type
13987
+ *
13988
+ * Which forms auto-resolution considers: annual (10-K / 20-F / 40-F, the default) or quarterly (10-Q as well)
13989
+ */
13990
+ period_type?: string | null;
13991
+ /**
13992
+ * Accession
13993
+ *
13994
+ * SEC only, with ticker: one filing by accession number — a report, or an 8-K from resolved_report.recent_releases
13995
+ */
13996
+ accession?: string | null;
13997
+ /**
13998
+ * Form
13999
+ *
14000
+ * SEC only, with ticker: '8-K' reads the latest earnings release
14001
+ */
14002
+ form?: string | null;
14003
+ /**
14004
+ * Offset
14005
+ *
14006
+ * Character offset to start from
14007
+ */
14008
+ offset?: number;
14009
+ /**
14010
+ * Length
14011
+ *
14012
+ * Characters to return (default 4000)
14013
+ */
14014
+ length?: number | null;
14015
+ };
14016
+ /**
14017
+ * ReadTextResponse
14018
+ *
14019
+ * The read-text view op's result: one window of the filing's text.
14020
+ */
14021
+ export type ReadTextResponse = {
14022
+ /**
14023
+ * Graph Id
14024
+ */
14025
+ graph_id: string;
14026
+ /**
14027
+ * Report Id
14028
+ */
14029
+ report_id?: string | null;
14030
+ /**
14031
+ * Accession
14032
+ */
14033
+ accession?: string | null;
14034
+ /**
14035
+ * Resolved Report
14036
+ */
14037
+ resolved_report?: {
14038
+ [key: string]: unknown;
14039
+ } | null;
14040
+ /**
14041
+ * Offset
14042
+ */
14043
+ offset: number;
14044
+ /**
14045
+ * Length
14046
+ */
14047
+ length: number;
14048
+ /**
14049
+ * Text
14050
+ */
14051
+ text: string;
14052
+ /**
14053
+ * Text Chars
14054
+ */
14055
+ text_chars: number;
14056
+ /**
14057
+ * Next Offset
14058
+ */
14059
+ next_offset?: number | null;
14060
+ /**
14061
+ * Section
14062
+ */
14063
+ section?: string | null;
14064
+ [key: string]: unknown;
13676
14065
  };
13677
14066
  /**
13678
14067
  * RebuildScheduleRequest
@@ -15156,6 +15545,7 @@ export type ResolvedReportInfo = {
15156
15545
  * Fiscal Period
15157
15546
  */
15158
15547
  fiscal_period?: string | null;
15548
+ links?: FilingLinks | null;
15159
15549
  };
15160
15550
  /**
15161
15551
  * ResponseMode
@@ -15942,6 +16332,135 @@ export type SearchResponse = {
15942
16332
  */
15943
16333
  graph_id: string;
15944
16334
  };
16335
+ /**
16336
+ * SearchTextRequest
16337
+ *
16338
+ * Request for the search-text view op — words inside one filing.
16339
+ */
16340
+ export type SearchTextRequest = {
16341
+ /**
16342
+ * Ticker
16343
+ *
16344
+ * Company ticker. On shared-repository graphs (SEC) it resolves the latest matching filing when report_id is not given; ignored on tenant graphs.
16345
+ */
16346
+ ticker?: string | null;
16347
+ /**
16348
+ * Report Id
16349
+ *
16350
+ * Specific report identifier. Required on tenant graphs; on SEC, optional when ticker is given.
16351
+ */
16352
+ report_id?: string | null;
16353
+ /**
16354
+ * Fiscal Year
16355
+ *
16356
+ * Narrow auto-resolution to this fiscal year focus
16357
+ */
16358
+ fiscal_year?: number | null;
16359
+ /**
16360
+ * Period Type
16361
+ *
16362
+ * Which forms auto-resolution considers: annual (10-K / 20-F / 40-F, the default) or quarterly (10-Q as well)
16363
+ */
16364
+ period_type?: string | null;
16365
+ /**
16366
+ * Accession
16367
+ *
16368
+ * SEC only, with ticker: one filing by accession number — a report, or an 8-K from resolved_report.recent_releases
16369
+ */
16370
+ accession?: string | null;
16371
+ /**
16372
+ * Form
16373
+ *
16374
+ * SEC only, with ticker: '8-K' reads the latest earnings release
16375
+ */
16376
+ form?: string | null;
16377
+ /**
16378
+ * Query
16379
+ *
16380
+ * Words matched in order across any spacing, case-insensitive; `|` between alternative phrases, a trailing `*` for a stem. Not a regular expression.
16381
+ */
16382
+ query: string;
16383
+ /**
16384
+ * Window
16385
+ *
16386
+ * Characters of context around each match (default 300)
16387
+ */
16388
+ window?: number | null;
16389
+ /**
16390
+ * Max Hits
16391
+ *
16392
+ * Matches to return (default 10)
16393
+ */
16394
+ max_hits?: number | null;
16395
+ };
16396
+ /**
16397
+ * SearchTextResponse
16398
+ *
16399
+ * The search-text view op's result: matches in document order.
16400
+ */
16401
+ export type SearchTextResponse = {
16402
+ /**
16403
+ * Graph Id
16404
+ */
16405
+ graph_id: string;
16406
+ /**
16407
+ * Report Id
16408
+ */
16409
+ report_id?: string | null;
16410
+ /**
16411
+ * Accession
16412
+ */
16413
+ accession?: string | null;
16414
+ /**
16415
+ * Resolved Report
16416
+ */
16417
+ resolved_report?: {
16418
+ [key: string]: unknown;
16419
+ } | null;
16420
+ /**
16421
+ * Query
16422
+ */
16423
+ query: string;
16424
+ /**
16425
+ * Total
16426
+ */
16427
+ total: number;
16428
+ /**
16429
+ * Hits
16430
+ */
16431
+ hits?: Array<{
16432
+ [key: string]: unknown;
16433
+ }>;
16434
+ /**
16435
+ * Text Chars
16436
+ */
16437
+ text_chars: number;
16438
+ /**
16439
+ * Text
16440
+ */
16441
+ text?: string | null;
16442
+ /**
16443
+ * Sections
16444
+ */
16445
+ sections?: Array<{
16446
+ [key: string]: unknown;
16447
+ }> | null;
16448
+ /**
16449
+ * Sections Omitted
16450
+ */
16451
+ sections_omitted?: number | null;
16452
+ /**
16453
+ * Terms
16454
+ */
16455
+ terms?: Array<{
16456
+ [key: string]: unknown;
16457
+ }> | null;
16458
+ /**
16459
+ * Note
16460
+ */
16461
+ note?: string | null;
16462
+ [key: string]: unknown;
16463
+ };
15945
16464
  /**
15946
16465
  * SecurityLite
15947
16466
  *
@@ -29847,6 +30366,183 @@ export type InformationBlockResponses = {
29847
30366
  200: OperationEnvelopeInformationBlockResponse;
29848
30367
  };
29849
30368
  export type InformationBlockResponse2 = InformationBlockResponses[keyof InformationBlockResponses];
30369
+ export type DescribeFilingData = {
30370
+ body: DescribeFilingRequest;
30371
+ headers?: {
30372
+ /**
30373
+ * Idempotency-Key
30374
+ */
30375
+ 'Idempotency-Key'?: string | null;
30376
+ };
30377
+ path: {
30378
+ /**
30379
+ * Graph Id
30380
+ */
30381
+ graph_id: string;
30382
+ };
30383
+ query?: never;
30384
+ url: '/extensions/roboledger/{graph_id}/operations/describe-filing';
30385
+ };
30386
+ export type DescribeFilingErrors = {
30387
+ /**
30388
+ * Invalid request
30389
+ */
30390
+ 400: ErrorResponse;
30391
+ /**
30392
+ * Authentication required
30393
+ */
30394
+ 401: ErrorResponse;
30395
+ /**
30396
+ * Access denied
30397
+ */
30398
+ 403: ErrorResponse;
30399
+ /**
30400
+ * Resource not found
30401
+ */
30402
+ 404: ErrorResponse;
30403
+ /**
30404
+ * Idempotency-Key conflict — key reused with different body
30405
+ */
30406
+ 409: ErrorResponse;
30407
+ /**
30408
+ * Validation error
30409
+ */
30410
+ 422: ErrorResponse;
30411
+ /**
30412
+ * Rate limit exceeded
30413
+ */
30414
+ 429: ErrorResponse;
30415
+ /**
30416
+ * Internal server error
30417
+ */
30418
+ 500: ErrorResponse;
30419
+ };
30420
+ export type DescribeFilingError = DescribeFilingErrors[keyof DescribeFilingErrors];
30421
+ export type DescribeFilingResponses = {
30422
+ /**
30423
+ * Successful Response
30424
+ */
30425
+ 200: OperationEnvelopeDescribeFilingResponse;
30426
+ };
30427
+ export type DescribeFilingResponse2 = DescribeFilingResponses[keyof DescribeFilingResponses];
30428
+ export type SearchTextData = {
30429
+ body: SearchTextRequest;
30430
+ headers?: {
30431
+ /**
30432
+ * Idempotency-Key
30433
+ */
30434
+ 'Idempotency-Key'?: string | null;
30435
+ };
30436
+ path: {
30437
+ /**
30438
+ * Graph Id
30439
+ */
30440
+ graph_id: string;
30441
+ };
30442
+ query?: never;
30443
+ url: '/extensions/roboledger/{graph_id}/operations/search-text';
30444
+ };
30445
+ export type SearchTextErrors = {
30446
+ /**
30447
+ * Invalid request
30448
+ */
30449
+ 400: ErrorResponse;
30450
+ /**
30451
+ * Authentication required
30452
+ */
30453
+ 401: ErrorResponse;
30454
+ /**
30455
+ * Access denied
30456
+ */
30457
+ 403: ErrorResponse;
30458
+ /**
30459
+ * Resource not found
30460
+ */
30461
+ 404: ErrorResponse;
30462
+ /**
30463
+ * Idempotency-Key conflict — key reused with different body
30464
+ */
30465
+ 409: ErrorResponse;
30466
+ /**
30467
+ * Validation error
30468
+ */
30469
+ 422: ErrorResponse;
30470
+ /**
30471
+ * Rate limit exceeded
30472
+ */
30473
+ 429: ErrorResponse;
30474
+ /**
30475
+ * Internal server error
30476
+ */
30477
+ 500: ErrorResponse;
30478
+ };
30479
+ export type SearchTextError = SearchTextErrors[keyof SearchTextErrors];
30480
+ export type SearchTextResponses = {
30481
+ /**
30482
+ * Successful Response
30483
+ */
30484
+ 200: OperationEnvelopeSearchTextResponse;
30485
+ };
30486
+ export type SearchTextResponse2 = SearchTextResponses[keyof SearchTextResponses];
30487
+ export type ReadTextData = {
30488
+ body: ReadTextRequest;
30489
+ headers?: {
30490
+ /**
30491
+ * Idempotency-Key
30492
+ */
30493
+ 'Idempotency-Key'?: string | null;
30494
+ };
30495
+ path: {
30496
+ /**
30497
+ * Graph Id
30498
+ */
30499
+ graph_id: string;
30500
+ };
30501
+ query?: never;
30502
+ url: '/extensions/roboledger/{graph_id}/operations/read-text';
30503
+ };
30504
+ export type ReadTextErrors = {
30505
+ /**
30506
+ * Invalid request
30507
+ */
30508
+ 400: ErrorResponse;
30509
+ /**
30510
+ * Authentication required
30511
+ */
30512
+ 401: ErrorResponse;
30513
+ /**
30514
+ * Access denied
30515
+ */
30516
+ 403: ErrorResponse;
30517
+ /**
30518
+ * Resource not found
30519
+ */
30520
+ 404: ErrorResponse;
30521
+ /**
30522
+ * Idempotency-Key conflict — key reused with different body
30523
+ */
30524
+ 409: ErrorResponse;
30525
+ /**
30526
+ * Validation error
30527
+ */
30528
+ 422: ErrorResponse;
30529
+ /**
30530
+ * Rate limit exceeded
30531
+ */
30532
+ 429: ErrorResponse;
30533
+ /**
30534
+ * Internal server error
30535
+ */
30536
+ 500: ErrorResponse;
30537
+ };
30538
+ export type ReadTextError = ReadTextErrors[keyof ReadTextErrors];
30539
+ export type ReadTextResponses = {
30540
+ /**
30541
+ * Successful Response
30542
+ */
30543
+ 200: OperationEnvelopeReadTextResponse;
30544
+ };
30545
+ export type ReadTextResponse2 = ReadTextResponses[keyof ReadTextResponses];
29850
30546
  export type LiveFinancialStatementData = {
29851
30547
  body: LiveFinancialStatementRequest;
29852
30548
  headers?: {