@firela/api-types 0.0.0-canary.a7bda42

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.
Files changed (35) hide show
  1. package/README.md +40 -0
  2. package/dist/generated/core/ApiError.d.ts +11 -0
  3. package/dist/generated/core/ApiError.d.ts.map +1 -0
  4. package/dist/generated/core/ApiError.js +11 -0
  5. package/dist/generated/core/ApiRequestOptions.d.ts +14 -0
  6. package/dist/generated/core/ApiRequestOptions.d.ts.map +1 -0
  7. package/dist/generated/core/ApiRequestOptions.js +1 -0
  8. package/dist/generated/core/ApiResult.d.ts +8 -0
  9. package/dist/generated/core/ApiResult.d.ts.map +1 -0
  10. package/dist/generated/core/ApiResult.js +1 -0
  11. package/dist/generated/core/CancelablePromise.d.ts +27 -0
  12. package/dist/generated/core/CancelablePromise.d.ts.map +1 -0
  13. package/dist/generated/core/CancelablePromise.js +88 -0
  14. package/dist/generated/core/OpenAPI.d.ts +28 -0
  15. package/dist/generated/core/OpenAPI.d.ts.map +1 -0
  16. package/dist/generated/core/OpenAPI.js +29 -0
  17. package/dist/generated/core/request.d.ts +30 -0
  18. package/dist/generated/core/request.d.ts.map +1 -0
  19. package/dist/generated/core/request.js +297 -0
  20. package/dist/generated/index.d.ts +7 -0
  21. package/dist/generated/index.d.ts.map +1 -0
  22. package/dist/generated/index.js +7 -0
  23. package/dist/generated/schemas.gen.d.ts +771 -0
  24. package/dist/generated/schemas.gen.d.ts.map +1 -0
  25. package/dist/generated/schemas.gen.js +771 -0
  26. package/dist/generated/services.gen.d.ts +313 -0
  27. package/dist/generated/services.gen.d.ts.map +1 -0
  28. package/dist/generated/services.gen.js +705 -0
  29. package/dist/generated/types.gen.d.ts +1159 -0
  30. package/dist/generated/types.gen.d.ts.map +1 -0
  31. package/dist/generated/types.gen.js +2 -0
  32. package/dist/index.d.ts +2 -0
  33. package/dist/index.d.ts.map +1 -0
  34. package/dist/index.js +3 -0
  35. package/package.json +31 -0
