@invinite-org/invinite-data-cli 1.2.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -214,7 +214,7 @@ command. A handful of commands are hand-written because they do more than one ca
214
214
  | `segments` | `list`, `list-detailed` |
215
215
  | `sec` | Invinite's SEC document store: `filers`, `filer`, `lifecycle`, `issuers`, `filings` (cursor-paged, `form_facet`), `filing` (its document manifest), `document` / `version` (immutable cited blocks, pages, footnotes), `sections`, `figure`, `fact-places`, `search` (`--mode lexical\|literal`, 100 credits), 13F `holders` / `portfolio` / `holding-deltas` / `form-filers`, `financials-catalog` / `statement` / `financial-fact`, `metric-export` / `export`, `datasets`; downloads `save` (originals), `save-figure`, `export-file` |
216
216
  | `earnings` | Calendar, events, live calls, transcripts, Q&A, participants, analysts, guidance and KPI extractions, diff, metrics, prosody, price moves during the call, media, documents, search, company IR documents |
217
- | `news` | News of US companies from SEC filings and their own newsrooms: `list` (cursor-paged), `get` (full text + attribution), `text` (citable blocks), `developments`, `search` (passages; off until the API enables it), `asset-download` |
217
+ | `news` | News of US companies from SEC filings and their own newsrooms: `list` (cursor-paged), `get` (Invinite's summary + attribution), `text` (the summary in citable blocks), `developments`, `search` (passages; off until the API enables it) |
218
218
  | `ownership` | 13F holdings by company / investor, institutions, transactions |
219
219
  | `insider-trades`, `ipos`, `market`, `metadata` | Insider transactions, IPOs, market holidays, available metric and filing-section ids |
220
220
  | `webhooks` | Earnings-call and `news.published` webhook subscriptions |
@@ -321,10 +321,10 @@ narrow its own publications). The list is cursor-paged: `--all` follows `next_ur
321
321
  `--cursor` with the same filters; without `--from` / `--to`, `--all` and `next_cursor` page back through the whole history; with either, the window is at most 92 days.
322
322
 
323
323
  Every item carries `attribution` (publisher, `source_url`, `published_at`, EDGAR form + accession, `statement`):
324
- wherever you show a headline or text, show its publisher, link and date with it. `news get` (STANDARD) has the
325
- `body_text` (`content_status: no_text` = headline and link only); `news text` serves it in blocks (a `409
326
- revision_changed` = the item was corrected; start again without `--cursor`). Process text with an AI model only when
327
- `model_processing_allowed` is `true`. `news asset-download` returns a URL valid for at most 60 seconds.
324
+ wherever you show a headline or text, show its publisher, link and date with it. `news get` (STANDARD) has Invinite's
325
+ summary of the publication, `summary_text` / `summary_html` (`content_status: no_text` = headline and link only), never
326
+ the publisher's own text; `news text` serves the summary in blocks (a `409 revision_changed` = the item was corrected;
327
+ start again without `--cursor`). `news search --field title|lede|summary|any` picks the searched text.
328
328
 
329
329
  `earnings transcript` and `news get` also carry the branded PDF of the version (`pdf`, a permanent public URL, or null while
330
330
  none exists): `--pdf` prints the URL, `--pdf-out <file>` saves the file (an error without a PDF). `earnings versions` lists
@@ -44,7 +44,7 @@ Common multi-step patterns:
44
44
  - **Comparative analysis**: metadata metrics (first) + financials snapshot with multiple tickers + metrics ratios for each
45
45
  - **Earnings call review**: earnings events (first, for the `event_id`) → then in parallel press-release + extractions `--kind guidance` + extractions `--kind kpi` + qa + diff (+ optionally price-attribution: minute price moves next to what was said — temporal coincidence, not cause)
46
46
  - **Guidance tracking**: earnings guidance-history `--metric <metric>` across calls + extractions of the latest call
47
- - **Company announcements**: news list `--publisher <cik>` (what the company published itself; `--ticker` = items mentioning it) → news get `--id <id>` for `body_text` + news developments `--publisher <cik>`; keep each item's `attribution` (publisher, `source_url`, `published_at`, EDGAR form + accession) in the results so the caller can cite it
47
+ - **Company announcements**: news list `--publisher <cik>` (what the company published itself; `--ticker` = items mentioning it) → news get `--id <id>` for `summary_text` (Invinite's summary) + news developments `--publisher <cik>`; keep each item's `attribution` (publisher, `source_url`, `published_at`, EDGAR form + accession) in the results so the caller can cite it
48
48
 
49
49
  ## Output format
50
50
 
@@ -39,7 +39,7 @@ Use the connected Invinite Data API MCP tools when available. Fall back to the `
39
39
  | Company IR documents (annual reports, proxy, ESG, investor-day decks, letters, webcast pages) | `earnings_company_documents`, `earnings_company_document` | `invd earnings company-documents\|document` |
40
40
  | Search company documents (passages with page numbers) | `earnings_document_search` | `invd earnings document-search` |
41
41
  | Keyword / guidance alerts | `earnings_call_alert_create\|list\|update\|delete\|test\|deliveries` | `invd webhooks …` |
