@invinite-org/data-api-client 6.1.0 → 6.2.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.
Files changed (41) hide show
  1. package/dist/apis/FilingsApi.d.ts +2 -2
  2. package/dist/apis/FilingsApi.js +2 -2
  3. package/dist/apis/ReferenceApi.d.ts +4 -4
  4. package/dist/apis/ReferenceApi.js +4 -4
  5. package/dist/esm/apis/FilingsApi.d.ts +2 -2
  6. package/dist/esm/apis/FilingsApi.js +2 -2
  7. package/dist/esm/apis/ReferenceApi.d.ts +4 -4
  8. package/dist/esm/apis/ReferenceApi.js +4 -4
  9. package/dist/esm/models/AlertCondition.d.ts +3 -3
  10. package/dist/esm/models/AlertConditionInput.d.ts +3 -3
  11. package/dist/esm/models/Company.d.ts +8 -8
  12. package/dist/esm/models/CompanyListItem.d.ts +1 -1
  13. package/dist/esm/models/CompanyRef.d.ts +1 -1
  14. package/dist/models/AlertCondition.d.ts +3 -3
  15. package/dist/models/AlertConditionInput.d.ts +3 -3
  16. package/dist/models/Company.d.ts +8 -8
  17. package/dist/models/CompanyListItem.d.ts +1 -1
  18. package/dist/models/CompanyRef.d.ts +1 -1
  19. package/docs/AlertCondition.md +1 -1
  20. package/docs/AlertConditionInput.md +1 -1
  21. package/docs/CompaniesApi.md +2 -2
  22. package/docs/EventsApi.md +2 -2
  23. package/docs/FilingsApi.md +5 -5
  24. package/docs/FinancialsApi.md +12 -12
  25. package/docs/GuidanceApi.md +4 -4
  26. package/docs/HoldingsApi.md +6 -6
  27. package/docs/IPOsApi.md +2 -2
  28. package/docs/InsiderTradesApi.md +2 -2
  29. package/docs/InvestorDocumentsApi.md +4 -4
  30. package/docs/MetricsApi.md +10 -10
  31. package/docs/NewsApi.md +6 -6
  32. package/docs/ReferenceApi.md +8 -8
  33. package/docs/TranscriptsApi.md +2 -2
  34. package/package.json +1 -1
  35. package/src/apis/FilingsApi.ts +2 -2
  36. package/src/apis/ReferenceApi.ts +4 -4
  37. package/src/models/AlertCondition.ts +3 -3
  38. package/src/models/AlertConditionInput.ts +3 -3
  39. package/src/models/Company.ts +8 -8
  40. package/src/models/CompanyListItem.ts +1 -1
  41. package/src/models/CompanyRef.ts +1 -1
@@ -538,7 +538,7 @@ export class FilingsApi extends runtime.BaseAPI {
538
538
  }
539
539
 
540
540
  /**
541
- * A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false.
541
+ * A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false. For a US ETF that is a series of a multi-series trust (TQQQ), only the accessions naming its series (`series_id`) are listed, never the whole trust; an ETF that is its own SEC registrant (SPY, QQQ) lists its registrant\'s filings.
542
542
  * List filings
543
543
  */
