@firela/api-types 0.0.0-canary.3550df41 → 0.0.0-canary.3cce6a41

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@firela/api-types",
3
- "version": "0.0.0-canary.3550df41",
3
+ "version": "0.0.0-canary.3cce6a41",
4
4
  "description": "TypeScript types generated from IGN OpenAPI specification",
5
5
  "license": "MIT",
6
6
  "author": "FireLa Team",
@@ -124,6 +124,8 @@ export const $AccountResponseDto = {
124
124
  'STUDENT_LOAN',
125
125
  'CREDIT_CARD',
126
126
  'PERSONAL_LOAN',
127
+ 'ACCOUNTS_PAYABLE',
128
+ 'TAX_PAYABLE',
127
129
  'OTHER'
128
130
  ],
129
131
  nullable: true,
@@ -395,9 +397,47 @@ export const $AccountStandardResponseDto = {
395
397
  type: 'string',
396
398
  description: 'Icon identifier for UI display',
397
399
  example: 'bank-icbc'
400
+ },
401
+ productCategory: {
402
+ type: 'string',
403
+ description:
404
+ 'Onboarding product category (coarse grouping derived from assetSubClass)',
405
+ enum: [
406
+ 'cash',
407
+ 'investment',
408
+ 'credit_card',
409
+ 'loan',
410
+ 'payable_tax',
411
+ 'other'
412
+ ],
413
+ example: 'investment'
414
+ },
415
+ assetClass: {
416
+ type: 'string',
417
+ description:
418
+ 'Asset class (LIQUIDITY/EQUITY/.../LIABILITY), derived at read time from classification rules',
419
+ enum: [
420
+ 'LIQUIDITY',
421
+ 'EQUITY',
422
+ 'FIXED_INCOME',
423
+ 'PRECIOUS_METALS',
424
+ 'COMMODITY',
425
+ 'INSURANCE',
426
+ 'ALTERNATIVE_INVESTMENT',
427
+ 'PERSONAL_ASSETS',
428
+ 'LIABILITY',
429
+ 'REAL_ESTATE',
430
+ 'INDEX'
431
+ ]
432
+ },
433
+ assetSubClass: {
434
+ type: 'string',
435
+ description:
436
+ 'Asset sub-class (product type, derived at read time from classification rules)',
437
+ example: 'STOCK'
398
438
  }
399
439
  },
400
- required: ['path', 'type', 'description', 'tags', 'icon']
440
+ required: ['path', 'type', 'description', 'tags', 'icon', 'productCategory']
401
441
  } as const;
402
442
 
403
443
  export const $AccountStandardListResponseDto = {
@@ -5707,12 +5747,14 @@ export const $ProviderSyncConfigDto = {
5707
5747
  },
5708
5748
  defaultExpenseAccount: {
5709
5749
  type: 'string',
5710
- description: 'Default expense account for the second posting',
5750
+ description:
5751
+ 'Default expense account for the second posting. Omit when no real default exists; the pipeline routes to Review via the Uncategorized sentinel (#618).',
5711
5752
  example: 'Expenses:Unknown'
5712
5753
  },
5713
5754
  defaultIncomeAccount: {
5714
5755
  type: 'string',
5715
- description: 'Default income account for the second posting',
5756
+ description:
5757
+ 'Default income account for the second posting. Omit when no real default exists; the pipeline routes to Review via the Uncategorized sentinel (#618).',
5716
5758
  example: 'Income:Unknown'
5717
5759
  },
5718
5760
  filterPending: {
@@ -5727,12 +5769,7 @@ export const $ProviderSyncConfigDto = {
5727
5769
  example: 'acc_gocardless_001'
5728
5770
  }
5729
5771
  },
5730
- required: [
5731
- 'sourceAccount',
5732
- 'defaultCurrency',
5733
- 'defaultExpenseAccount',
5734
- 'defaultIncomeAccount'
5735
- ]
5772
+ required: ['sourceAccount', 'defaultCurrency']
5736
5773
  } as const;
5737
5774
 
