@invinite-org/data-api-client 6.0.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 (69) 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 +199 -5
  10. package/dist/esm/models/AlertCondition.js +113 -0
  11. package/dist/esm/models/AlertConditionInput.d.ts +199 -5
  12. package/dist/esm/models/AlertConditionInput.js +113 -0
  13. package/dist/esm/models/Company.d.ts +8 -8
  14. package/dist/esm/models/CompanyListItem.d.ts +1 -1
  15. package/dist/esm/models/CompanyRef.d.ts +1 -1
  16. package/dist/esm/models/CreateDestinationRequest.d.ts +12 -0
  17. package/dist/esm/models/CreateDestinationRequest.js +4 -0
  18. package/dist/esm/models/Destination.d.ts +12 -0
  19. package/dist/esm/models/Destination.js +8 -0
  20. package/dist/esm/models/DestinationCreated.d.ts +12 -0
  21. package/dist/esm/models/DestinationCreated.js +8 -0
  22. package/dist/esm/models/UpdateDestinationRequest.d.ts +12 -0
  23. package/dist/esm/models/UpdateDestinationRequest.js +4 -0
  24. package/dist/models/AlertCondition.d.ts +199 -5
  25. package/dist/models/AlertCondition.js +114 -1
  26. package/dist/models/AlertConditionInput.d.ts +199 -5
  27. package/dist/models/AlertConditionInput.js +114 -1
  28. package/dist/models/Company.d.ts +8 -8
  29. package/dist/models/CompanyListItem.d.ts +1 -1
  30. package/dist/models/CompanyRef.d.ts +1 -1
  31. package/dist/models/CreateDestinationRequest.d.ts +12 -0
  32. package/dist/models/CreateDestinationRequest.js +4 -0
  33. package/dist/models/Destination.d.ts +12 -0
  34. package/dist/models/Destination.js +8 -0
  35. package/dist/models/DestinationCreated.d.ts +12 -0
  36. package/dist/models/DestinationCreated.js +8 -0
  37. package/dist/models/UpdateDestinationRequest.d.ts +12 -0
  38. package/dist/models/UpdateDestinationRequest.js +4 -0
  39. package/docs/AlertCondition.md +37 -1
  40. package/docs/AlertConditionInput.md +37 -1
  41. package/docs/CompaniesApi.md +2 -2
  42. package/docs/CreateDestinationRequest.md +4 -0
  43. package/docs/Destination.md +4 -0
  44. package/docs/DestinationCreated.md +4 -0
  45. package/docs/EventsApi.md +2 -2
  46. package/docs/FilingsApi.md +5 -5
  47. package/docs/FinancialsApi.md +12 -12
  48. package/docs/GuidanceApi.md +4 -4
  49. package/docs/HoldingsApi.md +6 -6
  50. package/docs/IPOsApi.md +2 -2
  51. package/docs/InsiderTradesApi.md +2 -2
  52. package/docs/InvestorDocumentsApi.md +4 -4
  53. package/docs/MetricsApi.md +10 -10
  54. package/docs/NewsApi.md +6 -6
  55. package/docs/ReferenceApi.md +8 -8
  56. package/docs/TranscriptsApi.md +2 -2
  57. package/docs/UpdateDestinationRequest.md +4 -0
  58. package/package.json +1 -1
  59. package/src/apis/FilingsApi.ts +2 -2
  60. package/src/apis/ReferenceApi.ts +4 -4
  61. package/src/models/AlertCondition.ts +244 -5
  62. package/src/models/AlertConditionInput.ts +244 -5
  63. package/src/models/Company.ts +8 -8
  64. package/src/models/CompanyListItem.ts +1 -1
  65. package/src/models/CompanyRef.ts +1 -1
  66. package/src/models/CreateDestinationRequest.ts +16 -0
  67. package/src/models/Destination.ts +18 -0
  68. package/src/models/DestinationCreated.ts +18 -0
  69. package/src/models/UpdateDestinationRequest.ts +16 -0
@@ -17,7 +17,7 @@ All URIs are relative to *https://api.data.invinite.com*
17
17
 
18
18
  List dividends
19
19
 
20
-
20
+ Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
21
21
 
22
22
  ### Example
23
23
 