42
- | News (SEC filings and the companies' own newsrooms; full text with attribution), its text in blocks, AI-read developments | `news_list`, `news_item`, `news_text`, `news_developments`, `news_search` | `invd news list\|get\|text\|developments\|search` (`news asset-download` is CLI-only) |
42
+ | News (SEC filings and the companies' own newsrooms; Invinite's summary with attribution), the summary in blocks, AI-read developments | `news_list`, `news_item`, `news_text`, `news_developments`, `news_search` | `invd news list\|get\|text\|developments\|search` |
43
43
 
44
44
  The discovery rules below apply to both transports: call `list_available_metrics` before ratios, growth, CAGR, or financial-statement analysis, and call `list_available_section_ids` before requesting filing sections.
45
45
 
@@ -153,12 +153,11 @@ invd webhooks deliveries --id <id> --json
153
153
 
154
154
  `invd news list` (FREE) lists items newest first from SEC EDGAR filings (`rights: public_record`) and the companies' own newsrooms (`rights: issuer`); wire services are never a source. `--ticker` / `--cik` = items that MENTION the company; `--publisher <cik>` = items the company PUBLISHED itself (its verified newsroom publication) — "what did NVIDIA announce" is `--publisher 1045810`, not `--ticker NVDA`. `--publication-type`, `--issuer-category` and `--issuer-tag` narrow the publisher's own publications (the last two need exactly one `--publisher`). Without `--from` / `--to` it pages back through the whole history; with either, the window is at most 92 days. Pages use a cursor, not an offset: `--all` follows `next_url`; by hand pass `next_cursor` as `--cursor` with the same filters.
155
155
 
156
- - **Attribution duty.** Every item carries `attribution` (`publisher`, `source_url`, `published_at`, `edgar.form` + `edgar.accession` for a filing, `statement`). Whenever you quote or show a headline, lede, `body_text` or text block, name the publisher, link `source_url` and give the date (and the form + accession of a filing). The text is the publisher's own words: quote it verbatim, never present it as Invinite's or as verified fact.
157
- - **Model use.** Process text with an AI model (summaries, extraction) only when the answer's `model_processing_allowed` is `true`; otherwise use the headline, links and attribution only. The MCP tools already withhold the words in that case (`text_withheld`).
158
- - `invd news get --id <id>` (STANDARD) has `body_text` (`content_status: available`, else `no_text` = headline and link only), `sightings`, `companies`, images / files and up to 20 developments; `invd news text --id <id>` serves the text in citable blocks (a `409 revision_changed` means the item was corrected: restart without `--cursor`). `superseded_by` names a corrected successor.
159
- - `invd news developments` lists product launches, partnerships, contracts, availability (AI-read from the text, `derived: true`): report `claim_status` as stated (`planned` is a plan, not availability) and cite the `evidence` quotes with the item's attribution.
160
- - `invd news search -q <keywords>` searches headlines and texts (`-m lexical` keywords, the default; `-m literal` exact characters; `--field title|body|any`; default window 365 days, at most 8 passages). It answers `503 search_disabled` until the API enables it; read `coverage` before concluding from few or no hits, and cite each passage with its item's `attribution`.
161
- - `invd news asset-download --id <id> --asset-id <asset_id>` returns a URL valid ≤ 60 s (keep the `credit` with the image); never store it.
156
+ - **Attribution duty.** Every item carries `attribution` (`publisher`, `source_url`, `published_at`, `edgar.form` + `edgar.accession` for a filing, `statement`). Whenever you show a headline, lede, `summary_text` or summary block, name the publisher, link `source_url` and give the date (and the form + accession of a filing). The lede, the summary and the developments are Invinite's own wording of the publication (never the publisher's text): present them as a summary of what the publisher stated, not as verified fact, and point to `source_url` for the publisher's own words.
157
+ - **Model use.** `model_processing_allowed` reports the publisher's machine-readable reservation on its ORIGINAL publication; it is informational — every text the API serves (lede, summary, developments) is Invinite's own wording.
158
+ - `invd news get --id <id>` (STANDARD) has Invinite's long summary as `summary_text` / `summary_html` with `summary_words`, `source_words` and `summarized_at` (`content_status: available`, else `no_text` = headline and link only: an item published before summaries started, a metadata-only item or a reserved source), the branded PDF (`pdf`), `sightings`, `companies` and up to 20 developments; `invd news text --id <id>` serves the summary in citable blocks (`index`, `kind` heading / paragraph / list, `heading`, `text`; a `409 revision_changed` means the item was corrected: restart without `--cursor`). `superseded_by` names a corrected successor.
159
+ - `invd news developments` lists product launches, partnerships, contracts, availability (AI-read from the text, `derived: true`): report `claim_status` as stated (`planned` is a plan, not availability) and cite the item's attribution.
160
+ - `invd news search -q <keywords>` searches headlines and texts (`-m lexical` keywords, the default; `-m literal` exact characters; `--field title|lede|summary|any`; default window 365 days, at most 8 passages). It answers `503 search_disabled` until the API enables it; read `coverage` before concluding from few or no hits, and cite each passage with its item's `attribution`.
162
161
  - New items as they appear: `invd ws listen --news --tickers NVDA` (STANDARD); a webhook: `"events":["news.published"]` in `invd webhooks create --body` (STANDARD and above, filtered by `ciks`).
163
162
 
