@robosystems/client 2.5.2 → 2.5.3

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@robosystems/client",
3
- "version": "2.5.2",
3
+ "version": "2.5.3",
4
4
  "description": "TypeScript client library for the RoboSystems financial intelligence platform",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
package/sdk/sdk.gen.d.ts CHANGED
@@ -1278,7 +1278,7 @@ export declare const unblockSourceGraph: <ThrowOnError extends boolean = false>(
1278
1278
  /**
1279
1279
  * Build Fact Grid
1280
1280
  *
1281
- * Queries LadybugDB `Fact` nodes by element qnames or canonical concepts, with filters for periods, entities, form, and fiscal context. Returns deduplicated facts plus the aspects they span — arranging them into a table is the consumer's job, since collapsing cells safely requires the full aspect signature. Works on both roboledger tenant graphs (post-materialization) and the SEC shared repository.
1281
+ * Queries LadybugDB `Fact` nodes by element qnames, with filters for periods and entities. Returns deduplicated facts plus the aspects they span — arranging them into a table is the consumer's job, since collapsing cells safely requires the full aspect signature. Works on both roboledger tenant graphs (post-materialization) and the SEC shared repository. Canonical concepts and the form and fiscal-period filters exist on shared repositories only: a ledger's graph carries none of them, and a query by them there is refused rather than answered with nothing.
1282
1282
  *
1283
1283
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1284
1284
  */
@@ -1310,7 +1310,7 @@ export declare const informationBlock: <ThrowOnError extends boolean = false>(op
1310
1310
  /**
1311
1311
  * Describe Filing
1312
1312
  *
1313
- * How one filing is laid out: entity, periods, statements and disclosures by role, axes, and its text — the Items of a 10-K or 10-Q and its largest text blocks, each with the character offset `read-text` pages from. On the SEC shared repository the filing is read from its public folder — its own document, from any processed year — and a `ticker` picks it: the latest annual report, narrowed by `fiscal_year` / `period_type`, or one `accession`, or with `form: 8-K` the latest earnings release and its exhibits. SEC only: a ledger files no document, and its sections read through `disclosures` and `information-block`.
1313
+ * How one filing is laid out: entity, periods, statements and disclosures by role, axes, and its text — the Items of a 10-K or 10-Q and its largest text blocks, each with the character offset `read-text` pages from. On the SEC shared repository the filing is read from its public folder — its own document, from any processed year — and a `ticker` picks it: the latest annual report, narrowed by `fiscal_year` / `period_type`, or one `accession`, or with `form: 8-K` the latest earnings release and its exhibits (`fiscal_year` is then the calendar year it was filed, and a CIK may stand in for the ticker). SEC only: a ledger files no document, and its sections read through `disclosures` and `information-block`.
1314
1314
  *
1315
1315
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1316
1316
  */
package/sdk/sdk.gen.js CHANGED
@@ -2640,7 +2640,7 @@ exports.unblockSourceGraph = unblockSourceGraph;
2640
2640
  /**
2641
2641
  * Build Fact Grid
2642
2642
  *
2643
- * Queries LadybugDB `Fact` nodes by element qnames or canonical concepts, with filters for periods, entities, form, and fiscal context. Returns deduplicated facts plus the aspects they span — arranging them into a table is the consumer's job, since collapsing cells safely requires the full aspect signature. Works on both roboledger tenant graphs (post-materialization) and the SEC shared repository.
2643
+ * Queries LadybugDB `Fact` nodes by element qnames, with filters for periods and entities. Returns deduplicated facts plus the aspects they span — arranging them into a table is the consumer's job, since collapsing cells safely requires the full aspect signature. Works on both roboledger tenant graphs (post-materialization) and the SEC shared repository. Canonical concepts and the form and fiscal-period filters exist on shared repositories only: a ledger's graph carries none of them, and a query by them there is refused rather than answered with nothing.
2644
2644
  *
2645
2645
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2646
2646
  */
@@ -2708,7 +2708,7 @@ exports.informationBlock = informationBlock;
2708
2708
  /**
2709
2709
  * Describe Filing
2710
2710
  *
2711
- * How one filing is laid out: entity, periods, statements and disclosures by role, axes, and its text — the Items of a 10-K or 10-Q and its largest text blocks, each with the character offset `read-text` pages from. On the SEC shared repository the filing is read from its public folder — its own document, from any processed year — and a `ticker` picks it: the latest annual report, narrowed by `fiscal_year` / `period_type`, or one `accession`, or with `form: 8-K` the latest earnings release and its exhibits. SEC only: a ledger files no document, and its sections read through `disclosures` and `information-block`.
2711
+ * How one filing is laid out: entity, periods, statements and disclosures by role, axes, and its text — the Items of a 10-K or 10-Q and its largest text blocks, each with the character offset `read-text` pages from. On the SEC shared repository the filing is read from its public folder — its own document, from any processed year — and a `ticker` picks it: the latest annual report, narrowed by `fiscal_year` / `period_type`, or one `accession`, or with `form: 8-K` the latest earnings release and its exhibits (`fiscal_year` is then the calendar year it was filed, and a CIK may stand in for the ticker). SEC only: a ledger files no document, and its sections read through `disclosures` and `information-block`.
2712
2712
  *
2713
2713
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2714
2714
  */
package/sdk/sdk.gen.ts CHANGED
@@ -2651,7 +2651,7 @@ export const unblockSourceGraph = <ThrowOnError extends boolean = false>(options
2651
2651
  /**
2652
2652
  * Build Fact Grid
2653
2653
  *
2654
- * Queries LadybugDB `Fact` nodes by element qnames or canonical concepts, with filters for periods, entities, form, and fiscal context. Returns deduplicated facts plus the aspects they span — arranging them into a table is the consumer's job, since collapsing cells safely requires the full aspect signature. Works on both roboledger tenant graphs (post-materialization) and the SEC shared repository.
2654
+ * Queries LadybugDB `Fact` nodes by element qnames, with filters for periods and entities. Returns deduplicated facts plus the aspects they span — arranging them into a table is the consumer's job, since collapsing cells safely requires the full aspect signature. Works on both roboledger tenant graphs (post-materialization) and the SEC shared repository. Canonical concepts and the form and fiscal-period filters exist on shared repositories only: a ledger's graph carries none of them, and a query by them there is refused rather than answered with nothing.
2655
2655
  *
2656
2656
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2657
2657
  */
@@ -2719,7 +2719,7 @@ export const informationBlock = <ThrowOnError extends boolean = false>(options:
2719
2719
  /**
2720
2720
  * Describe Filing
2721
2721
  *
2722
- * How one filing is laid out: entity, periods, statements and disclosures by role, axes, and its text — the Items of a 10-K or 10-Q and its largest text blocks, each with the character offset `read-text` pages from. On the SEC shared repository the filing is read from its public folder — its own document, from any processed year — and a `ticker` picks it: the latest annual report, narrowed by `fiscal_year` / `period_type`, or one `accession`, or with `form: 8-K` the latest earnings release and its exhibits. SEC only: a ledger files no document, and its sections read through `disclosures` and `information-block`.
2722
+ * How one filing is laid out: entity, periods, statements and disclosures by role, axes, and its text — the Items of a 10-K or 10-Q and its largest text blocks, each with the character offset `read-text` pages from. On the SEC shared repository the filing is read from its public folder — its own document, from any processed year — and a `ticker` picks it: the latest annual report, narrowed by `fiscal_year` / `period_type`, or one `accession`, or with `form: 8-K` the latest earnings release and its exhibits (`fiscal_year` is then the calendar year it was filed, and a CIK may stand in for the ticker). SEC only: a ledger files no document, and its sections read through `disclosures` and `information-block`.
2723
2723
  *
2724
2724
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2725
2725
  */
@@ -3302,7 +3302,7 @@ export type CreateViewRequest = {
3302
3302
  /**
3303
3303
  * Canonical Concepts
3304
3304
  *
3305
- * Canonical concept names (e.g., 'revenue', 'net_income'). Matches all mapped qnames.
3305
+ * Canonical concept names (e.g., 'revenue', 'net_income'). Matches all mapped qnames. Shared repositories only.
3306
3306
  */
3307
3307
  canonical_concepts?: Array<string>;
3308
3308
  /**
@@ -3326,19 +3326,19 @@ export type CreateViewRequest = {
3326
3326
  /**
3327
3327
  * Form
3328
3328
  *
3329
- * Filter by SEC filing form type (e.g., '10-K', '10-Q')
3329
+ * Filter by SEC filing form type (e.g., '10-K', '10-Q'). Shared repositories only.
3330
3330
  */
3331
3331
  form?: string | null;
3332
3332
  /**
3333
3333
  * Fiscal Year
3334
3334
  *
3335
- * Filter by fiscal year (e.g., 2024)
3335
+ * Filter by fiscal year (e.g., 2024). Shared repositories only.
3336
3336
  */
3337
3337
  fiscal_year?: number | null;
3338
3338
  /**
3339
3339
  * Fiscal Period
3340
3340
  *
3341
- * Filter by fiscal period (e.g., 'FY', 'Q1', 'Q2', 'Q3')
3341
+ * Filter by fiscal period (e.g., 'FY', 'Q1', 'Q2', 'Q3'). Shared repositories only.
3342
3342
  */
3343
3343
  fiscal_period?: string | null;
3344
3344
  /**
@@ -4221,7 +4221,7 @@ export type DescribeFilingRequest = {
4221
4221
  /**
4222
4222
  * Form
4223
4223
  *
4224
- * SEC only, with ticker: '8-K' reads the latest earnings release
4224
+ * SEC only, with ticker: '8-K' reads the latest earnings release, or with fiscal_year the latest filed in that calendar year
4225
4225
  */
4226
4226
  form?: string | null;
4227
4227
  };
@@ -5859,12 +5859,10 @@ export type FilingLinks = {
5859
5859
  } | null;
5860
5860
  /**
5861
5861
  * Manifest
5862
+ *
5863
+ * Every file in the filing's public folder, with its URL
5862
5864
  */
5863
5865
  manifest?: string | null;
5864
- /**
5865
- * Folder
5866
- */
5867
- folder?: string | null;
5868
5866
  /**
5869
5867
  * Edgar
5870
5868
  *
@@ -13997,7 +13995,7 @@ export type ReadTextRequest = {
13997
13995
  /**
13998
13996
  * Form
13999
13997
  *
14000
- * SEC only, with ticker: '8-K' reads the latest earnings release
13998
+ * SEC only, with ticker: '8-K' reads the latest earnings release, or with fiscal_year the latest filed in that calendar year
14001
13999
  */
14002
14000
  form?: string | null;
14003
14001
  /**
@@ -15148,7 +15146,7 @@ export type ReopenPeriodOperation = {
15148
15146
  /**
15149
15147
  * Period
15150
15148
  *
15151
- * Period to reopen, in YYYY-MM. Any closed period may be reopened. Reopening the current `closed_through` retreats it by one month; reopening an earlier period leaves `closed_through` where it is (a prior-period adjustment), and its re-close restores the period without moving the pointer.
15149
+ * 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.
15152
15150
  */
15153
15151
  period: string;
15154
15152
  };
@@ -16183,6 +16181,10 @@ export type SearchHit = {
16183
16181
  * Form Type
16184
16182
  */
16185
16183
  form_type?: string | null;
16184
+ /**
16185
+ * Accession Number
16186
+ */
16187
+ accession_number?: string | null;
16186
16188
  /**
16187
16189
  * Xbrl Elements
16188
16190
  */
@@ -16371,7 +16373,7 @@ export type SearchTextRequest = {
16371
16373
  /**
16372
16374
  * Form
16373
16375
  *
16374
- * SEC only, with ticker: '8-K' reads the latest earnings release
16376
+ * SEC only, with ticker: '8-K' reads the latest earnings release, or with fiscal_year the latest filed in that calendar year
16375
16377
  */
16376
16378
  form?: string | null;
16377
16379
  /**
package/sdk/types.gen.ts CHANGED
@@ -3383,7 +3383,7 @@ export type CreateViewRequest = {
3383
3383
  /**
3384
3384
  * Canonical Concepts
3385
3385
  *
3386
- * Canonical concept names (e.g., 'revenue', 'net_income'). Matches all mapped qnames.
3386
+ * Canonical concept names (e.g., 'revenue', 'net_income'). Matches all mapped qnames. Shared repositories only.
3387
3387
  */
3388
3388
  canonical_concepts?: Array<string>;
3389
3389
  /**
@@ -3407,19 +3407,19 @@ export type CreateViewRequest = {
3407
3407
  /**
3408
3408
  * Form
3409
3409
  *
3410
- * Filter by SEC filing form type (e.g., '10-K', '10-Q')
3410
+ * Filter by SEC filing form type (e.g., '10-K', '10-Q'). Shared repositories only.
3411
3411
  */
3412
3412
  form?: string | null;
3413
3413
  /**
3414
3414
  * Fiscal Year
3415
3415
  *
3416
- * Filter by fiscal year (e.g., 2024)
3416
+ * Filter by fiscal year (e.g., 2024). Shared repositories only.
3417
3417
  */
3418
3418
  fiscal_year?: number | null;
3419
3419
  /**
3420
3420
  * Fiscal Period
3421
3421
  *
3422
- * Filter by fiscal period (e.g., 'FY', 'Q1', 'Q2', 'Q3')
3422
+ * Filter by fiscal period (e.g., 'FY', 'Q1', 'Q2', 'Q3'). Shared repositories only.
3423
3423
  */
3424
3424
  fiscal_period?: string | null;
3425
3425
  /**
@@ -4330,7 +4330,7 @@ export type DescribeFilingRequest = {
4330
4330
  /**
4331
4331
  * Form
4332
4332
  *
4333
- * SEC only, with ticker: '8-K' reads the latest earnings release
4333
+ * SEC only, with ticker: '8-K' reads the latest earnings release, or with fiscal_year the latest filed in that calendar year
4334
4334
  */
4335
4335
  form?: string | null;
4336
4336
  };
@@ -6005,12 +6005,10 @@ export type FilingLinks = {
6005
6005
  } | null;
6006
6006
  /**
6007
6007
  * Manifest
6008
+ *
6009
+ * Every file in the filing's public folder, with its URL
6008
6010
  */
6009
6011
  manifest?: string | null;
6010
- /**
6011
- * Folder
6012
- */
6013
- folder?: string | null;
6014
6012
  /**
6015
6013
  * Edgar
6016
6014
  *
@@ -14336,7 +14334,7 @@ export type ReadTextRequest = {
14336
14334
  /**
14337
14335
  * Form
14338
14336
  *
14339
- * SEC only, with ticker: '8-K' reads the latest earnings release
14337
+ * SEC only, with ticker: '8-K' reads the latest earnings release, or with fiscal_year the latest filed in that calendar year
14340
14338
  */
14341
14339
  form?: string | null;
14342
14340
  /**
@@ -15513,7 +15511,7 @@ export type ReopenPeriodOperation = {
15513
15511
  /**
15514
15512
  * Period
15515
15513
  *
15516
- * Period to reopen, in YYYY-MM. Any closed period may be reopened. Reopening the current `closed_through` retreats it by one month; reopening an earlier period leaves `closed_through` where it is (a prior-period adjustment), and its re-close restores the period without moving the pointer.
15514
+ * 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.
15517
15515
  */
15518
15516
  period: string;
15519
15517
  };
@@ -16575,6 +16573,10 @@ export type SearchHit = {
16575
16573
  * Form Type
16576
16574
  */
16577
16575
  form_type?: string | null;
16576
+ /**
16577
+ * Accession Number
16578
+ */
16579
+ accession_number?: string | null;
16578
16580
  /**
16579
16581
  * Xbrl Elements
16580
16582
  */
@@ -16766,7 +16768,7 @@ export type SearchTextRequest = {
16766
16768
  /**
16767
16769
  * Form
16768
16770
  *
16769
- * SEC only, with ticker: '8-K' reads the latest earnings release
16771
+ * SEC only, with ticker: '8-K' reads the latest earnings release, or with fiscal_year the latest filed in that calendar year
16770
16772
  */
16771
16773
  form?: string | null;
16772
16774
  /**
package/sdk.gen.d.ts CHANGED
@@ -1278,7 +1278,7 @@ export declare const unblockSourceGraph: <ThrowOnError extends boolean = false>(
1278
1278
  /**
1279
1279
  * Build Fact Grid
1280
1280
  *
1281
- * Queries LadybugDB `Fact` nodes by element qnames or canonical concepts, with filters for periods, entities, form, and fiscal context. Returns deduplicated facts plus the aspects they span — arranging them into a table is the consumer's job, since collapsing cells safely requires the full aspect signature. Works on both roboledger tenant graphs (post-materialization) and the SEC shared repository.
1281
+ * Queries LadybugDB `Fact` nodes by element qnames, with filters for periods and entities. Returns deduplicated facts plus the aspects they span — arranging them into a table is the consumer's job, since collapsing cells safely requires the full aspect signature. Works on both roboledger tenant graphs (post-materialization) and the SEC shared repository. Canonical concepts and the form and fiscal-period filters exist on shared repositories only: a ledger's graph carries none of them, and a query by them there is refused rather than answered with nothing.
1282
1282
  *
1283
1283
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1284
1284
  */
@@ -1310,7 +1310,7 @@ export declare const informationBlock: <ThrowOnError extends boolean = false>(op
1310
1310
  /**
1311
1311
  * Describe Filing
1312
1312
  *
1313
- * How one filing is laid out: entity, periods, statements and disclosures by role, axes, and its text — the Items of a 10-K or 10-Q and its largest text blocks, each with the character offset `read-text` pages from. On the SEC shared repository the filing is read from its public folder — its own document, from any processed year — and a `ticker` picks it: the latest annual report, narrowed by `fiscal_year` / `period_type`, or one `accession`, or with `form: 8-K` the latest earnings release and its exhibits. SEC only: a ledger files no document, and its sections read through `disclosures` and `information-block`.
1313
+ * How one filing is laid out: entity, periods, statements and disclosures by role, axes, and its text — the Items of a 10-K or 10-Q and its largest text blocks, each with the character offset `read-text` pages from. On the SEC shared repository the filing is read from its public folder — its own document, from any processed year — and a `ticker` picks it: the latest annual report, narrowed by `fiscal_year` / `period_type`, or one `accession`, or with `form: 8-K` the latest earnings release and its exhibits (`fiscal_year` is then the calendar year it was filed, and a CIK may stand in for the ticker). SEC only: a ledger files no document, and its sections read through `disclosures` and `information-block`.
1314
1314
  *
1315
1315
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
1316
1316
  */
package/sdk.gen.js CHANGED
@@ -2640,7 +2640,7 @@ exports.unblockSourceGraph = unblockSourceGraph;
2640
2640
  /**
2641
2641
  * Build Fact Grid
2642
2642
  *
2643
- * Queries LadybugDB `Fact` nodes by element qnames or canonical concepts, with filters for periods, entities, form, and fiscal context. Returns deduplicated facts plus the aspects they span — arranging them into a table is the consumer's job, since collapsing cells safely requires the full aspect signature. Works on both roboledger tenant graphs (post-materialization) and the SEC shared repository.
2643
+ * Queries LadybugDB `Fact` nodes by element qnames, with filters for periods and entities. Returns deduplicated facts plus the aspects they span — arranging them into a table is the consumer's job, since collapsing cells safely requires the full aspect signature. Works on both roboledger tenant graphs (post-materialization) and the SEC shared repository. Canonical concepts and the form and fiscal-period filters exist on shared repositories only: a ledger's graph carries none of them, and a query by them there is refused rather than answered with nothing.
2644
2644
  *
2645
2645
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2646
2646
  */
@@ -2708,7 +2708,7 @@ exports.informationBlock = informationBlock;
2708
2708
  /**
2709
2709
  * Describe Filing
2710
2710
  *
2711
- * How one filing is laid out: entity, periods, statements and disclosures by role, axes, and its text — the Items of a 10-K or 10-Q and its largest text blocks, each with the character offset `read-text` pages from. On the SEC shared repository the filing is read from its public folder — its own document, from any processed year — and a `ticker` picks it: the latest annual report, narrowed by `fiscal_year` / `period_type`, or one `accession`, or with `form: 8-K` the latest earnings release and its exhibits. SEC only: a ledger files no document, and its sections read through `disclosures` and `information-block`.
2711
+ * How one filing is laid out: entity, periods, statements and disclosures by role, axes, and its text — the Items of a 10-K or 10-Q and its largest text blocks, each with the character offset `read-text` pages from. On the SEC shared repository the filing is read from its public folder — its own document, from any processed year — and a `ticker` picks it: the latest annual report, narrowed by `fiscal_year` / `period_type`, or one `accession`, or with `form: 8-K` the latest earnings release and its exhibits (`fiscal_year` is then the calendar year it was filed, and a CIK may stand in for the ticker). SEC only: a ledger files no document, and its sections read through `disclosures` and `information-block`.
2712
2712
  *
2713
2713
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2714
2714
  */
package/sdk.gen.ts CHANGED
@@ -2651,7 +2651,7 @@ export const unblockSourceGraph = <ThrowOnError extends boolean = false>(options
2651
2651
  /**
2652
2652
  * Build Fact Grid
2653
2653
  *
2654
- * Queries LadybugDB `Fact` nodes by element qnames or canonical concepts, with filters for periods, entities, form, and fiscal context. Returns deduplicated facts plus the aspects they span — arranging them into a table is the consumer's job, since collapsing cells safely requires the full aspect signature. Works on both roboledger tenant graphs (post-materialization) and the SEC shared repository.
2654
+ * Queries LadybugDB `Fact` nodes by element qnames, with filters for periods and entities. Returns deduplicated facts plus the aspects they span — arranging them into a table is the consumer's job, since collapsing cells safely requires the full aspect signature. Works on both roboledger tenant graphs (post-materialization) and the SEC shared repository. Canonical concepts and the form and fiscal-period filters exist on shared repositories only: a ledger's graph carries none of them, and a query by them there is refused rather than answered with nothing.
2655
2655
  *
2656
2656
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2657
2657
  */
@@ -2719,7 +2719,7 @@ export const informationBlock = <ThrowOnError extends boolean = false>(options:
2719
2719
  /**
2720
2720
  * Describe Filing
2721
2721
  *
2722
- * How one filing is laid out: entity, periods, statements and disclosures by role, axes, and its text — the Items of a 10-K or 10-Q and its largest text blocks, each with the character offset `read-text` pages from. On the SEC shared repository the filing is read from its public folder — its own document, from any processed year — and a `ticker` picks it: the latest annual report, narrowed by `fiscal_year` / `period_type`, or one `accession`, or with `form: 8-K` the latest earnings release and its exhibits. SEC only: a ledger files no document, and its sections read through `disclosures` and `information-block`.
2722
+ * How one filing is laid out: entity, periods, statements and disclosures by role, axes, and its text — the Items of a 10-K or 10-Q and its largest text blocks, each with the character offset `read-text` pages from. On the SEC shared repository the filing is read from its public folder — its own document, from any processed year — and a `ticker` picks it: the latest annual report, narrowed by `fiscal_year` / `period_type`, or one `accession`, or with `form: 8-K` the latest earnings release and its exhibits (`fiscal_year` is then the calendar year it was filed, and a CIK may stand in for the ticker). SEC only: a ledger files no document, and its sections read through `disclosures` and `information-block`.
2723
2723
  *
2724
2724
  * **Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
2725
2725
  */
package/types.gen.d.ts CHANGED
@@ -3302,7 +3302,7 @@ export type CreateViewRequest = {
3302
3302
  /**
3303
3303
  * Canonical Concepts
3304
3304
  *
3305
- * Canonical concept names (e.g., 'revenue', 'net_income'). Matches all mapped qnames.
3305
+ * Canonical concept names (e.g., 'revenue', 'net_income'). Matches all mapped qnames. Shared repositories only.
3306
3306
  */
3307
3307
  canonical_concepts?: Array<string>;
3308
3308
  /**
@@ -3326,19 +3326,19 @@ export type CreateViewRequest = {
3326
3326
  /**
3327
3327
  * Form
3328
3328
  *
3329
- * Filter by SEC filing form type (e.g., '10-K', '10-Q')
3329
+ * Filter by SEC filing form type (e.g., '10-K', '10-Q'). Shared repositories only.
3330
3330
  */
3331
3331
  form?: string | null;
3332
3332
  /**
3333
3333
  * Fiscal Year
3334
3334
  *
3335
- * Filter by fiscal year (e.g., 2024)
3335
+ * Filter by fiscal year (e.g., 2024). Shared repositories only.
3336
3336
  */
3337
3337
  fiscal_year?: number | null;
3338
3338
  /**
3339
3339
  * Fiscal Period
3340
3340
  *
3341
- * Filter by fiscal period (e.g., 'FY', 'Q1', 'Q2', 'Q3')
3341
+ * Filter by fiscal period (e.g., 'FY', 'Q1', 'Q2', 'Q3'). Shared repositories only.
3342
3342
  */
3343
3343
  fiscal_period?: string | null;
3344
3344
  /**
@@ -4221,7 +4221,7 @@ export type DescribeFilingRequest = {
4221
4221
  /**
4222
4222
  * Form
4223
4223
  *
4224
- * SEC only, with ticker: '8-K' reads the latest earnings release
4224
+ * SEC only, with ticker: '8-K' reads the latest earnings release, or with fiscal_year the latest filed in that calendar year
4225
4225
  */
4226
4226
  form?: string | null;
4227
4227
  };
@@ -5859,12 +5859,10 @@ export type FilingLinks = {
5859
5859
  } | null;
5860
5860
  /**
5861
5861
  * Manifest
5862
+ *
5863
+ * Every file in the filing's public folder, with its URL
5862
5864
  */
5863
5865
  manifest?: string | null;
5864
- /**
5865
- * Folder
5866
- */
5867
- folder?: string | null;
5868
5866
  /**
5869
5867
  * Edgar
5870
5868
  *
@@ -13997,7 +13995,7 @@ export type ReadTextRequest = {
13997
13995
  /**
13998
13996
  * Form
13999
13997
  *
14000
- * SEC only, with ticker: '8-K' reads the latest earnings release
13998
+ * SEC only, with ticker: '8-K' reads the latest earnings release, or with fiscal_year the latest filed in that calendar year
14001
13999
  */
14002
14000
  form?: string | null;
14003
14001
  /**
@@ -15148,7 +15146,7 @@ export type ReopenPeriodOperation = {
15148
15146
  /**
15149
15147
  * Period
15150
15148
  *
15151
- * Period to reopen, in YYYY-MM. Any closed period may be reopened. Reopening the current `closed_through` retreats it by one month; reopening an earlier period leaves `closed_through` where it is (a prior-period adjustment), and its re-close restores the period without moving the pointer.
15149
+ * 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.
15152
15150
  */
15153
15151
  period: string;
15154
15152
  };
@@ -16183,6 +16181,10 @@ export type SearchHit = {
16183
16181
  * Form Type
16184
16182
  */
16185
16183
  form_type?: string | null;
16184
+ /**
16185
+ * Accession Number
16186
+ */
16187
+ accession_number?: string | null;
16186
16188
  /**
16187
16189
  * Xbrl Elements
16188
16190
  */
@@ -16371,7 +16373,7 @@ export type SearchTextRequest = {
16371
16373
  /**
16372
16374
  * Form
16373
16375
  *
16374
- * SEC only, with ticker: '8-K' reads the latest earnings release
16376
+ * SEC only, with ticker: '8-K' reads the latest earnings release, or with fiscal_year the latest filed in that calendar year
16375
16377
  */
16376
16378
  form?: string | null;
16377
16379
  /**
package/types.gen.ts CHANGED
@@ -3383,7 +3383,7 @@ export type CreateViewRequest = {
3383
3383
  /**
3384
3384
  * Canonical Concepts
3385
3385
  *
3386
- * Canonical concept names (e.g., 'revenue', 'net_income'). Matches all mapped qnames.
3386
+ * Canonical concept names (e.g., 'revenue', 'net_income'). Matches all mapped qnames. Shared repositories only.
3387
3387
  */
3388
3388
  canonical_concepts?: Array<string>;
3389
3389
  /**
@@ -3407,19 +3407,19 @@ export type CreateViewRequest = {
3407
3407
  /**
3408
3408
  * Form
3409
3409
  *
3410
- * Filter by SEC filing form type (e.g., '10-K', '10-Q')
3410
+ * Filter by SEC filing form type (e.g., '10-K', '10-Q'). Shared repositories only.
3411
3411
  */
3412
3412
  form?: string | null;
3413
3413
  /**
3414
3414
  * Fiscal Year
3415
3415
  *
3416
- * Filter by fiscal year (e.g., 2024)
3416
+ * Filter by fiscal year (e.g., 2024). Shared repositories only.
3417
3417
  */
3418
3418
  fiscal_year?: number | null;
3419
3419
  /**
3420
3420
  * Fiscal Period
3421
3421
  *
3422
- * Filter by fiscal period (e.g., 'FY', 'Q1', 'Q2', 'Q3')
3422
+ * Filter by fiscal period (e.g., 'FY', 'Q1', 'Q2', 'Q3'). Shared repositories only.
3423
3423
  */
3424
3424
  fiscal_period?: string | null;
3425
3425
  /**
@@ -4330,7 +4330,7 @@ export type DescribeFilingRequest = {
4330
4330
  /**
4331
4331
  * Form
4332
4332
  *
4333
- * SEC only, with ticker: '8-K' reads the latest earnings release
4333
+ * SEC only, with ticker: '8-K' reads the latest earnings release, or with fiscal_year the latest filed in that calendar year
4334
4334
  */
4335
4335
  form?: string | null;
4336
4336
  };
@@ -6005,12 +6005,10 @@ export type FilingLinks = {
6005
6005
  } | null;
6006
6006
  /**
6007
6007
  * Manifest
6008
+ *
6009
+ * Every file in the filing's public folder, with its URL
6008
6010
  */
6009
6011
  manifest?: string | null;
6010
- /**
6011
- * Folder
6012
- */
6013
- folder?: string | null;
6014
6012
  /**
6015
6013
  * Edgar
6016
6014
  *
@@ -14336,7 +14334,7 @@ export type ReadTextRequest = {
14336
14334
  /**
14337
14335
  * Form
14338
14336
  *
14339
- * SEC only, with ticker: '8-K' reads the latest earnings release
14337
+ * SEC only, with ticker: '8-K' reads the latest earnings release, or with fiscal_year the latest filed in that calendar year
14340
14338
  */
14341
14339
  form?: string | null;
14342
14340
  /**
@@ -15513,7 +15511,7 @@ export type ReopenPeriodOperation = {
15513
15511
  /**
15514
15512
  * Period
15515
15513
  *
15516
- * Period to reopen, in YYYY-MM. Any closed period may be reopened. Reopening the current `closed_through` retreats it by one month; reopening an earlier period leaves `closed_through` where it is (a prior-period adjustment), and its re-close restores the period without moving the pointer.
15514
+ * 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.
15517
15515
  */
15518
15516
  period: string;
15519
15517
  };
@@ -16575,6 +16573,10 @@ export type SearchHit = {
16575
16573
  * Form Type
16576
16574
  */
16577
16575
  form_type?: string | null;
16576
+ /**
16577
+ * Accession Number
16578
+ */
16579
+ accession_number?: string | null;
16578
16580
  /**
16579
16581
  * Xbrl Elements
16580
16582
  */
@@ -16766,7 +16768,7 @@ export type SearchTextRequest = {
16766
16768
  /**
16767
16769
  * Form
16768
16770
  *
16769
- * SEC only, with ticker: '8-K' reads the latest earnings release
16771
+ * SEC only, with ticker: '8-K' reads the latest earnings release, or with fiscal_year the latest filed in that calendar year
16770
16772
  */
16771
16773
  form?: string | null;
16772
16774
  /**