@tammsyr/admin-api-client 1.0.16 → 1.0.18

package/dist/data-contracts.d.ts

@@ -597,6 +597,9 @@ export interface AgentListItemDto {
     contactPhone: string;
     address: string;
     city: string;
+    /** Public URL for agent logo */
+    logoUrl?: string | null;
+    cashService: "CASH_IN" | "CASH_OUT" | "BOTH";
     /** @format date-time */
     createdAt: string;
     /** @format date-time */
@@ -722,6 +725,70 @@ export interface BranchResponseDto {
      */
     updatedAt: string;
 }
+export interface AdminAccountResponseDto {
+    /**
+     * Account ID (UUID)
+     * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
+     */
+    id: string;
+    /**
+     * Human-readable 16-digit account number. Only set for main accounts.
+     * @example "1076012345678903"
+     */
+    accountNumber?: string;
+    /**
+     * Owning entity UUID: person (personal/business), merchant (merchant), or agent (agent). Absent for treasury.
+     * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
+     */
+    ownerId?: string;
+    /**
+     * Account type
+     * @example "personal"
+     */
+    type: "personal" | "business" | "merchant" | "agent" | "treasury";
+    /**
+     * ISO 4217 currency code
+     * @example "SYP"
+     */
+    currency: string;
+    /**
+     * Total ledger balance (available + reserved)
+     * @example "1000.00"
+     */
+    balance: string;
+    /**
+     * Funds available for new transactions
+     * @example "800.00"
+     */
+    availableBalance: string;
+    /**
+     * Funds reserved for pending transactions
+     * @example "200.00"
+     */
+    reservedBalance: string;
+    /**
+     * Account status
+     * @example "active"
+     */
+    status: "active" | "frozen" | "closed";
+    /**
+     * Account display name
+     * @example "Primary Wallet"
+     */
+    name?: string;
+    /**
+     * Parent account ID for pots
+     * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
+     */
+    parentAccountId?: string;
+    /**
+     * Account creation timestamp (ISO 8601)
+     * @example "2024-01-15T12:00:00Z"
+     */
+    createdAt: string;
+    /** QR payload for receiving (main accounts only) */
+    qrPayload?: string;
+}
 export interface AgentResponseDto {
     /** @format uuid */
     id: string;
@@ -734,6 +801,9 @@ export interface AgentResponseDto {
     contactPhone: string;
     address: string;
     city: string;
+    /** Public URL for agent logo */
+    logoUrl?: string | null;
+    cashService: "CASH_IN" | "CASH_OUT" | "BOTH";
     /** @format date-time */
     createdAt: string;
     /** @format date-time */
@@ -743,6 +813,21 @@ export interface AgentResponseDto {
     limits?: AgentLimitResponseDto[];
     commissions?: AgentCommissionResponseDto[];
     branches?: BranchResponseDto[];
+    /** Agent main wallets (admin GET only; unified ownerId + type per account) */
+    accounts?: AdminAccountResponseDto[];
+}
+export interface CreateAgentWalletDto {
+    /**
+     * ISO 4217 currency code for the agent main wallet
+     * @example "SYP"
+     */
+    currency: string;
+    /**
+     * Display name; defaults to a label including the currency code
+     * @maxLength 100
+     * @example "Main SYP wallet"
+     */
+    name?: string;
 }
 export interface CreateAgentDto {
     /**
@@ -778,6 +863,16 @@ export interface CreateAgentDto {
      * @example "Dubai"
      */
     city: string;
+    /**
+     * Public URL for agent logo
+     * @example "https://cdn.example.com/agents/acme.png"
+     */
+    logoUrl?: string;
+    /**
+     * Cash-in only, cash-out only, or both
+     * @default "BOTH"
+     */
+    cashService?: "CASH_IN" | "CASH_OUT" | "BOTH";
 }
 export interface CreateAgentResponseDto {
     /**
@@ -827,6 +922,16 @@ export interface UpdateAgentDto {
      * @example "Dubai"
      */
     city?: string;
+    /**
+     * Public URL for agent logo
+     * @example "https://cdn.example.com/agents/acme.png"
+     */
+    logoUrl?: string;
+    /**
+     * Cash-in only, cash-out only, or both
+     * @default "BOTH"
+     */
+    cashService?: "CASH_IN" | "CASH_OUT" | "BOTH";
 }
 export interface UpdateAgentResponseDto {
     /**
@@ -1157,7 +1262,7 @@ export interface AmlRuleDto {
      * Account types this rule applies to; empty/omitted = all types
      * @example ["personal","business"]
      */
-    accountTypes?: ("personal" | "business" | "merchant" | "agent")[];
+    accountTypes?: ("personal" | "business" | "merchant" | "agent" | "treasury")[];
     /**
      * Rule parameters as JSON string
      * @example "{"maxAmount": 10000, "currency": "SYP"}"
@@ -1232,7 +1337,7 @@ export interface CreateAmlRuleDto {
      * Account types this rule applies to; empty/omitted = all types
      * @example ["personal","business"]
      */
-    accountTypes?: ("personal" | "business" | "merchant" | "agent")[];
+    accountTypes?: ("personal" | "business" | "merchant" | "agent" | "treasury")[];
     /**
      * Whether the rule is active
      * @default true
@@ -1292,7 +1397,7 @@ export interface UpdateAmlRuleDto {
      * Account types this rule applies to; empty/omitted = all types
      * @example ["personal","business"]
      */
-    accountTypes?: ("personal" | "business" | "merchant" | "agent")[];
+    accountTypes?: ("personal" | "business" | "merchant" | "agent" | "treasury")[];
     /**
      * Rule parameters as JSON string
      * @example "{"maxAmount": 10000, "currency": "SYP"}"
@@ -1518,7 +1623,7 @@ export interface AccountListQueryDto {
      * Filter by account type
      * @example "personal"
      */
-    type?: "personal" | "business" | "merchant" | "agent";
+    type?: "personal" | "business" | "merchant" | "agent" | "treasury";
     /**
      * Filter by currency code
      * @example "SYP"
@@ -1530,130 +1635,30 @@ export interface AccountListQueryDto {
      */
     search?: string;
 }
-export interface AccountResponseDto {
-    /**
-     * Account ID (UUID)
-     * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
-     */
-    id: string;
-    /**
-     * Human-readable 16-digit account number (encodes type + currency). Only set for main accounts.
-     * @example "1076012345678903"
-     */
-    accountNumber?: string;
-    /**
-     * Person ID (UUID)
-     * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
-     */
-    personId: string;
-    /**
-     * Account type
-     * @example "personal"
-     */
-    type: "personal" | "business" | "merchant" | "agent";
-    /**
-     * ISO 4217 currency code (from supported currencies in the system)
-     * @example "SYP"
-     */
-    currency: string;
-    /**
-     * Total ledger balance (available + reserved)
-     * @example "1000.00"
-     */
-    balance: string;
-    /**
-     * Funds available for new transactions
-     * @example "800.00"
-     */
-    availableBalance: string;
-    /**
-     * Funds reserved for pending transactions
-     * @example "200.00"
-     */
-    reservedBalance: string;
-    /**
-     * Account status
-     * @example "active"
-     */
-    status: "active" | "frozen" | "closed";
-    /**
-     * Account name
-     * @example "Primary Wallet"
-     */
-    name?: string;
-    /**
-     * Parent account ID (null for Main Accounts, set for Pots)
-     * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
-     */
-    parentAccountId?: string;
-    /**
-     * Account creation timestamp (ISO format)
-     * @example "2024-01-15T12:00:00Z"
-     */
-    createdAt: string;
-    /** Base64-encoded static QR payload for receiving payments (primary accounts only) */
-    qrPayload?: string;
-}
 export interface AccountListResponseDto {
-    /** List of accounts */
-    data: AccountResponseDto[];
+    /** List of accounts (unified ownerId + type; no separate personId/agentId/merchantId) */
+    data: AdminAccountResponseDto[];
     /** Pagination metadata */
     meta: PaginationMetaDto;
 }
-export interface PersonAddressDto {
-    /**
-     * Country name (translatable)
-     * @example {"ar":"سوريا","en":"Syria"}
-     */
-    country: object;
-    /**
-     * Province name (translatable)
-     * @example {"ar":"دمشق","en":"Damascus"}
-     */
-    province: object;
+export interface FundAccountDto {
     /**
-     * City name (translatable)
-     * @example {"ar":"دمشق","en":"Damascus"}
+     * Account ID (UUID) to credit
+     * @example "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      */
-    city?: object;
-    /** @example "123 Main Street" */
-    detailedAddress: string;
-}
-export interface ConnectedUserDto {
-    /** @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890" */
-    userId: string;
-    /** @example "+963912345678" */
-    phoneNumber: string;
-    /** @example "active" */
-    status: "pending_phone_verification" | "pending_kyc" | "active" | "suspended" | "blocked" | "closed";
-}
-export interface PersonDetailDto {
-    /** @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890" */
-    id: string;
-    /** @example "Qusai" */
-    firstName: string;
-    /** @example "Armoush" */
-    lastName: string;
-    /** @example "1990-05-15" */
-    dateOfBirth: string;
-    /** @example "verified" */
-    status: "unverified" | "pending_kyc" | "verified" | "rejected" | "suspended";
-    /** @example "2026-01-24T08:09:53.496Z" */
-    createdAt: string;
-    /** @example "Syrian Arab" */
-    nationality: string;
+    accountId: string;
     /**
-     * Father name
-     * @example "Mohammad"
+     * Amount to credit (string for precision)
+     * @example "10000.00"
      */
-    fatherName: string;
+    amount: string;
     /**
-     * Mother name
-     * @example "Fatima"
+     * Currency code
+     * @example "SYP"
      */
-    motherName: string;
-    address: PersonAddressDto;
-    connectedUsers: ConnectedUserDto[];
+    currency: object;
+    /** Reason / justification for the funding */
+    reason?: string;
 }
 export interface TransactionResponseDto {
     /**
@@ -1762,6 +1767,61 @@ export interface TransactionResponseDto {
      */
     counterpartyMasked?: string;
 }
+export interface PersonAddressDto {
+    /**
+     * Country name (translatable)
+     * @example {"ar":"سوريا","en":"Syria"}
+     */
+    country: object;
+    /**
+     * Province name (translatable)
+     * @example {"ar":"دمشق","en":"Damascus"}
+     */
+    province: object;
+    /**
+     * City name (translatable)
+     * @example {"ar":"دمشق","en":"Damascus"}
+     */
+    city?: object;
+    /** @example "123 Main Street" */
+    detailedAddress: string;
+}
+export interface ConnectedUserDto {
+    /** @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890" */
+    userId: string;
+    /** @example "+963912345678" */
+    phoneNumber: string;
+    /** @example "active" */
+    status: "pending_phone_verification" | "pending_kyc" | "active" | "suspended" | "blocked" | "closed";
+}
+export interface PersonDetailDto {
+    /** @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890" */
+    id: string;
+    /** @example "Qusai" */
+    firstName: string;
+    /** @example "Armoush" */
+    lastName: string;
+    /** @example "1990-05-15" */
+    dateOfBirth: string;
+    /** @example "verified" */
+    status: "unverified" | "pending_kyc" | "verified" | "rejected" | "suspended";
+    /** @example "2026-01-24T08:09:53.496Z" */
+    createdAt: string;
+    /** @example "Syrian Arab" */
+    nationality: string;
+    /**
+     * Father name
+     * @example "Mohammad"
+     */
+    fatherName: string;
+    /**
+     * Mother name
+     * @example "Fatima"
+     */
+    motherName: string;
+    address: PersonAddressDto;
+    connectedUsers: ConnectedUserDto[];
+}
 export interface PaginatedTransactionsDto {
     /** List of transactions */
     data: TransactionResponseDto[];
@@ -1775,22 +1835,22 @@ export interface AdminAccountDetailResponseDto {
      */
     id: string;
     /**
-     * Human-readable 16-digit account number (encodes type + currency). Only set for main accounts.
+     * Human-readable 16-digit account number. Only set for main accounts.
      * @example "1076012345678903"
      */
     accountNumber?: string;
     /**
-     * Person ID (UUID)
+     * Owning entity UUID: person (personal/business), merchant (merchant), or agent (agent). Absent for treasury.
      * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      */
-    personId: string;
+    ownerId?: string;
     /**
      * Account type
      * @example "personal"
      */
-    type: "personal" | "business" | "merchant" | "agent";
+    type: "personal" | "business" | "merchant" | "agent" | "treasury";
     /**
-     * ISO 4217 currency code (from supported currencies in the system)
+     * ISO 4217 currency code
      * @example "SYP"
      */
     currency: string;
@@ -1815,23 +1875,23 @@ export interface AdminAccountDetailResponseDto {
      */
     status: "active" | "frozen" | "closed";
     /**
-     * Account name
+     * Account display name
      * @example "Primary Wallet"
      */
     name?: string;
     /**
-     * Parent account ID (null for Main Accounts, set for Pots)
+     * Parent account ID for pots
      * @example "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      */
     parentAccountId?: string;
     /**
-     * Account creation timestamp (ISO format)
+     * Account creation timestamp (ISO 8601)
      * @example "2024-01-15T12:00:00Z"
      */
     createdAt: string;
-    /** Base64-encoded static QR payload for receiving payments (primary accounts only) */
+    /** QR payload for receiving (main accounts only) */
     qrPayload?: string;
-    /** Owner (person) information. Null for merchant/agent accounts. */
+    /** Person KYC/owner profile when the account type is personal or business. Null for merchant, agent, or treasury. */
     owner?: PersonDetailDto;
     /** Paginated transactions for this account */
     transactions: PaginatedTransactionsDto;
@@ -2504,7 +2564,7 @@ export interface FindAllParams6 {
      */
     endDate?: string;
 }
-export type FindAllData1 = ActivityLogListResponseDto;
+export type FindAllResult1 = ActivityLogListResponseDto;
 export interface FindAllParams8 {
     /**
      * Page number (1-based)
@@ -2527,7 +2587,7 @@ export interface FindAllParams8 {
      */
     read?: boolean;
 }
-export type FindAllResult1 = AdminNotificationListResponseDto;
+export type FindAllOutput1 = AdminNotificationListResponseDto;
 export type GetUnreadCountData = any;
 export interface MarkAsReadParams {
     /** Notification ID */
@@ -2558,6 +2618,8 @@ export interface ListAgentsParams {
     status?: "PENDING" | "ACTIVE" | "SUSPENDED" | "TERMINATED";
     /** Search by name, legal name, or registration number */
     searchTerm?: string;
+    /** Filter by cash service capability */
+    cashService?: "CASH_IN" | "CASH_OUT" | "BOTH";
 }
 export type ListAgentsData = AgentListResponseDto;
 export type CreateAgentData = CreateAgentResponseDto;
@@ -2571,6 +2633,11 @@ export interface UpdateAgentParams {
     id: string;
 }
 export type UpdateAgentData = UpdateAgentResponseDto;
+export interface CreateAgentWalletParams {
+    /** Agent ID (UUID) */
+    id: string;
+}
+export type CreateAgentWalletData = AdminAccountResponseDto;
 export interface UpsertAgentBranchesParams {
     /** Agent ID */
     id: string;
@@ -2586,6 +2653,21 @@ export interface UpsertAgentCommissionsParams {
     id: string;
 }
 export type UpsertAgentCommissionsData = AgentCommissionsResponseDto;
+export interface DeleteBranchParams {
+    /** Branch ID (UUID) */
+    branchId: string;
+}
+export type DeleteBranchData = MessageResponseDto;
+export interface DeleteLimitParams {
+    /** Limit ID (UUID) */
+    limitId: string;
+}
+export type DeleteLimitData = MessageResponseDto;
+export interface DeleteCommissionParams {
+    /** Commission ID (UUID) */
+    commissionId: string;
+}
+export type DeleteCommissionData = MessageResponseDto;
 export type GetStatisticsResult = KycStatisticsResponseDto;
 export interface FindAllParams10 {
     /**
@@ -2726,7 +2808,7 @@ export interface ListAccountsParams {
      * Filter by account type
      * @example "personal"
      */
-    type?: "personal" | "business" | "merchant" | "agent";
+    type?: "personal" | "business" | "merchant" | "agent" | "treasury";
     /**
      * Filter by currency code
      * @example "SYP"
@@ -2739,6 +2821,7 @@ export interface ListAccountsParams {
     search?: string;
 }
 export type ListAccountsData = AccountListResponseDto;
+export type FundAccountData = TransactionResponseDto;
 export interface GetAccountDetailParams {
     /** Transaction history page number (default: 1) */
     txPage?: number;
@@ -2752,7 +2835,7 @@ export interface UpdateAccountStatusParams {
     /** Account ID (UUID) */
     id: string;
 }
-export type UpdateAccountStatusData = AccountResponseDto;
+export type UpdateAccountStatusData = AdminAccountResponseDto;
 export interface GetStatisticsParams3 {
     /** Start date filter (ISO date, e.g. 2025-01-01) */
     startDate?: string;
@@ -2840,7 +2923,7 @@ export interface CalculateFeeParams {
     amount: string;
 }
 export type CalculateFeeData = CalculateFeeResponseDto;
-export type GetStatisticsData2 = UserStatisticsResponseDto;
+export type GetStatisticsResult1 = UserStatisticsResponseDto;
 export interface FindAllParams12 {
     /**
      * Page number (1-based)