164
163
  ```bash
@@ -215,7 +214,7 @@ Earnings calls: calendar, transcripts, Q&A, extractions, media, search and webho
215
214
  # Analysts of a company (optional: --limit, --offset, --all)
216
215
  invd earnings analysts -i MSFT --json
217
216
 
218
- # Earnings call calendar (optional: --from, --to, --status, --session, --exchange, --event-type, --sort, --limit, --offset, --date-kind, --calendar-status, --all)
217
+ # Earnings call calendar (optional: --from, --to, --status, --session, --exchange, --event-type, --sort, --limit, --offset, --date-kind, --calendar-status, --include-expired, --all)
219
218
  invd earnings calendar --json
220
219
 
221
220
  # Call-over-call diff (optional: --event-id, --identifier, --year, --quarter, --date, --event-type, --vs)
@@ -227,7 +226,7 @@ invd earnings document-search -q "Azure growth" -i MSFT --json
227
226
  # Earnings call by ID (optional: --include)
228
227
  invd earnings event --event-id 9655a5db-8968-40be-8c79-7cd1a8aed8e9 --json
229
228
 
230
- # Event history of a company (optional: --from, --to, --include, --event-type, --sort, --limit, --offset, --all)
229
+ # Event history of a company (optional: --from, --to, --include, --event-type, --sort, --limit, --offset, --include-expired, --all)
231
230
  invd earnings events -i MSFT --json
232
231
 
233
232
  # Guidance and KPI extractions (optional: --event-id, --identifier, --year, --quarter, --date, --event-type, --kind, --review, --limit, --offset, --all)
@@ -338,40 +337,40 @@ invd earnings document --document-id <document_id> --output annual-report.pdf
338
337
  Financial statements (standardized & as-reported)
339
338
 
340
339
  ```bash
341
- # As-reported balance sheet (optional: --sort, --limit, --offset, --all)
340
+ # As-reported balance sheet (optional: --sort, --limit, --offset, --reported-only, --all)
342
341
  invd financials as-reported-balance-sheet -i AAPL -p annual --json
343
342
 
344
- # As-reported balance sheet (detailed) (optional: --sort, --limit, --offset, --with-formula, --all)
343
+ # As-reported balance sheet (detailed) (optional: --sort, --limit, --offset, --with-formula, --reported-only, --all)
345
344
  invd financials as-reported-balance-sheet-detailed -i AAPL -p annual --json
346
345
 
347
- # As-reported balance sheet (presentation) (optional: --sort, --limit, --offset, --all)
346
+ # As-reported balance sheet (presentation) (optional: --sort, --limit, --offset, --reported-only, --all)
348
347
  invd financials as-reported-balance-sheet-presentation -i AAPL -p annual --json
349
348
 
350
- # As-reported cash flow statement (optional: --sort, --limit, --offset, --all)
349
+ # As-reported cash flow statement (optional: --sort, --limit, --offset, --reported-only, --display-sign, --all)
351
350
  invd financials as-reported-cash-flow -i AAPL -p annual --json
352
351
 
353
- # As-reported cash flow statement (detailed) (optional: --sort, --limit, --offset, --with-formula, --all)
352
+ # As-reported cash flow statement (detailed) (optional: --sort, --limit, --offset, --with-formula, --reported-only, --display-sign, --all)
354
353
  invd financials as-reported-cash-flow-detailed -i AAPL -p annual --json
355
354
 
356
- # As-reported cash flow statement (presentation) (optional: --sort, --limit, --offset, --all)
355
+ # As-reported cash flow statement (presentation) (optional: --sort, --limit, --offset, --reported-only, --display-sign, --all)
357
356
  invd financials as-reported-cash-flow-presentation -i AAPL -p annual --json
358
357
 
359
- # As-reported income statement (optional: --sort, --limit, --offset, --all)
358
+ # As-reported income statement (optional: --sort, --limit, --offset, --reported-only, --all)
360
359
  invd financials as-reported-income-statement -i AAPL -p annual --json
361
360
 
362
- # As-reported income statement (detailed) (optional: --sort, --limit, --offset, --with-formula, --all)
361
+ # As-reported income statement (detailed) (optional: --sort, --limit, --offset, --with-formula, --reported-only, --all)
363
362
  invd financials as-reported-income-statement-detailed -i AAPL -p annual --json
364
363
 
365
- # As-reported income statement (presentation) (optional: --sort, --limit, --offset, --all)
364
+ # As-reported income statement (presentation) (optional: --sort, --limit, --offset, --reported-only, --all)
366
365
  invd financials as-reported-income-statement-presentation -i AAPL -p annual --json
367
366
 
368
- # As-reported snapshot (optional: --calendar-year, --calendar-quarter)
367
+ # As-reported snapshot (optional: --calendar-year, --calendar-quarter, --reported-only, --display-sign)
369
368
  invd financials as-reported-snapshot -i AAPL,MSFT -p annual --json
370
369
 
371
- # As-reported snapshot (detailed) (optional: --calendar-year, --calendar-quarter, --with-formula)
370
+ # As-reported snapshot (detailed) (optional: --calendar-year, --calendar-quarter, --reported-only, --display-sign, --with-formula)
372
371
  invd financials as-reported-snapshot-detailed -i AAPL,MSFT -p annual --json
373
372
 
374
- # As-reported snapshot (presentation) (optional: --calendar-year, --calendar-quarter)
373
+ # As-reported snapshot (presentation) (optional: --calendar-year, --calendar-quarter, --reported-only, --display-sign)
375
374
  invd financials as-reported-snapshot-presentation -i AAPL,MSFT -p annual --json
376
375
 
377
376
  # Standardized balance sheet (optional: --sort, --limit, --offset, --all)
@@ -498,27 +497,24 @@ invd metrics ratios -i AAPL -p annual --json
498
497
  News of US companies from SEC filings and their own newsrooms: items, full text with attribution, developments and files
499
498
 
