@invinite-org/data-api-client 7.0.0 → 7.1.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.
@@ -37,6 +37,8 @@ export interface ListAlertsRequest {
37
37
  type?: ListAlertsTypeEnum;
38
38
  externalUserId?: string;
39
39
  clientReferenceId?: string;
40
+ symbol?: string;
41
+ destinationId?: string;
40
42
  }
41
43
  export interface PauseAlertRequest {
42
44
  id: string;
@@ -263,6 +263,12 @@ class AlertsApi extends runtime.BaseAPI {
263
263
  if (requestParameters['clientReferenceId'] != null) {
264
264
  queryParameters['client_reference_id'] = requestParameters['clientReferenceId'];
265
265
  }
266
+ if (requestParameters['symbol'] != null) {
267
+ queryParameters['symbol'] = requestParameters['symbol'];
268
+ }
269
+ if (requestParameters['destinationId'] != null) {
270
+ queryParameters['destination_id'] = requestParameters['destinationId'];
271
+ }
266
272
  const headerParameters = {};
267
273
  if (this.configuration && this.configuration.accessToken) {
268
274
  const token = this.configuration.accessToken;
@@ -37,6 +37,8 @@ export interface ListAlertsRequest {
37
37
  type?: ListAlertsTypeEnum;
38
38
  externalUserId?: string;
39
39
  clientReferenceId?: string;
40
+ symbol?: string;
41
+ destinationId?: string;
40
42
  }
41
43
  export interface PauseAlertRequest {
42
44
  id: string;
@@ -260,6 +260,12 @@ export class AlertsApi extends runtime.BaseAPI {
260
260
  if (requestParameters['clientReferenceId'] != null) {
261
261
  queryParameters['client_reference_id'] = requestParameters['clientReferenceId'];
262
262
  }
263
+ if (requestParameters['symbol'] != null) {
264
+ queryParameters['symbol'] = requestParameters['symbol'];
265
+ }
266
+ if (requestParameters['destinationId'] != null) {
267
+ queryParameters['destination_id'] = requestParameters['destinationId'];
268
+ }
263
269
  const headerParameters = {};
264
270
  if (this.configuration && this.configuration.accessToken) {
265
271
  const token = this.configuration.accessToken;
package/docs/AlertsApi.md CHANGED
@@ -342,7 +342,7 @@ example().catch(console.error);
342
342
 
343
343
  ## listAlerts
344
344
 
345
- > ListAlerts200Response listAlerts(limit, cursor, status, type, externalUserId, clientReferenceId)
345
+ > ListAlerts200Response listAlerts(limit, cursor, status, type, externalUserId, clientReferenceId, symbol, destinationId)
346
346
 
347
347
  List alerts
348
348
 
@@ -378,6 +378,10 @@ async function example() {
378
378
  externalUserId: user_8812,
379
379
  // string | The alert with this client reference id (optional)
380
380
  clientReferenceId: watchlist-aapl-8k,
381
+ // string | Only alerts whose condition names this symbol, case-insensitive: its one `symbol` (a price, indicator or script alert\'s instrument as stored: a ticker, a commodity pair `XAUUSD`, a crypto coin by its slug `bitcoin`) or an entry of its `symbols` (multi-company alerts included). An alert that names companies by `cik` / `ciks` is found through the company the ticker resolves to (any of its listings: `GOOG` and `GOOGL` both find an alert on Alphabet\'s CIK); an alert given by symbol only through that symbol. Whole-market alerts (no company named) are not found. A symbol no alert names answers an empty page (optional)
382
+ symbol: AAPL,
383
+ // string | Only alerts that deliver to this destination (one of their `destination_ids`). An unknown id or one of another account answers an empty page (optional)
384
+ destinationId: dst_01JD2Q4X7Y8Z9A0B1C2D3E4F5G,
381
385
  } satisfies ListAlertsRequest;
382
386
 
383
387
  try {
@@ -403,6 +407,8 @@ example().catch(console.error);
403
407
  | **type** | `filing`, `filing_keyword`, `news`, `news_keyword`, `earnings_call`, `earnings_call_keyword`, `dividend`, `halt`, `fundamental_metric`, `earnings_results`, `event_countdown`, `price`, `price_move`, `volume_spike`, `price_reminder`, `indicator`, `script` | Only alerts of this type | [Optional] [Defaults to `undefined`] [Enum: filing, filing_keyword, news, news_keyword, earnings_call, earnings_call_keyword, dividend, halt, fundamental_metric, earnings_results, event_countdown, price, price_move, volume_spike, price_reminder, indicator, script] |
404
408
  | **externalUserId** | `string` | Only alerts of this end user (your own id, set at create) | [Optional] [Defaults to `undefined`] |
405
409
  | **clientReferenceId** | `string` | The alert with this client reference id | [Optional] [Defaults to `undefined`] |
410
+ | **symbol** | `string` | Only alerts whose condition names this symbol, case-insensitive: its one `symbol` (a price, indicator or script alert\'s instrument as stored: a ticker, a commodity pair `XAUUSD`, a crypto coin by its slug `bitcoin`) or an entry of its `symbols` (multi-company alerts included). An alert that names companies by `cik` / `ciks` is found through the company the ticker resolves to (any of its listings: `GOOG` and `GOOGL` both find an alert on Alphabet\'s CIK); an alert given by symbol only through that symbol. Whole-market alerts (no company named) are not found. A symbol no alert names answers an empty page | [Optional] [Defaults to `undefined`] |
411
+ | **destinationId** | `string` | Only alerts that deliver to this destination (one of their `destination_ids`). An unknown id or one of another account answers an empty page | [Optional] [Defaults to `undefined`] |
406
412
 
407
413
  ### Return type
408
414
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@invinite-org/data-api-client",
3
- "version": "7.0.0",
3
+ "version": "7.1.0",
4
4
  "description": "Typed TypeScript/JavaScript client for the Invinite Data API",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -74,6 +74,8 @@ export interface ListAlertsRequest {
74
74
  type?: ListAlertsTypeEnum;
75
75
  externalUserId?: string;
76
76
  clientReferenceId?: string;
77
+ symbol?: string;
78
+ destinationId?: string;
77
79
  }
78
80
 
79
81
  export interface PauseAlertRequest {
@@ -360,6 +362,14 @@ export class AlertsApi extends runtime.BaseAPI {
360
362
  queryParameters['client_reference_id'] = requestParameters['clientReferenceId'];
361
363
  }
362
364
 
365
+ if (requestParameters['symbol'] != null) {
366
+ queryParameters['symbol'] = requestParameters['symbol'];
367
+ }
368
+
369
+ if (requestParameters['destinationId'] != null) {
370
+ queryParameters['destination_id'] = requestParameters['destinationId'];
371
+ }
372
+
363
373
  const headerParameters: runtime.HTTPHeaders = {};
364
374
 
365
375
  if (this.configuration && this.configuration.accessToken) {