5738
5775
  export const $ProviderSyncDto = {
@@ -6808,6 +6845,19 @@ export const $PlatformListItemDto = {
6808
6845
  description: 'Logo URL',
6809
6846
  nullable: true
6810
6847
  },
6848
+ countryCode: {
6849
+ type: 'string',
6850
+ description: 'ISO 3166-1 alpha-2 (UPPERCASE); null = global platform',
6851
+ example: 'CN',
6852
+ nullable: true
6853
+ },
6854
+ category: {
6855
+ type: 'string',
6856
+ description:
6857
+ 'Region-aware category (institution vocab, e.g. DigitalWallet/Bank). null = no region-aware suggestion; fall back to type.',
6858
+ nullable: true,
6859
+ example: 'DigitalWallet'
6860
+ },
6811
6861
  isBound: {
6812
6862
  type: 'boolean',
6813
6863
  description: 'Whether user has accounts using this platform'
@@ -6821,6 +6871,8 @@ export const $PlatformListItemDto = {
6821
6871
  'canonical',
6822
6872
  'suggestedSegment',
6823
6873
  'logoUrl',
6874
+ 'countryCode',
6875
+ 'category',
6824
6876
  'isBound'
6825
6877
  ]
6826
6878
  } as const;
@@ -6863,6 +6915,19 @@ export const $PlatformMatchResultDto = {
6863
6915
  description: 'Logo URL',
6864
6916
  nullable: true
6865
6917
  },
6918
+ countryCode: {
6919
+ type: 'string',
6920
+ description: 'ISO 3166-1 alpha-2 (UPPERCASE); null = global platform',
6921
+ example: 'CN',
6922
+ nullable: true
6923
+ },
6924
+ category: {
6925
+ type: 'string',
6926
+ description:
6927
+ 'Region-aware category (institution vocab, e.g. DigitalWallet/Bank). null = no region-aware suggestion; fall back to type.',
6928
+ nullable: true,
6929
+ example: 'DigitalWallet'
6930
+ },
6866
6931
  matchType: {
6867
6932
  type: 'string',
6868
6933
  description: "How this row matched: 'exact' > 'prefix' > 'substring'",
@@ -6876,6 +6941,8 @@ export const $PlatformMatchResultDto = {
6876
6941
  'type',
6877
6942
  'suggestedSegment',
6878
6943
  'logoUrl',
6944
+ 'countryCode',
6945
+ 'category',
6879
6946
  'matchType'
6880
6947
  ]
6881
6948
  } as const;
@@ -257,6 +257,7 @@ import type {
257
257
  PlatformControllerFindAllResponse,
258
258
  PlatformControllerCreateData,
259
259
  PlatformControllerCreateResponse,
260
+ PlatformControllerGetPlatformListData,
260
261
  PlatformControllerGetPlatformListResponse,
261
262
  PlatformControllerMatchPlatformsData,
262
263
  PlatformControllerMatchPlatformsResponse,
@@ -3730,13 +3731,20 @@ export class BeanPlatformsService {
3730
3731
 
3731
3732
  /**
3732
3733
  * Get platform list for current user
3734
+ * @param data The data for the request.
3735
+ * @param data.region Region code (ISO 3166-1 alpha-2) that biases within-type-bucket ordering (local-region platforms first). Case-insensitive — stored/compared UPPERCASE ("cn" == "CN").
3733
3736
  * @returns PlatformListItemDto List of platforms with user binding status
3734
3737
  * @throws ApiError
3735
3738
  */
3736
- public static platformControllerGetPlatformList(): CancelablePromise<PlatformControllerGetPlatformListResponse> {
3739
+ public static platformControllerGetPlatformList(
3740
+ data: PlatformControllerGetPlatformListData = {}
3741
+ ): CancelablePromise<PlatformControllerGetPlatformListResponse> {
3737
3742
  return __request(OpenAPI, {
3738
3743
  method: 'GET',
3739
- url: '/api/v1/bean/platforms/list'
3744
+ url: '/api/v1/bean/platforms/list',
3745
+ query: {
3746
+ region: data.region
3747
+ }
3740
3748
  });
3741
3749
  }
3742
3750
 
@@ -3744,7 +3752,7 @@ export class BeanPlatformsService {
3744
3752
  * Match platforms by name or alias
3745
3753
  * @param data The data for the request.
3746
3754
  * @param data.q Search query — Chinese name, English name, or abbreviation
3747
- * @param data.region Region code for category override lookup
3755
+ * @param data.region Region code (ISO 3166-1 alpha-2) that biases within-tier ordering (local-region platforms first); also the intended categoryOverrides key. Case-insensitive — stored/compared UPPERCASE ("cn" == "CN").
3748
3756
  * @returns PlatformMatchResponseDto Matching platforms with overall match type and truncation flag
3749
3757
  * @throws ApiError
3750
3758
  */