@rivascva/dt-idl 1.1.163 → 1.1.165

package/dist/index.d.ts

@@ -6,15 +6,15 @@ import { ClientOptions } from 'openapi-fetch';
  * Do not make direct changes to the file.
  */
 interface paths$3 {
-    "/stocks/{symbol}": {
+    "/stocks/metadata": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        /** @description Gets the full quote for the given stock symbol */
-        get: operations$3["getStock"];
+        /** @description Gets metadata about the stocks */
+        get: operations$3["getStocksMetadata"];
         put?: never;
         post?: never;
         delete?: never;
@@ -23,15 +23,15 @@ interface paths$3 {
         patch?: never;
         trace?: never;
     };
-    "/stocks/{symbol}/history": {
+    "/stocks/{symbol}": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        /** @description Gets the price history chart for the given stock symbol */
-        get: operations$3["getStockHistory"];
+        /** @description Gets the full quote for the given stock symbol */
+        get: operations$3["getStock"];
         put?: never;
         post?: never;
         delete?: never;
@@ -40,15 +40,15 @@ interface paths$3 {
         patch?: never;
         trace?: never;
     };
-    "/stocks/by-symbols/{symbols}": {
+    "/stocks/{symbol}/history": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        /** @description Gets the simple quotes for the given stock symbols */
-        get: operations$3["getStocksBySymbols"];
+        /** @description Gets the price history chart for the given stock symbol */
+        get: operations$3["getStockHistory"];
         put?: never;
         post?: never;
         delete?: never;
@@ -57,15 +57,15 @@ interface paths$3 {
         patch?: never;
         trace?: never;
     };
-    "/stocks/by-exchange/{exchange}": {
+    "/stocks/by-symbols/{symbols}": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        /** @description Gets the simple quotes for the given stock exchange */
-        get: operations$3["getStocksByExchange"];
+        /** @description Gets the simple quotes for the given stock symbols */
+        get: operations$3["getStocksBySymbols"];
         put?: never;
         post?: never;
         delete?: never;
@@ -347,6 +347,14 @@ interface components$3 {
             displayName: string;
             components: components$3["schemas"]["SimpleQuote"][];
         };
+        /** @description Metadata about the stocks */
+        StocksMetadata: {
+            /**
+             * Format: int64
+             * @example 30
+             */
+            pollInterval: number;
+        };
         /** @description A generic error */
         Error: {
             /**
@@ -394,14 +402,11 @@ interface components$3 {
     pathItems: never;
 }
 interface operations$3 {
-    getStock: {
+    getStocksMetadata: {
         parameters: {
             query?: never;
             header?: never;
-            path: {
-                /** @description The stock symbol */
-                symbol: string;
-            };
+            path?: never;
             cookie?: never;
         };
         requestBody?: never;
@@ -412,23 +417,15 @@ interface operations$3 {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components$3["schemas"]["FullQuote"];
+                    "application/json": components$3["schemas"]["StocksMetadata"];
                 };
             };
-            404: components$3["responses"]["NotFound"];
             500: components$3["responses"]["InternalServerError"];
         };
     };
-    getStockHistory: {
+    getStock: {
         parameters: {
-            query: {
-                /** @description The stock history timeframe */
-                timeframe: components$3["schemas"]["StockHistoryTimeframe"];
-                /** @description The stock history from date */
-                from: string;
-                /** @description The stock history to date */
-                to: string;
-            };
+            query?: never;
             header?: never;
             path: {
                 /** @description The stock symbol */
@@ -444,25 +441,27 @@ interface operations$3 {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components$3["schemas"]["StockHistoryEntry"][];
+                    "application/json": components$3["schemas"]["FullQuote"];
                 };
             };
             404: components$3["responses"]["NotFound"];
             500: components$3["responses"]["InternalServerError"];
         };
     };
-    getStocksBySymbols: {
+    getStockHistory: {
         parameters: {
-            query?: {
-                /** @description The sort order of the stock quotes */
-                sortOrder?: components$3["schemas"]["SortOrder"];
-                /** @description The sort field of the stock quotes */
-                sortField?: components$3["schemas"]["SortField"];
+            query: {
+                /** @description The stock history timeframe */
+                timeframe: components$3["schemas"]["StockHistoryTimeframe"];
+                /** @description The stock history from date */
+                from: string;
+                /** @description The stock history to date */
+                to: string;
             };
             header?: never;
             path: {
-                /** @description The stock symbols */
-                symbols: string;
+                /** @description The stock symbol */
+                symbol: string;
             };
             cookie?: never;
         };
@@ -474,14 +473,14 @@ interface operations$3 {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components$3["schemas"]["SimpleQuote"][];
+                    "application/json": components$3["schemas"]["StockHistoryEntry"][];
                 };
             };
             404: components$3["responses"]["NotFound"];
             500: components$3["responses"]["InternalServerError"];
         };
     };
-    getStocksByExchange: {
+    getStocksBySymbols: {
         parameters: {
             query?: {
                 /** @description The sort order of the stock quotes */
@@ -491,8 +490,8 @@ interface operations$3 {
             };
             header?: never;
             path: {
-                /** @description The stock exchange */
-                exchange: string;
+                /** @description The stock symbols */
+                symbols: string;
             };
             cookie?: never;
         };
@@ -1990,10 +1989,10 @@ type SortOrder = MarketServiceSchemas['SortOrder'];
 type SortField = MarketServiceSchemas['SortField'];
 type Index = MarketServiceSchemas['Index'];
 type GetIndexesQueryParams = operations$3['getIndexes']['parameters']['query'];
-type GetStocksByExchangeQueryParams = operations$3['getStocksByExchange']['parameters']['query'];
 type GetStocksBySymbolsQueryParams = operations$3['getStocksBySymbols']['parameters']['query'];
 type GetSearchStocksQueryParams = operations$3['getSearchStocks']['parameters']['query'];
 type GetStockHistoryQueryParams = operations$3['getStockHistory']['parameters']['query'];
+type StocksMetadata = MarketServiceSchemas['StocksMetadata'];
 type Portfolio = TradeServiceSchemas['Portfolio'];
 type PortfolioType = TradeServiceSchemas['PortfolioType'];
 type UpdatePortfolioPayload = TradeServiceSchemas['UpdatePortfolioPayload'];
@@ -2022,4 +2021,4 @@ type UploadImageResponse = AssetServiceSchemas['UploadImageResponse'];
 type DeleteImagePayload = AssetServiceSchemas['DeleteImagePayload'];
 type AssetServiceError = AssetServiceSchemas['Error'];
 
-export { type AddOrderPayload, type AddUserPayload, type AssetServiceError, type DeleteImagePayload, type FullQuote, type GetIndexesQueryParams, type GetOrdersByPortfolioParams, type GetPortfolioHistoryParams, type GetSearchStocksQueryParams, type GetStockHistoryQueryParams, type GetStocksByExchangeQueryParams, type GetStocksBySymbolsQueryParams, type Holding, type ImageType, type Index, type LoginWithFirebasePayload, type LogoutPayload, type MarketServiceError, type NewsArticle, type Order, type OrderType, type Portfolio, type PortfolioHistoryTimeframe, type PortfolioHistoryValue, type PortfolioType, type RefreshAccessTokenPayload, type SendPushNotificationPayload, type SignupWithFirebasePayload, type SimpleQuote, type SortField, type SortOrder, type StockHistoryEntry, type StockHistoryTimeframe, type StockNewsArticle, type TradeServiceError, type UpdatePortfolioPayload, type UpdateUserDevicePayload, type UpdateUserPayload, type UploadImagePayload, type UploadImageResponse, type User, type UserServiceError, createAssetServiceClient, createMarketServiceClient, createTradeServiceClient, createUserServiceClient, isAssetServiceError, isMarketServiceError, isTradeServiceError, isUserServiceError };
+export { type AddOrderPayload, type AddUserPayload, type AssetServiceError, type DeleteImagePayload, type FullQuote, type GetIndexesQueryParams, type GetOrdersByPortfolioParams, type GetPortfolioHistoryParams, type GetSearchStocksQueryParams, type GetStockHistoryQueryParams, type GetStocksBySymbolsQueryParams, type Holding, type ImageType, type Index, type LoginWithFirebasePayload, type LogoutPayload, type MarketServiceError, type NewsArticle, type Order, type OrderType, type Portfolio, type PortfolioHistoryTimeframe, type PortfolioHistoryValue, type PortfolioType, type RefreshAccessTokenPayload, type SendPushNotificationPayload, type SignupWithFirebasePayload, type SimpleQuote, type SortField, type SortOrder, type StockHistoryEntry, type StockHistoryTimeframe, type StockNewsArticle, type StocksMetadata, type TradeServiceError, type UpdatePortfolioPayload, type UpdateUserDevicePayload, type UpdateUserPayload, type UploadImagePayload, type UploadImageResponse, type User, type UserServiceError, createAssetServiceClient, createMarketServiceClient, createTradeServiceClient, createUserServiceClient, isAssetServiceError, isMarketServiceError, isTradeServiceError, isUserServiceError };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rivascva/dt-idl",
-  "version": "1.1.163",
+  "version": "1.1.165",
   "description": "Dream Trade - Interface Definition Language",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",

package/services/dt-market-service.yaml

@@ -9,6 +9,22 @@ servers:
   - url: http://localhost:8082/v1
 
 paths:
+  /stocks/metadata:
+    get:
+      description: Gets metadata about the stocks
+      operationId: getStocksMetadata
+      tags:
+        - Stocks
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/StocksMetadata'
+        500:
+          $ref: '#/components/responses/InternalServerError'
+
   /stocks/{symbol}:
     get:
       description: Gets the full quote for the given stock symbol
@@ -129,50 +145,6 @@ paths:
         500:
           $ref: '#/components/responses/InternalServerError'
 
-  /stocks/by-exchange/{exchange}:
-    get:
-      description: Gets the simple quotes for the given stock exchange
-      operationId: getStocksByExchange
-      tags:
-        - Stocks
-      parameters:
-        - in: path
-          name: exchange
-          description: The stock exchange
-          required: true
-          schema:
-            type: string
-            example: NYSE
-        - in: query
-          name: sortOrder
-          description: The sort order of the stock quotes
-          required: false
-          schema:
-            $ref: '#/components/schemas/SortOrder'
-            example: DESC
-            default: DESC
-        - in: query
-          name: sortField
-          description: The sort field of the stock quotes
-          required: false
-          schema:
-            $ref: '#/components/schemas/SortField'
-            example: MARKET_CAP
-            default: MARKET_CAP
-      responses:
-        200:
-          description: Success
-          content:
-            application/json:
-              schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/SimpleQuote'
-        404:
-          $ref: '#/components/responses/NotFound'
-        500:
-          $ref: '#/components/responses/InternalServerError'
-
   /stocks/indexes:
     get:
       description: Gets all the indexes
@@ -571,6 +543,16 @@ components:
             - displayName
             - components
 
+    StocksMetadata:
+      description: Metadata about the stocks
+      properties:
+        pollInterval:
+          type: integer
+          format: int64
+          example: 30
+      required:
+        - pollInterval
+
     Error:
       description: A generic error
       properties:

package/ts/services/dt-market-service.ts

@@ -4,15 +4,15 @@
  */
 
 export interface paths {
-    "/stocks/{symbol}": {
+    "/stocks/metadata": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        /** @description Gets the full quote for the given stock symbol */
-        get: operations["getStock"];
+        /** @description Gets metadata about the stocks */
+        get: operations["getStocksMetadata"];
         put?: never;
         post?: never;
         delete?: never;
@@ -21,15 +21,15 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/stocks/{symbol}/history": {
+    "/stocks/{symbol}": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        /** @description Gets the price history chart for the given stock symbol */
-        get: operations["getStockHistory"];
+        /** @description Gets the full quote for the given stock symbol */
+        get: operations["getStock"];
         put?: never;
         post?: never;
         delete?: never;
@@ -38,15 +38,15 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/stocks/by-symbols/{symbols}": {
+    "/stocks/{symbol}/history": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        /** @description Gets the simple quotes for the given stock symbols */
-        get: operations["getStocksBySymbols"];
+        /** @description Gets the price history chart for the given stock symbol */
+        get: operations["getStockHistory"];
         put?: never;
         post?: never;
         delete?: never;
@@ -55,15 +55,15 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/stocks/by-exchange/{exchange}": {
+    "/stocks/by-symbols/{symbols}": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        /** @description Gets the simple quotes for the given stock exchange */
-        get: operations["getStocksByExchange"];
+        /** @description Gets the simple quotes for the given stock symbols */
+        get: operations["getStocksBySymbols"];
         put?: never;
         post?: never;
         delete?: never;
@@ -346,6 +346,14 @@ export interface components {
             displayName: string;
             components: components["schemas"]["SimpleQuote"][];
         };
+        /** @description Metadata about the stocks */
+        StocksMetadata: {
+            /**
+             * Format: int64
+             * @example 30
+             */
+            pollInterval: number;
+        };
         /** @description A generic error */
         Error: {
             /**
@@ -394,14 +402,11 @@ export interface components {
 }
 export type $defs = Record<string, never>;
 export interface operations {
-    getStock: {
+    getStocksMetadata: {
         parameters: {
             query?: never;
             header?: never;
-            path: {
-                /** @description The stock symbol */
-                symbol: string;
-            };
+            path?: never;
             cookie?: never;
         };
         requestBody?: never;
@@ -412,23 +417,15 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["FullQuote"];
+                    "application/json": components["schemas"]["StocksMetadata"];
                 };
             };
-            404: components["responses"]["NotFound"];
             500: components["responses"]["InternalServerError"];
         };
     };
-    getStockHistory: {
+    getStock: {
         parameters: {
-            query: {
-                /** @description The stock history timeframe */
-                timeframe: components["schemas"]["StockHistoryTimeframe"];
-                /** @description The stock history from date */
-                from: string;
-                /** @description The stock history to date */
-                to: string;
-            };
+            query?: never;
             header?: never;
             path: {
                 /** @description The stock symbol */
@@ -444,25 +441,27 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["StockHistoryEntry"][];
+                    "application/json": components["schemas"]["FullQuote"];
                 };
             };
             404: components["responses"]["NotFound"];
             500: components["responses"]["InternalServerError"];
         };
     };
-    getStocksBySymbols: {
+    getStockHistory: {
         parameters: {
-            query?: {
-                /** @description The sort order of the stock quotes */
-                sortOrder?: components["schemas"]["SortOrder"];
-                /** @description The sort field of the stock quotes */
-                sortField?: components["schemas"]["SortField"];
+            query: {
+                /** @description The stock history timeframe */
+                timeframe: components["schemas"]["StockHistoryTimeframe"];
+                /** @description The stock history from date */
+                from: string;
+                /** @description The stock history to date */
+                to: string;
             };
             header?: never;
             path: {
-                /** @description The stock symbols */
-                symbols: string;
+                /** @description The stock symbol */
+                symbol: string;
             };
             cookie?: never;
         };
@@ -474,14 +473,14 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["SimpleQuote"][];
+                    "application/json": components["schemas"]["StockHistoryEntry"][];
                 };
             };
             404: components["responses"]["NotFound"];
             500: components["responses"]["InternalServerError"];
         };
     };
-    getStocksByExchange: {
+    getStocksBySymbols: {
         parameters: {
             query?: {
                 /** @description The sort order of the stock quotes */
@@ -491,8 +490,8 @@ export interface operations {
             };
             header?: never;
             path: {
-                /** @description The stock exchange */
-                exchange: string;
+                /** @description The stock symbols */
+                symbols: string;
             };
             cookie?: never;
         };

package/ts/types/types.ts

@@ -26,10 +26,10 @@ export type SortOrder = MarketServiceSchemas['SortOrder'];
 export type SortField = MarketServiceSchemas['SortField'];
 export type Index = MarketServiceSchemas['Index'];
 export type GetIndexesQueryParams = MarketServiceOperations['getIndexes']['parameters']['query'];
-export type GetStocksByExchangeQueryParams = MarketServiceOperations['getStocksByExchange']['parameters']['query'];
 export type GetStocksBySymbolsQueryParams = MarketServiceOperations['getStocksBySymbols']['parameters']['query'];
 export type GetSearchStocksQueryParams = MarketServiceOperations['getSearchStocks']['parameters']['query'];
 export type GetStockHistoryQueryParams = MarketServiceOperations['getStockHistory']['parameters']['query'];
+export type StocksMetadata = MarketServiceSchemas['StocksMetadata'];
 
 // Trade Service Types
 export type Portfolio = TradeServiceSchemas['Portfolio'];