@@ -37,7 +37,7 @@ async function example() {
37
37
  const api = new ReferenceApi(config);
38
38
 
39
39
  const body = {
40
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required.
40
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company.
41
41
  company: AAPL,
42
42
  // Date | `ex_date` on or after this value (optional)
43
43
  exDateGte: 2025-01-01,
@@ -74,7 +74,7 @@ example().catch(console.error);
74
74
 
75
75
  | Name | Type | Description | Notes |
76
76
  |------------- | ------------- | ------------- | -------------|
77
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. | [Defaults to `undefined`] |
77
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
78
78
  | **exDateGte** | `Date` | `ex_date` on or after this value | [Optional] [Defaults to `undefined`] |
79
79
  | **exDateGt** | `Date` | `ex_date` after this value | [Optional] [Defaults to `undefined`] |
80
80
  | **exDateLte** | `Date` | `ex_date` on or before this value | [Optional] [Defaults to `undefined`] |
@@ -141,7 +141,7 @@ async function example() {
141
141
  const api = new ReferenceApi(config);
142
142
 
143
143
  const body = {
144
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required.
144
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company.
145
145
  company: AAPL,
146
146
  // 'period_end' | '-period_end' | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-period_end` (optional)
147
147
  sort: -period_end,
@@ -170,7 +170,7 @@ example().catch(console.error);
170
170
 
171
171
  | Name | Type | Description | Notes |
172
172
  |------------- | ------------- | ------------- | -------------|
173
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. | [Defaults to `undefined`] |
173
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
174
174
  | **sort** | `period_end`, `-period_end` | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-period_end` | [Optional] [Defaults to `'-period_end'`] [Enum: period_end, -period_end] |
175
175
  | **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
176
176
  | **limit** | `number` | Rows per page (default 25, max 200) | [Optional] [Defaults to `25`] |
@@ -313,7 +313,7 @@ example().catch(console.error);
313
313
 
314
314
  List stock splits
315
315
 
316
-
316
+ Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
317
317
 
318
318
  ### Example
319
319
 
@@ -333,7 +333,7 @@ async function example() {
333
333
  const api = new ReferenceApi(config);
334
334
 
335
335
  const body = {
336
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required.
336
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company.
337
337
  company: AAPL,
338
338
  // 'execution_date' | '-execution_date' | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-execution_date` (optional)
339
339
  sort: -execution_date,
@@ -362,7 +362,7 @@ example().catch(console.error);
362
362
 
363
363
  | Name | Type | Description | Notes |
364
364
  |------------- | ------------- | ------------- | -------------|
365
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. | [Defaults to `undefined`] |
365
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
366
366
  | **sort** | `execution_date`, `-execution_date` | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-execution_date` | [Optional] [Defaults to `'-execution_date'`] [Enum: execution_date, -execution_date] |
367
367
  | **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
368
368
  | **limit** | `number` | Rows per page (default 25, max 200) | [Optional] [Defaults to `25`] |
@@ -387,7 +387,7 @@ async function example() {
387
387
  const body = {
388
388
  // string | Query
389
389
  q: gross margin,
390
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. (optional)
390
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. (optional)
391
391
  company: AAPL,
392
392
  // string | Event id (optional)
393
393
  event: evt_01JC8M2X,
@@ -427,7 +427,7 @@ example().catch(console.error);
427
427
  | Name | Type | Description | Notes |
428
428
  |------------- | ------------- | ------------- | -------------|
429
429
  | **q** | `string` | Query | [Defaults to `undefined`] |
430
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. | [Optional] [Defaults to `undefined`] |
430
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
431
431
  | **event** | `string` | Event id | [Optional] [Defaults to `undefined`] |
432
432
  | **type** | `string` | Text types — any of `transcript`, `qa`, `prepared`, `presentation`, comma-separated | [Optional] [Defaults to `undefined`] |
433
433
  | **mode** | `lexical`, `literal` | Mode | [Optional] [Defaults to `'lexical'`] [Enum: lexical, literal] |
@@ -13,6 +13,8 @@ Name | Type
13
13
  `headers` | { [key: string]: string; }
14
14
  `body_template` | string
15
15
  `preset` | string
16
+ `max_events_per_minute` | number
17
+ `digest_seconds` | number
16
18
  `status` | string
17
19
 
18
20
  ## Example
@@ -28,6 +30,8 @@ const example = {
28
30
  "headers": null,
29
31
  "body_template": null,
30
32
  "preset": null,
33
+ "max_events_per_minute": null,
34
+ "digest_seconds": null,
31
35
  "status": null,
32
36
  } satisfies UpdateDestinationRequest
33
37
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@invinite-org/data-api-client",
3
- "version": "6.0.0",
3
+ "version": "6.2.0",
4
4
  "description": "Typed TypeScript/JavaScript client for the Invinite Data API",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -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. 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`
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
  */
@@ -236,13 +236,13 @@ export interface AlertCondition {
236
236
  */
237
237
  minutes_before?: number;
238
238
  /**
239
- * Local minute of the day the reminder fires (default 540 = 09:00). event_countdown
239
+ * Local minute of the day the reminder fires (event_countdown: default 540 = 09:00). event_countdown, price_reminder
240
240
  * @type {number}
241
241
  * @memberof AlertCondition
242
242
  */
243
243
  time_of_day_minutes?: number;
244
244
  /**
245
- * IANA time zone. event_countdown
245
+ * IANA time zone (price_reminder: default America/New_York). event_countdown, price_reminder
246
246
  * @type {string}
247
247
  * @memberof AlertCondition
248
248
  */
@@ -253,6 +253,114 @@ export interface AlertCondition {
253
253
  * @memberof AlertCondition
254
254
  */
255
255
  notify_on_date_change?: boolean;
256
+ /**
257
+ * The instrument's market: `us_stock` (US stocks and ETFs) or `crypto` (coins by CoinGecko slug or ticker). Absent at create = a stock first, then a coin; stored resolved. price, price_move, volume_spike, price_reminder
258
+ * @type {AlertConditionAssetClassEnum}
259
+ * @memberof AlertCondition
260
+ */
261
+ asset_class?: AlertConditionAssetClassEnum;
262
+ /**
263
+ * `crosses_*` fire when the price crosses `level`; `above` / `below` also fire at once when the price is already on that side. price
264
+ * @type {AlertConditionOperatorEnum}
265
+ * @memberof AlertCondition
266
+ */
267
+ operator?: AlertConditionOperatorEnum;
268
+ /**
269
+ * The price level (> 0). price
270
+ * @type {number}
271
+ * @memberof AlertCondition
272
+ */
273
+ level?: number;
274
+ /**
275
+ * Which move fires. price_move
276
+ * @type {AlertConditionDirectionEnum}
277
+ * @memberof AlertCondition
278
+ */
279
+ direction?: AlertConditionDirectionEnum;
280
+ /**
281
+ * The move in percent of the baseline. price_move
282
+ * @type {number}
283
+ * @memberof AlertCondition
284
+ */
285
+ pct?: number;
286
+ /**
287
+ * What the move is measured from (ignored with window_minutes); gap_open = the session open against the prior close, once per session. price_move
288
+ * @type {AlertConditionBaselineEnum}
289
+ * @memberof AlertCondition
290
+ */
291
+ baseline?: AlertConditionBaselineEnum;
292
+ /**
293
+ * Measure the move against the price this many minutes ago instead of the baseline. price_move
294
+ * @type {number}
295
+ * @memberof AlertCondition
296
+ */
297
+ window_minutes?: number;
298
+ /**
299
+ * `relative` = a closed bar's volume ≥ multiple × its baseline; `absolute` = ≥ threshold; `session` = today's cumulative volume ≥ multiple × the 20-session average daily volume (US stocks). volume_spike
300
+ * @type {AlertConditionModeEnum}
301
+ * @memberof AlertCondition
302
+ */
303
+ mode?: AlertConditionModeEnum;
304
+ /**
305
+ * The bar evaluated at its close (relative / absolute). volume_spike
306
+ * @type {AlertConditionIntervalEnum}
307
+ * @memberof AlertCondition
308
+ */
309
+ interval?: AlertConditionIntervalEnum;
310
+ /**
311
+ * Volume multiple of the baseline (relative / session). volume_spike
312
+ * @type {number}
313
+ * @memberof AlertCondition
314
+ */
315
+ multiple?: number;
316
+ /**
317
+ * Bar volume threshold, > 0 (absolute). volume_spike
318
+ * @type {number}
319
+ * @memberof AlertCondition
320
+ */
321
+ threshold?: number;
322
+ /**
323
+ * Bars in the baseline, 5–200 (rvol_slot: sessions, 2–20). volume_spike
324
+ * @type {number}
325
+ * @memberof AlertCondition
326
+ */
327
+ lookback_bars?: number;
328
+ /**
329
+ * The volume baseline: the mean or the median of the previous bars, or `rvol_slot` = the mean of the same time-of-day bar of earlier sessions (default flat_mean). volume_spike
330
+ * @type {AlertConditionBaselineModeEnum}
331
+ * @memberof AlertCondition
332
+ */
333
+ baseline_mode?: AlertConditionBaselineModeEnum;
334
+ /**
335
+ * Only bars that closed up / down (default any). volume_spike
336
+ * @type {AlertConditionPriceDirectionEnum}
337
+ * @memberof AlertCondition
338
+ */
339
+ price_direction?: AlertConditionPriceDirectionEnum;
340
+ /**
341
+ * When the reminder fires: once at `at`, on the hour, daily or weekly at `time_of_day_minutes`. price_reminder
342
+ * @type {AlertConditionFrequencyEnum}
343
+ * @memberof AlertCondition
344
+ */
345
+ frequency?: AlertConditionFrequencyEnum;
346
+ /**
347
+ * The instant of a `once` reminder (ISO 8601 date-time with offset, e.g. 2026-12-01T14:30:00Z). price_reminder
348
+ * @type {Date}
349
+ * @memberof AlertCondition
350
+ */
351
+ at?: Date;
352
+ /**
353
+ * Day of a weekly reminder, 0 = Sunday. price_reminder
354
+ * @type {number}
355
+ * @memberof AlertCondition
356
+ */
357
+ weekday?: number;
358
+ /**
359
+ * Several weekdays (0 = Sunday) of a daily / weekly reminder. price_reminder
360
+ * @type {Array<number>}
361
+ * @memberof AlertCondition
362
+ */
363
+ days?: Array<number>;
256
364
  }
257
365
 
258
366
 
@@ -380,6 +488,101 @@ export const AlertConditionEventEnum = {
380
488
  } as const;
381
489
  export type AlertConditionEventEnum = typeof AlertConditionEventEnum[keyof typeof AlertConditionEventEnum] | (string & {});
382
490
 
491
+ /**
492
+ * @export
493
+ */
494
+ export const AlertConditionAssetClassEnum = {
495
+ UsStock: 'us_stock',
496
+ Crypto: 'crypto'
497
+ } as const;
498
+ export type AlertConditionAssetClassEnum = typeof AlertConditionAssetClassEnum[keyof typeof AlertConditionAssetClassEnum] | (string & {});
499
+
500
+ /**
501
+ * @export
502
+ */
503
+ export const AlertConditionOperatorEnum = {
504
+ CrossesAbove: 'crosses_above',
505
+ CrossesBelow: 'crosses_below',
506
+ Crosses: 'crosses',
507
+ Above: 'above',
508
+ Below: 'below'
509
+ } as const;
510
+ export type AlertConditionOperatorEnum = typeof AlertConditionOperatorEnum[keyof typeof AlertConditionOperatorEnum] | (string & {});
511
+
512
+ /**
513
+ * @export
514
+ */
515
+ export const AlertConditionDirectionEnum = {
516
+ Up: 'up',
517
+ Down: 'down',
518
+ Both: 'both'
519
+ } as const;
520
+ export type AlertConditionDirectionEnum = typeof AlertConditionDirectionEnum[keyof typeof AlertConditionDirectionEnum] | (string & {});
521
+
522
+ /**
523
+ * @export
524
+ */
525
+ export const AlertConditionBaselineEnum = {
526
+ PriorClose: 'prior_close',
527
+ IntradayOpen: 'intraday_open',
528
+ SessionHigh: 'session_high',
529
+ SessionLow: 'session_low',
530
+ GapOpen: 'gap_open'
531
+ } as const;
532
+ export type AlertConditionBaselineEnum = typeof AlertConditionBaselineEnum[keyof typeof AlertConditionBaselineEnum] | (string & {});
533
+
534
+ /**
535
+ * @export
536
+ */
537
+ export const AlertConditionModeEnum = {
538
+ Relative: 'relative',
539
+ Absolute: 'absolute',
540
+ Session: 'session'
541
+ } as const;
542
+ export type AlertConditionModeEnum = typeof AlertConditionModeEnum[keyof typeof AlertConditionModeEnum] | (string & {});
543
+
544
+ /**
545
+ * @export
546
+ */
547
+ export const AlertConditionIntervalEnum = {
548
+ _1h: '1h',
549
+ _1d: '1d',
550
+ _1w: '1w',
551
+ _1mo: '1mo'
552
+ } as const;
553
+ export type AlertConditionIntervalEnum = typeof AlertConditionIntervalEnum[keyof typeof AlertConditionIntervalEnum] | (string & {});
554
+
555
+ /**
556
+ * @export
557
+ */
558
+ export const AlertConditionBaselineModeEnum = {
559
+ FlatMean: 'flat_mean',
560
+ RvolSlot: 'rvol_slot',
561
+ Median: 'median'
562
+ } as const;
563
+ export type AlertConditionBaselineModeEnum = typeof AlertConditionBaselineModeEnum[keyof typeof AlertConditionBaselineModeEnum] | (string & {});
564
+
565
+ /**
566
+ * @export
567
+ */
568
+ export const AlertConditionPriceDirectionEnum = {
569
+ Up: 'up',
570
+ Down: 'down',
571
+ Any: 'any'
572
+ } as const;
573
+ export type AlertConditionPriceDirectionEnum = typeof AlertConditionPriceDirectionEnum[keyof typeof AlertConditionPriceDirectionEnum] | (string & {});
574
+
575
+ /**
576
+ * @export
577
+ */
578
+ export const AlertConditionFrequencyEnum = {
579
+ Once: 'once',
580
+ Hourly: 'hourly',
581
+ Daily: 'daily',
582
+ Weekly: 'weekly'
583
+ } as const;
584
+ export type AlertConditionFrequencyEnum = typeof AlertConditionFrequencyEnum[keyof typeof AlertConditionFrequencyEnum] | (string & {});
585
+
383
586
 
384
587
  /**
385
588
  * Check if a given object implements the AlertCondition interface.
@@ -431,6 +634,24 @@ export function AlertConditionFromJSONTyped(json: any, ignoreDiscriminator: bool
431
634
  'time_of_day_minutes': json['time_of_day_minutes'] == null ? undefined : json['time_of_day_minutes'],
432
635
  'timezone': json['timezone'] == null ? undefined : json['timezone'],
433
636
  'notify_on_date_change': json['notify_on_date_change'] == null ? undefined : json['notify_on_date_change'],
637
+ 'asset_class': json['asset_class'] == null ? undefined : json['asset_class'],
638
+ 'operator': json['operator'] == null ? undefined : json['operator'],
639
+ 'level': json['level'] == null ? undefined : json['level'],
640
+ 'direction': json['direction'] == null ? undefined : json['direction'],
641
+ 'pct': json['pct'] == null ? undefined : json['pct'],
642
+ 'baseline': json['baseline'] == null ? undefined : json['baseline'],
643
+ 'window_minutes': json['window_minutes'] == null ? undefined : json['window_minutes'],
644
+ 'mode': json['mode'] == null ? undefined : json['mode'],
645
+ 'interval': json['interval'] == null ? undefined : json['interval'],
646
+ 'multiple': json['multiple'] == null ? undefined : json['multiple'],
647
+ 'threshold': json['threshold'] == null ? undefined : json['threshold'],
648
+ 'lookback_bars': json['lookback_bars'] == null ? undefined : json['lookback_bars'],
649
+ 'baseline_mode': json['baseline_mode'] == null ? undefined : json['baseline_mode'],
650
+ 'price_direction': json['price_direction'] == null ? undefined : json['price_direction'],
651
+ 'frequency': json['frequency'] == null ? undefined : json['frequency'],
652
+ 'at': json['at'] == null ? undefined : (new Date(json['at'])),
653
+ 'weekday': json['weekday'] == null ? undefined : json['weekday'],
654
+ 'days': json['days'] == null ? undefined : json['days'],
434
655
  };
435
656
  }
436
657
 
@@ -478,6 +699,24 @@ export function AlertConditionToJSONTyped(value?: AlertCondition | null, ignoreD
478
699
  'time_of_day_minutes': value['time_of_day_minutes'],
479
700
  'timezone': value['timezone'],
480
701
  'notify_on_date_change': value['notify_on_date_change'],
702
+ 'asset_class': value['asset_class'],
703
+ 'operator': value['operator'],
704
+ 'level': value['level'],
705
+ 'direction': value['direction'],
706
+ 'pct': value['pct'],
707
+ 'baseline': value['baseline'],
708
+ 'window_minutes': value['window_minutes'],
709
+ 'mode': value['mode'],
710
+ 'interval': value['interval'],
711
+ 'multiple': value['multiple'],
712
+ 'threshold': value['threshold'],
713
+ 'lookback_bars': value['lookback_bars'],
714
+ 'baseline_mode': value['baseline_mode'],
715
+ 'price_direction': value['price_direction'],
716
+ 'frequency': value['frequency'],
717
+ 'at': value['at'] == null ? value['at'] : value['at'].toISOString(),
718
+ 'weekday': value['weekday'],
719
+ 'days': value['days'],
481
720
  };
482
721
  }
483
722