@rivascva/dt-idl 1.1.55 → 1.1.57

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/dist/index.d.ts CHANGED
@@ -6,6 +6,23 @@ import { ClientOptions } from 'openapi-fetch';
6
6
  * Do not make direct changes to the file.
7
7
  */
8
8
  interface paths$3 {
9
+ "/stocks/indexes": {
10
+ parameters: {
11
+ query?: never;
12
+ header?: never;
13
+ path?: never;
14
+ cookie?: never;
15
+ };
16
+ /** @description Gets all the market indexes */
17
+ get: operations$3["getMarketIndexes"];
18
+ put?: never;
19
+ post?: never;
20
+ delete?: never;
21
+ options?: never;
22
+ head?: never;
23
+ patch?: never;
24
+ trace?: never;
25
+ };
9
26
  "/stocks/{symbol}": {
10
27
  parameters: {
11
28
  query?: never;
@@ -200,6 +217,11 @@ interface components$3 {
200
217
  * @example 1.25
201
218
  */
202
219
  percentChange: number;
220
+ /**
221
+ * Format: int64
222
+ * @example 28000000000
223
+ */
224
+ marketCap: number;
203
225
  };
204
226
  /** @description A full stock quote */
205
227
  FullQuote: components$3["schemas"]["SimpleQuote"] & {
@@ -319,6 +341,15 @@ interface components$3 {
319
341
  /** @example AAPL */
320
342
  symbol: string;
321
343
  };
344
+ /** @description A market index that represents a group of stocks */
345
+ MarketIndex: {
346
+ /** @example ^GSPC */
347
+ symbol: string;
348
+ /** @example S&P 500 */
349
+ name: string;
350
+ quote: components$3["schemas"]["SimpleQuote"];
351
+ quotes: components$3["schemas"]["SimpleQuote"][];
352
+ };
322
353
  /** @description A generic error */
323
354
  Error: {
324
355
  /**
@@ -338,7 +369,7 @@ interface components$3 {
338
369
  /** @enum {string} */
339
370
  SortOrder: "ASC" | "DESC";
340
371
  /** @enum {string} */
341
- SortField: "SYMBOL" | "NAME" | "PRICE" | "PRICE_CHANGE" | "PERCENT_CHANGE";
372
+ SortField: "SYMBOL" | "NAME" | "PRICE" | "PERCENT_CHANGE" | "MARKET_CAP";
342
373
  };
343
374
  responses: {
344
375
  /** @description The resource was not found */
@@ -366,6 +397,32 @@ interface components$3 {
366
397
  pathItems: never;
367
398
  }
368
399
  interface operations$3 {
400
+ getMarketIndexes: {
401
+ parameters: {
402
+ query?: {
403
+ /** @description The sort order of the stock quotes */
404
+ sortOrder?: components$3["schemas"]["SortOrder"];
405
+ /** @description The sort field of the stock quotes */
406
+ sortField?: components$3["schemas"]["SortField"];
407
+ };
408
+ header?: never;
409
+ path?: never;
410
+ cookie?: never;
411
+ };
412
+ requestBody?: never;
413
+ responses: {
414
+ /** @description Success */
415
+ 200: {
416
+ headers: {
417
+ [name: string]: unknown;
418
+ };
419
+ content: {
420
+ "application/json": components$3["schemas"]["MarketIndex"][];
421
+ };
422
+ };
423
+ 500: components$3["responses"]["InternalServerError"];
424
+ };
425
+ };
369
426
  getStock: {
370
427
  parameters: {
371
428
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rivascva/dt-idl",
3
- "version": "1.1.55",
3
+ "version": "1.1.57",
4
4
  "description": "Dream Trade - Interface Definition Language",
5
5
  "main": "dist/index.cjs.js",
6
6
  "module": "dist/index.esm.js",
@@ -9,6 +9,41 @@ servers:
9
9
  - url: http://localhost:8082/v1
10
10
 
11
11
  paths:
12
+ /stocks/indexes:
13
+ get:
14
+ description: Gets all the market indexes
15
+ operationId: getMarketIndexes
16
+ tags:
17
+ - Stocks
18
+ parameters:
19
+ - in: query
20
+ name: sortOrder
21
+ description: The sort order of the stock quotes
22
+ required: false
23
+ schema:
24
+ $ref: '#/components/schemas/SortOrder'
25
+ example: DESC
26
+ default: DESC
27
+ - in: query
28
+ name: sortField
29
+ description: The sort field of the stock quotes
30
+ required: false
31
+ schema:
32
+ $ref: '#/components/schemas/SortField'
33
+ example: MARKET_CAP
34
+ default: MARKET_CAP
35
+ responses:
36
+ 200:
37
+ description: Success
38
+ content:
39
+ application/json:
40
+ schema:
41
+ type: array
42
+ items:
43
+ $ref: '#/components/schemas/MarketIndex'
44
+ 500:
45
+ $ref: '#/components/responses/InternalServerError'
46
+
12
47
  /stocks/{symbol}:
13
48
  get:
14
49
  description: Gets the full quote for the given stock symbol
@@ -105,16 +140,16 @@ paths:
105
140
  required: false
106
141
  schema:
107
142
  $ref: '#/components/schemas/SortOrder'
108
- example: ASC
109
- default: ASC
143
+ example: DESC
144
+ default: DESC
110
145
  - in: query
111
146
  name: sortField
112
147
  description: The sort field of the stock quotes
113
148
  required: false
114
149
  schema:
115
150
  $ref: '#/components/schemas/SortField'
116
- example: SYMBOL
117
- default: SYMBOL
151
+ example: MARKET_CAP
152
+ default: MARKET_CAP
118
153
  responses:
119
154
  200:
120
155
  description: Success
@@ -149,16 +184,16 @@ paths:
149
184
  required: false
150
185
  schema:
151
186
  $ref: '#/components/schemas/SortOrder'
152
- example: ASC
153
- default: ASC
187
+ example: DESC
188
+ default: DESC
154
189
  - in: query
155
190
  name: sortField
156
191
  description: The sort field of the stock quotes
157
192
  required: false
158
193
  schema:
159
194
  $ref: '#/components/schemas/SortField'
160
- example: SYMBOL
161
- default: SYMBOL
195
+ example: MARKET_CAP
196
+ default: MARKET_CAP
162
197
  responses:
163
198
  200:
164
199
  description: Success
@@ -350,12 +385,17 @@ components:
350
385
  type: number
351
386
  format: double
352
387
  example: 1.25
388
+ marketCap:
389
+ type: integer
390
+ format: int64
391
+ example: 28000000000
353
392
  required:
354
393
  - symbol
355
394
  - name
356
395
  - price
357
396
  - priceChange
358
397
  - percentChange
398
+ - marketCap
359
399
 
360
400
  FullQuote:
361
401
  description: A full stock quote
@@ -514,6 +554,27 @@ components:
514
554
  required:
515
555
  - symbol
516
556
 
557
+ MarketIndex:
558
+ description: A market index that represents a group of stocks
559
+ properties:
560
+ symbol:
561
+ type: string
562
+ example: ^GSPC
563
+ name:
564
+ type: string
565
+ example: S&P 500
566
+ quote:
567
+ $ref: '#/components/schemas/SimpleQuote'
568
+ quotes:
569
+ type: array
570
+ items:
571
+ $ref: '#/components/schemas/SimpleQuote'
572
+ required:
573
+ - symbol
574
+ - name
575
+ - quote
576
+ - quotes
577
+
517
578
  Error:
518
579
  description: A generic error
519
580
  properties:
@@ -559,8 +620,8 @@ components:
559
620
  - SYMBOL
560
621
  - NAME
561
622
  - PRICE
562
- - PRICE_CHANGE
563
623
  - PERCENT_CHANGE
624
+ - MARKET_CAP
564
625
 
565
626
  responses:
566
627
  NotFound:
@@ -4,6 +4,23 @@
4
4
  */
5
5
 
6
6
  export interface paths {
7
+ "/stocks/indexes": {
8
+ parameters: {
9
+ query?: never;
10
+ header?: never;
11
+ path?: never;
12
+ cookie?: never;
13
+ };
14
+ /** @description Gets all the market indexes */
15
+ get: operations["getMarketIndexes"];
16
+ put?: never;
17
+ post?: never;
18
+ delete?: never;
19
+ options?: never;
20
+ head?: never;
21
+ patch?: never;
22
+ trace?: never;
23
+ };
7
24
  "/stocks/{symbol}": {
8
25
  parameters: {
9
26
  query?: never;
@@ -199,6 +216,11 @@ export interface components {
199
216
  * @example 1.25
200
217
  */
201
218
  percentChange: number;
219
+ /**
220
+ * Format: int64
221
+ * @example 28000000000
222
+ */
223
+ marketCap: number;
202
224
  };
203
225
  /** @description A full stock quote */
204
226
  FullQuote: components["schemas"]["SimpleQuote"] & {
@@ -318,6 +340,15 @@ export interface components {
318
340
  /** @example AAPL */
319
341
  symbol: string;
320
342
  };
343
+ /** @description A market index that represents a group of stocks */
344
+ MarketIndex: {
345
+ /** @example ^GSPC */
346
+ symbol: string;
347
+ /** @example S&P 500 */
348
+ name: string;
349
+ quote: components["schemas"]["SimpleQuote"];
350
+ quotes: components["schemas"]["SimpleQuote"][];
351
+ };
321
352
  /** @description A generic error */
322
353
  Error: {
323
354
  /**
@@ -337,7 +368,7 @@ export interface components {
337
368
  /** @enum {string} */
338
369
  SortOrder: "ASC" | "DESC";
339
370
  /** @enum {string} */
340
- SortField: "SYMBOL" | "NAME" | "PRICE" | "PRICE_CHANGE" | "PERCENT_CHANGE";
371
+ SortField: "SYMBOL" | "NAME" | "PRICE" | "PERCENT_CHANGE" | "MARKET_CAP";
341
372
  };
342
373
  responses: {
343
374
  /** @description The resource was not found */
@@ -366,6 +397,32 @@ export interface components {
366
397
  }
367
398
  export type $defs = Record<string, never>;
368
399
  export interface operations {
400
+ getMarketIndexes: {
401
+ parameters: {
402
+ query?: {
403
+ /** @description The sort order of the stock quotes */
404
+ sortOrder?: components["schemas"]["SortOrder"];
405
+ /** @description The sort field of the stock quotes */
406
+ sortField?: components["schemas"]["SortField"];
407
+ };
408
+ header?: never;
409
+ path?: never;
410
+ cookie?: never;
411
+ };
412
+ requestBody?: never;
413
+ responses: {
414
+ /** @description Success */
415
+ 200: {
416
+ headers: {
417
+ [name: string]: unknown;
418
+ };
419
+ content: {
420
+ "application/json": components["schemas"]["MarketIndex"][];
421
+ };
422
+ };
423
+ 500: components["responses"]["InternalServerError"];
424
+ };
425
+ };
369
426
  getStock: {
370
427
  parameters: {
371
428
  query?: never;