500
499
  ```bash
501
- # Get a short-lived URL of a news image or file (optional: --purpose)
502
- invd news asset-download --id 13351ae7-876b-4839-ba2b-78873f6b4e00 --asset-id 612cd78d-b618-42c6-b3be-ff5c9df1a0f7 --json
503
-
504
500
  # List company developments from news (optional: --publisher, --topic, --item-id, --from, --to, --effective-from, --effective-to, --limit, --cursor, --all)
505
501
  invd news developments --json
506
502
 
507
- # List news items (optional: --ticker, --cik, --from, --to, --source, --kind, --topic, --earnings, --has-media, --publisher, --publication-type, --issuer-category, --issuer-tag, --limit, --cursor, --all)
503
+ # List news items (optional: --ticker, --cik, --from, --to, --source, --kind, --topic, --earnings, --publisher, --publication-type, --issuer-category, --issuer-tag, --limit, --cursor, --all)
508
504
  invd news list --json
509
505
 
510
506
  # Search news (optional: --mode, --case-sensitive, --field, --ticker, --cik, --publisher, --publisher-host, --kind, --topic, --from, --to, --limit)
511
507
  invd news search -q "data center revenue" -m lexical -t NVDA --json
512
508
 
513
- # Get a news item's text in blocks (optional: --limit, --max-chars, --cursor, --all)
514
- invd news text --id 13351ae7-876b-4839-ba2b-78873f6b4e00 --json
509
+ # Get a news item's summary in blocks (optional: --limit, --max-chars, --cursor, --all)
510
+ invd news text --id 06304274-da4a-400e-9d5c-fb4ce04f01c9 --json
515
511
  ```
516
512
 
517
513
  <!-- invd:hand:news get -->
518
514
  ```bash
519
- # Get a news item (optional: --body text|html|both); --pdf prints its branded PDF's URL, --pdf-out saves the file
520
- invd news get --body both --id 13351ae7-876b-4839-ba2b-78873f6b4e00 --json
521
- invd news get --id 13351ae7-876b-4839-ba2b-78873f6b4e00 --pdf-out item.pdf
515
+ # Get a news item with Invinite's summary; --pdf prints its branded PDF's URL, --pdf-out saves the file
516
+ invd news get --id 06304274-da4a-400e-9d5c-fb4ce04f01c9 --json
517
+ invd news get --id 06304274-da4a-400e-9d5c-fb4ce04f01c9 --pdf-out item.pdf
522
518
  ```
523
519
  <!-- /invd:hand:news get -->
524
520
 
@@ -802,7 +798,7 @@ Ask for the company's own publications (publisher = CIK), then read one in full
802
798
  ```bash
803
799
  invd news list --publisher 1045810 --from 2026-10-29 --json # what NVIDIA published itself
804
800
  invd news list --ticker NVDA --source edgar --from 2026-10-29 --json # SEC filings mentioning NVIDIA
805
- invd news get --id <id> --json # body_text + attribution
801
+ invd news get --id <id> --json # summary_text + attribution
806
802
  invd news developments --publisher 1045810 --topic product_launch --json
807
803
  ```
808
804
  Answer with the publisher, the date and the link of each item (`attribution`), and keep "announced" / "planned" claims as such.
@@ -1,4 +1,3 @@
1
- import { Option } from 'commander';
2
1
  import chalk from 'chalk';
3
2
  import { apiGet } from '../client/api-client.js';
4
3
  import { printPdfUrl, savePdf } from '../client/pdf.js';
@@ -11,7 +10,10 @@ import { setJsonMode } from '../shared/spinner.js';
11
10
  * The hand-written `invd news get`: it can save the item's PDF, so it is not one REST call plus one view
12
11
  * (`src/hand-written-commands.ts`). Every other `news` action is generated and attached to the same group.
13
12
  */
