@rivascva/dt-idl 1.1.34 → 1.1.36

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
@@ -670,6 +670,57 @@ interface paths$1 {
670
670
  patch?: never;
671
671
  trace?: never;
672
672
  };
673
+ "/portfolios": {
674
+ parameters: {
675
+ query?: never;
676
+ header?: never;
677
+ path?: never;
678
+ cookie?: never;
679
+ };
680
+ get?: never;
681
+ put?: never;
682
+ /** @description Adds a new portfolio */
683
+ post: operations$1["addPortfolio"];
684
+ delete?: never;
685
+ options?: never;
686
+ head?: never;
687
+ patch?: never;
688
+ trace?: never;
689
+ };
690
+ "/portfolios/{portfolioId}": {
691
+ parameters: {
692
+ query?: never;
693
+ header?: never;
694
+ path?: never;
695
+ cookie?: never;
696
+ };
697
+ get?: never;
698
+ /** @description Updates an existing portfolio */
699
+ put: operations$1["updatePortfolio"];
700
+ post?: never;
701
+ delete?: never;
702
+ options?: never;
703
+ head?: never;
704
+ patch?: never;
705
+ trace?: never;
706
+ };
707
+ "/portfolios/by-user/{userId}": {
708
+ parameters: {
709
+ query?: never;
710
+ header?: never;
711
+ path?: never;
712
+ cookie?: never;
713
+ };
714
+ /** @description Gets the portfolios for the given user */
715
+ get: operations$1["getPortfoliosByUser"];
716
+ put?: never;
717
+ post?: never;
718
+ delete?: never;
719
+ options?: never;
720
+ head?: never;
721
+ patch?: never;
722
+ trace?: never;
723
+ };
673
724
  "/orders": {
674
725
  parameters: {
675
726
  query?: never;
@@ -735,10 +786,8 @@ interface components$1 {
735
786
  */
736
787
  dateUpdated: number;
737
788
  };
738
- /** @description A trading portfolio */
739
- Portfolio: {
740
- /** @example 123456 */
741
- id: string;
789
+ /** @description Payload to add a new portfolio */
790
+ AddPortfolioPayload: {
742
791
  /** @example 123456 */
743
792
  userId: string;
744
793
  /** @example PERSONAL */
@@ -748,6 +797,13 @@ interface components$1 {
748
797
  * @example 10500.25
749
798
  */
750
799
  cash: number;
800
+ };
801
+ /** @description Payload to update an existing portfolio */
802
+ UpdatePortfolioPayload: components$1["schemas"]["AddPortfolioPayload"];
803
+ /** @description A trading portfolio */
804
+ Portfolio: components$1["schemas"]["AddPortfolioPayload"] & {
805
+ /** @example 123456 */
806
+ id: string;
751
807
  holdings: components$1["schemas"]["Holding"][];
752
808
  orders: components$1["schemas"]["Order"][];
753
809
  /**
@@ -977,7 +1033,7 @@ interface operations$1 {
977
1033
  };
978
1034
  cookie?: never;
979
1035
  };
980
- /** @description The request body to updated a user */
1036
+ /** @description The request body to update a user */
981
1037
  requestBody: {
982
1038
  content: {
983
1039
  "application/json": components$1["schemas"]["UpdateUserPayload"];
@@ -1023,6 +1079,90 @@ interface operations$1 {
1023
1079
  500: components$1["responses"]["InternalServerError"];
1024
1080
  };
1025
1081
  };
1082
+ addPortfolio: {
1083
+ parameters: {
1084
+ query?: never;
1085
+ header?: never;
1086
+ path?: never;
1087
+ cookie?: never;
1088
+ };
1089
+ /** @description The request body to add a portfolio */
1090
+ requestBody: {
1091
+ content: {
1092
+ "application/json": components$1["schemas"]["AddPortfolioPayload"];
1093
+ };
1094
+ };
1095
+ responses: {
1096
+ /** @description Added */
1097
+ 201: {
1098
+ headers: {
1099
+ [name: string]: unknown;
1100
+ };
1101
+ content: {
1102
+ "application/json": components$1["schemas"]["Portfolio"];
1103
+ };
1104
+ };
1105
+ 400: components$1["responses"]["BadRequest"];
1106
+ 404: components$1["responses"]["NotFound"];
1107
+ 500: components$1["responses"]["InternalServerError"];
1108
+ };
1109
+ };
1110
+ updatePortfolio: {
1111
+ parameters: {
1112
+ query?: never;
1113
+ header?: never;
1114
+ path: {
1115
+ /** @description The portfolio id */
1116
+ portfolioId: string;
1117
+ };
1118
+ cookie?: never;
1119
+ };
1120
+ /** @description The request body to update a portfolio */
1121
+ requestBody: {
1122
+ content: {
1123
+ "application/json": components$1["schemas"]["UpdatePortfolioPayload"];
1124
+ };
1125
+ };
1126
+ responses: {
1127
+ /** @description Success */
1128
+ 200: {
1129
+ headers: {
1130
+ [name: string]: unknown;
1131
+ };
1132
+ content: {
1133
+ "application/json": components$1["schemas"]["Portfolio"];
1134
+ };
1135
+ };
1136
+ 400: components$1["responses"]["BadRequest"];
1137
+ 404: components$1["responses"]["NotFound"];
1138
+ 500: components$1["responses"]["InternalServerError"];
1139
+ };
1140
+ };
1141
+ getPortfoliosByUser: {
1142
+ parameters: {
1143
+ query?: never;
1144
+ header?: never;
1145
+ path: {
1146
+ /** @description The user id */
1147
+ userId: string;
1148
+ };
1149
+ cookie?: never;
1150
+ };
1151
+ requestBody?: never;
1152
+ responses: {
1153
+ /** @description Success */
1154
+ 200: {
1155
+ headers: {
1156
+ [name: string]: unknown;
1157
+ };
1158
+ content: {
1159
+ "application/json": components$1["schemas"]["Portfolio"][];
1160
+ };
1161
+ };
1162
+ 404: components$1["responses"]["NotFound"];
1163
+ 500: components$1["responses"]["InternalServerError"];
1164
+ };
1165
+ };
1026
1166
  addOrder: {
1027
1167
  parameters: {
1028
1168
  query?: never;
@@ -1284,7 +1424,7 @@ interface operations {
1284
1424
  };
1285
1425
  cookie?: never;
1286
1426
  };
1287
- /** @description The request body to updated a user */
1427
+ /** @description The request body to update a user */
1288
1428
  requestBody: {
1289
1429
  content: {
1290
1430
  "application/json": components["schemas"]["UpdateUserPayload"];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rivascva/dt-idl",
3
- "version": "1.1.34",
3
+ "version": "1.1.36",
4
4
  "description": "Dream Trade - Interface Definition Language",
5
5
  "main": "dist/index.cjs.js",
6
6
  "module": "dist/index.esm.js",
@@ -92,7 +92,7 @@ paths:
92
92
  type: string
93
93
  example: 123456
94
94
  requestBody:
95
- description: The request body to updated a user
95
+ description: The request body to update a user
96
96
  required: true
97
97
  content:
98
98
  application/json:
@@ -92,7 +92,7 @@ paths:
92
92
  type: string
93
93
  example: 123456
94
94
  requestBody:
95
- description: The request body to updated a user
95
+ description: The request body to update a user
96
96
  required: true
97
97
  content:
98
98
  application/json:
@@ -140,6 +140,96 @@ paths:
140
140
  500:
141
141
  $ref: '#/components/responses/InternalServerError'
142
142
 
143
+ /portfolios:
144
+ post:
145
+ description: Adds a new portfolio
146
+ operationId: addPortfolio
147
+ tags:
148
+ - Portfolios
149
+ requestBody:
150
+ description: The request body to add a portfolio
151
+ required: true
152
+ content:
153
+ application/json:
154
+ schema:
155
+ $ref: '#/components/schemas/AddPortfolioPayload'
156
+ responses:
157
+ 201:
158
+ description: Added
159
+ content:
160
+ application/json:
161
+ schema:
162
+ $ref: '#/components/schemas/Portfolio'
163
+ 400:
164
+ $ref: '#/components/responses/BadRequest'
165
+ 404:
166
+ $ref: '#/components/responses/NotFound'
167
+ 500:
168
+ $ref: '#/components/responses/InternalServerError'
169
+
170
+ /portfolios/{portfolioId}:
171
+ put:
172
+ description: Updates an existing portfolio
173
+ operationId: updatePortfolio
174
+ tags:
175
+ - Portfolios
176
+ parameters:
177
+ - in: path
178
+ name: portfolioId
179
+ description: The portfolio id
180
+ required: true
181
+ schema:
182
+ type: string
183
+ example: 123456
184
+ requestBody:
185
+ description: The request body to update a portfolio
186
+ required: true
187
+ content:
188
+ application/json:
189
+ schema:
190
+ $ref: '#/components/schemas/UpdatePortfolioPayload'
191
+ responses:
192
+ 200:
193
+ description: Success
194
+ content:
195
+ application/json:
196
+ schema:
197
+ $ref: '#/components/schemas/Portfolio'
198
+ 400:
199
+ $ref: '#/components/responses/BadRequest'
200
+ 404:
201
+ $ref: '#/components/responses/NotFound'
202
+ 500:
203
+ $ref: '#/components/responses/InternalServerError'
204
+
205
+ /portfolios/by-user/{userId}:
206
+ get:
207
+ description: Gets the portfolios for the given user
208
+ operationId: getPortfoliosByUser
209
+ tags:
210
+ - Portfolios
211
+ parameters:
212
+ - in: path
213
+ name: userId
214
+ description: The user id
215
+ required: true
216
+ schema:
217
+ type: string
218
+ example: 123456
219
+ responses:
220
+ 200:
221
+ description: Success
222
+ content:
223
+ application/json:
224
+ schema:
225
+ type: array
226
+ items:
227
+ $ref: '#/components/schemas/Portfolio'
228
+ 404:
229
+ $ref: '#/components/responses/NotFound'
230
+ 500:
231
+ $ref: '#/components/responses/InternalServerError'
232
+
143
233
  /orders:
144
234
  post:
145
235
  description: Adds a new order
@@ -240,12 +330,9 @@ components:
240
330
  - dateCreated
241
331
  - dateUpdated
242
332
 
243
- Portfolio:
244
- description: A trading portfolio
333
+ AddPortfolioPayload:
334
+ description: Payload to add a new portfolio
245
335
  properties:
246
- id:
247
- type: string
248
- example: 123456
249
336
  userId:
250
337
  type: string
251
338
  example: 123456
@@ -256,31 +343,47 @@ components:
256
343
  type: number
257
344
  format: double
258
345
  example: 10500.25
259
- holdings:
260
- type: array
261
- items:
262
- $ref: '#/components/schemas/Holding'
263
- orders:
264
- type: array
265
- items:
266
- $ref: '#/components/schemas/Order'
267
- dateCreated:
268
- type: integer
269
- format: int64
270
- example: 1713398544000
271
- dateUpdated:
272
- type: integer
273
- format: int64
274
- example: 1713398544000
275
346
  required:
276
- - id
277
347
  - userId
278
348
  - type
279
349
  - cash
280
- - holdings
281
- - orders
282
- - dateCreated
283
- - dateUpdated
350
+
351
+ UpdatePortfolioPayload:
352
+ description: Payload to update an existing portfolio
353
+ allOf:
354
+ - $ref: '#/components/schemas/AddPortfolioPayload'
355
+
356
+ Portfolio:
357
+ description: A trading portfolio
358
+ allOf:
359
+ - $ref: '#/components/schemas/AddPortfolioPayload'
360
+ - type: object
361
+ properties:
362
+ id:
363
+ type: string
364
+ example: 123456
365
+ holdings:
366
+ type: array
367
+ items:
368
+ $ref: '#/components/schemas/Holding'
369
+ orders:
370
+ type: array
371
+ items:
372
+ $ref: '#/components/schemas/Order'
373
+ dateCreated:
374
+ type: integer
375
+ format: int64
376
+ example: 1713398544000
377
+ dateUpdated:
378
+ type: integer
379
+ format: int64
380
+ example: 1713398544000
381
+ required:
382
+ - id
383
+ - holdings
384
+ - orders
385
+ - dateCreated
386
+ - dateUpdated
284
387
 
285
388
  Holding:
286
389
  description: A stock holding
@@ -214,7 +214,7 @@ export interface operations {
214
214
  };
215
215
  cookie?: never;
216
216
  };
217
- /** @description The request body to updated a user */
217
+ /** @description The request body to update a user */
218
218
  requestBody: {
219
219
  content: {
220
220
  "application/json": components["schemas"]["UpdateUserPayload"];
@@ -57,6 +57,57 @@ export interface paths {
57
57
  patch?: never;
58
58
  trace?: never;
59
59
  };
60
+ "/portfolios": {
61
+ parameters: {
62
+ query?: never;
63
+ header?: never;
64
+ path?: never;
65
+ cookie?: never;
66
+ };
67
+ get?: never;
68
+ put?: never;
69
+ /** @description Adds a new portfolio */
70
+ post: operations["addPortfolio"];
71
+ delete?: never;
72
+ options?: never;
73
+ head?: never;
74
+ patch?: never;
75
+ trace?: never;
76
+ };
77
+ "/portfolios/{portfolioId}": {
78
+ parameters: {
79
+ query?: never;
80
+ header?: never;
81
+ path?: never;
82
+ cookie?: never;
83
+ };
84
+ get?: never;
85
+ /** @description Updates an existing portfolio */
86
+ put: operations["updatePortfolio"];
87
+ post?: never;
88
+ delete?: never;
89
+ options?: never;
90
+ head?: never;
91
+ patch?: never;
92
+ trace?: never;
93
+ };
94
+ "/portfolios/by-user/{userId}": {
95
+ parameters: {
96
+ query?: never;
97
+ header?: never;
98
+ path?: never;
99
+ cookie?: never;
100
+ };
101
+ /** @description Gets the portfolios for the given user */
102
+ get: operations["getPortfoliosByUser"];
103
+ put?: never;
104
+ post?: never;
105
+ delete?: never;
106
+ options?: never;
107
+ head?: never;
108
+ patch?: never;
109
+ trace?: never;
110
+ };
60
111
  "/orders": {
61
112
  parameters: {
62
113
  query?: never;
@@ -123,10 +174,8 @@ export interface components {
123
174
  */
124
175
  dateUpdated: number;
125
176
  };
126
- /** @description A trading portfolio */
127
- Portfolio: {
128
- /** @example 123456 */
129
- id: string;
177
+ /** @description Payload to add a new portfolio */
178
+ AddPortfolioPayload: {
130
179
  /** @example 123456 */
131
180
  userId: string;
132
181
  /** @example PERSONAL */
@@ -136,6 +185,13 @@ export interface components {
136
185
  * @example 10500.25
137
186
  */
138
187
  cash: number;
188
+ };
189
+ /** @description Payload to update an existing portfolio */
190
+ UpdatePortfolioPayload: components["schemas"]["AddPortfolioPayload"];
191
+ /** @description A trading portfolio */
192
+ Portfolio: components["schemas"]["AddPortfolioPayload"] & {
193
+ /** @example 123456 */
194
+ id: string;
139
195
  holdings: components["schemas"]["Holding"][];
140
196
  orders: components["schemas"]["Order"][];
141
197
  /**
@@ -366,7 +422,7 @@ export interface operations {
366
422
  };
367
423
  cookie?: never;
368
424
  };
369
- /** @description The request body to updated a user */
425
+ /** @description The request body to update a user */
370
426
  requestBody: {
371
427
  content: {
372
428
  "application/json": components["schemas"]["UpdateUserPayload"];
@@ -412,6 +468,90 @@ export interface operations {
412
468
  500: components["responses"]["InternalServerError"];
413
469
  };
414
470
  };
471
+ addPortfolio: {
472
+ parameters: {
473
+ query?: never;
474
+ header?: never;
475
+ path?: never;
476
+ cookie?: never;
477
+ };
478
+ /** @description The request body to add a portfolio */
479
+ requestBody: {
480
+ content: {
481
+ "application/json": components["schemas"]["AddPortfolioPayload"];
482
+ };
483
+ };
484
+ responses: {
485
+ /** @description Added */
486
+ 201: {
487
+ headers: {
488
+ [name: string]: unknown;
489
+ };
490
+ content: {
491
+ "application/json": components["schemas"]["Portfolio"];
492
+ };
493
+ };
494
+ 400: components["responses"]["BadRequest"];
495
+ 404: components["responses"]["NotFound"];
496
+ 500: components["responses"]["InternalServerError"];
497
+ };
498
+ };
499
+ updatePortfolio: {
500
+ parameters: {
501
+ query?: never;
502
+ header?: never;
503
+ path: {
504
+ /** @description The portfolio id */
505
+ portfolioId: string;
506
+ };
507
+ cookie?: never;
508
+ };
509
+ /** @description The request body to update a portfolio */
510
+ requestBody: {
511
+ content: {
512
+ "application/json": components["schemas"]["UpdatePortfolioPayload"];
513
+ };
514
+ };
515
+ responses: {
516
+ /** @description Success */
517
+ 200: {
518
+ headers: {
519
+ [name: string]: unknown;
520
+ };
521
+ content: {
522
+ "application/json": components["schemas"]["Portfolio"];
523
+ };
524
+ };
525
+ 400: components["responses"]["BadRequest"];
526
+ 404: components["responses"]["NotFound"];
527
+ 500: components["responses"]["InternalServerError"];
528
+ };
529
+ };
530
+ getPortfoliosByUser: {
531
+ parameters: {
532
+ query?: never;
533
+ header?: never;
534
+ path: {
535
+ /** @description The user id */
536
+ userId: string;
537
+ };
538
+ cookie?: never;
539
+ };
540
+ requestBody?: never;
541
+ responses: {
542
+ /** @description Success */
543
+ 200: {
544
+ headers: {
545
+ [name: string]: unknown;
546
+ };
547
+ content: {
548
+ "application/json": components["schemas"]["Portfolio"][];
549
+ };
550
+ };
551
+ 404: components["responses"]["NotFound"];
552
+ 500: components["responses"]["InternalServerError"];
553
+ };
554
+ };
415
555
  addOrder: {
416
556
  parameters: {
417
557
  query?: never;