544
544
  async listFilingsRaw(requestParameters: ListFilingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListFilings200Response>> {
@@ -549,7 +549,7 @@ export class FilingsApi extends runtime.BaseAPI {
549
549
  }
550
550
 
551
551
  /**
552
- * A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false.
552
+ * A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false. For a US ETF that is a series of a multi-series trust (TQQQ), only the accessions naming its series (`series_id`) are listed, never the whole trust; an ETF that is its own SEC registrant (SPY, QQQ) lists its registrant\'s filings.
553
553
  * List filings
554
554
  */
555
555
  async listFilings(requestParameters: ListFilingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListFilings200Response> {
@@ -154,7 +154,7 @@ export class ReferenceApi extends runtime.BaseAPI {
154
154
  }
155
155
 
156
156
  /**
157
- *
157
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
158
158
  * List dividends
159
159
  */
160
160
  async listDividendsRaw(requestParameters: ListDividendsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListDividends200Response>> {
@@ -165,7 +165,7 @@ export class ReferenceApi extends runtime.BaseAPI {
165
165
  }
166
166
 
167
167
  /**
168
- *
168
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
169
169
  * List dividends
170
170
  */
171
171
  async listDividends(requestParameters: ListDividendsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListDividends200Response> {
@@ -381,7 +381,7 @@ export class ReferenceApi extends runtime.BaseAPI {
381
381
  }
382
382
 
383
383
  /**
384
- *
384
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
385
385
  * List stock splits
386
386
  */
387
387
  async listSplitsRaw(requestParameters: ListSplitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListSplits200Response>> {
@@ -392,7 +392,7 @@ export class ReferenceApi extends runtime.BaseAPI {
392
392
  }
393
393
 
394
394
  /**
395
- *
395
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
396
396
  * List stock splits
397
397
  */
398
398
  async listSplits(requestParameters: ListSplitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListSplits200Response> {
@@ -50,7 +50,7 @@ import {
50
50
  } from './AlertConditionYoyRulesInner';
51
51
 
52
52
  /**
53
- * What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) watch ONE instrument: `symbol` + `asset_class`. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls.
53
+ * What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) watch ONE instrument: `symbol` + `asset_class`. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`), `news` / `news_keyword` a series ETF.
54
54
  * @export
55
55
  * @interface AlertCondition
56
56
  */
@@ -62,7 +62,7 @@ export interface AlertCondition {
62
62
  */
63
63
  ciks?: Array<string>;
64
64
  /**
65
- * Companies by ticker. Same types as `ciks`
65
+ * Companies by ticker. Same types as `ciks`; a US ETF ticker for the types that take ETFs
66
66
  * @type {Array<string>}
67
67
  * @memberof AlertCondition
68
68
  */
@@ -74,7 +74,7 @@ export interface AlertCondition {
74
74
  */
75
75
  cik?: string;
76
76
  /**
77
- * The company by ticker. Same types as `cik`; price types: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
77
+ * The company (or, for the types that take ETFs, the US ETF) by ticker. Same types as `cik`; price types: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
78
78
  * @type {string}
79
79
  * @memberof AlertCondition
80
80
  */
@@ -50,7 +50,7 @@ import {
50
50
  } from './AlertConditionInputYieldRule';
51
51
 
52
52
  /**
53
- * What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) watch ONE instrument: `symbol` + `asset_class`. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. (request form)
53
+ * What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) watch ONE instrument: `symbol` + `asset_class`. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. (request form) US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`), `news` / `news_keyword` a series ETF.
54
54
  * @export
55
55
  * @interface AlertConditionInput
56
56
  */
@@ -62,7 +62,7 @@ export interface AlertConditionInput {
62
62
  */
63
63
  ciks?: Array<string>;
64
64
  /**
65
- * Companies by ticker. Same types as `ciks`
65
+ * Companies by ticker. Same types as `ciks`; a US ETF ticker for the types that take ETFs
66
66
  * @type {Array<string>}
67
67
  * @memberof AlertConditionInput
68
68
  */
@@ -74,7 +74,7 @@ export interface AlertConditionInput {
74
74
  */
75
75
  cik?: string;
76
76
  /**
77
- * The company by ticker. Same types as `cik`; price types: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
77
+ * The company (or, for the types that take ETFs, the US ETF) by ticker. Same types as `cik`; price types: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
78
78
  * @type {string}
79
79
  * @memberof AlertConditionInput
80
80
  */
@@ -58,23 +58,23 @@ export interface Company {
58
58
  */
59
59
  category: string;
60
60
  /**
61
- * Sector, from the issuer's SIC code (SEC mapping)
61
+ * Sector, from the issuer's SIC code (SEC mapping); null for a US ETF (no SIC-derived values are shown for a fund)
62
62
  * @type {string}
63
63
  * @memberof Company
64
64
  */
65
- sector: string;
65
+ sector: string | null;
66
66
  /**
67
- * Industry, from the issuer's SIC code (SEC mapping)
67
+ * Industry, from the issuer's SIC code (SEC mapping); null for a US ETF (no SIC-derived values are shown for a fund)
68
68
  * @type {string}
69
69
  * @memberof Company
70
70
  */
71
- industry: string;
71
+ industry: string | null;
72
72
  /**
73
- * SIC code
73
+ * SIC code; null for a US ETF (no SIC-derived values are shown for a fund)
74
74
  * @type {string}
75
75
  * @memberof Company
76
76
  */
77
- sic: string;
77
+ sic: string | null;
78
78
  /**
79
79
  * Fama-French sector
80
80
  * @type {string}
@@ -208,13 +208,13 @@ export interface Company {
208
208
  */
209
209
  street: string | null;
210
210
  /**
211
- * City
211
+ * City; null for a US ETF
212
212
  * @type {string}
213
213
  * @memberof Company
214
214
  */
215
215
  city: string | null;
216
216
  /**
217
- * State or province
217
+ * State or province; null for a US ETF
218
218
  * @type {string}
219
219
  * @memberof Company
220
220
  */
@@ -44,7 +44,7 @@ export interface CompanyListItem {
44
44
  */
45
45
  exchange: string | null;
46
46
  /**
47
- * Sector
47
+ * Sector; null for a US ETF
48
48
  * @type {string}
49
49
  * @memberof CompanyListItem
50
50
  */
@@ -20,7 +20,7 @@ import { mapValues } from '../runtime';
20
20
  */
21
21
  export interface CompanyRef {
22
22
  /**
23
- * SEC CIK, 10 digits
23
+ * SEC CIK, 10 digits; for a US ETF that is a series of a trust (TQQQ) the trust's CIK, empty ("") for such an ETF without a registrant link
24
24
  * @type {string}
25
25
  * @memberof CompanyRef
26
26
  */