14
- /** The attribution block, then the text it attributes (backend news task 17); the URL above the long text. */
13
+ /**
14
+ * The attribution block, then Invinite's summary it attributes (backend news summaries task 5, API 2.0.0): the lengths and
15
+ * the PDF URL above the long text. The publisher's own text is never served.
16
+ */
15
17
  const COLUMNS = [
16
18
  'id',
17
19
  'published_at',
@@ -19,7 +21,6 @@ const COLUMNS = [
19
21
  'kind',
20
22
  'source.id',
21
23
  'url',
22
- 'content_status',
23
24
  'attribution.publisher',
24
25
  'attribution.publisher_host',
25
26
  'attribution.source_url',
@@ -28,17 +29,19 @@ const COLUMNS = [
28
29
  'attribution.edgar.form',
29
30
  'attribution.edgar.accession',
30
31
  'attribution.statement',
31
- 'content_formats',
32
+ 'content_status',
33
+ 'summary_words',
34
+ 'source_words',
35
+ 'summarized_at',
32
36
  'pdf.url',
33
- 'body_text',
34
- 'body_html',
37
+ 'summary_text',
38
+ 'summary_html',
35
39
  ];
36
40
  export function registerNewsCommands(program) {
37
41
  const news = program.commands.find(command => command.name() === 'news') ?? program.command('news');
38
42
  news.command('get')
39
- .description('Get a news item')
43
+ .description("Get a news item with Invinite's summary of the publication")
40
44
  .requiredOption('--id <id>', 'News item id')
41
- .addOption(new Option('--body <form>', 'Which text forms to return: text = body_text (plain, default), html = body_html (sanitized HTML with the images inline) instead, both = both').choices(['text', 'html', 'both']))
42
45
  .option('--pdf', 'Print the URL of the branded PDF of this item')
43
46
  .option('--pdf-out <file>', 'Save the branded PDF of this item (e.g. item.pdf)')
44
47
  .option('--force', 'Overwrite an existing --pdf-out file')
@@ -48,7 +51,6 @@ export function registerNewsCommands(program) {
48
51
  setJsonMode(true);
49
52
  const data = await apiGet({
50
53
  path: `/v1/news/${encodeURIComponent(cmdOpts.id)}`,
51
- params: { body: cmdOpts.body },
52
54
  });
53
55
  const saved = await savePdf(data.pdf, cmdOpts, 'Downloading news PDF...');
54
56
  output(data, opts, () => {
@@ -1 +1 @@
1
- {"version":3,"file":"news.js","sourceRoot":"","sources":["../../../src/commands/news.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,MAAM,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD;;;GAGG;AAEH,8GAA8G;AAC9G,MAAM,OAAO,GAAG;IACd,IAAI;IACJ,cAAc;IACd,OAAO;IACP,MAAM;IACN,WAAW;IACX,KAAK;IACL,gBAAgB;IAChB,uBAAuB;IACvB,4BAA4B;IAC5B,wBAAwB;IACxB,0BAA0B;IAC1B,oBAAoB;IACpB,wBAAwB;IACxB,6BAA6B;IAC7B,uBAAuB;IACvB,iBAAiB;IACjB,SAAS;IACT,WAAW;IACX,WAAW;CACZ,CAAC;AAEF,MAAM,UAAU,oBAAoB,CAAC,OAAgB;IACnD,MAAM,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,MAAM,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAEpG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;SAChB,WAAW,CAAC,iBAAiB,CAAC;SAC9B,cAAc,CAAC,WAAW,EAAE,cAAc,CAAC;SAC3C,SAAS,CAAC,IAAI,MAAM,CAAC,eAAe,EAAE,8IAA8I,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;SACxN,MAAM,CAAC,OAAO,EAAE,+CAA+C,CAAC;SAChE,MAAM,CAAC,kBAAkB,EAAE,mDAAmD,CAAC;SAC/E,MAAM,CAAC,SAAS,EAAE,sCAAsC,CAAC;SACzD,MAAM,CAAC,iBAAiB,CAAC,KAAK,EAAE,OAAuF,EAAE,EAAE;QAC1H,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;QAC5B,IAAI,IAAI,CAAC,IAAI;YAAE,WAAW,CAAC,IAAI,CAAC,CAAC;QACjC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAsB;YAC7C,IAAI,EAAE,YAAY,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;YAClD,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE;SAC/B,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,yBAAyB,CAAC,CAAC;QAC1E,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE;YACtB,IAAI,KAAK,EAAE,CAAC;gBACV,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC/F,OAAO;YACT,CAAC;YACD,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;gBAChB,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACtB,OAAO;YACT,CAAC;YACD,cAAc,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC;AACtB,CAAC"}
1
+ {"version":3,"file":"news.js","sourceRoot":"","sources":["../../../src/commands/news.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD;;;GAGG;AAEH;;;GAGG;AACH,MAAM,OAAO,GAAG;IACd,IAAI;IACJ,cAAc;IACd,OAAO;IACP,MAAM;IACN,WAAW;IACX,KAAK;IACL,uBAAuB;IACvB,4BAA4B;IAC5B,wBAAwB;IACxB,0BAA0B;IAC1B,oBAAoB;IACpB,wBAAwB;IACxB,6BAA6B;IAC7B,uBAAuB;IACvB,gBAAgB;IAChB,eAAe;IACf,cAAc;IACd,eAAe;IACf,SAAS;IACT,cAAc;IACd,cAAc;CACf,CAAC;AAEF,MAAM,UAAU,oBAAoB,CAAC,OAAgB;IACnD,MAAM,IAAI,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,MAAM,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAEpG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;SAChB,WAAW,CAAC,4DAA4D,CAAC;SACzE,cAAc,CAAC,WAAW,EAAE,cAAc,CAAC;SAC3C,MAAM,CAAC,OAAO,EAAE,+CAA+C,CAAC;SAChE,MAAM,CAAC,kBAAkB,EAAE,mDAAmD,CAAC;SAC/E,MAAM,CAAC,SAAS,EAAE,sCAAsC,CAAC;SACzD,MAAM,CAAC,iBAAiB,CAAC,KAAK,EAAE,OAAwE,EAAE,EAAE;QAC3G,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;QAC5B,IAAI,IAAI,CAAC,IAAI;YAAE,WAAW,CAAC,IAAI,CAAC,CAAC;QACjC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAsB;YAC7C,IAAI,EAAE,YAAY,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;SACnD,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,yBAAyB,CAAC,CAAC;QAC1E,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE;YACtB,IAAI,KAAK,EAAE,CAAC;gBACV,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC/F,OAAO;YACT,CAAC;YACD,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;gBAChB,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACtB,OAAO;YACT,CAAC;YACD,cAAc,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC;AACtB,CAAC"}
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "specVersion": "1.0.0",
3
- "specSha256": "558348830d2357af9cbbb9e5cb7f3ab1d6538afbf990ea779ccb07546df5c405",
3
+ "specSha256": "f2359dda15915d63db6863c844c1ca07e9cfd365e1296a1901310967b79e24ce",
4
4
  "groups": [
5
5
  {
6
6
  "name": "company",
@@ -601,6 +601,18 @@
601
601
  "confirmed"
602
602
  ],
603
603
  "description": "Filter by `calendar.status` (repeatable), applied beside `status`"
604
+ },
605
+ {
606
+ "name": "include_expired",
607
+ "in": "query",
608
+ "required": false,
609
+ "type": "string",
610
+ "enum": [
611
+ "true",
612
+ "false"
613
+ ],
614
+ "example": "false",
615
+ "description": "Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer; see `expired_reason`) are omitted unless true. Default: false"
604
616
  }
605
617
  ],
606
618
  "view": "table",
@@ -1001,6 +1013,18 @@
1001
1013
  "default": 0,
1002
1014
  "example": 0,
1003
1015
  "description": "Number of events to skip for pagination"
1016
+ },
1017
+ {
1018
+ "name": "include_expired",
1019
+ "in": "query",
1020
+ "required": false,
1021
+ "type": "string",
1022
+ "enum": [
1023
+ "true",
1024
+ "false"
1025
+ ],
1026
+ "example": "false",
1027
+ "description": "Expired calendar rows (an estimate that never became a call, a duplicate, a non-call issuer; see `expired_reason`) are omitted unless true. Default: false"
1004
1028
  }
1005
1029
  ],
1006
1030
  "view": "table",
@@ -2242,6 +2266,19 @@
2242
2266
  "default": 0,
2243
2267
  "example": 0,
2244
2268
  "description": "Number of periods to skip for pagination"
2269
+ },
2270
+ {
2271
+ "name": "reported_only",
2272
+ "in": "query",
2273
+ "required": false,
2274
+ "type": "string",
2275
+ "enum": [
2276
+ "true",
2277
+ "false"
2278
+ ],
2279
+ "default": "false",
2280
+ "example": "true",
2281
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
2245
2282
  }
2246
2283
  ],
2247
2284
  "view": "json",
@@ -2327,7 +2364,20 @@
2327
2364
  ],
2328
2365
  "default": "false",
2329
2366
  "example": "true",
2330
- "description": "Include formula in response"
2367
+ "description": "Include each derived fact's formula (its members and their values)"
2368
+ },
2369
+ {
2370
+ "name": "reported_only",
2371
+ "in": "query",
2372
+ "required": false,
2373
+ "type": "string",
2374
+ "enum": [
2375
+ "true",
2376
+ "false"
2377
+ ],
2378
+ "default": "false",
2379
+ "example": "true",
2380
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
2331
2381
  }
2332
2382
  ],
