@tammsyr/admin-api-client 1.0.4 → 1.0.6

package/dist/data-contracts.d.ts

@@ -575,20 +575,393 @@ export interface AdminNotificationListResponseDto {
     /** Pagination metadata */
     meta: PaginationMetaDto;
 }
-export type CreateAgentDto = object;
-export type UpdateAgentDto = object;
-export type UpdateAgentStatusDto = object;
-export type SetLimitDto = object;
-export type SetLimitsDto = object;
-export type CreateCommissionDto = object;
-export type UpdateCommissionDto = object;
-export type CreateBranchDto = object;
-export type UpdateBranchDto = object;
-export type UpdateBranchStatusDto = object;
-export type CreateSettlementDto = object;
-export type UpdateSettlementStatusDto = object;
-export type UpdateSettlementAmountsDto = object;
-export type AddAdjustmentDto = object;
+export interface AgentStatisticsDto {
+    /** Total number of agents */
+    totalAgents: number;
+    /** Number of active agents */
+    activeAgents: number;
+    /** Number of suspended agents */
+    suspendedAgents: number;
+    /** Total number of branches across all agents */
+    totalBranches: number;
+}
+export interface AgentLimitResponseDto {
+    /**
+     * Limit ID
+     * @format uuid
+     */
+    id: string;
+    /**
+     * Agent ID
+     * @format uuid
+     */
+    agentId: string;
+    /** Limit type */
+    limitType: "DAILY_AMOUNT" | "DAILY_COUNT" | "SINGLE_TX";
+    /** Currency */
+    currency: "SYP" | "USD" | "EUR";
+    /** Limit amount */
+    amount: string;
+    /** Whether limit is active */
+    isActive: boolean;
+    /**
+     * Created at
+     * @format date-time
+     */
+    createdAt: string;
+    /**
+     * Updated at
+     * @format date-time
+     */
+    updatedAt: string;
+}
+export interface AgentCommissionResponseDto {
+    /**
+     * Commission ID
+     * @format uuid
+     */
+    id: string;
+    /**
+     * Agent ID
+     * @format uuid
+     */
+    agentId: string;
+    /** Commission name */
+    name: string;
+    /** Commission type */
+    commissionType: string;
+    /** Currency */
+    currency: "SYP" | "USD" | "EUR";
+    /** Minimum amount */
+    minAmount: string;
+    /** Maximum amount */
+    maxAmount?: string;
+    /** Commission value */
+    value: string;
+    /** Whether commission is active */
+    isActive: boolean;
+    /**
+     * Created at
+     * @format date-time
+     */
+    createdAt: string;
+    /**
+     * Updated at
+     * @format date-time
+     */
+    updatedAt: string;
+}
+export interface BranchResponseDto {
+    /**
+     * Branch ID
+     * @format uuid
+     */
+    id: string;
+    /**
+     * Agent ID
+     * @format uuid
+     */
+    agentId: string;
+    /** Branch name */
+    name: string;
+    /** Branch code */
+    code: string;
+    /** Branch status */
+    status: "ACTIVE" | "INACTIVE" | "SUSPENDED";
+    /** Address */
+    address: string;
+    /** City */
+    city: string;
+    /** Latitude */
+    latitude: number;
+    /** Longitude */
+    longitude: number;
+    /** Contact phone */
+    contactPhone: string;
+    /** Contact email */
+    contactEmail?: string;
+    /** Whether the branch is active */
+    isActive: boolean;
+    /**
+     * Created at
+     * @format date-time
+     */
+    createdAt: string;
+    /**
+     * Updated at
+     * @format date-time
+     */
+    updatedAt: string;
+}
+export interface AgentResponseDto {
+    /** @format uuid */
+    id: string;
+    type: "MONEY_TRANSFER" | "EXCHANGE_BUREAU" | "BANK";
+    status: "PENDING" | "ACTIVE" | "SUSPENDED" | "TERMINATED";
+    name: string;
+    licenseNumber: string;
+    contactPerson: string;
+    contactEmail: string;
+    contactPhone: string;
+    address: string;
+    city: string;
+    /** @format date-time */
+    createdAt: string;
+    /** @format date-time */
+    updatedAt: string;
+    /** @example 3 */
+    branchCount: number;
+    limits?: AgentLimitResponseDto[];
+    commissions?: AgentCommissionResponseDto[];
+    branches?: BranchResponseDto[];
+}
+export interface AgentListResponseDto {
+    /** List of agents */
+    agents: AgentResponseDto[];
+    /** Total count */
+    total: number;
+    /** Current page */
+    page: number;
+    /** Items per page */
+    limit: number;
+}
+export interface CreateAgentDto {
+    /**
+     * Agent name
+     * @example "Acme Agent"
+     */
+    name: string;
+    /** @example "MONEY_TRANSFER" */
+    type: "MONEY_TRANSFER" | "EXCHANGE_BUREAU" | "BANK";
+    /**
+     * License number
+     * @example "MT-2024-001"
+     */
+    licenseNumber: string;
+    /** @default "ACTIVE" */
+    status?: "PENDING" | "ACTIVE" | "SUSPENDED" | "TERMINATED";
+    /**
+     * Contact person full name
+     * @example "John Doe"
+     */
+    contactPerson: string;
+    /** @example "agent@acme.com" */
+    contactEmail: string;
+    /** @example "+1-800-123-4567" */
+    contactPhone: string;
+    /**
+     * Street address
+     * @example "123 Main St"
+     */
+    address: string;
+    /**
+     * City
+     * @example "Dubai"
+     */
+    city: string;
+}
+export interface CreateAgentResponseDto {
+    /**
+     * Success message
+     * @example "Agent created successfully"
+     */
+    message: string;
+    /**
+     * Created agent ID
+     * @format uuid
+     */
+    id: string;
+    /** Agent name */
+    name: string;
+}
+export interface UpdateAgentDto {
+    /**
+     * Agent name
+     * @example "Acme Agent"
+     */
+    name?: string;
+    /** @example "MONEY_TRANSFER" */
+    type?: "MONEY_TRANSFER" | "EXCHANGE_BUREAU" | "BANK";
+    /**
+     * License number
+     * @example "MT-2024-001"
+     */
+    licenseNumber?: string;
+    /** @default "ACTIVE" */
+    status?: "PENDING" | "ACTIVE" | "SUSPENDED" | "TERMINATED";
+    /**
+     * Contact person full name
+     * @example "John Doe"
+     */
+    contactPerson?: string;
+    /** @example "agent@acme.com" */
+    contactEmail?: string;
+    /** @example "+1-800-123-4567" */
+    contactPhone?: string;
+    /**
+     * Street address
+     * @example "123 Main St"
+     */
+    address?: string;
+    /**
+     * City
+     * @example "Dubai"
+     */
+    city?: string;
+}
+export interface UpdateAgentResponseDto {
+    /**
+     * Success message
+     * @example "Agent created successfully"
+     */
+    message: string;
+    /**
+     * Created agent ID
+     * @format uuid
+     */
+    id: string;
+    /** Agent name */
+    name: string;
+}
+export interface UpsertBranchItemDto {
+    /**
+     * Agent ID (UUID)
+     * @example "9aee8ab4-a692-4814-9a65-d322dc1882a1"
+     */
+    agentId: string;
+    /**
+     * Branch name
+     * @example "Downtown Branch"
+     */
+    name: string;
+    /**
+     * Unique branch code
+     * @example "BR-001"
+     */
+    code: string;
+    /**
+     * Address
+     * @example "123 Main St"
+     */
+    address: string;
+    /**
+     * City
+     * @example "Dubai"
+     */
+    city: string;
+    /**
+     * Latitude
+     * @example 25.276987
+     */
+    latitude?: number;
+    /**
+     * Longitude
+     * @example 55.296249
+     */
+    longitude?: number;
+    /**
+     * Contact phone
+     * @example "+971501234567"
+     */
+    contactPhone: string;
+    /**
+     * Contact email
+     * @example "branch@acme.com"
+     */
+    contactEmail?: string;
+    /**
+     * Whether the branch is active
+     * @default true
+     */
+    isActive?: boolean;
+    /** Branch status */
+    status?: "PENDING" | "ACTIVE" | "SUSPENDED" | "CLOSED";
+    /**
+     * Branch ID — if provided, updates; if omitted, creates
+     * @format uuid
+     */
+    branchId?: string;
+}
+export interface UpsertBranchesDto {
+    branches: UpsertBranchItemDto[];
+}
+export interface BranchesUpsertResponseDto {
+    branches: BranchResponseDto[];
+}
+export interface SetLimitDto {
+    /**
+     * Limit type
+     * @example "DAILY_AMOUNT"
+     */
+    limitType: "DAILY_AMOUNT" | "DAILY_COUNT" | "SINGLE_TX";
+    /**
+     * Currency
+     * @example "USD"
+     */
+    currency: "SYP" | "USD" | "EUR";
+    /**
+     * Limit amount
+     * @example "10000.00"
+     */
+    amount: string;
+    /**
+     * Whether the limit is active
+     * @default true
+     * @example true
+     */
+    isActive?: boolean;
+}
+export interface UpsertLimitsDto {
+    /** Limits to upsert — matched by (limitType, currency) */
+    limits: SetLimitDto[];
+}
+export interface AgentLimitsResponseDto {
+    /** List of agent limits */
+    limits: AgentLimitResponseDto[];
+}
+export interface UpsertCommissionItemDto {
+    /**
+     * Commission name
+     * @example "Standard Transfer"
+     */
+    name: string;
+    /** @example "PERCENTAGE" */
+    commissionType: "PERCENTAGE" | "FIXED";
+    /** @example "USD" */
+    currency: "SYP" | "USD" | "EUR";
+    /**
+     * Minimum amount for this commission tier
+     * @example "0"
+     */
+    minAmount: string;
+    /**
+     * Maximum amount (open-ended if omitted)
+     * @example "10000"
+     */
+    maxAmount?: string;
+    /**
+     * Commission value (percentage or fixed amount)
+     * @example "2.5"
+     */
+    value: string;
+    /**
+     * @default true
+     * @example true
+     */
+    isActive?: boolean;
+    /**
+     * Commission ID — if provided, updates; if omitted, creates
+     * @format uuid
+     */
+    commissionId?: string;
+}
+export interface UpsertCommissionsDto {
+    commissions: UpsertCommissionItemDto[];
+}
+export interface AgentCommissionsResponseDto {
+    /** List of agent commissions */
+    commissions: AgentCommissionResponseDto[];
+}
 export interface KycStatisticsResponseDto {
     /**
      * Total number of KYC requests
@@ -709,6 +1082,186 @@ export interface UpdateKycStatusDto {
      */
     rejectionReason: string;
 }
