@firela/api-types 0.0.0-canary.13e64482 → 0.0.0-canary.188a8787

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.
@@ -88,6 +88,47 @@ export const $AccountResponseDto = {
88
88
  enum: ['Assets', 'Liabilities', 'Income', 'Expenses', 'Equity'],
89
89
  example: 'Assets'
90
90
  },
91
+ assetSubClass: {
92
+ type: 'string',
93
+ description:
94
+ 'Account-level asset sub-class (product type, e.g. STOCK/DEPOSIT/CREDIT_CARD/PERSONAL_LOAN). Computed from the account path via the asset-classifier (ADR-0077). Null for non-asset accounts (Income/Expenses/Equity) or unmatched paths.',
95
+ enum: [
96
+ 'DEPOSIT',
97
+ 'CASH',
98
+ 'MONEY_MARKET_FUND',
99
+ 'STOCK',
100
+ 'ETF',
101
+ 'MUTUAL_FUND',
102
+ 'EQUITY_COMPENSATION',
103
+ 'GOVERNMENT_BOND',
104
+ 'CORPORATE_BOND',
105
+ 'BOND_FUND',
106
+ 'PRIMARY_RESIDENCE',
107
+ 'INVESTMENT_PROPERTY',
108
+ 'REIT',
109
+ 'GOLD',
110
+ 'SILVER',
111
+ 'PRECIOUS_METAL',
112
+ 'PRECIOUS_METAL_FUND',
113
+ 'COMMODITY',
114
+ 'COMMODITY_FUND',
115
+ 'CRYPTOCURRENCY',
116
+ 'RETIREMENT_ACCOUNT',
117
+ 'HEALTH_ACCOUNT',
118
+ 'EDUCATION_ACCOUNT',
119
+ 'INSURANCE',
120
+ 'PRIVATE_EQUITY',
121
+ 'HEDGE_FUND',
122
+ 'COLLECTIBLES',
123
+ 'MORTGAGE',
124
+ 'STUDENT_LOAN',
125
+ 'CREDIT_CARD',
126
+ 'PERSONAL_LOAN',
127
+ 'OTHER'
128
+ ],
129
+ nullable: true,
130
+ example: 'STOCK'
131
+ },
91
132
  status: {
92
133
  type: 'string',
93
134
  description: 'Account status',
@@ -3751,202 +3792,649 @@ export const $ForecastResponseDto = {
3751
3792
  ]
3752
3793
  } as const;
3753
3794
 
