@tammsyr/admin-api-client 1.3.8 → 1.3.9

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 (46) hide show
  1. package/dist/AccountProducts.d.ts.map +1 -1
  2. package/dist/AccountProducts.js.map +1 -1
  3. package/dist/AccountTypes.d.ts.map +1 -1
  4. package/dist/AccountTypes.js.map +1 -1
  5. package/dist/ActivityLogs.d.ts.map +1 -1
  6. package/dist/ActivityLogs.js.map +1 -1
  7. package/dist/AddressRegions.js.map +1 -1
  8. package/dist/AppVersion.js.map +1 -1
  9. package/dist/ApprovalPolicies.d.ts +2 -2
  10. package/dist/ApprovalPolicies.d.ts.map +1 -1
  11. package/dist/ApprovalPolicies.js.map +1 -1
  12. package/dist/BankBranches.d.ts.map +1 -1
  13. package/dist/BankBranches.js.map +1 -1
  14. package/dist/Currencies.d.ts.map +1 -1
  15. package/dist/Currencies.js.map +1 -1
  16. package/dist/Dlq.d.ts.map +1 -1
  17. package/dist/Dlq.js.map +1 -1
  18. package/dist/GlobalNotifications.d.ts.map +1 -1
  19. package/dist/GlobalNotifications.js.map +1 -1
  20. package/dist/MerchantCategories.d.ts.map +1 -1
  21. package/dist/MerchantCategories.js.map +1 -1
  22. package/dist/Notifications.d.ts.map +1 -1
  23. package/dist/Seed.d.ts +0 -10
  24. package/dist/Seed.d.ts.map +1 -1
  25. package/dist/Seed.js +0 -15
  26. package/dist/Seed.js.map +1 -1
  27. package/dist/Transactions.d.ts +17 -17
  28. package/dist/Transactions.d.ts.map +1 -1
  29. package/dist/Transactions.js +19 -19
  30. package/dist/Transactions.js.map +1 -1
  31. package/dist/Users.js.map +1 -1
  32. package/dist/data-contracts.d.ts +208 -58
  33. package/dist/data-contracts.d.ts.map +1 -1
  34. package/dist/index.d.ts +0 -6
  35. package/dist/index.d.ts.map +1 -1
  36. package/dist/index.js +1 -9
  37. package/dist/index.js.map +1 -1
  38. package/package.json +1 -1
  39. package/dist/FeeConfigs.d.ts +0 -57
  40. package/dist/FeeConfigs.d.ts.map +0 -1
  41. package/dist/FeeConfigs.js +0 -107
  42. package/dist/FeeConfigs.js.map +0 -1
  43. package/dist/SystemConfigs.d.ts +0 -37
  44. package/dist/SystemConfigs.d.ts.map +0 -1
  45. package/dist/SystemConfigs.js +0 -72
  46. package/dist/SystemConfigs.js.map +0 -1
@@ -2860,34 +2860,169 @@ export interface UpdateScheduledNotificationDto {
2860
2860
  */
2861
2861
  scheduledAt?: string;
2862
2862
  }