+export interface UserStatisticsResponseDto {
+    /**
+     * Total number of users
+     * @example 1000
+     */
+    totalUsers: number;
+    /**
+     * Number of active users
+     * @example 750
+     */
+    activeUsers: number;
+    /**
+     * Number of suspended users
+     * @example 50
+     */
+    suspendedUsers: number;
+    /**
+     * Number of users pending KYC
+     * @example 200
+     */
+    pendingKycUsers: number;
+    /**
+     * Number of rejected users
+     * @example 100
+     */
+    rejectedUsers: number;
+    /**
+     * Number of unverified users
+     * @example 100
+     */
+    unverifiedUsers: number;
+}
+export interface UserListQueryDto {
+    /**
+     * Page number (1-based)
+     * @min 1
+     * @default 1
+     * @example 1
+     */
+    page?: number;
+    /**
+     * Number of items per page
+     * @min 1
+     * @max 200
+     * @default 20
+     * @example 20
+     */
+    limit?: number;
+    /**
+     * Field to sort by
+     * @example "createdAt"
+     */
+    sortBy?: string;
+    /**
+     * Sort direction
+     * @default "desc"
+     */
+    sortOrder?: "asc" | "desc";
+    /**
+     * Start date (ISO 8601)
+     * @example "2025-01-01T00:00:00.000Z"
+     */
+    startDate?: string;
+    /**
+     * End date (ISO 8601)
+     * @example "2026-12-31T23:59:59.999Z"
+     */
+    endDate?: string;
+    /**
+     * Filter by person status
+     * @example "verified"
+     */
+    status?: "unverified" | "pending_kyc" | "verified" | "rejected" | "suspended";
+    /**
+     * Search query (name or phone number)
+     * @example "Qusai"
+     */
+    query?: string;
+}
+export interface PersonSummaryDto {
+    /** @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;
+}
+export interface PersonListResponseDto {
+    data: PersonSummaryDto[];
+    meta: PaginationMetaDto;
+}
+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 UpdatePersonStatusDto {
+    /**
+     * New person status
+     * @example "verified"
+     */
+    status: "unverified" | "pending_kyc" | "verified" | "rejected" | "suspended";
+    /**
+     * Reason for status change (e.g. for audit)
+     * @maxLength 500
+     * @example "KYC verified by admin"
+     */
+    reason?: string;
+}
+export interface UpdateUserStatusDto {
+    /**
+     * New user status
+     * @example "active"
+     */
+    status: "pending_phone_verification" | "pending_kyc" | "active" | "suspended" | "blocked" | "closed";
+    /**
+     * Reason for status change (e.g. for audit)
+     * @maxLength 500
+     * @example "Account reactivated per support request"
+     */
+    reason?: string;
+}
 export type LoginData = AdminLoginResponseDto;
 export type LoginError = ErrorResponseDto;
 export type RefreshData = AdminLoginResponseDto;