@@ -0,0 +1,771 @@
1
+ // This file is auto-generated by @hey-api/openapi-ts
2
+ export const $AccountType = {
3
+ type: 'string',
4
+ enum: ['Assets', 'Liabilities', 'Income', 'Expenses', 'Equity'],
5
+ description: 'Beancount account type'
6
+ };
7
+ export const $AccountStatus = {
8
+ type: 'string',
9
+ enum: ['OPEN', 'CLOSED', 'SUSPENDED'],
10
+ description: 'Account lifecycle status'
11
+ };
12
+ export const $BookingMethod = {
13
+ type: 'string',
14
+ enum: ['FIFO', 'LIFO', 'HIFO', 'AVERAGE', 'STRICT', 'STRICT_WITH_SIZE', 'NONE'],
15
+ description: 'Inventory booking method for cost tracking'
16
+ };
17
+ export const $TxnStatus = {
18
+ type: 'string',
19
+ enum: ['ACTIVE', 'VOIDED', 'SUPERSEDED'],
20
+ description: 'Transaction lifecycle status'
21
+ };
22
+ export const $TransactionFlag = {
23
+ type: 'string',
24
+ enum: ['*', '!'],
25
+ description: "Transaction flag: '*' = complete, '!' = incomplete"
26
+ };
27
+ export const $HealthResponse = {
28
+ type: 'object',
29
+ required: ['status'],
30
+ properties: {
31
+ status: {
32
+ type: 'string',
33
+ enum: ['ok', 'degraded']
34
+ },
35
+ version: {
36
+ type: 'string'
37
+ }
38
+ }
39
+ };
40
+ export const $Posting = {
41
+ type: 'object',
42
+ required: ['account'],
43
+ properties: {
44
+ id: {
45
+ type: 'string'
46
+ },
47
+ accountId: {
48
+ type: 'string'
49
+ },
50
+ accountName: {
51
+ type: 'string',
52
+ description: 'Full Beancount account path'
53
+ },
54
+ units: {
55
+ type: 'string',
56
+ description: 'Decimal string for precision'
57
+ },
58
+ currency: {
59
+ type: 'string',
60
+ maxLength: 20
61
+ },
62
+ costAmount: {
63
+ type: 'string'
64
+ },
65
+ costCurrency: {
66
+ type: 'string'
67
+ },
68
+ costDate: {
69
+ type: 'string',
70
+ format: 'date'
71
+ },
72
+ priceAmount: {
73
+ type: 'string'
74
+ },
75
+ priceCurrency: {
76
+ type: 'string'
77
+ },
78
+ flag: {
79
+ type: 'string'
80
+ },
81
+ meta: {
82
+ type: 'object',
83
+ additionalProperties: true
84
+ }
85
+ }
86
+ };
87
+ export const $CreatePostingRequest = {
88
+ type: 'object',
89
+ required: ['account'],
90
+ properties: {
91
+ account: {
92
+ type: 'string',
93
+ description: 'Full Beancount account path (e.g., "Assets:Bank:Checking")'
94
+ },
95
+ units: {
96
+ type: 'string',
97
+ description: 'Decimal string for precision (e.g., "100.50")'
98
+ },
99
+ currency: {
100
+ type: 'string',
101
+ maxLength: 20,
102
+ description: 'Currency code if units provided'
103
+ },
104
+ meta: {
105
+ type: 'object',
106
+ additionalProperties: true
107
+ }
108
+ }
109
+ };
110
+ export const $CreateTransactionRequest = {
111
+ type: 'object',
112
+ required: ['date', 'narration', 'postings'],
113
+ properties: {
114
+ date: {
115
+ type: 'string',
116
+ format: 'date'
117
+ },
118
+ flag: {
119
+ '$ref': '#/components/schemas/TransactionFlag',
120
+ default: '*'
121
+ },
122
+ payee: {
123
+ type: 'string'
124
+ },
125
+ narration: {
126
+ type: 'string'
127
+ },
128
+ tags: {
129
+ type: 'array',
130
+ items: {
131
+ type: 'string'
132
+ }
133
+ },
134
+ links: {
135
+ type: 'array',
136
+ items: {
137
+ type: 'string'
138
+ }
139
+ },
140
+ postings: {
141
+ type: 'array',
142
+ items: {
143
+ '$ref': '#/components/schemas/CreatePostingRequest'
144
+ },
145
+ minItems: 1
146
+ },
147
+ meta: {
148
+ type: 'object',
149
+ additionalProperties: true
150
+ },
151
+ idempotencyKey: {
152
+ type: 'string',
153
+ maxLength: 128
154
+ }
155
+ }
156
+ };
157
+ export const $UpdateTransactionRequest = {
158
+ type: 'object',
159
+ properties: {
160
+ payee: {
161
+ type: 'string'
162
+ },
163
+ narration: {
164
+ type: 'string'
165
+ },
166
+ tags: {
167
+ type: 'array',
168
+ items: {
169
+ type: 'string'
170
+ }
171
+ },
172
+ links: {
173
+ type: 'array',
174
+ items: {
175
+ type: 'string'
176
+ }
177
+ },
178
+ meta: {
179
+ type: 'object',
180
+ additionalProperties: true
181
+ }
182
+ }
183
+ };
184
+ export const $TransactionDetail = {
185
+ type: 'object',
186
+ required: ['id', 'date', 'narration', 'status', 'postings'],
187
+ properties: {
188
+ id: {
189
+ type: 'string'
190
+ },
191
+ date: {
192
+ type: 'string',
193
+ format: 'date'
194
+ },
195
+ flag: {
196
+ '$ref': '#/components/schemas/TransactionFlag'
197
+ },
198
+ customFlag: {
199
+ type: 'string'
200
+ },
201
+ payee: {
202
+ type: 'string'
203
+ },
204
+ narration: {
205
+ type: 'string'
206
+ },
207
+ tags: {
208
+ type: 'array',
209
+ items: {
210
+ type: 'string'
211
+ }
212
+ },
213
+ links: {
214
+ type: 'array',
215
+ items: {
216
+ type: 'string'
217
+ }
218
+ },
219
+ meta: {
220
+ type: 'object',
221
+ additionalProperties: true
222
+ },
223
+ status: {
224
+ '$ref': '#/components/schemas/TxnStatus'
225
+ },
226
+ sourceType: {
227
+ type: 'string'
228
+ },
229
+ sourcePlatform: {
230
+ type: 'string'
231
+ },
232
+ postings: {
233
+ type: 'array',
234
+ items: {
235
+ '$ref': '#/components/schemas/Posting'
236
+ }
237
+ },
238
+ createdAt: {
239
+ type: 'string',
240
+ format: 'date-time'
241
+ },
242
+ voidedAt: {
243
+ type: 'string',
244
+ format: 'date-time'
245
+ },
246
+ voidedBy: {
247
+ type: 'string'
248
+ },
249
+ correctionReason: {
250
+ type: 'string'
251
+ }
252
+ }
253
+ };
254
+ export const $TransactionResponse = {
255
+ type: 'object',
256
+ required: ['transactionId', 'date', 'narration', 'postings'],
257
+ properties: {
258
+ transactionId: {
259
+ type: 'string'
260
+ },
261
+ idempotencyKey: {
262
+ type: 'string'
263
+ },
264
+ date: {
265
+ type: 'string',
266
+ format: 'date'
267
+ },
268
+ flag: {
269
+ '$ref': '#/components/schemas/TransactionFlag'
270
+ },
271
+ payee: {
272
+ type: 'string'
273
+ },
274
+ narration: {
275
+ type: 'string'
276
+ },
277
+ postings: {
278
+ type: 'array',
279
+ items: {
280
+ '$ref': '#/components/schemas/Posting'
281
+ }
282
+ },
283
+ interpolated: {
284
+ type: 'boolean'
285
+ },
286
+ booked: {
287
+ type: 'boolean'
288
+ },
289
+ warnings: {
290
+ type: 'array',
291
+ items: {
292
+ type: 'string'
293
+ }
294
+ },
295
+ createdAccountIds: {
296
+ type: 'array',
297
+ items: {
298
+ type: 'string'
299
+ }
300
+ },
301
+ recurringSuggestion: {
302
+ type: 'object',
303
+ additionalProperties: true
304
+ }
305
+ }
306
+ };
307
+ export const $TransactionListResponse = {
308
+ type: 'object',
309
+ required: ['data', 'total'],
310
+ properties: {
311
+ data: {
312
+ type: 'array',
313
+ items: {
314
+ '$ref': '#/components/schemas/TransactionDetail'
315
+ }
316
+ },
317
+ total: {
318
+ type: 'integer'
319
+ },
320
+ limit: {
321
+ type: 'integer'
322
+ },
323
+ offset: {
324
+ type: 'integer'
325
+ }
326
+ }
327
+ };
328
+ export const $PlatformInfo = {
329
+ type: 'object',
330
+ properties: {
331
+ id: {
332
+ type: 'string'
333
+ },
334
+ name: {
335
+ type: 'string'
336
+ },
337
+ canonical: {
338
+ type: 'string'
339
+ },
340
+ logoUrl: {
341
+ type: 'string'
342
+ },
343
+ type: {
344
+ type: 'string'
345
+ }
346
+ }
347
+ };
348
+ export const $AccountResponse = {
349
+ type: 'object',
350
+ required: ['id', 'path', 'type', 'status', 'openDate', 'bookingMethod', 'isCustom'],
351
+ properties: {
352
+ id: {
353
+ type: 'string',
354
+ format: 'uuid'
355
+ },
356
+ path: {
357
+ type: 'string',
358
+ description: 'Full Beancount account path'
359
+ },
360
+ type: {
361
+ '$ref': '#/components/schemas/AccountType'
362
+ },
363
+ status: {
364
+ '$ref': '#/components/schemas/AccountStatus'
365
+ },
366
+ openDate: {
367
+ type: 'string',
368
+ format: 'date'
369
+ },
370
+ closeDate: {
371
+ type: 'string',
372
+ format: 'date'
373
+ },
374
+ currencies: {
375
+ type: 'array',
376
+ items: {
377
+ type: 'string'
378
+ },
379
+ nullable: true
380
+ },
381
+ bookingMethod: {
382
+ '$ref': '#/components/schemas/BookingMethod'
383
+ },
384
+ templatePath: {
385
+ type: 'string'
386
+ },
387
+ isCustom: {
388
+ type: 'boolean'
389
+ },
390
+ i18nKey: {
391
+ type: 'string',
392
+ maxLength: 100
393
+ },
394
+ icon: {
395
+ type: 'string',
396
+ maxLength: 50
397
+ },
398
+ openMeta: {
399
+ type: 'object',
400
+ additionalProperties: true
401
+ },
402
+ platformId: {
403
+ type: 'string',
404
+ format: 'uuid',
405
+ nullable: true
406
+ },
407
+ platform: {
408
+ '$ref': '#/components/schemas/PlatformInfo'
409
+ },
410
+ createdAt: {
411
+ type: 'string',
412
+ format: 'date-time'
413
+ },
414
+ updatedAt: {
415
+ type: 'string',
416
+ format: 'date-time'
417
+ }
418
+ }
419
+ };
420
+ export const $CreateAccountRequest = {
421
+ type: 'object',
422
+ required: ['path', 'openDate'],
423
+ properties: {
424
+ path: {
425
+ type: 'string',
426
+ pattern: '^(Assets|Liabilities|Income|Expenses|Equity)(:[A-Za-z0-9]+)+$',
427
+ description: 'Full Beancount account path'
428
+ },
429
+ openDate: {
430
+ type: 'string',
431
+ format: 'date'
432
+ },
433
+ currencies: {
434
+ type: 'array',
435
+ items: {
436
+ type: 'string'
437
+ },
438
+ nullable: true
439
+ },
440
+ bookingMethod: {
441
+ '$ref': '#/components/schemas/BookingMethod'
442
+ },
443
+ templatePath: {
444
+ type: 'string'
445
+ },
446
+ isCustom: {
447
+ type: 'boolean',
448
+ default: false
449
+ },
450
+ i18nKey: {
451
+ type: 'string',
452
+ maxLength: 100
453
+ },
454
+ icon: {
455
+ type: 'string',
456
+ maxLength: 50
457
+ },
458
+ openMeta: {
459
+ type: 'object',
460
+ additionalProperties: true
461
+ },
462
+ platformId: {
463
+ type: 'string',
464
+ format: 'uuid'
465
+ }
466
+ }
467
+ };
468
+ export const $UpdateAccountRequest = {
469
+ type: 'object',
470
+ properties: {
471
+ currencies: {
472
+ type: 'array',
473
+ items: {
474
+ type: 'string'
475
+ },
476
+ nullable: true
477
+ },
478
+ bookingMethod: {
479
+ '$ref': '#/components/schemas/BookingMethod'
480
+ },
481
+ i18nKey: {
482
+ type: 'string',
483
+ maxLength: 100
484
+ },
485
+ icon: {
486
+ type: 'string',
487
+ maxLength: 50
488
+ }
489
+ }
490
+ };
491
+ export const $AccountListResponse = {
492
+ type: 'object',
493
+ required: ['items', 'total'],
494
+ properties: {
495
+ items: {
496
+ type: 'array',
497
+ items: {
498
+ '$ref': '#/components/schemas/AccountResponse'
499
+ }
500
+ },
501
+ total: {
502
+ type: 'integer'
503
+ }
504
+ }
505
+ };
506
+ export const $CommodityResponse = {
507
+ type: 'object',
508
+ required: ['id', 'symbol', 'date'],
509
+ properties: {
510
+ id: {
511
+ type: 'string'
512
+ },
513
+ userId: {
514
+ type: 'string',
515
+ nullable: true
516
+ },
517
+ symbol: {
518
+ type: 'string',
519
+ maxLength: 50
520
+ },
521
+ date: {
522
+ type: 'string',
523
+ format: 'date'
524
+ },
525
+ metadata: {
526
+ type: 'object',
527
+ additionalProperties: true
528
+ },
529
+ symbolProfileId: {
530
+ type: 'string',
531
+ format: 'uuid',
532
+ nullable: true
533
+ },
534
+ createdAt: {
535
+ type: 'string',
536
+ format: 'date-time'
537
+ },
538
+ updatedAt: {
539
+ type: 'string',
540
+ format: 'date-time'
541
+ }
542
+ }
543
+ };
544
+ export const $CreateCommodityRequest = {
545
+ type: 'object',
546
+ required: ['symbol', 'date'],
547
+ properties: {
548
+ symbol: {
549
+ type: 'string',
550
+ maxLength: 50,
551
+ pattern: '^[A-Z0-9_\\-\\.]+$'
552
+ },
553
+ date: {
554
+ type: 'string',
555
+ format: 'date'
556
+ },
557
+ metadata: {
558
+ type: 'object',
559
+ additionalProperties: true
560
+ },
561
+ symbolProfileId: {
562
+ type: 'string',
563
+ format: 'uuid'
564
+ }
565
+ }
566
+ };
567
+ export const $UpdateCommodityRequest = {
568
+ type: 'object',
569
+ properties: {
570
+ metadata: {
571
+ type: 'object',
572
+ additionalProperties: true
573
+ },
574
+ symbolProfileId: {
575
+ type: 'string',
576
+ format: 'uuid'
577
+ }
578
+ }
579
+ };
580
+ export const $EnsureCommodityRequest = {
581
+ type: 'object',
582
+ required: ['date'],
583
+ properties: {
584
+ date: {
585
+ type: 'string',
586
+ format: 'date'
587
+ },
588
+ metadata: {
589
+ type: 'object',
590
+ additionalProperties: true
591
+ },
592
+ symbolProfileId: {
593
+ type: 'string',
594
+ format: 'uuid'
595
+ }
596
+ }
597
+ };
598
+ export const $CommodityListResponse = {
599
+ type: 'object',
600
+ required: ['items', 'total'],
601
+ properties: {
602
+ items: {
603
+ type: 'array',
604
+ items: {
605
+ '$ref': '#/components/schemas/CommodityResponse'
606
+ }
607
+ },
608
+ total: {
609
+ type: 'integer'
610
+ }
611
+ }
612
+ };
613
+ export const $PriceResponse = {
614
+ type: 'object',
615
+ required: ['id', 'userId', 'currency', 'quoteCurrency', 'amount', 'date'],
616
+ properties: {
617
+ id: {
618
+ type: 'string'
619
+ },
620
+ userId: {
621
+ type: 'string'
622
+ },
623
+ currency: {
624
+ type: 'string'
625
+ },
626
+ quoteCurrency: {
627
+ type: 'string'
628
+ },
629
+ amount: {
630
+ type: 'number',
631
+ minimum: 0
632
+ },
633
+ date: {
634
+ type: 'string',
635
+ format: 'date'
636
+ },
637
+ meta: {
638
+ type: 'object',
639
+ additionalProperties: true
640
+ },
641
+ createdAt: {
642
+ type: 'string',
643
+ format: 'date-time'
644
+ },
645
+ updatedAt: {
646
+ type: 'string',
647
+ format: 'date-time'
648
+ }
649
+ }
650
+ };
651
+ export const $CreatePriceRequest = {
652
+ type: 'object',
653
+ required: ['currency', 'quoteCurrency', 'amount', 'date'],
654
+ properties: {
655
+ currency: {
656
+ type: 'string',
657
+ description: 'Base currency (e.g., "USD")'
658
+ },
659
+ quoteCurrency: {
660
+ type: 'string',
661
+ description: 'Quote currency (e.g., "CNY")'
662
+ },
663
+ amount: {
664
+ type: 'number',
665
+ minimum: 0,
666
+ description: 'Exchange rate'
667
+ },
668
+ date: {
669
+ type: 'string',
670
+ format: 'date'
671
+ },
672
+ metadata: {
673
+ type: 'object',
674
+ additionalProperties: true
675
+ }
676
+ }
677
+ };
678
+ export const $UpdatePriceRequest = {
679
+ type: 'object',
680
+ properties: {
681
+ amount: {
682
+ type: 'number',
683
+ minimum: 0
684
+ },
685
+ metadata: {
686
+ type: 'object',
687
+ additionalProperties: true
688
+ }
689
+ }
690
+ };
691
+ export const $PriceListResponse = {
692
+ type: 'object',
693
+ required: ['items', 'total'],
694
+ properties: {
695
+ items: {
696
+ type: 'array',
697
+ items: {
698
+ '$ref': '#/components/schemas/PriceResponse'
699
+ }
700
+ },
701
+ total: {
702
+ type: 'integer'
703
+ }
704
+ }
705
+ };
706
+ export const $BalanceResponse = {
707
+ type: 'object',
708
+ required: ['account', 'balance', 'currency', 'date'],
709
+ properties: {
710
+ account: {
711
+ type: 'string'
712
+ },
713
+ balance: {
714
+ type: 'string',
715
+ description: 'Decimal string for precision'
716
+ },
717
+ currency: {
718
+ type: 'string'
719
+ },
720
+ date: {
721
+ type: 'string',
722
+ format: 'date'
723
+ }
724
+ }
725
+ };
726
+ export const $MultiCurrencyBalanceResponse = {
727
+ type: 'object',
728
+ required: ['account', 'balances', 'date'],
729
+ properties: {
730
+ account: {
731
+ type: 'string'
732
+ },
733
+ balances: {
734
+ type: 'object',
735
+ additionalProperties: {
736
+ type: 'string'
737
+ },
738
+ description: 'Map of currency to balance (decimal strings)'
739
+ },
740
+ date: {
741
+ type: 'string',
742
+ format: 'date'
743
+ }
744
+ }
745
+ };
746
+ export const $ApiError = {
747
+ type: 'object',
748
+ required: ['type', 'title', 'status'],
749
+ properties: {
750
+ type: {
751
+ type: 'string',
752
+ description: 'Error type URI'
753
+ },
754
+ title: {
755
+ type: 'string',
756
+ description: 'Short error title'
757
+ },
758
+ status: {
759
+ type: 'integer',
760
+ description: 'HTTP status code'
761
+ },
762
+ detail: {
763
+ type: 'string',
764
+ description: 'Detailed error message'
765
+ },
766
+ instance: {
767
+ type: 'string',
768
+ description: 'Request path'
769
+ }
770
+ }
771
+ };