2333
2383
  "view": "json",
@@ -2401,6 +2451,19 @@
2401
2451
  "default": 0,
2402
2452
  "example": 0,
2403
2453
  "description": "Number of periods to skip for pagination"
2454
+ },
2455
+ {
2456
+ "name": "reported_only",
2457
+ "in": "query",
2458
+ "required": false,
2459
+ "type": "string",
2460
+ "enum": [
2461
+ "true",
2462
+ "false"
2463
+ ],
2464
+ "default": "false",
2465
+ "example": "true",
2466
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
2404
2467
  }
2405
2468
  ],
2406
2469
  "view": "json",
@@ -2474,6 +2537,32 @@
2474
2537
  "default": 0,
2475
2538
  "example": 0,
2476
2539
  "description": "Number of periods to skip for pagination"
2540
+ },
2541
+ {
2542
+ "name": "reported_only",
2543
+ "in": "query",
2544
+ "required": false,
2545
+ "type": "string",
2546
+ "enum": [
2547
+ "true",
2548
+ "false"
2549
+ ],
2550
+ "default": "false",
2551
+ "example": "true",
2552
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
2553
+ },
2554
+ {
2555
+ "name": "display_sign",
2556
+ "in": "query",
2557
+ "required": false,
2558
+ "type": "string",
2559
+ "enum": [
2560
+ "as_filed",
2561
+ "cash_flow_direction"
2562
+ ],
2563
+ "default": "as_filed",
2564
+ "example": "as_filed",
2565
+ "description": "Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive)."
2477
2566
  }
2478
2567
  ],
2479
2568
  "view": "json",
@@ -2559,7 +2648,33 @@
2559
2648
  ],
2560
2649
  "default": "false",
2561
2650
  "example": "true",
2562
- "description": "Include formula in response"
2651
+ "description": "Include each derived fact's formula (its members and their values)"
2652
+ },
2653
+ {
2654
+ "name": "reported_only",
2655
+ "in": "query",
2656
+ "required": false,
2657
+ "type": "string",
2658
+ "enum": [
2659
+ "true",
2660
+ "false"
2661
+ ],
2662
+ "default": "false",
2663
+ "example": "true",
2664
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
2665
+ },
2666
+ {
2667
+ "name": "display_sign",
2668
+ "in": "query",
2669
+ "required": false,
2670
+ "type": "string",
2671
+ "enum": [
2672
+ "as_filed",
2673
+ "cash_flow_direction"
2674
+ ],
2675
+ "default": "as_filed",
2676
+ "example": "as_filed",
2677
+ "description": "Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive)."
2563
2678
  }
2564
2679
  ],
2565
2680
  "view": "json",
@@ -2633,6 +2748,32 @@
2633
2748
  "default": 0,
2634
2749
  "example": 0,
2635
2750
  "description": "Number of periods to skip for pagination"
2751
+ },
2752
+ {
2753
+ "name": "reported_only",
2754
+ "in": "query",
2755
+ "required": false,
2756
+ "type": "string",
2757
+ "enum": [
2758
+ "true",
2759
+ "false"
2760
+ ],
2761
+ "default": "false",
2762
+ "example": "true",
2763
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
2764
+ },
2765
+ {
2766
+ "name": "display_sign",
2767
+ "in": "query",
2768
+ "required": false,
2769
+ "type": "string",
2770
+ "enum": [
2771
+ "as_filed",
2772
+ "cash_flow_direction"
2773
+ ],
2774
+ "default": "as_filed",
2775
+ "example": "as_filed",
2776
+ "description": "Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive)."
2636
2777
  }
2637
2778
  ],
2638
2779
  "view": "json",
@@ -2706,6 +2847,19 @@
2706
2847
  "default": 0,
2707
2848
  "example": 0,
2708
2849
  "description": "Number of periods to skip for pagination"