@@ -918,152 +1471,58 @@ export interface MarkAsReadParams {
 }
 export type MarkAsReadData = AdminNotificationResponseDto;
 export type MarkAllAsReadData = MessageResponseDto;
+export type GetStatisticsData = AgentStatisticsDto;
 export interface ListAgentsParams {
-    type?: string;
-    status?: string;
-    searchTerm?: string;
+    /**
+     * Page number (1-based)
+     * @min 1
+     * @default 1
+     * @example 1
+     */
     page?: number;
+    /**
+     * Number of items per page
+     * @min 1
+     * @max 200
+     * @default 20
+     * @example 20
+     */
     limit?: number;
+    /** Filter by agent type */
+    type?: "MONEY_TRANSFER" | "EXCHANGE_BUREAU" | "BANK";
+    /** Filter by agent status */
+    status?: "PENDING" | "ACTIVE" | "SUSPENDED" | "TERMINATED";
+    /** Search by name, legal name, or registration number */
+    searchTerm?: string;
 }
-export type ListAgentsData = any;
-export type CreateAgentData = any;
+export type ListAgentsData = AgentListResponseDto;
+export type CreateAgentData = CreateAgentResponseDto;
 export interface GetAgentParams {
     /** Agent ID */
     id: string;
 }
-export type GetAgentData = any;
+export type GetAgentData = AgentResponseDto;
 export interface UpdateAgentParams {
-    /** Agent ID */
-    id: string;
-}
-export type UpdateAgentData = any;
-export interface DeleteAgentParams {
-    /** Agent ID */
-    id: string;
-}
-export type DeleteAgentData = any;
-export interface UpdateAgentStatusParams {
-    /** Agent ID */
-    id: string;
-}
-export type UpdateAgentStatusData = any;
-export interface GetAgentLimitsParams {
-    activeOnly?: boolean;
-    /** Agent ID */
-    id: string;
-}
-export type GetAgentLimitsData = any;
-export interface SetAgentLimitParams {
-    /** Agent ID */
+    /** Agent ID (UUID) */
     id: string;
 }
