@rivascva/dt-idl 1.1.25 → 1.1.27

package/dist/index.d.ts

@@ -679,9 +679,9 @@ interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Add a new order */
+        /** @description Adds a new order */
         post: operations["addOrder"];
-        /** @description Delete an existing order */
+        /** @description Deletes an existing order */
         delete: operations["deleteOrder"];
         options?: never;
         head?: never;
@@ -691,15 +691,17 @@ interface paths {
 }
 interface components {
     schemas: {
-        /** @description A user payload */
-        UserPayload: {
+        /** @description Payload to add a new user */
+        AddUserPayload: {
             /** @example sam.smith@example.com */
             email: string;
             /** @example Sam Smith */
             name: string;
         };
+        /** @description Payload to update an existing user */
+        UpdateUserPayload: components["schemas"]["AddUserPayload"];
         /** @description A user */
-        User: components["schemas"]["UserPayload"] & {
+        User: components["schemas"]["AddUserPayload"] & {
             /** @example 123456 */
             id: string;
             /**
@@ -766,8 +768,8 @@ interface components {
              */
             dateUpdated: number;
         };
-        /** @description A trade order payload */
-        OrderPayload: {
+        /** @description Payload to add a new order */
+        AddOrderPayload: {
             /** @example 123456 */
             portfolioId: string;
             /** @example BUY */
@@ -785,8 +787,13 @@ interface components {
              */
             shares: number;
         };
-        /** @description A trade order */
-        Order: components["schemas"]["OrderPayload"] & {
+        /** @description Payload to delete an existing order */
+        DeleteOrderPayload: {
+            /** @example 123456 */
+            id: string;
+        };
+        /** @description An order */
+        Order: components["schemas"]["AddOrderPayload"] & {
             /** @example 123456 */
             id: string;
             /**
@@ -823,7 +830,7 @@ interface components {
             message: string;
         };
         /** @enum {string} */
-        ErrorCode: "ERROR" | "NOT_ENOUGH_CASH" | "NOT_ENOUGH_SHARES";
+        ErrorCode: "ERROR" | "NOT_ENOUGH_CASH" | "NOT_ENOUGH_SHARES" | "UNDELETABLE";
         /** @enum {string} */
         PortfolioType: "PERSONAL" | "COMPETITIVE";
         /** @enum {string} */
@@ -903,7 +910,7 @@ interface operations {
         /** @description The request body to add a user */
         requestBody: {
             content: {
-                "application/json": components["schemas"]["UserPayload"];
+                "application/json": components["schemas"]["AddUserPayload"];
             };
         };
         responses: {
@@ -958,7 +965,7 @@ interface operations {
         /** @description The request body to updated a user */
         requestBody: {
             content: {
-                "application/json": components["schemas"]["UserPayload"];
+                "application/json": components["schemas"]["UpdateUserPayload"];
             };
         };
         responses: {
@@ -1011,7 +1018,7 @@ interface operations {
         /** @description The request body to add an order */
         requestBody: {
             content: {
-                "application/json": components["schemas"]["OrderPayload"];
+                "application/json": components["schemas"]["AddOrderPayload"];
             };
         };
         responses: {
@@ -1039,10 +1046,7 @@ interface operations {
         /** @description The request body to delete an existing order */
         requestBody: {
             content: {
-                "application/json": {
-                    /** @example 123456 */
-                    id: string;
-                };
+                "application/json": components["schemas"]["DeleteOrderPayload"];
             };
         };
         responses: {
@@ -1064,7 +1068,7 @@ declare const isMarketServiceError: (error: unknown) => error is {
 };
 declare const isTradeServiceError: (error: unknown) => error is {
     status: number;
-    code: "ERROR" | "NOT_ENOUGH_CASH" | "NOT_ENOUGH_SHARES";
+    code: "ERROR" | "NOT_ENOUGH_CASH" | "NOT_ENOUGH_SHARES" | "UNDELETABLE";
     message: string;
 };
 
@@ -1078,10 +1082,11 @@ type MarketServiceError = MarketServiceSchemas['Error'];
 type User = TradeServiceSchemas['User'];
 type Portfolio = TradeServiceSchemas['Portfolio'];
 type PortfolioType = TradeServiceSchemas['PortfolioType'];
-type OrderPayload = TradeServiceSchemas['OrderPayload'];
+type AddOrderPayload = TradeServiceSchemas['AddOrderPayload'];
+type DeleteOrderPayload = TradeServiceSchemas['DeleteOrderPayload'];
 type Order = TradeServiceSchemas['Order'];
 type OrderType = TradeServiceSchemas['OrderType'];
 type Holding = TradeServiceSchemas['Holding'];
 type TradeServiceError = TradeServiceSchemas['Error'];
 
-export { type FullQuote, type Holding, type MarketServiceError, type NewsArticle, type Order, type OrderPayload, type OrderType, type Portfolio, type PortfolioType, type SimpleQuote, type StockNewsArticle, type TradeServiceError, type User, createMarketServiceClient, createTradeServiceClient, isMarketServiceError, isTradeServiceError };
+export { type AddOrderPayload, type DeleteOrderPayload, type FullQuote, type Holding, type MarketServiceError, type NewsArticle, type Order, type OrderType, type Portfolio, type PortfolioType, type SimpleQuote, type StockNewsArticle, type TradeServiceError, type User, createMarketServiceClient, createTradeServiceClient, isMarketServiceError, isTradeServiceError };

package/package.json

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

package/services/dt-trade-service.yaml

@@ -39,7 +39,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/UserPayload'
+              $ref: '#/components/schemas/AddUserPayload'
       responses:
         201:
           description: Added
@@ -97,7 +97,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/UserPayload'
+              $ref: '#/components/schemas/UpdateUserPayload'
       responses:
         200:
           description: Success
@@ -142,7 +142,7 @@ paths:
 
   /orders:
     post:
-      description: Add a new order
+      description: Adds a new order
       operationId: addOrder
       tags:
         - Orders
@@ -152,7 +152,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/OrderPayload'
+              $ref: '#/components/schemas/AddOrderPayload'
       responses:
         201:
           description: Added
@@ -167,7 +167,7 @@ paths:
         500:
           $ref: '#/components/responses/InternalServerError'
     delete:
-      description: Delete an existing order
+      description: Deletes an existing order
       operationId: deleteOrder
       tags:
         - Orders
@@ -177,12 +177,7 @@ paths:
         content:
           application/json:
             schema:
-              properties:
-                id:
-                  type: string
-                  example: 123456
-              required:
-                - id
+              $ref: '#/components/schemas/DeleteOrderPayload'
       responses:
         204:
           $ref: '#/components/responses/NoContent'
@@ -195,8 +190,8 @@ paths:
 
 components:
   schemas:
-    UserPayload:
-      description: A user payload
+    AddUserPayload:
+      description: Payload to add a new user
       properties:
         email:
           type: string
@@ -208,10 +203,15 @@ components:
         - email
         - name
 
+    UpdateUserPayload:
+      description: Payload to update an existing user
+      allOf:
+        - $ref: '#/components/schemas/AddUserPayload'
+
     User:
       description: A user
       allOf:
-        - $ref: '#/components/schemas/UserPayload'
+        - $ref: '#/components/schemas/AddUserPayload'
         - type: object
           properties:
             id:
@@ -305,8 +305,8 @@ components:
         - dateCreated
         - dateUpdated
 
-    OrderPayload:
-      description: A trade order payload
+    AddOrderPayload:
+      description: Payload to add a new order
       properties:
         portfolioId:
           type: string
@@ -332,10 +332,19 @@ components:
         - targetPrice
         - shares
 
+    DeleteOrderPayload:
+      description: Payload to delete an existing order
+      properties:
+        id:
+          type: string
+          example: 123456
+      required:
+        - id
+
     Order:
-      description: A trade order
+      description: An order
       allOf:
-        - $ref: '#/components/schemas/OrderPayload'
+        - $ref: '#/components/schemas/AddOrderPayload'
         - type: object
           properties:
             id:
@@ -390,6 +399,7 @@ components:
         - ERROR
         - NOT_ENOUGH_CASH
         - NOT_ENOUGH_SHARES
+        - UNDELETABLE
 
     PortfolioType:
       type: string

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

@@ -66,9 +66,9 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** @description Add a new order */
+        /** @description Adds a new order */
         post: operations["addOrder"];
-        /** @description Delete an existing order */
+        /** @description Deletes an existing order */
         delete: operations["deleteOrder"];
         options?: never;
         head?: never;
@@ -79,15 +79,17 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
-        /** @description A user payload */
-        UserPayload: {
+        /** @description Payload to add a new user */
+        AddUserPayload: {
             /** @example sam.smith@example.com */
             email: string;
             /** @example Sam Smith */
             name: string;
         };
+        /** @description Payload to update an existing user */
+        UpdateUserPayload: components["schemas"]["AddUserPayload"];
         /** @description A user */
-        User: components["schemas"]["UserPayload"] & {
+        User: components["schemas"]["AddUserPayload"] & {
             /** @example 123456 */
             id: string;
             /**
@@ -154,8 +156,8 @@ export interface components {
              */
             dateUpdated: number;
         };
-        /** @description A trade order payload */
-        OrderPayload: {
+        /** @description Payload to add a new order */
+        AddOrderPayload: {
             /** @example 123456 */
             portfolioId: string;
             /** @example BUY */
@@ -173,8 +175,13 @@ export interface components {
              */
             shares: number;
         };
-        /** @description A trade order */
-        Order: components["schemas"]["OrderPayload"] & {
+        /** @description Payload to delete an existing order */
+        DeleteOrderPayload: {
+            /** @example 123456 */
+            id: string;
+        };
+        /** @description An order */
+        Order: components["schemas"]["AddOrderPayload"] & {
             /** @example 123456 */
             id: string;
             /**
@@ -211,7 +218,7 @@ export interface components {
             message: string;
         };
         /** @enum {string} */
-        ErrorCode: "ERROR" | "NOT_ENOUGH_CASH" | "NOT_ENOUGH_SHARES";
+        ErrorCode: "ERROR" | "NOT_ENOUGH_CASH" | "NOT_ENOUGH_SHARES" | "UNDELETABLE";
         /** @enum {string} */
         PortfolioType: "PERSONAL" | "COMPETITIVE";
         /** @enum {string} */
@@ -292,7 +299,7 @@ export interface operations {
         /** @description The request body to add a user */
         requestBody: {
             content: {
-                "application/json": components["schemas"]["UserPayload"];
+                "application/json": components["schemas"]["AddUserPayload"];
             };
         };
         responses: {
@@ -347,7 +354,7 @@ export interface operations {
         /** @description The request body to updated a user */
         requestBody: {
             content: {
-                "application/json": components["schemas"]["UserPayload"];
+                "application/json": components["schemas"]["UpdateUserPayload"];
             };
         };
         responses: {
@@ -400,7 +407,7 @@ export interface operations {
         /** @description The request body to add an order */
         requestBody: {
             content: {
-                "application/json": components["schemas"]["OrderPayload"];
+                "application/json": components["schemas"]["AddOrderPayload"];
             };
         };
         responses: {
@@ -428,10 +435,7 @@ export interface operations {
         /** @description The request body to delete an existing order */
         requestBody: {
             content: {
-                "application/json": {
-                    /** @example 123456 */
-                    id: string;
-                };
+                "application/json": components["schemas"]["DeleteOrderPayload"];
             };
         };
         responses: {

package/ts/types/types.ts

@@ -15,7 +15,8 @@ export type MarketServiceError = MarketServiceSchemas['Error'];
 export type User = TradeServiceSchemas['User'];
 export type Portfolio = TradeServiceSchemas['Portfolio'];
 export type PortfolioType = TradeServiceSchemas['PortfolioType'];
-export type OrderPayload = TradeServiceSchemas['OrderPayload'];
+export type AddOrderPayload = TradeServiceSchemas['AddOrderPayload'];
+export type DeleteOrderPayload = TradeServiceSchemas['DeleteOrderPayload'];
 export type Order = TradeServiceSchemas['Order'];
 export type OrderType = TradeServiceSchemas['OrderType'];
 export type Holding = TradeServiceSchemas['Holding'];