@firela/api-types 0.0.0-canary.4cf7f99a → 0.0.0-canary.4e161540

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.js CHANGED
@@ -556,7 +556,7 @@ var BeanAccountsService = class {
556
556
  }
557
557
  /**
558
558
  * Delete account
559
- * Deletes an account (only if no transactions)
559
+ * Deletes an account (only if no active transactions; voided/superseded residual postings are cleaned up)
560
560
  * @param data The data for the request.
561
561
  * @param data.id Account UUID
562
562
  * @param data.region Region code for tenant context
@@ -573,7 +573,7 @@ var BeanAccountsService = class {
573
573
  },
574
574
  errors: {
575
575
  404: "Account not found",
576
- 409: "Account has transactions and cannot be deleted"
576
+ 409: "Account has active transactions and cannot be deleted"
577
577
  }
578
578
  });
579
579
  }
package/dist/index.mjs CHANGED
@@ -524,7 +524,7 @@ var BeanAccountsService = class {
524
524
  }
525
525
  /**
526
526
  * Delete account
527
- * Deletes an account (only if no transactions)
527
+ * Deletes an account (only if no active transactions; voided/superseded residual postings are cleaned up)
528
528
  * @param data The data for the request.
529
529
  * @param data.id Account UUID
530
530
  * @param data.region Region code for tenant context
@@ -541,7 +541,7 @@ var BeanAccountsService = class {
541
541
  },
542
542
  errors: {
543
543
  404: "Account not found",
544
- 409: "Account has transactions and cannot be deleted"
544
+ 409: "Account has active transactions and cannot be deleted"
545
545
  }
546
546
  });
547
547
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@firela/api-types",
3
- "version": "0.0.0-canary.4cf7f99a",
3
+ "version": "0.0.0-canary.4e161540",
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 = {
@@ -6497,7 +6534,8 @@ export const $NlpSuggestedAccountDto = {
6497
6534
  },
6498
6535
  confidence: {
6499
6536
  type: 'number',
6500
- description: 'Confidence score for this suggestion (0-1)',
6537
+ description:
6538
+ 'Confidence score for this suggestion (0-1). Present = predicted (confirm/confirm_rule/confirm_account); omitted = actual persisted account (created). (#586)',
6501
6539
  example: 0.9
6502
6540
  }
6503
6541
  },
@@ -6533,23 +6571,31 @@ export const $NlpDefaultAccountsDto = {
6533
6571
  properties: {
6534
6572
  asset: {
6535
6573
  type: 'string',
6536
- description: 'Default asset account',
6537
- example: 'Assets:Checking'
6574
+ description:
6575
+ 'Default OPEN asset account (MRU when multiple), or null when none/ambiguous',
6576
+ example: 'Assets:Checking',
6577
+ nullable: true
6538
6578
  },
6539
6579
  expense: {
6540
6580
  type: 'string',
6541
- description: 'Default expense account',
6542
- example: 'Expenses:Uncategorized'
6581
+ description:
6582
+ 'Default OPEN expense account (MRU when multiple), or null when none/ambiguous',
6583
+ example: 'Expenses:Food:Coffee',
6584
+ nullable: true
6543
6585
  },
6544
6586
  income: {
6545
6587
  type: 'string',
6546
- description: 'Default income account',
6547
- example: 'Income:Uncategorized'
6588
+ description:
6589
+ 'Default OPEN income account (MRU when multiple), or null when none/ambiguous',
6590
+ example: 'Income:Salary',
6591
+ nullable: true
6548
6592
  },
6549
6593
  liability: {
6550
6594
  type: 'string',
6551
- description: 'Default liability account',
6552
- example: 'Liabilities:CreditCard'
6595
+ description:
6596
+ 'Default OPEN liability account (MRU when multiple), or null when none/ambiguous',
6597
+ example: 'Liabilities:CreditCard',
6598
+ nullable: true
6553
6599
  }
6554
6600
  },
6555
6601
  required: ['asset', 'expense', 'income', 'liability']
@@ -6737,7 +6783,7 @@ export const $NlpResponseDto = {
6737
6783
  },
6738
6784
  suggestedAccounts: {
6739
6785
  description:
6740
- 'Suggested accounts for this transaction. Contains recommended source and destination accounts based on the detected intent and rules.',
6786
+ '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.',
6741
6787
  allOf: [
6742
6788
  {
6743
6789
  $ref: '#/components/schemas/NlpSuggestedAccountsDto'
@@ -6746,7 +6792,7 @@ export const $NlpResponseDto = {
6746
6792
  },
6747
6793
  defaultAccounts: {
6748
6794
  description:
6749
- 'Default accounts for the user/region. These are fallback accounts used when no specific suggestion is available.',
6795
+ 'Default fallback accounts for the user/region (#586). v1 returns universal constants; per-user personalization is planned.',
6750
6796
  allOf: [
6751
6797
  {
6752
6798
  $ref: '#/components/schemas/NlpDefaultAccountsDto'
@@ -6799,6 +6845,12 @@ export const $PlatformListItemDto = {
6799
6845
  description: 'Logo URL',
6800
6846
  nullable: true
6801
6847
  },
6848
+ countryCode: {
6849
+ type: 'string',
6850
+ description: 'ISO 3166-1 alpha-2 (UPPERCASE); null = global platform',
6851
+ example: 'CN',
6852
+ nullable: true
6853
+ },
6802
6854
  isBound: {
6803
6855
  type: 'boolean',
6804
6856
  description: 'Whether user has accounts using this platform'
@@ -6812,6 +6864,7 @@ export const $PlatformListItemDto = {
6812
6864
  'canonical',
6813
6865
  'suggestedSegment',
6814
6866
  'logoUrl',
6867
+ 'countryCode',
6815
6868
  'isBound'
6816
6869
  ]
6817
6870
  } as const;
@@ -6854,6 +6907,12 @@ export const $PlatformMatchResultDto = {
6854
6907
  description: 'Logo URL',
6855
6908
  nullable: true
6856
6909
  },
6910
+ countryCode: {
6911
+ type: 'string',
6912
+ description: 'ISO 3166-1 alpha-2 (UPPERCASE); null = global platform',
6913
+ example: 'CN',
6914
+ nullable: true
6915
+ },
6857
6916
  matchType: {
6858
6917
  type: 'string',
6859
6918
  description: "How this row matched: 'exact' > 'prefix' > 'substring'",
@@ -6867,6 +6926,7 @@ export const $PlatformMatchResultDto = {
6867
6926
  'type',
6868
6927
  'suggestedSegment',
6869
6928
  'logoUrl',
6929
+ 'countryCode',
6870
6930
  'matchType'
6871
6931
  ]
6872
6932
  } 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,
@@ -411,7 +412,7 @@ export class BeanAccountsService {
411
412
 
412
413
  /**
413
414
  * Delete account
414
- * Deletes an account (only if no transactions)
415
+ * Deletes an account (only if no active transactions; voided/superseded residual postings are cleaned up)
415
416
  * @param data The data for the request.
416
417
  * @param data.id Account UUID
417
418
  * @param data.region Region code for tenant context
@@ -430,7 +431,7 @@ export class BeanAccountsService {
430
431
  },
431
432
  errors: {
432
433
  404: 'Account not found',
433
- 409: 'Account has transactions and cannot be deleted'
434
+ 409: 'Account has active transactions and cannot be deleted'
434
435
  }
435
436
  });
436
437
  }
@@ -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
  */