-export type SetAgentLimitData = any;
-export interface SetAgentLimitsParams {
+export type UpdateAgentData = UpdateAgentResponseDto;
+export interface UpsertAgentBranchesParams {
     /** Agent ID */
     id: string;
 }
-export type SetAgentLimitsData = any;
-export interface DeleteAgentLimitParams {
-    /** Limit ID */
-    limitId: string;
-}
-export type DeleteAgentLimitData = any;
-export interface GetAgentCommissionsParams {
-    activeOnly?: boolean;
-    /** Agent ID */
-    id: string;
-}
-export type GetAgentCommissionsData = any;
-export interface CreateAgentCommissionParams {
-    /** Agent ID */
+export type UpsertAgentBranchesData = BranchesUpsertResponseDto;
+export interface UpsertAgentLimitsParams {
+    /** Agent ID (UUID) */
     id: string;
 }
-export type CreateAgentCommissionData = any;
-export interface UpdateAgentCommissionParams {
-    /** Commission ID */
-    commissionId: string;
-}
-export type UpdateAgentCommissionData = any;
-export interface DeleteAgentCommissionParams {
-    /** Commission ID */
-    commissionId: string;
-}
-export type DeleteAgentCommissionData = any;
-export interface CalculateCommissionParams {
+export type UpsertAgentLimitsData = AgentLimitsResponseDto;
+export interface UpsertAgentCommissionsParams {
     /** Agent ID */
     id: string;
 }
-export type CalculateCommissionData = any;
-export interface ListBranchesParams {
-    agentId?: string;
-    city?: string;
-    status?: string;
-    page?: number;
-    limit?: number;
-}
-export type ListBranchesData = any;
-export type CreateBranchData = any;
-export interface GetBranchParams {
-    /** Branch ID */
-    id: string;
-}
-export type GetBranchData = any;
-export interface UpdateBranchParams {
-    /** Branch ID */
-    id: string;
-}
-export type UpdateBranchData = any;
-export interface DeleteBranchParams {
-    /** Branch ID */
-    id: string;
-}
-export type DeleteBranchData = any;
-export interface UpdateBranchStatusParams {
-    /** Branch ID */
-    id: string;
-}
-export type UpdateBranchStatusData = any;
-export interface ListSettlementsParams {
-    branchId?: string;
-    status?: string;
-    startDate?: string;
-    endDate?: string;
-    page?: number;
-    limit?: number;
-}
-export type ListSettlementsData = any;
-export type CreateSettlementData = any;
-export interface GetSettlementParams {
-    /** Settlement ID */
-    id: string;
-}
-export type GetSettlementData = any;
-export interface UpdateSettlementStatusParams {
-    /** Settlement ID */
-    id: string;
-}
-export type UpdateSettlementStatusData = any;
-export interface UpdateSettlementAmountsParams {
-    /** Settlement ID */
-    id: string;
-}
-export type UpdateSettlementAmountsData = any;
-export interface GetSettlementAdjustmentsParams {
-    /** Settlement ID */
-    id: string;
-}
-export type GetSettlementAdjustmentsData = any;
-export interface AddSettlementAdjustmentParams {
-    /** Settlement ID */
-    id: string;
-}
-export type AddSettlementAdjustmentData = any;
-export interface ApproveAdjustmentParams {
-    /** Adjustment ID */
-    adjustmentId: string;
-}
-export type ApproveAdjustmentData = any;
-export type GetStatisticsData = KycStatisticsResponseDto;
+export type UpsertAgentCommissionsData = AgentCommissionsResponseDto;
+export type GetStatisticsResult = KycStatisticsResponseDto;
 export interface FindAllParams10 {
     /**
      * Page number (1-based)
@@ -1102,4 +1561,106 @@ export interface UpdateStatusParams2 {
     id: string;
 }
 export type UpdateStatusResult = KycRequestResponseDto;
+export type GetStatisticsOutput = UserStatisticsResponseDto;
+export interface FindAllParams12 {
+    /**
+     * Page number (1-based)
+     * @min 1
+     * @default 1
+     * @example 1
+     */
+    page?: number;
+    /**
+     * Number of items per page
+     * @min 1
+     * @max 200
+     * @default 20
+     * @example 20
+     */
+    limit?: number;
+    /**
+     * Field to sort by
+     * @example "createdAt"
+     */
+    sortBy?: string;
+    /**
+     * Sort direction
+     * @default "desc"
+     */
+    sortOrder?: "asc" | "desc";
+    /**
+     * Start date (ISO 8601)
+     * @example "2025-01-01T00:00:00.000Z"
+     */
+    startDate?: string;
+    /**
+     * End date (ISO 8601)
+     * @example "2026-12-31T23:59:59.999Z"
+     */
+    endDate?: string;
+    /**
+     * Filter by person status
+     * @example "verified"
+     */
+    status?: "unverified" | "pending_kyc" | "verified" | "rejected" | "suspended";
+    /**
+     * Search query (name or phone number)
+     * @example "Qusai"
+     */
+    query?: string;
+}
+export type FindAllOutput2 = PersonListResponseDto;
+export interface ExportUsersParams {
+    /**
+     * Field to sort by
+     * @example "createdAt"
+     */
+    sortBy?: string;
+    /**
+     * Sort direction
+     * @default "desc"
+     */
+    sortOrder?: "asc" | "desc";
+    /**
+     * Start date (ISO 8601)
+     * @example "2025-01-01T00:00:00.000Z"
+     */
+    startDate?: string;
+    /**
+     * End date (ISO 8601)
+     * @example "2026-12-31T23:59:59.999Z"
+     */
+    endDate?: string;
+    /**
+     * Filter by person status
+     * @example "verified"
+     */
+    status?: "unverified" | "pending_kyc" | "verified" | "rejected" | "suspended";
+    /**
+     * Search query (name or phone number)
+     * @example "Qusai"
+     */
+    query?: string;
+    /**
+     * Export format
+     * @default "csv"
+     */
+    format?: "csv" | "excel" | "pdf" | "print";
+}
+export type ExportUsersData = any;
+export interface FindByIdParams8 {
+    /** Person ID (UUID) */
+    id: string;
+}
+export type FindByIdOutput2 = PersonDetailDto;
+export interface UpdatePersonStatusParams {
+    /** Person ID (UUID) */
+    id: string;
+}
+export type UpdatePersonStatusData = PersonDetailDto;
+export interface UpdateUserStatusParams {
+    /** User ID (UUID) */
+    id: string;
+}
+export type UpdateUserStatusData = any;
 //# sourceMappingURL=data-contracts.d.ts.map