2863
- export interface SystemConfigResponseDto {
2863
+ export interface AdminTransactionItemDto {
2864
+ /** @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890" */
2864
2865
  id: string;
2865
- configKey: string;
2866
- currency: string;
2867
- value: string;
2866
+ /** @example "TXN-20240115-123456" */
2867
+ publicTxnId: string;
2868
+ /** @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890" */
2869
+ fromAccountId: string;
2870
+ /** @example "b2c3d4e5-f6a7-8901-bcde-f12345678901" */
2871
+ toAccountId: string;
2872
+ /** @example "100.50" */
2873
+ amount: string;
2874
+ /** @example "99.50" */
2875
+ netAmount: string;
2876
+ /** @example "1.00" */
2877
+ feeAmount: string;
2878
+ /** @example "SYP" */
2879
+ currency: "SYP" | "USD" | "EUR";
2880
+ /** @example "P2P_TRANSFER" */
2881
+ type: "P2P_TRANSFER" | "WITHDRAWAL" | "TOP_UP" | "MERCHANT_PAYMENT" | "REVERSAL" | "REFUND" | "MOVING" | "ADMIN_FUNDING";
2882
+ /** @example "COMPLETED" */
2883
+ status: "COMPLETED" | "FAILED" | "VOUCHER_PENDING" | "REVERSED";
2884
+ /** @example "Payment for services" */
2868
2885
  description?: string;
2869
- isActive: boolean;
2870
- updatedBy?: string;
2886
+ /**
2887
+ * AML risk score (0-100). Computed asynchronously after the transaction is posted; admin views fetch this from aml-service.transaction_summaries via gRPC and merge it in.
2888
+ * @example 0
2889
+ */
2890
+ amlRiskScore: number;
2891
+ /** @example "LOW" */
2892
+ amlRiskLevel: "LOW" | "MEDIUM" | "HIGH" | "CRITICAL";
2893
+ /** @example "2024-01-15T12:00:00Z" */
2871
2894
  createdAt: string;
2872
- updatedAt: string;
2895
+ /** @example "2024-01-15T12:00:01Z" */
2896
+ completedAt?: string;
2897
+ /** @example {"key":"value"} */
2898
+ metadata?: object;
2873
2899
  }
2874
- export interface SystemConfigListResponseDto {
2875
- configs: SystemConfigResponseDto[];
2900
+ export interface AdminTransactionListResponseDto {
2901
+ data: AdminTransactionItemDto[];
2902
+ meta: PaginationMetaDto;
2876
2903
  }
2877
- export interface UpsertSystemConfigDto {
2878
- /** Configuration key */
2879
- configKey: "CASHIN_MIN_AMOUNT" | "CASHIN_MAX_AMOUNT" | "CASHOUT_MIN_AMOUNT" | "CASHOUT_MAX_AMOUNT" | "P2P_MIN_AMOUNT" | "P2P_MAX_AMOUNT" | "MERCHANT_PAYMENT_MIN_AMOUNT" | "MERCHANT_PAYMENT_MAX_AMOUNT" | "TRANSACTION_MAX_AMOUNT" | "DAILY_TRANSACTION_LIMIT" | "DAILY_TRANSACTION_COUNT" | "PAYMENT_REQUEST_MIN_AMOUNT" | "PAYMENT_REQUEST_MAX_AMOUNT" | "MAX_WALLET_BALANCE";
2880
- /** Currency code */
2881
- currency: "SYP" | "USD" | "EUR";
2882
- /** Configuration value */
2883
- value: string;
2884
- /** Human-readable description */
2885
- description?: string;
2904
+ export interface CurrencyStatsDto {
2905
+ /** @example "SYP" */
2906
+ currency: string;
2907
+ /** @example "150000.00" */
2908
+ totalVolume: string;
2909
+ /** @example "75000.00" */
2910
+ totalCredits: string;
2911
+ /** @example "74000.00" */
2912
+ totalDebits: string;
2913
+ /** @example "1000.00" */
2914
+ totalFees: string;
2915
+ /** @example "1250.00" */
2916
+ avgTransactionAmount: string;
2917
+ }
2918
+ export interface TransactionStatisticsResponseDto {
2886
2919
  /**
2887
- * Whether this config is active
2888
- * @default true
2920
+ * Total number of transactions
2921
+ * @example 150
2889
2922
  */
2890
- isActive?: boolean;
2923
+ totalTransactions: number;
2924
+ /**
2925
+ * Number of completed transactions
2926
+ * @example 120
2927
+ */
2928
+ completedTransactions: number;
2929
+ /**
2930
+ * Number of failed/declined/rejected transactions
2931
+ * @example 5
2932
+ */
2933
+ failedTransactions: number;
2934
+ /**
2935
+ * Number of cancelled transactions
2936
+ * @example 3
2937
+ */
2938
+ cancelledTransactions: number;
2939
+ /** Breakdown by currency */
2940
+ byCurrency: CurrencyStatsDto[];
2941
+ /**
2942
+ * Transaction count by type
2943
+ * @example {"P2P_TRANSFER":45,"TOP_UP":12}
2944
+ */
2945
+ typeBreakdown: object;
2946
+ }
2947
+ export interface LedgerEntryResponseDto {
2948
+ /**
2949
+ * Ledger entry ID (UUID)
2950
+ * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
2951
+ */
2952
+ id: string;
2953
+ /**
2954
+ * Transaction ID this entry belongs to
2955
+ * @example "b2c3d4e5-f6a7-8901-bcde-f12345678901"
2956
+ */
2957
+ transactionId: string;
2958
+ /**
2959
+ * Account ID affected by this entry
2960
+ * @example "c3d4e5f6-a7b8-9012-cdef-123456789012"
2961
+ */
2962
+ accountId: string;
2963
+ /**
2964
+ * Entry amount (string for precision)
2965
+ * @example "100.50"
2966
+ */
2967
+ amount: string;
2968
+ /**
2969
+ * Direction of the entry
2970
+ * @example "DEBIT"
2971
+ */
2972
+ direction: "DEBIT" | "CREDIT";
2973
+ /**
2974
+ * Account balance before this entry
2975
+ * @example "1000.00"
2976
+ */
2977
+ balanceBefore: string;
2978
+ /**
2979
+ * Account balance after this entry
2980
+ * @example "899.50"
2981
+ */
2982
+ balanceAfter: string;
2983
+ /**
2984
+ * Reason for the entry
2985
+ * @example "TRANSACTION"
2986
+ */
2987
+ reason: "TRANSACTION" | "REVERSAL" | "FEE" | "MOVING";
2988
+ /**
2989
+ * Display name of the counterparty
2990
+ * @example "Ahmed M."
2991
+ */
2992
+ counterpartyLabel?: string;
2993
+ /**
2994
+ * Masked identifier of the counterparty
2995
+ * @example "****7890"
2996
+ */
2997
+ counterpartyMasked?: string;
2998
+ /**
2999
+ * Entry creation timestamp (ISO format)
3000
+ * @example "2024-01-15T12:00:00Z"
3001
+ */
3002
+ createdAt: string;
3003
+ }
3004
+ export interface TransactionPartyDto {
3005
+ /** @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890" */
3006
+ accountId: string;
3007
+ /** @example "b2c3d4e5-f6a7-8901-bcde-f12345678901" */
3008
+ personId?: string;
3009
+ /** @example "Qusai" */
3010
+ firstName?: string;
3011
+ /** @example "Armoush" */
3012
+ lastName?: string;
3013
+ /** @example "+963912345678" */
3014
+ phoneNumber?: string;
3015
+ /** @example "ACTIVE" */
3016
+ accountStatus?: string;
3017
+ /** @example "PERSONAL" */
3018
+ accountType?: string;
3019
+ }
3020
+ export interface AdminTransactionDetailResponseDto {
3021
+ transaction: AdminTransactionItemDto;
3022
+ ledgerEntries: LedgerEntryResponseDto[];
3023
+ fromUser: TransactionPartyDto;
3024
+ toUser: TransactionPartyDto;
3025
+ amlAlerts: AmlAlertDto[];
2891
3026
  }
2892
3027
  export interface ChargeNameDto {
2893
3028
  /** @example "P2P transfer fee" */
@@ -3965,7 +4100,6 @@ export interface UpdateStatusParams {
3965
4100
  }
3966
4101
  export type UpdateStatusData = AdminUserDetailResponseDto;
3967
4102
  export type SeedPermissionsAndRolesData = SeedPermissionsRolesResponseDto;
3968
- export type SeedConfigDefaultsData = any;
3969
4103
  export interface FindAllParams6 {
3970
4104
  /**
3971
4105
  * Page number (1-based)
@@ -4000,7 +4134,7 @@ export interface FindAllParams6 {
4000
4134
  */
4001
4135
  endDate?: string;
4002
4136
  }
4003
- export type FindAllData1 = ActivityLogListResponseDto;
4137
+ export type FindAllResult1 = ActivityLogListResponseDto;
4004
4138
  export interface FindAllParams8 {
4005
4139
  /**
4006
4140
  * Page number (1-based)
@@ -4023,7 +4157,7 @@ export interface FindAllParams8 {
4023
4157
  */
4024
4158
  read?: boolean;
4025
4159
  }
4026
- export type FindAllOutput1 = AdminNotificationListResponseDto;
4160
+ export type FindAllResult2 = AdminNotificationListResponseDto;
4027
4161
  export type GetUnreadCountData = any;
4028
4162
  export interface MarkAsReadParams {
4029
4163
  /** Notification ID */
@@ -4423,7 +4557,7 @@ export interface UpdateParams6 {
4423
4557
  /** @example 2 */
4424
4558
  version: number;
4425
4559
  }
4426
- export type UpdateData1 = AccountProductResponseDto;
4560
+ export type UpdateResult1 = AccountProductResponseDto;
4427
4561
  export interface PublishVersionParams {
4428
4562
  /** @example "PERS-CURRENT" */
4429
4563
  code: string;
@@ -4514,10 +4648,10 @@ export interface UpdateParams8 {
4514
4648
  /** 4-digit MCC code */
4515
4649
  code: string;
4516
4650
  }
4517
- export type UpdateData2 = MerchantCategoryResponseDto;
4651
+ export type UpdateResult2 = MerchantCategoryResponseDto;
4518
4652
  export type SendGlobalNotificationData = SendGlobalNotificationResponseDto;
4519
4653
  export type SendGlobalNotificationError = ErrorResponseDto;
4520
- export type CreateOutput1 = ScheduledNotificationResponseDto;
4654
+ export type CreateResult2 = ScheduledNotificationResponseDto;
4521
4655
  export type CreateBadResponse = ErrorResponseDto;
4522
4656
  export interface FindAllParams10 {
4523
4657
  /** Filter by status */
@@ -4534,7 +4668,7 @@ export interface FindAllParams10 {
4534
4668
  */
4535
4669
  limit?: number;
4536
4670
  }
4537
- export type FindAllResult1 = ScheduledNotificationsListResponseDto;
4671
+ export type FindAllOutput1 = ScheduledNotificationsListResponseDto;
4538
4672
  export interface FindOneParams {
4539
4673
  /** MongoDB ObjectId */
4540
4674
  id: string;
@@ -4545,7 +4679,7 @@ export interface UpdateParams10 {
4545
4679
  /** MongoDB ObjectId */
4546
4680
  id: string;
4547
4681
  }
4548
- export type UpdateResult1 = ScheduledNotificationResponseDto;
4682
+ export type UpdateData1 = ScheduledNotificationResponseDto;
4549
4683
  export type UpdateBadResponse = ErrorResponseDto;
4550
4684
  export interface RemoveParams2 {
4551
4685
  /** MongoDB ObjectId */
@@ -4553,20 +4687,36 @@ export interface RemoveParams2 {
4553
4687
  }
4554
4688
  export type RemoveResult = any;
4555
4689
  export type RemoveError = ErrorResponseDto;
4556
- export interface GetSystemConfigsParams {
4557
- /** Filter by config key */
4558
- configKey?: "CASHIN_MIN_AMOUNT" | "CASHIN_MAX_AMOUNT" | "CASHOUT_MIN_AMOUNT" | "CASHOUT_MAX_AMOUNT" | "P2P_MIN_AMOUNT" | "P2P_MAX_AMOUNT" | "MERCHANT_PAYMENT_MIN_AMOUNT" | "MERCHANT_PAYMENT_MAX_AMOUNT" | "TRANSACTION_MAX_AMOUNT" | "DAILY_TRANSACTION_LIMIT" | "DAILY_TRANSACTION_COUNT" | "PAYMENT_REQUEST_MIN_AMOUNT" | "PAYMENT_REQUEST_MAX_AMOUNT" | "MAX_WALLET_BALANCE";
4559
- /** Filter by currency */
4560
- currency?: "SYP" | "USD" | "EUR";
4690
+ export interface ListTransactionsParams {
4691
+ search?: string;
4692
+ status?: string;
4693
+ type?: string;
4694
+ currency?: string;
4695
+ fromAccountId?: string;
4696
+ toAccountId?: string;
4697
+ accountId?: string;
4698
+ startDate?: string;
4699
+ endDate?: string;
4700
+ sortBy?: string;
4701
+ sortOrder?: string;
4702
+ page?: number;
4703
+ limit?: number;
4704
+ }
4705
+ export type ListTransactionsData = AdminTransactionListResponseDto;
4706
+ export interface GetTransactionStatisticsParams {
4707
+ /** ISO-8601 */
4708
+ startDate?: string;
4709
+ /** ISO-8601 */
4710
+ endDate?: string;
4711
+ currency?: string;
4561
4712
  }
4562
- export type GetSystemConfigsData = SystemConfigListResponseDto;
4563
- export type UpsertSystemConfigData = SystemConfigResponseDto;
4564
- export interface DeleteSystemConfigParams {
4565
- /** System config UUID */
4713
+ export type GetTransactionStatisticsData = TransactionStatisticsResponseDto;
4714
+ export interface GetTransactionDetailParams {
4715
+ /** Transaction UUID or reference number */
4566
4716
  id: string;
4567
4717
  }
4568
- export type DeleteSystemConfigData = any;
4569
- export type DeleteSystemConfigError = ErrorResponseDto;
4718
+ export type GetTransactionDetailData = AdminTransactionDetailResponseDto;
4719
+ export type GetTransactionDetailError = ErrorResponseDto;
4570
4720
  export interface ListChargesParams {
4571
4721
  category?: "FEE" | "TAX";
4572
4722
  }
@@ -4699,13 +4849,13 @@ export interface DeleteDocumentParams {
4699
4849
  }
4700
4850
  export type DeleteDocumentData = any;
4701
4851
  export type DeleteDocumentError = ErrorResponseDto;
4702
- export type ListData1 = AppVersionPolicyListResponseDto;
4852
+ export type ListResult1 = AppVersionPolicyListResponseDto;
4703
4853
  export type UpsertData = AppVersionPolicyDto;
4704
4854
  export interface GetParams4 {
4705
4855
  platform: "ios" | "android";
4706
4856
  }
4707
4857
  export type GetOutput = AppVersionPolicyDto;
4708
- export type GetStatisticsData1 = UserStatisticsResponseDto;
4858
+ export type GetStatisticsResult1 = UserStatisticsResponseDto;
4709
4859
  export interface FindAllParams12 {
4710
4860
  /**
4711
4861
  * Page number (1-based)
@@ -4753,7 +4903,7 @@ export interface FindAllParams12 {
4753
4903
  */
4754
4904
  query?: string;
4755
4905
  }
4756
- export type FindAllResult2 = PersonListResponseDto;
4906
+ export type FindAllResult3 = PersonListResponseDto;
4757
4907
  export interface ExportUsersParams {
4758
4908
  /**
4759
4909
  * Field to sort by
@@ -4798,7 +4948,7 @@ export interface FindByIdParams6 {
4798
4948
  /** Person ID (UUID) */
4799
4949
  id: string;
4800
4950
  }
4801
- export type FindByIdOutput1 = PersonDetailDto;
4951
+ export type FindByIdData1 = PersonDetailDto;
4802
4952
  export interface UpdatePersonStatusParams {
4803
4953
  /** Person ID (UUID) */
4804
4954
  id: string;
@@ -4838,7 +4988,7 @@ export interface FindAllParams14 {
4838
4988
  */
4839
4989
  endDate?: string;
4840
4990
  }
4841
- export type FindAllResult3 = DlqMessageListResponseDto;
4991
+ export type FindAllData1 = DlqMessageListResponseDto;
4842
4992
  export type PendingByTopicData = DlqPendingByTopicResponseDto[];
4843
4993
  export interface FindByIdParams8 {
4844
4994
  id: string;
@@ -4852,8 +5002,8 @@ export interface ListParams7 {
4852
5002
  /** Return only active branches */
4853
5003
  onlyActive?: boolean;
4854
5004
  }
4855
- export type ListData2 = BankBranchesListResponseDto;
4856
- export type CreateResult2 = BankBranchResponseDto;
5005
+ export type ListResult2 = BankBranchesListResponseDto;
5006
+ export type CreateData3 = BankBranchResponseDto;
4857
5007
  export interface GetByCodeParams {
4858
5008
  /** 3-digit branch code */
4859
5009
  code: string;
@@ -4863,21 +5013,21 @@ export interface UpdateParams12 {
4863
5013
  /** 3-digit branch code */
4864
5014
  code: string;
4865
5015
  }
4866
- export type UpdateResult2 = BankBranchResponseDto;
5016
+ export type UpdateResult3 = BankBranchResponseDto;
4867
5017
  export interface ListParams9 {
4868
5018
  onlyActive?: boolean;
4869
5019
  }
4870
- export type ListOutput1 = AccountTypesListResponseDto;
5020
+ export type ListResult3 = AccountTypesListResponseDto;
4871
5021
  export interface UpdateParams14 {
4872
5022
  /** 2-digit account-type code */
4873
5023
  code: string;
4874
5024
  }
4875
- export type UpdateResult3 = AccountTypeResponseDto;
5025
+ export type UpdateData2 = AccountTypeResponseDto;
4876
5026
  export interface ListParams11 {
4877
5027
  onlyActive?: boolean;
4878
5028
  }
4879
- export type ListData3 = CurrencyConfigListResponseDto;
4880
- export type CreateData3 = CurrencyConfigResponseDto;
5029
+ export type ListData1 = CurrencyConfigListResponseDto;
5030
+ export type CreateOutput1 = CurrencyConfigResponseDto;
4881
5031
  export interface GetByCodeParams2 {
4882
5032
  /** ISO 4217 alpha-3 code (e.g. USD) */
4883
5033
  code: string;
@@ -4887,19 +5037,19 @@ export interface DeleteParams6 {
4887
5037
  /** ISO 4217 alpha-3 code */
4888
5038
  code: string;
4889
5039
  }
4890
- export type DeleteData1 = any;
5040
+ export type DeleteResult1 = any;
4891
5041
  export interface UpdateParams16 {
4892
5042
  /** ISO 4217 alpha-3 code */
4893
5043
  code: string;
4894
5044
  }
4895
- export type UpdateResult4 = CurrencyConfigResponseDto;
4896
- export type ListResult1 = CountryListResponseDto;
5045
+ export type UpdateOutput1 = CurrencyConfigResponseDto;
5046
+ export type ListOutput1 = CountryListResponseDto;
4897
5047
  export type CreateResult3 = CountryResponseDto;
4898
5048
  export interface UpdateParams18 {
4899
5049
  /** Country UUID */
4900
5050
  id: string;
4901
5051
  }
4902
- export type UpdateOutput1 = CountryResponseDto;
5052
+ export type UpdateData3 = CountryResponseDto;
4903
5053
  export interface List2Params2 {
4904
5054
  /** Country UUID */
4905
5055
  countryId?: string;
@@ -4945,10 +5095,10 @@ export interface CancelParams {
4945
5095
  id: string;
4946
5096
  }
4947
5097
  export type CancelData = ApprovalRequestResponseDto;
4948
- export type ListData4 = ApprovalPolicyResponseDto[];
5098
+ export type ListOutput2 = ApprovalPolicyResponseDto[];
4949
5099
  export interface UpdateParams20 {
4950
5100
  actionType: "admin.create" | "admin.update" | "admin.delete" | "admin.status_update" | "system_config.upsert" | "system_config.delete" | "account.fund" | "role.assign_permissions" | "reconciliation.run" | "kyc.approve" | "kyc.reject";
4951
5101
  }
4952
- export type UpdateOutput2 = ApprovalPolicyResponseDto;
5102
+ export type UpdateData4 = ApprovalPolicyResponseDto;
4953
5103
  export type IndexData = any;
4954
5104
  //# sourceMappingURL=data-contracts.d.ts.map