3754
- export const $CreateTransactionRuleDto = {
3795
+ export const $CurrencyBalanceDto = {
3755
3796
  type: 'object',
3756
3797
  properties: {
3757
- name: {
3798
+ currency: {
3758
3799
  type: 'string',
3759
- minLength: 1,
3760
- maxLength: 100
3800
+ description: 'ISO 4217 currency code',
3801
+ example: 'CNY'
3761
3802
  },
3762
- description: {
3803
+ balance: {
3763
3804
  type: 'string',
3764
- maxLength: 500
3765
- },
3766
- narrationKeywords: {
3767
- items: {
3768
- type: 'array'
3769
- },
3770
- maxItems: 50,
3771
- type: 'array'
3772
- },
3773
- payeeKeywords: {
3774
- items: {
3775
- type: 'array'
3776
- },
3777
- maxItems: 50,
3778
- type: 'array'
3779
- },
3780
- categoryKeywords: {
3781
- items: {
3782
- type: 'array'
3783
- },
3784
- maxItems: 50,
3785
- type: 'array'
3786
- },
3787
- methodKeywords: {
3788
- items: {
3789
- type: 'array'
3790
- },
3791
- maxItems: 50,
3792
- description: 'Payment method keywords (e.g., HuaBei, YuEBao)',
3793
- type: 'array'
3794
- },
3795
- categoryAccount: {
3805
+ description: 'Balance amount',
3806
+ example: '500000.00'
3807
+ }
3808
+ },
3809
+ required: ['currency', 'balance']
3810
+ } as const;
3811
+
3812
+ export const $TimeSeriesPointDto = {
3813
+ type: 'object',
3814
+ properties: {
3815
+ date: {
3796
3816
  type: 'string',
3797
- maxLength: 200,
3798
- description:
3799
- 'Destination account for expenses/income (e.g., Expenses:Food:Coffee)'
3817
+ description: 'Date in YYYY-MM-DD format',
3818
+ example: '2024-06-15'
3800
3819
  },
3801
- matchLogic: {
3820
+ value: {
3802
3821
  type: 'string',
3803
- enum: ['OR', 'AND'],
3804
- default: 'OR'
3822
+ description: 'Value at this date (in base currency)',
3823
+ example: '500000.00'
3805
3824
  },
3806
- amountMin: {
3807
- type: 'number',
3808
- minimum: 0,
3809
- description: 'Minimum transaction amount (inclusive)'
3825
+ change: {
3826
+ type: 'object',
3827
+ description: 'Change from previous point',
3828
+ example: '5000.00'
3810
3829
  },
3811
- amountMax: {
3812
- type: 'number',
3813
- minimum: 0,
3814
- description: 'Maximum transaction amount (inclusive)'
3830
+ assets: {
3831
+ type: 'string',
3832
+ description: 'Total assets at this date (in base currency)',
3833
+ example: '494338.00'
3815
3834
  },
3816
- priority: {
3817
- type: 'number',
3818
- default: 50,
3819
- minimum: 0,
3820
- maximum: 1000
3835
+ liabilities: {
3836
+ type: 'string',
3837
+ description: 'Total liabilities at this date (in base currency)',
3838
+ example: '310098.00'
3821
3839
  },
3822
- additionalTags: {
3840
+ byCurrency: {
3841
+ description: 'Multi-currency breakdown for this point',
3842
+ type: 'array',
3823
3843
  items: {
3824
- type: 'array'
3825
- },
3826
- maxItems: 20,
3827
- type: 'array'
3828
- },
3829
- additionalMetadata: {
3830
- type: 'object'
3831
- },
3832
- upsertByPayee: {
3833
- type: 'boolean',
3834
- description:
3835
- 'If true, update existing rule with matching payeeKeywords[0] instead of creating new rule'
3844
+ $ref: '#/components/schemas/CurrencyBalanceDto'
3845
+ }
3836
3846
  }
3837
3847
  },
3838
- required: ['name', 'matchLogic', 'priority']
3848
+ required: ['date', 'value']
3839
3849
  } as const;
3840
3850
 
3841
- export const $AmountRangeDto = {
3851
+ export const $TrendSummaryDto = {
3842
3852
  type: 'object',
3843
3853
  properties: {
3844
- min: {
3845
- type: 'number',
3846
- description: 'Minimum amount'
3854
+ startValue: {
3855
+ type: 'string',
3856
+ description: 'Value at start of period',
3857
+ example: '450000.00'
3847
3858
  },
3848
- max: {
3849
- type: 'number',
3850
- description: 'Maximum amount'
3859
+ endValue: {
3860
+ type: 'string',
3861
+ description: 'Value at end of period',
3862
+ example: '500000.00'
3863
+ },
3864
+ totalChange: {
3865
+ type: 'string',
3866
+ description: 'Total change over period',
3867
+ example: '50000.00'
3868
+ },
3869
+ totalChangePercentage: {
3870
+ type: 'string',
3871
+ description: 'Total change percentage',
3872
+ example: '+11.11%'
3851
3873
  }
3852
- }
3874
+ },
3875
+ required: ['startValue', 'endValue', 'totalChange', 'totalChangePercentage']
3853
3876
  } as const;
3854
3877
 
3855
- export const $TransactionRuleResponseDto = {
3878
+ export const $MultiCurrencyPointDto = {
3856
3879
  type: 'object',
3857
3880
  properties: {
3858
- id: {
3859
- type: 'string',
3860
- description: 'Rule ID'
3861
- },
3862
- name: {
3863
- type: 'string',
3864
- description: 'Rule name'
3865
- },
3866
- description: {
3881
+ date: {
3867
3882
  type: 'string',
3868
- description: 'Rule description'
3869
- },
3870
- narrationKeywords: {
3871
- description: 'Keywords to match in transaction narration',
3872
- type: 'array',
3873
- items: {
3874
- type: 'string'
3875
- }
3876
- },
3877
- payeeKeywords: {
3878
- description: 'Keywords to match in payee name',
3879
- type: 'array',
3880
- items: {
3881
- type: 'string'
3882
- }
3883
+ description: 'Date in YYYY-MM-DD format',
3884
+ example: '2024-06-15'
3883
3885
  },
3884
- categoryKeywords: {
3885
- description: 'Keywords to match in category',
3886
+ byCurrency: {
3887
+ description: 'Balances by currency',
3886
3888
  type: 'array',
3887
3889
  items: {
3888
- type: 'string'
3890
+ $ref: '#/components/schemas/CurrencyBalanceDto'
3889
3891
  }
3890
- },
3891
- methodKeywords: {
3892
- description: 'Keywords to match in payment method',
3892
+ }
3893
+ },
3894
+ required: ['date', 'byCurrency']
3895
+ } as const;
3896
+
3897
+ export const $PortfolioTrendsResponseDto = {
3898
+ type: 'object',
3899
+ properties: {
3900
+ series: {
3901
+ description: 'Time series data points',
3893
3902
  type: 'array',
3894
3903
  items: {
3895
- type: 'string'
3904
+ $ref: '#/components/schemas/TimeSeriesPointDto'
3896
3905
  }
3897
3906
  },
3898
- categoryAccount: {
3899
- type: 'string',
3900
- description: 'Destination account for categorization'
3901
- },
3902
- matchLogic: {
3903
- type: 'string',
3904
- description: 'Keyword matching logic',
3905
- enum: ['OR', 'AND'],
3906
- example: 'OR'
3907
- },
3908
- amountRange: {
3909
- description: 'Amount range for matching',
3907
+ summary: {
3908
+ description: 'Period summary',
3910
3909
  allOf: [
3911
3910
  {
3912
- $ref: '#/components/schemas/AmountRangeDto'
3911
+ $ref: '#/components/schemas/TrendSummaryDto'
3913
3912
  }
3914
3913
  ]
3915
3914
  },
3916
- priority: {
3917
- type: 'number',
3918
- description: 'Rule priority (0-1000, higher = first match)',
3919
- example: 50
3920
- },
3921
- enabled: {
3922
- type: 'boolean',
3923
- description: 'Whether the rule is enabled'
3924
- },
3925
- learningSource: {
3915
+ period: {
3926
3916
  type: 'string',
3927
- description: 'Learning source: NLP, REVIEW_CENTER, or null for manual',
3928
- enum: ['NLP', 'REVIEW_CENTER'],
3929
- nullable: true,
3930
- example: 'REVIEW_CENTER'
3917
+ description: 'Period requested',
3918
+ example: '6m'
3931
3919
  },
3932
- autoApplyEnabled: {
3933
- type: 'boolean',
3934
- description: 'Whether auto-apply is enabled for this rule'
3920
+ granularity: {
3921
+ type: 'string',
3922
+ description: 'Data granularity',
3923
+ example: 'month'
3935
3924
  },
3936
- confirmationCount: {
3937
- type: 'number',
3938
- description: 'Number of confirmations for NLP-learned rules',
3939
- example: 3
3925
+ currency: {
3926
+ type: 'string',
3927
+ description: 'Base currency for converted values',
3928
+ example: 'CNY'
3940
3929
  },
3941
- additionalTags: {
3942
- description: 'Additional tags',
3930
+ byCurrency: {
3931
+ description:
3932
+ 'Multi-currency time series (each point has currency breakdown)',
3943
3933
  type: 'array',
3944
3934
  items: {
3945
- type: 'string'
3935
+ $ref: '#/components/schemas/MultiCurrencyPointDto'
3946
3936
  }
3947
3937
  },
3948
- additionalMetadata: {
3949
- type: 'object',
3938
+ warnings: {
3939
+ description: 'Exchange rate warnings',
3940
+ type: 'array',
3941
+ items: {
3942
+ $ref: '#/components/schemas/ExchangeRateWarningDto'
3943
+ }
3944
+ }
3945
+ },
3946
+ required: ['series', 'summary', 'period', 'granularity', 'currency']
3947
+ } as const;
3948
+
3949
+ export const $CashFlowPointDto = {
3950
+ type: 'object',
3951
+ properties: {
3952
+ month: {
3953
+ type: 'string',
3954
+ description: 'Month key (YYYY-MM)',
3955
+ example: '2024-03'
3956
+ },
3957
+ income: {
3958
+ type: 'string',
3959
+ description: 'Income in base currency (absolute, converted)',
3960
+ example: '10000.00'
3961
+ },
3962
+ expense: {
3963
+ type: 'string',
3964
+ description: 'Expense in base currency (absolute, converted)',
3965
+ example: '5000.00'
3966
+ },
3967
+ netSavings: {
3968
+ type: 'string',
3969
+ description: 'netSavings = income − expense (savings positive)',
3970
+ example: '5000.00'
3971
+ }
3972
+ },
3973
+ required: ['month', 'income', 'expense', 'netSavings']
3974
+ } as const;
3975
+
3976
+ export const $CashFlowTrendSummaryDto = {
3977
+ type: 'object',
3978
+ properties: {
3979
+ totalIncome: {
3980
+ type: 'string',
3981
+ description: 'Total income across the period',
3982
+ example: '60000.00'
3983
+ },
3984
+ totalExpense: {
3985
+ type: 'string',
3986
+ description: 'Total expense across the period',
3987
+ example: '30000.00'
3988
+ },
3989
+ totalNetSavings: {
3990
+ type: 'string',
3991
+ description: 'income − expense across the period',
3992
+ example: '30000.00'
3993
+ },
3994
+ averageMonthlyNetSavings: {
3995
+ type: 'string',
3996
+ description:
3997
+ 'totalNetSavings divided by the window length (N months, incl. zero-filled)',
3998
+ example: '5000.00'
3999
+ }
4000
+ },
4001
+ required: [
4002
+ 'totalIncome',
4003
+ 'totalExpense',
4004
+ 'totalNetSavings',
4005
+ 'averageMonthlyNetSavings'
4006
+ ]
4007
+ } as const;
4008
+
4009
+ export const $CashFlowTrendsResponseDto = {
4010
+ type: 'object',
4011
+ properties: {
4012
+ series: {
4013
+ description:
4014
+ 'Monthly cash-flow series (fixed N-month window, zero-filled)',
4015
+ type: 'array',
4016
+ items: {
4017
+ $ref: '#/components/schemas/CashFlowPointDto'
4018
+ }
4019
+ },
4020
+ summary: {
4021
+ description: 'Period totals',
4022
+ allOf: [
4023
+ {
4024
+ $ref: '#/components/schemas/CashFlowTrendSummaryDto'
4025
+ }
4026
+ ]
4027
+ },
4028
+ period: {
4029
+ type: 'string',
4030
+ description: 'Period requested',
4031
+ example: '6m'
4032
+ },
4033
+ granularity: {
4034
+ type: 'string',
4035
+ description: 'Data granularity (v1 returns month buckets)',
4036
+ example: 'month'
4037
+ },
4038
+ currency: {
4039
+ type: 'string',
4040
+ description: 'Base currency for converted values',
4041
+ example: 'CNY'
4042
+ },
4043
+ warnings: {
4044
+ description: 'Exchange rate warnings (e.g. missing rate for a currency)',
4045
+ type: 'array',
4046
+ items: {
4047
+ $ref: '#/components/schemas/ExchangeRateWarningDto'
4048
+ }
4049
+ }
4050
+ },
4051
+ required: ['series', 'summary', 'period', 'granularity', 'currency']
4052
+ } as const;
4053
+
4054
+ export const $GenerateSnapshotBody = {
4055
+ type: 'object',
4056
+ properties: {}
4057
+ } as const;
4058
+
4059
+ export const $GenerateSnapshotResponse = {
4060
+ type: 'object',
4061
+ properties: {}
4062
+ } as const;
4063
+
4064
+ export const $BackfillSnapshotsBody = {
4065
+ type: 'object',
4066
+ properties: {}
4067
+ } as const;
4068
+
4069
+ export const $BackfillSnapshotsResponse = {
4070
+ type: 'object',
4071
+ properties: {}
4072
+ } as const;
4073
+
4074
+ export const $DeleteOwnUserDto = {
4075
+ type: 'object',
4076
+ properties: {
4077
+ accessToken: {
4078
+ type: 'string',
4079
+ description: 'Access token for user verification',
4080
+ example: 'abc123xyz'
4081
+ }
4082
+ },
4083
+ required: ['accessToken']
4084
+ } as const;
4085
+
4086
+ export const $SignupDto = {
4087
+ type: 'object',
4088
+ properties: {
4089
+ turnstileToken: {
4090
+ type: 'string',
4091
+ description:
4092
+ 'Cloudflare Turnstile verification token (optional when Turnstile disabled)',
4093
+ example: '0.abc123def456...'
4094
+ }
4095
+ }
4096
+ } as const;
4097
+
4098
+ export const $SignupResponseDto = {
4099
+ type: 'object',
4100
+ properties: {
4101
+ authToken: {
4102
+ type: 'string',
4103
+ description: 'JWT auth token',
4104
+ example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
4105
+ },
4106
+ accessToken: {
4107
+ type: 'string',
4108
+ description: 'Auto-generated access token'
4109
+ },
4110
+ role: {
4111
+ type: 'string',
4112
+ description: 'Assigned user role',
4113
+ enum: ['USER', 'ADMIN', 'DEMO', 'INACTIVE', 'PAID', 'OPS']
4114
+ }
4115
+ },
4116
+ required: ['authToken', 'accessToken', 'role']
4117
+ } as const;
4118
+
4119
+ export const $UpdateUserSettingDto = {
4120
+ type: 'object',
4121
+ properties: {
4122
+ secId: {
4123
+ type: 'number',
4124
+ description: 'Security ID'
4125
+ },
4126
+ annualInterestRate: {
4127
+ type: 'number',
4128
+ description: 'Annual interest rate',
4129
+ example: 0.05
4130
+ },
4131
+ currency: {
4132
+ type: 'string',
4133
+ description: 'Currency code',
4134
+ example: 'USD'
4135
+ },
4136
+ baseCurrency: {
4137
+ type: 'string',
4138
+ description: 'Base currency code',
4139
+ example: 'USD'
4140
+ },
4141
+ benchmark: {
4142
+ type: 'string',
4143
+ description: 'Benchmark symbol',
4144
+ example: 'SPY'
4145
+ },
4146
+ colorScheme: {
4147
+ type: 'string',
4148
+ description: 'Color scheme',
4149
+ enum: ['DARK', 'LIGHT']
4150
+ },
4151
+ dateRange: {
4152
+ type: 'string',
4153
+ description: 'Date range filter',
4154
+ example: '1y'
4155
+ },
4156
+ emergencyFund: {
4157
+ type: 'number',
4158
+ description: 'Emergency fund amount',
4159
+ example: 10000
4160
+ },
4161
+ 'filters.accounts': {
4162
+ description: 'Account filter IDs',
4163
+ type: 'array',
4164
+ items: {
4165
+ type: 'string'
4166
+ }
4167
+ },
4168
+ 'filters.assetClasses': {
4169
+ description: 'Asset class filters',
4170
+ type: 'array',
4171
+ items: {
4172
+ type: 'string'
4173
+ }
4174
+ },
4175
+ 'filters.dataSource': {
4176
+ type: 'string',
4177
+ description: 'Data source filter'
4178
+ },
4179
+ 'filters.symbol': {
4180
+ type: 'string',
4181
+ description: 'Symbol filter'
4182
+ },
4183
+ 'filters.tags': {
4184
+ description: 'Tag filters',
4185
+ type: 'array',
4186
+ items: {
4187
+ type: 'string'
4188
+ }
4189
+ },
4190
+ isExperimentalFeatures: {
4191
+ type: 'boolean',
4192
+ description: 'Enable experimental features'
4193
+ },
4194
+ isRestrictedView: {
4195
+ type: 'boolean',
4196
+ description: 'Enable restricted view mode'
4197
+ },
4198
+ language: {
4199
+ type: 'string',
4200
+ description: 'Language code',
4201
+ example: 'en'
4202
+ },
4203
+ locale: {
4204
+ type: 'string',
4205
+ description: 'Locale code',
4206
+ example: 'en-US'
4207
+ },
4208
+ projectedTotalAmount: {
4209
+ type: 'number',
4210
+ description: 'Projected total amount',
4211
+ example: 1000000
4212
+ },
4213
+ retirementDate: {
4214
+ type: 'string',
4215
+ description: 'Retirement date in ISO 8601 format',
4216
+ example: '2050-01-01'
4217
+ },
4218
+ savingsRate: {
4219
+ type: 'number',
4220
+ description: 'Savings rate percentage',
4221
+ example: 0.2
4222
+ },
4223
+ viewMode: {
4224
+ type: 'string',
4225
+ description: 'View mode',
4226
+ enum: ['DEFAULT', 'ZEN']
4227
+ }
4228
+ }
4229
+ } as const;
4230
+
4231
+ export const $UpdatePropertyDto = {
4232
+ type: 'object',
4233
+ properties: {
4234
+ value: {
4235
+ type: 'string',
4236
+ description: 'Property value'
4237
+ }
4238
+ },
4239
+ required: ['value']
4240
+ } as const;
4241
+
4242
+ export const $CreateTransactionRuleDto = {
4243
+ type: 'object',
4244
+ properties: {
4245
+ name: {
4246
+ type: 'string',
4247
+ minLength: 1,
4248
+ maxLength: 100
4249
+ },
4250
+ description: {
4251
+ type: 'string',
4252
+ maxLength: 500
4253
+ },
4254
+ narrationKeywords: {
4255
+ items: {
4256
+ type: 'array'
4257
+ },
4258
+ maxItems: 50,
4259
+ type: 'array'
4260
+ },
4261
+ payeeKeywords: {
4262
+ items: {
4263
+ type: 'array'
4264
+ },
4265
+ maxItems: 50,
4266
+ type: 'array'
4267
+ },
4268
+ categoryKeywords: {
4269
+ items: {
4270
+ type: 'array'
4271
+ },
4272
+ maxItems: 50,
4273
+ type: 'array'
4274
+ },
4275
+ methodKeywords: {
4276
+ items: {
4277
+ type: 'array'
4278
+ },
4279
+ maxItems: 50,
4280
+ description: 'Payment method keywords (e.g., HuaBei, YuEBao)',
4281
+ type: 'array'
4282
+ },
4283
+ categoryAccount: {
4284
+ type: 'string',
4285
+ maxLength: 200,
4286
+ description:
4287
+ 'Destination account for expenses/income (e.g., Expenses:Food:Coffee)'
4288
+ },
4289
+ matchLogic: {
4290
+ type: 'string',
4291
+ enum: ['OR', 'AND'],
4292
+ default: 'OR'
4293
+ },
4294
+ amountMin: {
4295
+ type: 'number',
4296
+ minimum: 0,
4297
+ description: 'Minimum transaction amount (inclusive)'
4298
+ },
4299
+ amountMax: {
4300
+ type: 'number',
4301
+ minimum: 0,
4302
+ description: 'Maximum transaction amount (inclusive)'
4303
+ },
4304
+ priority: {
4305
+ type: 'number',
4306
+ default: 50,
4307
+ minimum: 0,
4308
+ maximum: 1000
4309
+ },
4310
+ additionalTags: {
4311
+ items: {
4312
+ type: 'array'
4313
+ },
4314
+ maxItems: 20,
4315
+ type: 'array'
4316
+ },
4317
+ additionalMetadata: {
4318
+ type: 'object'
4319
+ },
4320
+ upsertByPayee: {
4321
+ type: 'boolean',
4322
+ description:
4323
+ 'If true, update existing rule with matching payeeKeywords[0] instead of creating new rule'
4324
+ }
4325
+ },
4326
+ required: ['name', 'matchLogic', 'priority']
4327
+ } as const;
4328
+
4329
+ export const $AmountRangeDto = {
4330
+ type: 'object',
4331
+ properties: {
4332
+ min: {
4333
+ type: 'number',
4334
+ description: 'Minimum amount'
4335
+ },
4336
+ max: {
4337
+ type: 'number',
4338
+ description: 'Maximum amount'
4339
+ }
4340
+ }
4341
+ } as const;
4342
+
4343
+ export const $TransactionRuleResponseDto = {
4344
+ type: 'object',
4345
+ properties: {
4346
+ id: {
4347
+ type: 'string',
4348
+ description: 'Rule ID'
4349
+ },
4350
+ name: {
4351
+ type: 'string',
4352
+ description: 'Rule name'
4353
+ },
4354
+ description: {
4355
+ type: 'string',
4356
+ description: 'Rule description'
4357
+ },
4358
+ narrationKeywords: {
4359
+ description: 'Keywords to match in transaction narration',
4360
+ type: 'array',
4361
+ items: {
4362
+ type: 'string'
4363
+ }
4364
+ },
4365
+ payeeKeywords: {
4366
+ description: 'Keywords to match in payee name',
4367
+ type: 'array',
4368
+ items: {
4369
+ type: 'string'
4370
+ }
4371
+ },
4372
+ categoryKeywords: {
4373
+ description: 'Keywords to match in category',
4374
+ type: 'array',
4375
+ items: {
4376
+ type: 'string'
4377
+ }
4378
+ },
4379
+ methodKeywords: {
4380
+ description: 'Keywords to match in payment method',
4381
+ type: 'array',
4382
+ items: {
4383
+ type: 'string'
4384
+ }
4385
+ },
4386
+ categoryAccount: {
4387
+ type: 'string',
4388
+ description: 'Destination account for categorization'
4389
+ },
4390
+ matchLogic: {
4391
+ type: 'string',
4392
+ description: 'Keyword matching logic',
4393
+ enum: ['OR', 'AND'],
4394
+ example: 'OR'
4395
+ },
4396
+ amountRange: {
4397
+ description: 'Amount range for matching',
4398
+ allOf: [
4399
+ {
4400
+ $ref: '#/components/schemas/AmountRangeDto'
4401
+ }
4402
+ ]
4403
+ },
4404
+ priority: {
4405
+ type: 'number',
4406
+ description: 'Rule priority (0-1000, higher = first match)',
4407
+ example: 50
4408
+ },
4409
+ enabled: {
4410
+ type: 'boolean',
4411
+ description: 'Whether the rule is enabled'
4412
+ },
4413
+ learningSource: {
4414
+ type: 'string',
4415
+ description: 'Learning source: NLP, REVIEW_CENTER, or null for manual',
4416
+ enum: ['NLP', 'REVIEW_CENTER'],
4417
+ nullable: true,
4418
+ example: 'REVIEW_CENTER'
4419
+ },
4420
+ autoApplyEnabled: {
4421
+ type: 'boolean',
4422
+ description: 'Whether auto-apply is enabled for this rule'
4423
+ },
4424
+ confirmationCount: {
4425
+ type: 'number',
4426
+ description: 'Number of confirmations for NLP-learned rules',
4427
+ example: 3
4428
+ },
4429
+ additionalTags: {
4430
+ description: 'Additional tags',
4431
+ type: 'array',
4432
+ items: {
4433
+ type: 'string'
4434
+ }
4435
+ },
4436
+ additionalMetadata: {
4437
+ type: 'object',
3950
4438
  description: 'Additional metadata',
3951
4439
  additionalProperties: {
3952
4440
  type: 'string'
@@ -4320,231 +4808,84 @@ export const $UpdateTransactionRuleDto = {
4320
4808
  amountMax: {
4321
4809
  type: 'number',
4322
4810
  minimum: 0,
4323
- description: 'Maximum transaction amount (inclusive)'
4324
- },
4325
- priority: {
4326
- type: 'number',
4327
- minimum: 0,
4328
- maximum: 1000
4329
- },
4330
- enabled: {
4331
- type: 'boolean',
4332
- description: 'Enable or disable the rule'
4333
- },
4334
- additionalTags: {
4335
- items: {
4336
- type: 'array'
4337
- },
4338
- maxItems: 20,
4339
- type: 'array'
4340
- },
4341
- additionalMetadata: {
4342
- type: 'object'
4343
- }
4344
- }
4345
- } as const;
4346
-
4347
- export const $TestRuleDto = {
4348
- type: 'object',
4349
- properties: {
4350
- narration: {
4351
- type: 'string',
4352
- minLength: 1,
4353
- maxLength: 500
4354
- },
4355
- payee: {
4356
- type: 'string',
4357
- maxLength: 200
4358
- },
4359
- categoryAccount: {
4360
- type: 'string',
4361
- maxLength: 200
4362
- },
4363
- amount: {
4364
- type: 'number'
4365
- },
4366
- currency: {
4367
- type: 'string',
4368
- maxLength: 10
4369
- }
4370
- },
4371
- required: ['narration']
4372
- } as const;
4373
-
4374
- export const $TestRuleResponseDto = {
4375
- type: 'object',
4376
- properties: {
4377
- ruleId: {
4378
- type: 'string',
4379
- description: 'Rule ID that was tested'
4380
- },
4381
- matches: {
4382
- type: 'boolean',
4383
- description: 'Whether the rule matched the test data'
4384
- },
4385
- confidence: {
4386
- type: 'number',
4387
- description: 'Match confidence score (0-1)',
4388
- example: 0.85
4389
- },
4390
- matchDetails: {
4391
- type: 'object',
4392
- description: 'Details of which fields matched',
4393
- example: {
4394
- narration: true,
4395
- payee: false,
4396
- categoryAccount: false
4397
- }
4398
- }
4399
- },
4400
- required: ['ruleId', 'matches', 'confidence', 'matchDetails']
4401
- } as const;
4402
-
4403
- export const $DeleteOwnUserDto = {
4404
- type: 'object',
4405
- properties: {
4406
- accessToken: {
4407
- type: 'string',
4408
- description: 'Access token for user verification',
4409
- example: 'abc123xyz'
4410
- }
4411
- },
4412
- required: ['accessToken']
4413
- } as const;
4414
-
4415
- export const $SignupDto = {
4416
- type: 'object',
4417
- properties: {
4418
- turnstileToken: {
4419
- type: 'string',
4420
- description:
4421
- 'Cloudflare Turnstile verification token (optional when Turnstile disabled)',
4422
- example: '0.abc123def456...'
4423
- }
4424
- }
4425
- } as const;
4426
-
4427
- export const $UpdateUserSettingDto = {
4428
- type: 'object',
4429
- properties: {
4430
- secId: {
4431
- type: 'number',
4432
- description: 'Security ID'
4433
- },
4434
- annualInterestRate: {
4435
- type: 'number',
4436
- description: 'Annual interest rate',
4437
- example: 0.05
4438
- },
4439
- currency: {
4440
- type: 'string',
4441
- description: 'Currency code',
4442
- example: 'USD'
4443
- },
4444
- baseCurrency: {
4445
- type: 'string',
4446
- description: 'Base currency code',
4447
- example: 'USD'
4448
- },
4449
- benchmark: {
4450
- type: 'string',
4451
- description: 'Benchmark symbol',
4452
- example: 'SPY'
4453
- },
4454
- colorScheme: {
4455
- type: 'string',
4456
- description: 'Color scheme',
4457
- enum: ['DARK', 'LIGHT']
4458
- },
4459
- dateRange: {
4460
- type: 'string',
4461
- description: 'Date range filter',
4462
- example: '1y'
4463
- },
4464
- emergencyFund: {
4465
- type: 'number',
4466
- description: 'Emergency fund amount',
4467
- example: 10000
4468
- },
4469
- 'filters.accounts': {
4470
- description: 'Account filter IDs',
4471
- type: 'array',
4472
- items: {
4473
- type: 'string'
4474
- }
4475
- },
4476
- 'filters.assetClasses': {
4477
- description: 'Asset class filters',
4478
- type: 'array',
4479
- items: {
4480
- type: 'string'
4481
- }
4482
- },
4483
- 'filters.dataSource': {
4484
- type: 'string',
4485
- description: 'Data source filter'
4486
- },
4487
- 'filters.symbol': {
4488
- type: 'string',
4489
- description: 'Symbol filter'
4811
+ description: 'Maximum transaction amount (inclusive)'
4490
4812
  },
4491
- 'filters.tags': {
4492
- description: 'Tag filters',
4493
- type: 'array',
4494
- items: {
4495
- type: 'string'
4496
- }
4813
+ priority: {
4814
+ type: 'number',
4815
+ minimum: 0,
4816
+ maximum: 1000
4497
4817
  },
4498
- isExperimentalFeatures: {
4818
+ enabled: {
4499
4819
  type: 'boolean',
4500
- description: 'Enable experimental features'
4820
+ description: 'Enable or disable the rule'
4501
4821
  },
4502
- isRestrictedView: {
4503
- type: 'boolean',
4504
- description: 'Enable restricted view mode'
4822
+ additionalTags: {
4823
+ items: {
4824
+ type: 'array'
4825
+ },
4826
+ maxItems: 20,
4827
+ type: 'array'
4505
4828
  },
4506
- language: {
4829
+ additionalMetadata: {
4830
+ type: 'object'
4831
+ }
4832
+ }
4833
+ } as const;
4834
+
4835
+ export const $TestRuleDto = {
4836
+ type: 'object',
4837
+ properties: {
4838
+ narration: {
4507
4839
  type: 'string',
4508
- description: 'Language code',
4509
- example: 'en'
4840
+ minLength: 1,
4841
+ maxLength: 500
4510
4842
  },
4511
- locale: {
4843
+ payee: {
4512
4844
  type: 'string',
4513
- description: 'Locale code',
4514
- example: 'en-US'
4515
- },
4516
- projectedTotalAmount: {
4517
- type: 'number',
4518
- description: 'Projected total amount',
4519
- example: 1000000
4845
+ maxLength: 200
4520
4846
  },
4521
- retirementDate: {
4847
+ categoryAccount: {
4522
4848
  type: 'string',
4523
- description: 'Retirement date in ISO 8601 format',
4524
- example: '2050-01-01'
4849
+ maxLength: 200
4525
4850
  },
4526
- savingsRate: {
4527
- type: 'number',
4528
- description: 'Savings rate percentage',
4529
- example: 0.2
4851
+ amount: {
4852
+ type: 'number'
4530
4853
  },
4531
- viewMode: {
4854
+ currency: {
4532
4855
  type: 'string',
4533
- description: 'View mode',
4534
- enum: ['DEFAULT', 'ZEN']
4856
+ maxLength: 10
4535
4857
  }
4536
- }
4858
+ },
4859
+ required: ['narration']
4537
4860
  } as const;
4538
4861
 
4539
- export const $UpdatePropertyDto = {
4862
+ export const $TestRuleResponseDto = {
4540
4863
  type: 'object',
4541
4864
  properties: {
4542
- value: {
4865
+ ruleId: {
4543
4866
  type: 'string',
4544
- description: 'Property value'
4867
+ description: 'Rule ID that was tested'
4868
+ },
4869
+ matches: {
4870
+ type: 'boolean',
4871
+ description: 'Whether the rule matched the test data'
4872
+ },
4873
+ confidence: {
4874
+ type: 'number',
4875
+ description: 'Match confidence score (0-1)',
4876
+ example: 0.85
4877
+ },
4878
+ matchDetails: {
4879
+ type: 'object',
4880
+ description: 'Details of which fields matched',
4881
+ example: {
4882
+ narration: true,
4883
+ payee: false,
4884
+ categoryAccount: false
4885
+ }
4545
4886
  }
4546
4887
  },
4547
- required: ['value']
4888
+ required: ['ruleId', 'matches', 'confidence', 'matchDetails']
4548
4889
  } as const;
4549
4890
 
4550
4891
  export const $CreateBeanEventDto = {
@@ -5625,6 +5966,18 @@ export const $ProcessNlpDto = {
5625
5966
  currency: 'CNY',
5626
5967
  payee: 'Starbucks'
5627
5968
  }
5969
+ },
5970
+ selectedRuleId: {
5971
+ type: 'string',
5972
+ description:
5973
+ 'confirm_rule echo-back: rule id selected from the prior confirm_rule response (matchedRule.id or alternatives[i].ruleId). Applied directly when the session is confirming_rule — no NL re-parse.',
5974
+ example: 'rule_abc123'
5975
+ },
5976
+ selectedAccount: {
5977
+ type: 'string',
5978
+ description:
5979
+ 'confirm_account echo-back: account path selected from the prior confirm_account response (suggestedAccount, similarAccounts[i], or a typed path). Applied directly when the session is confirming_account — no NL re-parse.',
5980
+ example: 'Expenses:Food:Coffee'
5628
5981
  }
5629
5982
  },
5630
5983
  required: ['message']
@@ -5949,7 +6302,8 @@ export const $NlpAccountConfirmationDataDto = {
5949
6302
  },
5950
6303
  suggestedAccount: {
5951
6304
  type: 'string',
5952
- description: 'Suggested replacement account',
6305
+ description:
6306
+ 'Suggested replacement account (omitted when no clear candidate)',
5953
6307
  example: 'Expenses:Food:Drinks'
5954
6308
  },
5955
6309
  similarAccounts: {
@@ -5971,7 +6325,6 @@ export const $NlpAccountConfirmationDataDto = {
5971
6325
  },
5972
6326
  required: [
5973
6327
  'invalidAccount',
5974
- 'suggestedAccount',
5975
6328
  'similarAccounts',
5976
6329
  'errorMessage',
5977
6330
  'transactionContext'
@@ -6144,7 +6497,8 @@ export const $NlpSuggestedAccountDto = {
6144
6497
  },
6145
6498
  confidence: {
6146
6499
  type: 'number',
6147
- description: 'Confidence score for this suggestion (0-1)',
6500
+ description:
6501
+ 'Confidence score for this suggestion (0-1). Present = predicted (confirm/confirm_rule/confirm_account); omitted = actual persisted account (created). (#586)',
6148
6502
  example: 0.9
6149
6503
  }
6150
6504
  },
@@ -6180,23 +6534,31 @@ export const $NlpDefaultAccountsDto = {
6180
6534
  properties: {
6181
6535
  asset: {
6182
6536
  type: 'string',
6183
- description: 'Default asset account',
6184
- example: 'Assets:Checking'
6537
+ description:
6538
+ 'Default OPEN asset account (MRU when multiple), or null when none/ambiguous',
6539
+ example: 'Assets:Checking',
6540
+ nullable: true
6185
6541
  },
6186
6542
  expense: {
6187
6543
  type: 'string',
6188
- description: 'Default expense account',
6189
- example: 'Expenses:Uncategorized'
6544
+ description:
6545
+ 'Default OPEN expense account (MRU when multiple), or null when none/ambiguous',
6546
+ example: 'Expenses:Food:Coffee',
6547
+ nullable: true
6190
6548
  },
6191
6549
  income: {
6192
6550
  type: 'string',
6193
- description: 'Default income account',
6194
- example: 'Income:Uncategorized'
6551
+ description:
6552
+ 'Default OPEN income account (MRU when multiple), or null when none/ambiguous',
6553
+ example: 'Income:Salary',
6554
+ nullable: true
6195
6555
  },
6196
6556
  liability: {
6197
6557
  type: 'string',
6198
- description: 'Default liability account',
6199
- example: 'Liabilities:CreditCard'
6558
+ description:
6559
+ 'Default OPEN liability account (MRU when multiple), or null when none/ambiguous',
6560
+ example: 'Liabilities:CreditCard',
6561
+ nullable: true
6200
6562
  }
6201
6563
  },
6202
6564
  required: ['asset', 'expense', 'income', 'liability']
@@ -6221,7 +6583,8 @@ export const $NlpResponseDto = {
6221
6583
  'confirm_rule',
6222
6584
  'confirm_account',
6223
6585
  'confirm_payee',
6224
- 'cancel'
6586
+ 'cancel',
6587
+ 'aborted'
6225
6588
  ]
6226
6589
  },
6227
6590
  intent: {
@@ -6383,7 +6746,7 @@ export const $NlpResponseDto = {
6383
6746
  },
6384
6747
  suggestedAccounts: {
6385
6748
  description:
6386
- 'Suggested accounts for this transaction. Contains recommended source and destination accounts based on the detected intent and rules.',
6749
+ 'Suggested accounts for this transaction (#586). confirm/confirm_rule/confirm_account: predicted (source/destination carry confidence); created: actual persisted accounts (confidence omitted). confirm_account destination is the suggested replacement, never the invalid account.',
6387
6750
  allOf: [
6388
6751
  {
6389
6752
  $ref: '#/components/schemas/NlpSuggestedAccountsDto'
@@ -6392,7 +6755,7 @@ export const $NlpResponseDto = {
6392
6755
  },
6393
6756
  defaultAccounts: {
6394
6757
  description:
6395
- 'Default accounts for the user/region. These are fallback accounts used when no specific suggestion is available.',
6758
+ 'Default fallback accounts for the user/region (#586). v1 returns universal constants; per-user personalization is planned.',
6396
6759
  allOf: [
6397
6760
  {
6398
6761
  $ref: '#/components/schemas/NlpDefaultAccountsDto'
@@ -7687,344 +8050,220 @@ export const $HoldingPnlWarningDto = {
7687
8050
  'OVERSOLD_LOTS',
7688
8051
  'NO_PRICE',
7689
8052
  'MIXED_COST_CURRENCY'
7690
- ]
7691
- },
7692
- symbol: {
7693
- type: 'object',
7694
- nullable: true
7695
- },
7696
- accountId: {
7697
- type: 'object',
7698
- nullable: true
7699
- },
7700
- currency: {
7701
- type: 'object',
7702
- nullable: true
7703
- }
7704
- },
7705
- required: ['type']
7706
- } as const;
7707
-
7708
- export const $HoldingPnlResponseDto = {
7709
- type: 'object',
7710
- properties: {
7711
- asOfDate: {
7712
- type: 'string',
7713
- example: '2026-07-08'
7714
- },
7715
- baseCurrency: {
7716
- type: 'string',
7717
- example: 'CNY'
7718
- },
7719
- method: {
7720
- type: 'string',
7721
- description:
7722
- 'Realized-P&L lot-matching method (FIFO or average). Unrealized cost basis remains average regardless of this value (#473).',
7723
- enum: ['average', 'FIFO'],
7724
- example: 'average'
7725
- },
7726
- rows: {
7727
- type: 'array',
7728
- items: {
7729
- $ref: '#/components/schemas/HoldingPnlRowDto'
7730
- }
7731
- },
7732
- warnings: {
7733
- type: 'array',
7734
- items: {
7735
- $ref: '#/components/schemas/HoldingPnlWarningDto'
7736
- }
7737
- }
7738
- },
7739
- required: ['asOfDate', 'baseCurrency', 'method', 'rows', 'warnings']
7740
- } as const;
7741
-
7742
- export const $CurrencyBalanceDto = {
7743
- type: 'object',
7744
- properties: {
7745
- currency: {
7746
- type: 'string',
7747
- description: 'ISO 4217 currency code',
7748
- example: 'CNY'
7749
- },
7750
- balance: {
7751
- type: 'string',
7752
- description: 'Balance amount',
7753
- example: '500000.00'
7754
- }
7755
- },
7756
- required: ['currency', 'balance']
7757
- } as const;
7758
-
7759
- export const $TimeSeriesPointDto = {
7760
- type: 'object',
7761
- properties: {
7762
- date: {
7763
- type: 'string',
7764
- description: 'Date in YYYY-MM-DD format',
7765
- example: '2024-06-15'
7766
- },
7767
- value: {
7768
- type: 'string',
7769
- description: 'Value at this date (in base currency)',
7770
- example: '500000.00'
7771
- },
7772
- change: {
7773
- type: 'object',
7774
- description: 'Change from previous point',
7775
- example: '5000.00'
7776
- },
7777
- assets: {
7778
- type: 'string',
7779
- description: 'Total assets at this date (in base currency)',
7780
- example: '494338.00'
7781
- },
7782
- liabilities: {
7783
- type: 'string',
7784
- description: 'Total liabilities at this date (in base currency)',
7785
- example: '310098.00'
7786
- },
7787
- byCurrency: {
7788
- description: 'Multi-currency breakdown for this point',
7789
- type: 'array',
7790
- items: {
7791
- $ref: '#/components/schemas/CurrencyBalanceDto'
7792
- }
7793
- }
7794
- },
7795
- required: ['date', 'value']
7796
- } as const;
7797
-
7798
- export const $TrendSummaryDto = {
7799
- type: 'object',
7800
- properties: {
7801
- startValue: {
7802
- type: 'string',
7803
- description: 'Value at start of period',
7804
- example: '450000.00'
7805
- },
7806
- endValue: {
7807
- type: 'string',
7808
- description: 'Value at end of period',
7809
- example: '500000.00'
7810
- },
7811
- totalChange: {
7812
- type: 'string',
7813
- description: 'Total change over period',
7814
- example: '50000.00'
7815
- },
7816
- totalChangePercentage: {
7817
- type: 'string',
7818
- description: 'Total change percentage',
7819
- example: '+11.11%'
7820
- }
7821
- },
7822
- required: ['startValue', 'endValue', 'totalChange', 'totalChangePercentage']
7823
- } as const;
7824
-
7825
- export const $MultiCurrencyPointDto = {
7826
- type: 'object',
7827
- properties: {
7828
- date: {
7829
- type: 'string',
7830
- description: 'Date in YYYY-MM-DD format',
7831
- example: '2024-06-15'
8053
+ ]
7832
8054
  },
7833
- byCurrency: {
7834
- description: 'Balances by currency',
7835
- type: 'array',
7836
- items: {
7837
- $ref: '#/components/schemas/CurrencyBalanceDto'
7838
- }
8055
+ symbol: {
8056
+ type: 'object',
8057
+ nullable: true
8058
+ },
8059
+ accountId: {
8060
+ type: 'object',
8061
+ nullable: true
8062
+ },
8063
+ currency: {
8064
+ type: 'object',
8065
+ nullable: true
7839
8066
  }
7840
8067
  },
7841
- required: ['date', 'byCurrency']
8068
+ required: ['type']
7842
8069
  } as const;
7843
8070
 
7844
- export const $PortfolioTrendsResponseDto = {
8071
+ export const $HoldingPnlResponseDto = {
7845
8072
  type: 'object',
7846
8073
  properties: {
7847
- series: {
7848
- description: 'Time series data points',
7849
- type: 'array',
7850
- items: {
7851
- $ref: '#/components/schemas/TimeSeriesPointDto'
7852
- }
7853
- },
7854
- summary: {
7855
- description: 'Period summary',
7856
- allOf: [
7857
- {
7858
- $ref: '#/components/schemas/TrendSummaryDto'
7859
- }
7860
- ]
7861
- },
7862
- period: {
7863
- type: 'string',
7864
- description: 'Period requested',
7865
- example: '6m'
7866
- },
7867
- granularity: {
8074
+ asOfDate: {
7868
8075
  type: 'string',
7869
- description: 'Data granularity',
7870
- example: 'month'
8076
+ example: '2026-07-08'
7871
8077
  },
7872
- currency: {
8078
+ baseCurrency: {
7873
8079
  type: 'string',
7874
- description: 'Base currency for converted values',
7875
8080
  example: 'CNY'
7876
8081
  },
7877
- byCurrency: {
8082
+ method: {
8083
+ type: 'string',
7878
8084
  description:
7879
- 'Multi-currency time series (each point has currency breakdown)',
8085
+ 'Realized-P&L lot-matching method (FIFO or average). Unrealized cost basis remains average regardless of this value (#473).',
8086
+ enum: ['average', 'FIFO'],
8087
+ example: 'average'
8088
+ },
8089
+ rows: {
7880
8090
  type: 'array',
7881
8091
  items: {
7882
- $ref: '#/components/schemas/MultiCurrencyPointDto'
8092
+ $ref: '#/components/schemas/HoldingPnlRowDto'
7883
8093
  }
7884
8094
  },
7885
8095
  warnings: {
7886
- description: 'Exchange rate warnings',
7887
8096
  type: 'array',
7888
8097
  items: {
7889
- $ref: '#/components/schemas/ExchangeRateWarningDto'
8098
+ $ref: '#/components/schemas/HoldingPnlWarningDto'
7890
8099
  }
7891
8100
  }
7892
8101
  },
7893
- required: ['series', 'summary', 'period', 'granularity', 'currency']
8102
+ required: ['asOfDate', 'baseCurrency', 'method', 'rows', 'warnings']
7894
8103
  } as const;
7895
8104
 
7896
- export const $CashFlowPointDto = {
8105
+ export const $AnonymousLoginDto = {
7897
8106
  type: 'object',
7898
8107
  properties: {
7899
- month: {
7900
- type: 'string',
7901
- description: 'Month key (YYYY-MM)',
7902
- example: '2024-03'
7903
- },
7904
- income: {
7905
- type: 'string',
7906
- description: 'Income in base currency (absolute, converted)',
7907
- example: '10000.00'
7908
- },
7909
- expense: {
7910
- type: 'string',
7911
- description: 'Expense in base currency (absolute, converted)',
7912
- example: '5000.00'
7913
- },
7914
- netSavings: {
8108
+ accessToken: {
7915
8109
  type: 'string',
7916
- description: 'netSavings = income − expense (savings positive)',
7917
- example: '5000.00'
8110
+ description: 'Access token for anonymous login'
7918
8111
  }
7919
8112
  },
7920
- required: ['month', 'income', 'expense', 'netSavings']
8113
+ required: ['accessToken']
7921
8114
  } as const;
7922
8115
 
7923
- export const $CashFlowTrendSummaryDto = {
8116
+ export const $AnonymousLoginResponseDto = {
7924
8117
  type: 'object',
7925
8118
  properties: {
7926
- totalIncome: {
7927
- type: 'string',
7928
- description: 'Total income across the period',
7929
- example: '60000.00'
7930
- },
7931
- totalExpense: {
7932
- type: 'string',
7933
- description: 'Total expense across the period',
7934
- example: '30000.00'
7935
- },
7936
- totalNetSavings: {
7937
- type: 'string',
7938
- description: 'income − expense across the period',
7939
- example: '30000.00'
7940
- },
7941
- averageMonthlyNetSavings: {
8119
+ authToken: {
7942
8120
  type: 'string',
7943
- description:
7944
- 'totalNetSavings divided by the window length (N months, incl. zero-filled)',
7945
- example: '5000.00'
8121
+ description: 'JWT auth token',
8122
+ example: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
7946
8123
  }
7947
8124
  },
7948
- required: [
7949
- 'totalIncome',
7950
- 'totalExpense',
7951
- 'totalNetSavings',
7952
- 'averageMonthlyNetSavings'
7953
- ]
8125
+ required: ['authToken']
7954
8126
  } as const;
7955
8127
 
7956
- export const $CashFlowTrendsResponseDto = {
8128
+ export const $SymbolSearchResultDto = {
7957
8129
  type: 'object',
7958
8130
  properties: {
7959
- series: {
7960
- description:
7961
- 'Monthly cash-flow series (fixed N-month window, zero-filled)',
7962
- type: 'array',
7963
- items: {
7964
- $ref: '#/components/schemas/CashFlowPointDto'
7965
- }
8131
+ symbol: {
8132
+ type: 'string',
8133
+ example: 'AAPL'
7966
8134
  },
7967
- summary: {
7968
- description: 'Period totals',
7969
- allOf: [
7970
- {
7971
- $ref: '#/components/schemas/CashFlowTrendSummaryDto'
7972
- }
7973
- ]
8135
+ name: {
8136
+ type: 'object',
8137
+ example: 'Apple Inc.',
8138
+ nullable: true
7974
8139
  },
7975
- period: {
7976
- type: 'string',
7977
- description: 'Period requested',
7978
- example: '6m'
8140
+ exchange: {
8141
+ type: 'object',
8142
+ example: 'US',
8143
+ nullable: true
7979
8144
  },
7980
- granularity: {
7981
- type: 'string',
7982
- description: 'Data granularity (v1 returns month buckets)',
7983
- example: 'month'
8145
+ assetType: {
8146
+ type: 'object',
8147
+ description: 'OpenBB asset_type (e.g. stock, etf)',
8148
+ example: 'stock',
8149
+ nullable: true
7984
8150
  },
7985
- currency: {
7986
- type: 'string',
7987
- description: 'Base currency for converted values',
7988
- example: 'CNY'
8151
+ assetClass: {
8152
+ type: 'object',
8153
+ description: 'IGN asset class (region.types.ts ASSET_CLASSES)',
8154
+ example: 'EQUITY',
8155
+ nullable: true
7989
8156
  },
7990
- warnings: {
7991
- description: 'Exchange rate warnings (e.g. missing rate for a currency)',
7992
- type: 'array',
7993
- items: {
7994
- $ref: '#/components/schemas/ExchangeRateWarningDto'
7995
- }
8157
+ assetSubClass: {
8158
+ type: 'object',
8159
+ description: 'IGN asset sub-class (region.types.ts ASSET_SUB_CLASSES)',
8160
+ example: 'STOCK',
8161
+ nullable: true
8162
+ },
8163
+ currency: {
8164
+ type: 'object',
8165
+ description: 'Trading currency (extra_data or inferred from exchange)',
8166
+ example: 'USD',
8167
+ nullable: true
7996
8168
  }
7997
8169
  },
7998
- required: ['series', 'summary', 'period', 'granularity', 'currency']
7999
- } as const;
8000
-
8001
- export const $GenerateSnapshotBody = {
8002
- type: 'object',
8003
- properties: {}
8004
- } as const;
8005
-
8006
- export const $GenerateSnapshotResponse = {
8007
- type: 'object',
8008
- properties: {}
8009
- } as const;
8010
-
8011
- export const $BackfillSnapshotsBody = {
8012
- type: 'object',
8013
- properties: {}
8014
- } as const;
8015
-
8016
- export const $BackfillSnapshotsResponse = {
8017
- type: 'object',
8018
- properties: {}
8170
+ required: ['symbol']
8019
8171
  } as const;
8020
8172
 
8021
- export const $AnonymousLoginDto = {
8173
+ export const $SymbolQuoteDto = {
8022
8174
  type: 'object',
8023
8175
  properties: {
8024
- accessToken: {
8176
+ symbol: {
8025
8177
  type: 'string',
8026
- description: 'Access token for anonymous login'
8178
+ example: 'AAPL'
8179
+ },
8180
+ name: {
8181
+ type: 'object',
8182
+ example: 'Apple Inc.',
8183
+ nullable: true
8184
+ },
8185
+ exchange: {
8186
+ type: 'object',
8187
+ example: 'US',
8188
+ nullable: true
8189
+ },
8190
+ assetType: {
8191
+ type: 'object',
8192
+ description: 'OpenBB asset_type',
8193
+ example: 'stock',
8194
+ nullable: true
8195
+ },
8196
+ assetClass: {
8197
+ type: 'object',
8198
+ description: 'IGN asset class',
8199
+ example: 'EQUITY',
8200
+ nullable: true
8201
+ },
8202
+ assetSubClass: {
8203
+ type: 'object',
8204
+ description: 'IGN asset sub-class',
8205
+ example: 'STOCK',
8206
+ nullable: true
8207
+ },
8208
+ currency: {
8209
+ type: 'object',
8210
+ description: 'Trading currency (extra_data or inferred from exchange)',
8211
+ example: 'USD',
8212
+ nullable: true
8213
+ },
8214
+ price: {
8215
+ type: 'object',
8216
+ description: 'Latest price (Decimal string)',
8217
+ example: '189.84',
8218
+ nullable: true
8219
+ },
8220
+ priceDate: {
8221
+ type: 'object',
8222
+ description: 'Date the price was observed (ISO yyyy-MM-dd)',
8223
+ example: '2026-08-05',
8224
+ nullable: true
8225
+ },
8226
+ changePercent: {
8227
+ type: 'object',
8228
+ description:
8229
+ 'Change vs previous close, in percentage points (1.7 == 1.7%). openbb stores change_percent as a normalized decimal; this exposes percentage points for frontend convenience.',
8230
+ example: 1.7,
8231
+ nullable: true
8232
+ },
8233
+ prevClose: {
8234
+ type: 'object',
8235
+ description: 'Previous close (Decimal string)',
8236
+ nullable: true
8237
+ },
8238
+ open: {
8239
+ type: 'object',
8240
+ description: 'Day open (Decimal string)',
8241
+ nullable: true
8242
+ },
8243
+ high: {
8244
+ type: 'object',
8245
+ description: 'Day high (Decimal string)',
8246
+ nullable: true
8247
+ },
8248
+ low: {
8249
+ type: 'object',
8250
+ description: 'Day low (Decimal string)',
8251
+ nullable: true
8252
+ },
8253
+ volume: {
8254
+ type: 'object',
8255
+ description: 'Day volume (Decimal string)',
8256
+ nullable: true
8257
+ },
8258
+ yearHigh: {
8259
+ type: 'object',
8260
+ description: '52-week high (Decimal string)',
8261
+ nullable: true
8262
+ },
8263
+ yearLow: {
8264
+ type: 'object',
8265
+ description: '52-week low (Decimal string)',
8266
+ nullable: true
8027
8267
  }
8028
- },
8029
- required: ['accessToken']
8268
+ }
8030
8269
  } as const;