@rivascva/dt-idl 1.1.8 → 1.1.9

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.
@@ -3,369 +3,498 @@
3
3
  * Do not make direct changes to the file.
4
4
  */
5
5
 
6
-
7
6
  export interface paths {
8
- "/stocks/{symbol}": {
9
- /** @description Gets the full quote for the given stock symbol */
10
- get: operations["getStock"];
11
- };
12
- "/stocks/{symbol}/history": {
13
- /** @description Gets the price history chart for the given stock symbol */
14
- get: operations["getStockHistory"];
15
- };
16
- "/stocks/by-symbols/{symbols}": {
17
- /** @description Gets the simple quotes for the given stock symbols */
18
- get: operations["getStocksBySymbols"];
19
- };
20
- "/stocks/by-exchange/{exchange}": {
21
- /** @description Gets the simple quotes for the given stock exchange */
22
- get: operations["getStocksByExchange"];
23
- };
24
- "/stocks/search": {
25
- /** @description Gets the simple quotes that fuzzy match the search query */
26
- get: operations["searchStocks"];
27
- };
28
- "/news": {
29
- /** @description Gets the latest news articles */
30
- get: operations["getNews"];
31
- };
32
- "/news/by-symbols/{symbols}": {
33
- /** @description Gets the latest stock news articles for the given stock symbols */
34
- get: operations["getNewsBySymbols"];
35
- };
36
- }
37
-
38
- export type webhooks = Record<string, never>;
39
-
40
- export interface components {
41
- schemas: {
42
- /** @description A simple stock quote */
43
- SimpleQuote: {
44
- /** @example AAPL */
45
- symbol: string;
46
- /** @example Apple Inc */
47
- name: string;
48
- /**
49
- * Format: double
50
- * @example 182.25
51
- */
52
- price: number;
53
- /**
54
- * Format: double
55
- * @example 5.75
56
- */
57
- priceChange: number;
58
- /**
59
- * Format: double
60
- * @example 1.25
61
- */
62
- percentChange: number;
63
- };
64
- /** @description A full stock quote */
65
- FullQuote: components["schemas"]["SimpleQuote"] & {
66
- /**
67
- * Format: double
68
- * @example 180.75
69
- */
70
- previousClose: number;
71
- /**
72
- * Format: double
73
- * @example 180.75
74
- */
75
- open: number;
76
- /**
77
- * Format: double
78
- * @example 178.25
79
- */
80
- dayLow: number;
81
- /**
82
- * Format: double
83
- * @example 185.75
84
- */
85
- dayHigh: number;
86
- /**
87
- * Format: double
88
- * @example 165.25
89
- */
90
- weekLow52: number;
91
- /**
92
- * Format: double
93
- * @example 192.75
94
- */
95
- weekHigh52: number;
96
- /**
97
- * Format: int64
98
- * @example 164000000
99
- */
100
- volume: number;
101
- /**
102
- * Format: int64
103
- * @example 62000000
104
- */
105
- averageVolume: number;
106
- /**
107
- * Format: int64
108
- * @example 28000000000
109
- */
110
- marketCap: number;
111
- /**
112
- * Format: double
113
- * @example 28.25
114
- */
115
- pe: number;
116
- /**
117
- * Format: double
118
- * @example 6.75
119
- */
120
- eps: number;
121
- /** @example Apple designs and manufactures smartphones. */
122
- description: string;
123
- /** @example Timothy Cook */
124
- ceo: string;
125
- /** @example Technology */
126
- sector: string;
127
- /** @example Consumer Electronics */
128
- industry: string;
129
- /** @example Cupertino */
130
- city: string;
131
- /** @example California */
132
- state: string;
133
- /** @example USA */
134
- country: string;
7
+ "/stocks/{symbol}": {
8
+ parameters: {
9
+ query?: never;
10
+ header?: never;
11
+ path?: never;
12
+ cookie?: never;
13
+ };
14
+ /** @description Gets the full quote for the given stock symbol */
15
+ get: operations["getStock"];
16
+ put?: never;
17
+ post?: never;
18
+ delete?: never;
19
+ options?: never;
20
+ head?: never;
21
+ patch?: never;
22
+ trace?: never;
135
23
  };
136
- /** @description A stock history chart entry */
137
- HistoryChartEntry: {
138
- /** @example "2024-12-24T02:30:00.000Z" */
139
- date: string;
140
- /**
141
- * Format: double
142
- * @example 175.25
143
- */
144
- open: number;
145
- /**
146
- * Format: double
147
- * @example 172.75
148
- */
149
- low: number;
150
- /**
151
- * Format: double
152
- * @example 185.25
153
- */
154
- high: number;
155
- /**
156
- * Format: double
157
- * @example 180.75
158
- */
159
- close: number;
24
+ "/stocks/{symbol}/history": {
25
+ parameters: {
26
+ query?: never;
27
+ header?: never;
28
+ path?: never;
29
+ cookie?: never;
30
+ };
31
+ /** @description Gets the price history chart for the given stock symbol */
32
+ get: operations["getStockHistory"];
33
+ put?: never;
34
+ post?: never;
35
+ delete?: never;
36
+ options?: never;
37
+ head?: never;
38
+ patch?: never;
39
+ trace?: never;
160
40
  };
161
- /** @description A news article */
162
- NewsArticle: {
163
- /** @example Apple Watches Recalled */
164
- title: string;
165
- /** @example Apple Watches are being recalled worldwide */
166
- description: string;
167
- /**
168
- * Format: int64
169
- * @example 1709500000000
170
- */
171
- date: number;
172
- /** @example https://news.com/articles/abc */
173
- link: string;
174
- /** @example https://news.com/articles/abc/image.png */
175
- thumbnail: string;
41
+ "/stocks/by-symbols/{symbols}": {
42
+ parameters: {
43
+ query?: never;
44
+ header?: never;
45
+ path?: never;
46
+ cookie?: never;
47
+ };
48
+ /** @description Gets the simple quotes for the given stock symbols */
49
+ get: operations["getStocksBySymbols"];
50
+ put?: never;
51
+ post?: never;
52
+ delete?: never;
53
+ options?: never;
54
+ head?: never;
55
+ patch?: never;
56
+ trace?: never;
176
57
  };
177
- /** @description A stock news article */
178
- StockNewsArticle: components["schemas"]["NewsArticle"] & {
179
- /** @example AAPL */
180
- symbol: string;
58
+ "/stocks/by-exchange/{exchange}": {
59
+ parameters: {
60
+ query?: never;
61
+ header?: never;
62
+ path?: never;
63
+ cookie?: never;
64
+ };
65
+ /** @description Gets the simple quotes for the given stock exchange */
66
+ get: operations["getStocksByExchange"];
67
+ put?: never;
68
+ post?: never;
69
+ delete?: never;
70
+ options?: never;
71
+ head?: never;
72
+ patch?: never;
73
+ trace?: never;
181
74
  };
182
- /** @description A generic error */
183
- Error: {
184
- /**
185
- * Format: int64
186
- * @example 500
187
- */
188
- status: number;
189
- /** @example ERROR */
190
- code: components["schemas"]["ErrorCode"];
191
- /** @example Error */
192
- message: string;
75
+ "/stocks/search": {
76
+ parameters: {
77
+ query?: never;
78
+ header?: never;
79
+ path?: never;
80
+ cookie?: never;
81
+ };
82
+ /** @description Gets the simple quotes that fuzzy match the search query */
83
+ get: operations["searchStocks"];
84
+ put?: never;
85
+ post?: never;
86
+ delete?: never;
87
+ options?: never;
88
+ head?: never;
89
+ patch?: never;
90
+ trace?: never;
193
91
  };
194
- /** @enum {string} */
195
- ErrorCode: "ERROR";
196
- /** @enum {string} */
197
- HistoryTimeframe: "MIN5" | "MIN15" | "MIN30" | "HOUR1" | "HOUR4" | "DAY1";
198
- };
199
- responses: {
200
- /** @description The resource was not found */
201
- NotFound: {
202
- content: {
203
- "application/json": components["schemas"]["Error"];
204
- };
92
+ "/news": {
93
+ parameters: {
94
+ query?: never;
95
+ header?: never;
96
+ path?: never;
97
+ cookie?: never;
98
+ };
99
+ /** @description Gets the latest news articles */
100
+ get: operations["getNews"];
101
+ put?: never;
102
+ post?: never;
103
+ delete?: never;
104
+ options?: never;
105
+ head?: never;
106
+ patch?: never;
107
+ trace?: never;
205
108
  };
206
- /** @description There was an internal server error */
207
- InternalServerError: {
208
- content: {
209
- "application/json": components["schemas"]["Error"];
210
- };
109
+ "/news/by-symbols/{symbols}": {
110
+ parameters: {
111
+ query?: never;
112
+ header?: never;
113
+ path?: never;
114
+ cookie?: never;
115
+ };
116
+ /** @description Gets the latest stock news articles for the given stock symbols */
117
+ get: operations["getNewsBySymbols"];
118
+ put?: never;
119
+ post?: never;
120
+ delete?: never;
121
+ options?: never;
122
+ head?: never;
123
+ patch?: never;
124
+ trace?: never;
211
125
  };
212
- };
213
- parameters: never;
214
- requestBodies: never;
215
- headers: never;
216
- pathItems: never;
217
126
  }
218
-
219
- export type $defs = Record<string, never>;
220
-
221
- export type external = Record<string, never>;
222
-
223
- export interface operations {
224
-
225
- /** @description Gets the full quote for the given stock symbol */
226
- getStock: {
227
- parameters: {
228
- path: {
229
- /** @description The stock symbol */
230
- symbol: string;
231
- };
232
- };
233
- responses: {
234
- /** @description Success */
235
- 200: {
236
- content: {
237
- "application/json": components["schemas"]["FullQuote"];
127
+ export type webhooks = Record<string, never>;
128
+ export interface components {
129
+ schemas: {
130
+ /** @description A simple stock quote */
131
+ SimpleQuote: {
132
+ /** @example AAPL */
133
+ symbol: string;
134
+ /** @example Apple Inc */
135
+ name: string;
136
+ /**
137
+ * Format: double
138
+ * @example 182.25
139
+ */
140
+ price: number;
141
+ /**
142
+ * Format: double
143
+ * @example 5.75
144
+ */
145
+ priceChange: number;
146
+ /**
147
+ * Format: double
148
+ * @example 1.25
149
+ */
150
+ percentChange: number;
238
151
  };
239
- };
240
- 404: components["responses"]["NotFound"];
241
- 500: components["responses"]["InternalServerError"];
242
- };
243
- };
244
- /** @description Gets the price history chart for the given stock symbol */
245
- getStockHistory: {
246
- parameters: {
247
- query: {
248
- /** @description The stock history timeframe */
249
- timeframe: components["schemas"]["HistoryTimeframe"];
250
- /** @description The stock history from date */
251
- from: string;
252
- /** @description The stock history to date */
253
- to: string;
254
- };
255
- path: {
256
- /** @description The stock symbol */
257
- symbol: string;
258
- };
259
- };
260
- responses: {
261
- /** @description Success */
262
- 200: {
263
- content: {
264
- "application/json": components["schemas"]["HistoryChartEntry"][];
152
+ /** @description A full stock quote */
153
+ FullQuote: components["schemas"]["SimpleQuote"] & {
154
+ /**
155
+ * Format: double
156
+ * @example 180.75
157
+ */
158
+ previousClose: number;
159
+ /**
160
+ * Format: double
161
+ * @example 180.75
162
+ */
163
+ open: number;
164
+ /**
165
+ * Format: double
166
+ * @example 178.25
167
+ */
168
+ dayLow: number;
169
+ /**
170
+ * Format: double
171
+ * @example 185.75
172
+ */
173
+ dayHigh: number;
174
+ /**
175
+ * Format: double
176
+ * @example 165.25
177
+ */
178
+ weekLow52: number;
179
+ /**
180
+ * Format: double
181
+ * @example 192.75
182
+ */
183
+ weekHigh52: number;
184
+ /**
185
+ * Format: int64
186
+ * @example 164000000
187
+ */
188
+ volume: number;
189
+ /**
190
+ * Format: int64
191
+ * @example 62000000
192
+ */
193
+ averageVolume: number;
194
+ /**
195
+ * Format: int64
196
+ * @example 28000000000
197
+ */
198
+ marketCap: number;
199
+ /**
200
+ * Format: double
201
+ * @example 28.25
202
+ */
203
+ pe: number;
204
+ /**
205
+ * Format: double
206
+ * @example 6.75
207
+ */
208
+ eps: number;
209
+ /** @example Apple designs and manufactures smartphones. */
210
+ description: string;
211
+ /** @example Timothy Cook */
212
+ ceo: string;
213
+ /** @example Technology */
214
+ sector: string;
215
+ /** @example Consumer Electronics */
216
+ industry: string;
217
+ /** @example Cupertino */
218
+ city: string;
219
+ /** @example California */
220
+ state: string;
221
+ /** @example USA */
222
+ country: string;
265
223
  };
266
- };
267
- 404: components["responses"]["NotFound"];
268
- 500: components["responses"]["InternalServerError"];
269
- };
270
- };
271
- /** @description Gets the simple quotes for the given stock symbols */
272
- getStocksBySymbols: {
273
- parameters: {
274
- path: {
275
- /** @description The stock symbols */
276
- symbols: string;
277
- };
224
+ /** @description A stock history chart entry */
225
+ HistoryChartEntry: {
226
+ /** @example 2024-12-24T02:30:00Z */
227
+ date: string;
228
+ /**
229
+ * Format: double
230
+ * @example 175.25
231
+ */
232
+ open: number;
233
+ /**
234
+ * Format: double
235
+ * @example 172.75
236
+ */
237
+ low: number;
238
+ /**
239
+ * Format: double
240
+ * @example 185.25
241
+ */
242
+ high: number;
243
+ /**
244
+ * Format: double
245
+ * @example 180.75
246
+ */
247
+ close: number;
248
+ };
249
+ /** @description A news article */
250
+ NewsArticle: {
251
+ /** @example Apple Watches Recalled */
252
+ title: string;
253
+ /** @example Apple Watches are being recalled worldwide */
254
+ description: string;
255
+ /**
256
+ * Format: int64
257
+ * @example 1709500000000
258
+ */
259
+ date: number;
260
+ /** @example https://news.com/articles/abc */
261
+ link: string;
262
+ /** @example https://news.com/articles/abc/image.png */
263
+ thumbnail: string;
264
+ };
265
+ /** @description A stock news article */
266
+ StockNewsArticle: components["schemas"]["NewsArticle"] & {
267
+ /** @example AAPL */
268
+ symbol: string;
269
+ };
270
+ /** @description A generic error */
271
+ Error: {
272
+ /**
273
+ * Format: int64
274
+ * @example 500
275
+ */
276
+ status: number;
277
+ /** @example ERROR */
278
+ code: components["schemas"]["ErrorCode"];
279
+ /** @example Error */
280
+ message: string;
281
+ };
282
+ /** @enum {string} */
283
+ ErrorCode: "ERROR";
284
+ /** @enum {string} */
285
+ HistoryTimeframe: "MIN5" | "MIN15" | "MIN30" | "HOUR1" | "HOUR4" | "DAY1";
278
286
  };
279
287
  responses: {
280
- /** @description Success */
281
- 200: {
282
- content: {
283
- "application/json": components["schemas"]["SimpleQuote"][];
288
+ /** @description The resource was not found */
289
+ NotFound: {
290
+ headers: {
291
+ [name: string]: unknown;
292
+ };
293
+ content: {
294
+ "application/json": components["schemas"]["Error"];
295
+ };
296
+ };
297
+ /** @description There was an internal server error */
298
+ InternalServerError: {
299
+ headers: {
300
+ [name: string]: unknown;
301
+ };
302
+ content: {
303
+ "application/json": components["schemas"]["Error"];
304
+ };
284
305
  };
285
- };
286
- 404: components["responses"]["NotFound"];
287
- 500: components["responses"]["InternalServerError"];
288
- };
289
- };
290
- /** @description Gets the simple quotes for the given stock exchange */
291
- getStocksByExchange: {
292
- parameters: {
293
- path: {
294
- /** @description The stock exchange */
295
- exchange: string;
296
- };
297
306
  };
298
- responses: {
299
- /** @description Success */
300
- 200: {
301
- content: {
302
- "application/json": components["schemas"]["SimpleQuote"][];
307
+ parameters: never;
308
+ requestBodies: never;
309
+ headers: never;
310
+ pathItems: never;
311
+ }
312
+ export type $defs = Record<string, never>;
313
+ export interface operations {
314
+ getStock: {
315
+ parameters: {
316
+ query?: never;
317
+ header?: never;
318
+ path: {
319
+ /** @description The stock symbol */
320
+ symbol: string;
321
+ };
322
+ cookie?: never;
323
+ };
324
+ requestBody?: never;
325
+ responses: {
326
+ /** @description Success */
327
+ 200: {
328
+ headers: {
329
+ [name: string]: unknown;
330
+ };
331
+ content: {
332
+ "application/json": components["schemas"]["FullQuote"];
333
+ };
334
+ };
335
+ 404: components["responses"]["NotFound"];
336
+ 500: components["responses"]["InternalServerError"];
303
337
  };
304
- };
305
- 404: components["responses"]["NotFound"];
306
- 500: components["responses"]["InternalServerError"];
307
338
  };
308
- };
309
- /** @description Gets the simple quotes that fuzzy match the search query */
310
- searchStocks: {
311
- parameters: {
312
- query: {
313
- /** @description The search query */
314
- query: string;
315
- /** @description The maximum number of search results */
316
- limit?: number;
317
- };
339
+ getStockHistory: {
340
+ parameters: {
341
+ query: {
342
+ /** @description The stock history timeframe */
343
+ timeframe: components["schemas"]["HistoryTimeframe"];
344
+ /** @description The stock history from date */
345
+ from: string;
346
+ /** @description The stock history to date */
347
+ to: string;
348
+ };
349
+ header?: never;
350
+ path: {
351
+ /** @description The stock symbol */
352
+ symbol: string;
353
+ };
354
+ cookie?: never;
355
+ };
356
+ requestBody?: never;
357
+ responses: {
358
+ /** @description Success */
359
+ 200: {
360
+ headers: {
361
+ [name: string]: unknown;
362
+ };
363
+ content: {
364
+ "application/json": components["schemas"]["HistoryChartEntry"][];
365
+ };
366
+ };
367
+ 404: components["responses"]["NotFound"];
368
+ 500: components["responses"]["InternalServerError"];
369
+ };
318
370
  };
319
- responses: {
320
- /** @description Success */
321
- 200: {
322
- content: {
323
- "application/json": components["schemas"]["SimpleQuote"][];
371
+ getStocksBySymbols: {
372
+ parameters: {
373
+ query?: never;
374
+ header?: never;
375
+ path: {
376
+ /** @description The stock symbols */
377
+ symbols: string;
378
+ };
379
+ cookie?: never;
380
+ };
381
+ requestBody?: never;
382
+ responses: {
383
+ /** @description Success */
384
+ 200: {
385
+ headers: {
386
+ [name: string]: unknown;
387
+ };
388
+ content: {
389
+ "application/json": components["schemas"]["SimpleQuote"][];
390
+ };
391
+ };
392
+ 404: components["responses"]["NotFound"];
393
+ 500: components["responses"]["InternalServerError"];
324
394
  };
325
- };
326
- 404: components["responses"]["NotFound"];
327
- 500: components["responses"]["InternalServerError"];
328
395
  };
329
- };
330
- /** @description Gets the latest news articles */
331
- getNews: {
332
- parameters: {
333
- query?: {
334
- /** @description The maximum number of articles */
335
- limit?: number;
336
- };
396
+ getStocksByExchange: {
397
+ parameters: {
398
+ query?: never;
399
+ header?: never;
400
+ path: {
401
+ /** @description The stock exchange */
402
+ exchange: string;
403
+ };
404
+ cookie?: never;
405
+ };
406
+ requestBody?: never;
407
+ responses: {
408
+ /** @description Success */
409
+ 200: {
410
+ headers: {
411
+ [name: string]: unknown;
412
+ };
413
+ content: {
414
+ "application/json": components["schemas"]["SimpleQuote"][];
415
+ };
416
+ };
417
+ 404: components["responses"]["NotFound"];
418
+ 500: components["responses"]["InternalServerError"];
419
+ };
337
420
  };
338
- responses: {
339
- /** @description Success */
340
- 200: {
341
- content: {
342
- "application/json": components["schemas"]["NewsArticle"][];
421
+ searchStocks: {
422
+ parameters: {
423
+ query: {
424
+ /** @description The search query */
425
+ query: string;
426
+ /** @description The maximum number of search results */
427
+ limit?: number;
428
+ };
429
+ header?: never;
430
+ path?: never;
431
+ cookie?: never;
432
+ };
433
+ requestBody?: never;
434
+ responses: {
435
+ /** @description Success */
436
+ 200: {
437
+ headers: {
438
+ [name: string]: unknown;
439
+ };
440
+ content: {
441
+ "application/json": components["schemas"]["SimpleQuote"][];
442
+ };
443
+ };
444
+ 404: components["responses"]["NotFound"];
445
+ 500: components["responses"]["InternalServerError"];
343
446
  };
344
- };
345
- 500: components["responses"]["InternalServerError"];
346
447
  };
347
- };
348
- /** @description Gets the latest stock news articles for the given stock symbols */
349
- getNewsBySymbols: {
350
- parameters: {
351
- query?: {
352
- /** @description The maximum number of articles */
353
- limit?: number;
354
- };
355
- path: {
356
- /** @description The stock symbols */
357
- symbols: string;
358
- };
448
+ getNews: {
449
+ parameters: {
450
+ query?: {
451
+ /** @description The maximum number of articles */
452
+ limit?: number;
453
+ };
454
+ header?: never;
455
+ path?: never;
456
+ cookie?: never;
457
+ };
458
+ requestBody?: never;
459
+ responses: {
460
+ /** @description Success */
461
+ 200: {
462
+ headers: {
463
+ [name: string]: unknown;
464
+ };
465
+ content: {
466
+ "application/json": components["schemas"]["NewsArticle"][];
467
+ };
468
+ };
469
+ 500: components["responses"]["InternalServerError"];
470
+ };
359
471
  };
360
- responses: {
361
- /** @description Success */
362
- 200: {
363
- content: {
364
- "application/json": components["schemas"]["StockNewsArticle"][];
472
+ getNewsBySymbols: {
473
+ parameters: {
474
+ query?: {
475
+ /** @description The maximum number of articles */
476
+ limit?: number;
477
+ };
478
+ header?: never;
479
+ path: {
480
+ /** @description The stock symbols */
481
+ symbols: string;
482
+ };
483
+ cookie?: never;
484
+ };
485
+ requestBody?: never;
486
+ responses: {
487
+ /** @description Success */
488
+ 200: {
489
+ headers: {
490
+ [name: string]: unknown;
491
+ };
492
+ content: {
493
+ "application/json": components["schemas"]["StockNewsArticle"][];
494
+ };
495
+ };
496
+ 404: components["responses"]["NotFound"];
497
+ 500: components["responses"]["InternalServerError"];
365
498
  };
366
- };
367
- 404: components["responses"]["NotFound"];
368
- 500: components["responses"]["InternalServerError"];
369
499
  };
370
- };
371
500
  }