2850
+ },
2851
+ {
2852
+ "name": "reported_only",
2853
+ "in": "query",
2854
+ "required": false,
2855
+ "type": "string",
2856
+ "enum": [
2857
+ "true",
2858
+ "false"
2859
+ ],
2860
+ "default": "false",
2861
+ "example": "true",
2862
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
2709
2863
  }
2710
2864
  ],
2711
2865
  "view": "json",
@@ -2791,7 +2945,20 @@
2791
2945
  ],
2792
2946
  "default": "false",
2793
2947
  "example": "true",
2794
- "description": "Include formula in response"
2948
+ "description": "Include each derived fact's formula (its members and their values)"
2949
+ },
2950
+ {
2951
+ "name": "reported_only",
2952
+ "in": "query",
2953
+ "required": false,
2954
+ "type": "string",
2955
+ "enum": [
2956
+ "true",
2957
+ "false"
2958
+ ],
2959
+ "default": "false",
2960
+ "example": "true",
2961
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
2795
2962
  }
2796
2963
  ],
2797
2964
  "view": "json",
@@ -2865,6 +3032,19 @@
2865
3032
  "default": 0,
2866
3033
  "example": 0,
2867
3034
  "description": "Number of periods to skip for pagination"
3035
+ },
3036
+ {
3037
+ "name": "reported_only",
3038
+ "in": "query",
3039
+ "required": false,
3040
+ "type": "string",
3041
+ "enum": [
3042
+ "true",
3043
+ "false"
3044
+ ],
3045
+ "default": "false",
3046
+ "example": "true",
3047
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
2868
3048
  }
2869
3049
  ],
2870
3050
  "view": "json",
@@ -2921,6 +3101,32 @@
2921
3101
  "type": "integer",
2922
3102
  "example": 4,
2923
3103
  "description": "Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year."
3104
+ },
3105
+ {
3106
+ "name": "reported_only",
3107
+ "in": "query",
3108
+ "required": false,
3109
+ "type": "string",
3110
+ "enum": [
3111
+ "true",
3112
+ "false"
3113
+ ],
3114
+ "default": "false",
3115
+ "example": "true",
3116
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
3117
+ },
3118
+ {
3119
+ "name": "display_sign",
3120
+ "in": "query",
3121
+ "required": false,
3122
+ "type": "string",
3123
+ "enum": [
3124
+ "as_filed",
3125
+ "cash_flow_direction"
3126
+ ],
3127
+ "default": "as_filed",
3128
+ "example": "as_filed",
3129
+ "description": "Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive)."
2924
3130
  }
2925
3131
  ],
2926
3132
  "view": "json",
@@ -2975,6 +3181,32 @@
2975
3181
  "example": 4,
2976
3182
  "description": "Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year."
2977
3183
  },
3184
+ {
3185
+ "name": "reported_only",
3186
+ "in": "query",
3187
+ "required": false,
3188
+ "type": "string",
3189
+ "enum": [
3190
+ "true",
3191
+ "false"
3192
+ ],
3193
+ "default": "false",
3194
+ "example": "true",
3195
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
3196
+ },
3197
+ {
3198
+ "name": "display_sign",
3199
+ "in": "query",
3200
+ "required": false,
3201
+ "type": "string",
3202
+ "enum": [
3203
+ "as_filed",
3204
+ "cash_flow_direction"
3205
+ ],
3206
+ "default": "as_filed",
3207
+ "example": "as_filed",
3208
+ "description": "Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive)."
3209
+ },
2978
3210
  {
2979
3211
  "name": "with_formula",
2980
3212
  "in": "query",
@@ -2986,7 +3218,7 @@
2986
3218
  ],
2987
3219
  "default": "false",
2988
3220
  "example": "true",
2989
- "description": "Include formula in response"
3221
+ "description": "Include each derived fact's formula (its members and their values)"
2990
3222
  }
2991
3223
  ],
2992
3224
  "view": "json",
@@ -3040,6 +3272,32 @@
3040
3272
  "type": "integer",
3041
3273
  "example": 4,
3042
3274
  "description": "Calendar quarter (1-4). For annual periods, should not be provided. For non-annual periods, must be provided together with calendar_year."
3275
+ },
3276
+ {
3277
+ "name": "reported_only",
3278
+ "in": "query",
3279
+ "required": false,
3280
+ "type": "string",
3281
+ "enum": [
3282
+ "true",
3283
+ "false"
3284
+ ],
3285
+ "default": "false",
3286
+ "example": "true",
3287
+ "description": "`true`: only the facts the company reported (`derived: false`); the pipeline's derived Q4 / TTM / YTD values are left out"
3288
+ },
3289
+ {
3290
+ "name": "display_sign",
3291
+ "in": "query",
3292
+ "required": false,
3293
+ "type": "string",
3294
+ "enum": [
3295
+ "as_filed",
3296
+ "cash_flow_direction"
3297
+ ],
3298
+ "default": "as_filed",
3299
+ "example": "as_filed",
3300
+ "description": "Sign of cash-flow facts. `as_filed` (default): the value as the company tagged it in XBRL. `cash_flow_direction`: a credit-balance cash-flow fact (outside the supplemental disclosures) is negated so outflows read negative. Standardized cash-flow metrics already carry one sign per metric (outflows negative, capital expenditures positive)."
3043
3301
  }
3044
3302
  ],
3045
3303
  "view": "json",
@@ -4565,54 +4823,6 @@
4565
4823
  "periods"
4566
4824
  ]
4567
4825
  },
4568
- {
4569
- "operationId": "newsAssetDownload",
4570
- "group": "news",
4571
- "action": "asset-download",
4572
- "method": "get",
4573
- "path": "/v1/news/{id}/assets/{asset_id}/download",
4574
- "auth": true,
4575
- "summary": "Get a short-lived URL of a news image or file",
4576
- "params": [
4577
- {
4578
- "name": "purpose",
4579
- "in": "query",
4580
- "required": false,
4581
- "type": "string",
4582
- "enum": [
4583
- "display",
4584
- "download"
4585
- ],
4586
- "example": "display",
4587
- "description": "display = an inline URL (an image with `can_display`, or a PDF with `can_download`: viewed in the browser); download = an attachment (`can_download`). Omitted: download when allowed, else display"
4588
- },
4589
- {
4590
- "name": "id",
4591
- "in": "path",
4592
- "required": true,
4593
- "type": "string",
4594
- "example": "13351ae7-876b-4839-ba2b-78873f6b4e00",
4595
- "description": "News item id"
4596
- },
4597
- {
4598
- "name": "asset_id",
4599
- "in": "path",
4600
- "required": true,
4601
- "type": "string",
4602
- "example": "612cd78d-b618-42c6-b3be-ff5c9df1a0f7",
4603
- "description": "Asset id (`assets[].id` of the item)"
4604
- }
4605
- ],
4606
- "view": "keyValue",
4607
- "columns": [
4608
- "purpose",
4609
- "url",
4610
- "expires_at",
4611
- "content_type",
4612
- "credit"
4613
- ],
4614
- "pagination": "none"
4615
- },
4616
4826
  {
4617
4827
  "operationId": "newsDevelopments",
4618
4828
  "group": "news",
@@ -4808,18 +5018,6 @@
4808
5018
  "example": "true",
4809
5019
  "description": "true = only earnings news (results, results dates, call announcements, guidance); false = none of it"
4810
5020
  },
4811
- {
4812
- "name": "has_media",
4813
- "in": "query",
4814
- "required": false,
4815
- "type": "string",
4816
- "enum": [
4817
- "true",
4818
- "false"
4819
- ],
4820
- "example": "true",
4821
- "description": "true = only items with media you can get now (`media_count` > 0: an original PDF or image to show or download); false = items without"
4822
- },
4823
5021
  {
4824
5022
  "name": "publisher",
4825
5023
  "in": "query",
@@ -4949,12 +5147,13 @@
4949
5147
  "type": "string",
4950
5148
  "enum": [
4951
5149
  "title",
4952
- "body",
5150
+ "lede",
5151
+ "summary",
4953
5152
  "any"
4954
5153
  ],
4955
5154
  "default": "any",
4956
5155
  "example": "any",
4957
- "description": "title = headlines and ledes, body = the item text, any = both"
5156
+ "description": "title = headlines, lede = the ledes, summary = the summaries, any = every field"
4958
5157
  },
4959
5158
  {
4960
5159
  "name": "ticker",
@@ -5071,7 +5270,7 @@
5071
5270
  "method": "get",
5072
5271
  "path": "/v1/news/{id}/text",
5073
5272
  "auth": true,
5074
- "summary": "Get a news item's text in blocks",
5273
+ "summary": "Get a news item's summary in blocks",
5075
5274
  "params": [
5076
5275
  {
5077
5276
  "name": "limit",
@@ -5089,7 +5288,7 @@
5089
5288
  "type": "integer",
5090
5289
  "default": 12000,
5091
5290
  "example": 12000,
5092
- "description": "Unicode code points per page; a block is never split (the minimum is the largest block)"
5291
+ "description": "Unicode code points per page; a block is never split (the minimum is larger than any block)"
5093
5292
  },
5094
5293
  {
5095
5294
  "name": "cursor",
@@ -5104,7 +5303,7 @@
5104
5303
  "in": "path",
5105
5304
  "required": true,
5106
5305
  "type": "string",
5107
- "example": "13351ae7-876b-4839-ba2b-78873f6b4e00",
5306
+ "example": "06304274-da4a-400e-9d5c-fb4ce04f01c9",
5108
5307
  "description": "News item id"
5109
5308
  }
5110
5309
  ],
@@ -4,7 +4,7 @@ export declare function flagName(parameterName: string): string;
4
4
  export declare const RESERVED_FLAGS: readonly string[];
5
5
  /**
6
6
  * The JSON-body flags `defineOperationCommand` adds to an operation WITH a request body only: a body-less read may
7
- * name a parameter `body` (`GET /v1/news/{id}?body=html` → `invd news get --body html`).
7
+ * name a parameter `body` (a `GET …?body=html` would become `--body html`).
8
8
  */
9
9
  export declare const BODY_FLAGS: readonly string[];
10
10
  /** Short flags commander owns (`-V`, `-h`). */
@@ -6,7 +6,7 @@ export function flagName(parameterName) {
6
6
  export const RESERVED_FLAGS = ['json', 'all', 'show-cost', 'version', 'help'];
7
7
  /**
8
8
  * The JSON-body flags `defineOperationCommand` adds to an operation WITH a request body only: a body-less read may
9
- * name a parameter `body` (`GET /v1/news/{id}?body=html` → `invd news get --body html`).
9
+ * name a parameter `body` (a `GET …?body=html` would become `--body html`).
10
10
  */
11
11
  export const BODY_FLAGS = ['body', 'body-file'];
12
12
  /** Short flags commander owns (`-V`, `-h`). */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@invinite-org/invinite-data-cli",
3
- "version": "1.2.0",
3
+ "version": "3.0.0",
4
4
  "type": "module",
5
5
  "description": "CLI for the Invinite Data API",
6
6
  "publishConfig": {