@temboplus/afloat 0.1.77-beta.9 → 0.1.79

package/dist/modules/payout/payout.dtos.d.ts

@@ -1,605 +0,0 @@
-import { z } from "zod";
-/**
- * Represents the available channels through which payouts can be processed.
- * @enum {string}
- * @readonly
- */
-export declare enum PayoutChannel {
-    /** Payment processed through mobile money services */
-    MOBILE = "Mobile",
-    /** Payment processed through traditional banking channels */
-    BANK = "Bank"
-}
-/**
- * Represents the current status of a payout transaction.
- * @enum {string}
- * @readonly
- */
-export declare enum PayoutStatus {
-    /** Payout has been initially created but not yet processed */
-    CREATED = "CREATED",
-    /** Payout is awaiting processing */
-    PENDING = "PENDING",
-    /** Payout has been successfully processed */
-    PAID = "PAID",
-    /** Payout processing has failed */
-    FAILED = "FAILED",
-    /** Payout has been rejected */
-    REJECTED = "REJECTED",
-    /** Payout has been reversed */
-    REVERSED = "REVERSED"
-}
-/**
- * Represents the approval status for payouts that require authorization.
- * @enum {string}
- * @readonly
- */
-export declare enum PayoutApprovalStatus {
-    /** Payout is awaiting approval decision */
-    PENDING = "Pending",
-    /** Payout has been approved */
-    APPROVED = "Approved",
-    /** Payout has been rejected during approval process */
-    REJECTED = "Rejected"
-}
-/**
- * Schema for identifying users in the payout process
- * Used to track who created or actioned a payout
- */
-declare const AuthorizerSchema: z.ZodObject<{
-    id: z.ZodString;
-    name: z.ZodString;
-    identity: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    name: string;
-    id: string;
-    identity: string;
-}, {
-    name: string;
-    id: string;
-    identity: string;
-}>;
-/**
- * Schema for creating a new payout
- * Extends base payout schema with payee information
- */
-declare const PayoutInputDTOSchema: z.ZodObject<{
-    channel: z.ZodString;
-    msisdn: z.ZodString;
-    amount: z.ZodNumber;
-    description: z.ZodString;
-    notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-} & {
-    payeeName: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    description: string;
-    channel: string;
-    msisdn: string;
-    amount: number;
-    payeeName: string;
-    notes?: string | null | undefined;
-}, {
-    description: string;
-    channel: string;
-    msisdn: string;
-    amount: number;
-    payeeName: string;
-    notes?: string | null | undefined;
-}>;
-/**
- * Schema for complete payout record
- * Extends base payout schema with additional fields for:
- * - Identification (id, profileId)
- * - Status tracking
- * - Timestamps
- * - Approval information
- * - User tracking (created by, actioned by)
- */
-declare const PayoutDTOSchema: z.ZodObject<{
-    msisdn: z.ZodString;
-    amount: z.ZodNumber;
-    description: z.ZodString;
-    notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-} & {
-    id: z.ZodString;
-    profileId: z.ZodString;
-    payeeName: z.ZodString;
-    countryCode: z.ZodEffects<z.ZodDefault<z.ZodString>, import("@temboplus/frontend-core").ISO2CountryCode, string | undefined>;
-    currencyCode: z.ZodEffects<z.ZodDefault<z.ZodString>, import("@temboplus/frontend-core").CurrencyCode, string | undefined>;
-    channel: z.ZodString;
-    status: z.ZodNativeEnum<typeof PayoutStatus>;
-    statusMessage: z.ZodString;
-    partnerReference: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    createdAt: z.ZodDate;
-    updatedAt: z.ZodDate;
-    actionedAt: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
-    approvalStatus: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof PayoutApprovalStatus>>>;
-    createdBy: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-        id: z.ZodString;
-        name: z.ZodString;
-        identity: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        name: string;
-        id: string;
-        identity: string;
-    }, {
-        name: string;
-        id: string;
-        identity: string;
-    }>>>;
-    actionedBy: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-        id: z.ZodString;
-        name: z.ZodString;
-        identity: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        name: string;
-        id: string;
-        identity: string;
-    }, {
-        name: string;
-        id: string;
-        identity: string;
-    }>>>;
-}, "strip", z.ZodTypeAny, {
-    status: PayoutStatus;
-    id: string;
-    profileId: string;
-    createdAt: Date;
-    updatedAt: Date;
-    description: string;
-    channel: string;
-    countryCode: import("@temboplus/frontend-core").ISO2CountryCode;
-    currencyCode: import("@temboplus/frontend-core").CurrencyCode;
-    msisdn: string;
-    amount: number;
-    payeeName: string;
-    statusMessage: string;
-    notes?: string | null | undefined;
-    partnerReference?: string | null | undefined;
-    actionedAt?: Date | null | undefined;
-    approvalStatus?: PayoutApprovalStatus | null | undefined;
-    createdBy?: {
-        name: string;
-        id: string;
-        identity: string;
-    } | null | undefined;
-    actionedBy?: {
-        name: string;
-        id: string;
-        identity: string;
-    } | null | undefined;
-}, {
-    status: PayoutStatus;
-    id: string;
-    profileId: string;
-    createdAt: Date;
-    updatedAt: Date;
-    description: string;
-    channel: string;
-    msisdn: string;
-    amount: number;
-    payeeName: string;
-    statusMessage: string;
-    countryCode?: string | undefined;
-    currencyCode?: string | undefined;
-    notes?: string | null | undefined;
-    partnerReference?: string | null | undefined;
-    actionedAt?: Date | null | undefined;
-    approvalStatus?: PayoutApprovalStatus | null | undefined;
-    createdBy?: {
-        name: string;
-        id: string;
-        identity: string;
-    } | null | undefined;
-    actionedBy?: {
-        name: string;
-        id: string;
-        identity: string;
-    } | null | undefined;
-}>;
-/**
- * Lightweight filters interface for payout queries
- */
-declare const PayoutFiltersSchema: z.ZodObject<{
-    page: z.ZodDefault<z.ZodNumber>;
-    limit: z.ZodDefault<z.ZodNumber>;
-    sortBy: z.ZodDefault<z.ZodString>;
-    sortOrder: z.ZodDefault<z.ZodEnum<["asc", "desc"]>>;
-    startDate: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    endDate: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    payeeName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    msisdn: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    profileId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    partnerReference: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    channel: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    currencyCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    status: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof PayoutStatus>>>;
-    approvalStatus: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof PayoutApprovalStatus>>>;
-    minAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
-    maxAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
-    search: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-}, "strip", z.ZodTypeAny, {
-    page: number;
-    limit: number;
-    sortBy: string;
-    sortOrder: "asc" | "desc";
-    status?: PayoutStatus | null | undefined;
-    id?: string | null | undefined;
-    profileId?: string | null | undefined;
-    search?: string | null | undefined;
-    startDate?: string | null | undefined;
-    endDate?: string | null | undefined;
-    channel?: string | null | undefined;
-    currencyCode?: string | null | undefined;
-    msisdn?: string | null | undefined;
-    payeeName?: string | null | undefined;
-    partnerReference?: string | null | undefined;
-    approvalStatus?: PayoutApprovalStatus | null | undefined;
-    minAmount?: number | null | undefined;
-    maxAmount?: number | null | undefined;
-}, {
-    status?: PayoutStatus | null | undefined;
-    id?: string | null | undefined;
-    profileId?: string | null | undefined;
-    search?: string | null | undefined;
-    startDate?: string | null | undefined;
-    endDate?: string | null | undefined;
-    page?: number | undefined;
-    limit?: number | undefined;
-    channel?: string | null | undefined;
-    currencyCode?: string | null | undefined;
-    msisdn?: string | null | undefined;
-    payeeName?: string | null | undefined;
-    partnerReference?: string | null | undefined;
-    approvalStatus?: PayoutApprovalStatus | null | undefined;
-    sortBy?: string | undefined;
-    sortOrder?: "asc" | "desc" | undefined;
-    minAmount?: number | null | undefined;
-    maxAmount?: number | null | undefined;
-}>;
-/**
- * URL-safe schema for query parameters (all strings)
- */
-declare const PayoutURLQueryParamsSchema: z.ZodObject<{
-    page: z.ZodOptional<z.ZodEffects<z.ZodString, number, string>>;
-    limit: z.ZodOptional<z.ZodEffects<z.ZodString, number, string>>;
-    sortBy: z.ZodDefault<z.ZodString>;
-    sortOrder: z.ZodDefault<z.ZodEnum<["asc", "desc"]>>;
-    startDate: z.ZodOptional<z.ZodString>;
-    endDate: z.ZodOptional<z.ZodString>;
-    payeeName: z.ZodOptional<z.ZodString>;
-    msisdn: z.ZodOptional<z.ZodString>;
-    profileId: z.ZodOptional<z.ZodString>;
-    id: z.ZodOptional<z.ZodString>;
-    partnerReference: z.ZodOptional<z.ZodString>;
-    channel: z.ZodOptional<z.ZodString>;
-    status: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, PayoutStatus, string>>;
-    approvalStatus: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, PayoutApprovalStatus, string>>;
-    minAmount: z.ZodOptional<z.ZodEffects<z.ZodString, number, string>>;
-    maxAmount: z.ZodOptional<z.ZodEffects<z.ZodString, number, string>>;
-    search: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    sortBy: string;
-    sortOrder: "asc" | "desc";
-    status?: PayoutStatus | undefined;
-    id?: string | undefined;
-    profileId?: string | undefined;
-    search?: string | undefined;
-    startDate?: string | undefined;
-    endDate?: string | undefined;
-    page?: number | undefined;
-    limit?: number | undefined;
-    channel?: string | undefined;
-    msisdn?: string | undefined;
-    payeeName?: string | undefined;
-    partnerReference?: string | undefined;
-    approvalStatus?: PayoutApprovalStatus | undefined;
-    minAmount?: number | undefined;
-    maxAmount?: number | undefined;
-}, {
-    status?: string | undefined;
-    id?: string | undefined;
-    profileId?: string | undefined;
-    search?: string | undefined;
-    startDate?: string | undefined;
-    endDate?: string | undefined;
-    page?: string | undefined;
-    limit?: string | undefined;
-    channel?: string | undefined;
-    msisdn?: string | undefined;
-    payeeName?: string | undefined;
-    partnerReference?: string | undefined;
-    approvalStatus?: string | undefined;
-    sortBy?: string | undefined;
-    sortOrder?: "asc" | "desc" | undefined;
-    minAmount?: string | undefined;
-    maxAmount?: string | undefined;
-}>;
-/**
- * Type definition inferred from AuthorizerSchema
- * Represents the structure of a user who actions the payout
- */
-type PayoutAuthorizerDTO = z.infer<typeof AuthorizerSchema>;
-/**
- * Type definition inferred from PayoutInputDTOSchema
- * Represents the structure of data required to create a new payout
- */
-type PayoutInputDTO = z.infer<typeof PayoutInputDTOSchema>;
-/**
- * Type definition inferred from PayoutDTOSchema
- * Represents the complete payout record structure
- */
-type PayoutDTO = z.infer<typeof PayoutDTOSchema>;
-/**
- * Type definition for payout filters
- */
-type PayoutFilters = z.infer<typeof PayoutFiltersSchema>;
-/**
- * Type definition for URL query parameters
- */
-type PayoutURLQueryParams = z.infer<typeof PayoutURLQueryParamsSchema>;
-/**
- * Export object containing all payout-related schemas
- * Used for validation and type checking throughout the application
- */
-export declare const PayoutDTOSchemas: {
-    readonly PayoutDTO: z.ZodObject<{
-        msisdn: z.ZodString;
-        amount: z.ZodNumber;
-        description: z.ZodString;
-        notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    } & {
-        id: z.ZodString;
-        profileId: z.ZodString;
-        payeeName: z.ZodString;
-        countryCode: z.ZodEffects<z.ZodDefault<z.ZodString>, import("@temboplus/frontend-core").ISO2CountryCode, string | undefined>;
-        currencyCode: z.ZodEffects<z.ZodDefault<z.ZodString>, import("@temboplus/frontend-core").CurrencyCode, string | undefined>;
-        channel: z.ZodString;
-        status: z.ZodNativeEnum<typeof PayoutStatus>;
-        statusMessage: z.ZodString;
-        partnerReference: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        createdAt: z.ZodDate;
-        updatedAt: z.ZodDate;
-        actionedAt: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
-        approvalStatus: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof PayoutApprovalStatus>>>;
-        createdBy: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-            id: z.ZodString;
-            name: z.ZodString;
-            identity: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            name: string;
-            id: string;
-            identity: string;
-        }, {
-            name: string;
-            id: string;
-            identity: string;
-        }>>>;
-        actionedBy: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-            id: z.ZodString;
-            name: z.ZodString;
-            identity: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            name: string;
-            id: string;
-            identity: string;
-        }, {
-            name: string;
-            id: string;
-            identity: string;
-        }>>>;
-    }, "strip", z.ZodTypeAny, {
-        status: PayoutStatus;
-        id: string;
-        profileId: string;
-        createdAt: Date;
-        updatedAt: Date;
-        description: string;
-        channel: string;
-        countryCode: import("@temboplus/frontend-core").ISO2CountryCode;
-        currencyCode: import("@temboplus/frontend-core").CurrencyCode;
-        msisdn: string;
-        amount: number;
-        payeeName: string;
-        statusMessage: string;
-        notes?: string | null | undefined;
-        partnerReference?: string | null | undefined;
-        actionedAt?: Date | null | undefined;
-        approvalStatus?: PayoutApprovalStatus | null | undefined;
-        createdBy?: {
-            name: string;
-            id: string;
-            identity: string;
-        } | null | undefined;
-        actionedBy?: {
-            name: string;
-            id: string;
-            identity: string;
-        } | null | undefined;
-    }, {
-        status: PayoutStatus;
-        id: string;
-        profileId: string;
-        createdAt: Date;
-        updatedAt: Date;
-        description: string;
-        channel: string;
-        msisdn: string;
-        amount: number;
-        payeeName: string;
-        statusMessage: string;
-        countryCode?: string | undefined;
-        currencyCode?: string | undefined;
-        notes?: string | null | undefined;
-        partnerReference?: string | null | undefined;
-        actionedAt?: Date | null | undefined;
-        approvalStatus?: PayoutApprovalStatus | null | undefined;
-        createdBy?: {
-            name: string;
-            id: string;
-            identity: string;
-        } | null | undefined;
-        actionedBy?: {
-            name: string;
-            id: string;
-            identity: string;
-        } | null | undefined;
-    }>;
-    readonly PayoutInputDTO: z.ZodObject<{
-        channel: z.ZodString;
-        msisdn: z.ZodString;
-        amount: z.ZodNumber;
-        description: z.ZodString;
-        notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    } & {
-        payeeName: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        description: string;
-        channel: string;
-        msisdn: string;
-        amount: number;
-        payeeName: string;
-        notes?: string | null | undefined;
-    }, {
-        description: string;
-        channel: string;
-        msisdn: string;
-        amount: number;
-        payeeName: string;
-        notes?: string | null | undefined;
-    }>;
-    readonly PayoutStatus: z.ZodNativeEnum<typeof PayoutStatus>;
-    readonly PayoutApprovalStatus: z.ZodNativeEnum<typeof PayoutApprovalStatus>;
-    readonly PayoutAuthorizer: z.ZodObject<{
-        id: z.ZodString;
-        name: z.ZodString;
-        identity: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        name: string;
-        id: string;
-        identity: string;
-    }, {
-        name: string;
-        id: string;
-        identity: string;
-    }>;
-    readonly PayoutFilters: z.ZodObject<{
-        page: z.ZodDefault<z.ZodNumber>;
-        limit: z.ZodDefault<z.ZodNumber>;
-        sortBy: z.ZodDefault<z.ZodString>;
-        sortOrder: z.ZodDefault<z.ZodEnum<["asc", "desc"]>>;
-        startDate: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        endDate: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        payeeName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        msisdn: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        profileId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        partnerReference: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        channel: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        currencyCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-        status: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof PayoutStatus>>>;
-        approvalStatus: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof PayoutApprovalStatus>>>;
-        minAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
-        maxAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
-        search: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    }, "strip", z.ZodTypeAny, {
-        page: number;
-        limit: number;
-        sortBy: string;
-        sortOrder: "asc" | "desc";
-        status?: PayoutStatus | null | undefined;
-        id?: string | null | undefined;
-        profileId?: string | null | undefined;
-        search?: string | null | undefined;
-        startDate?: string | null | undefined;
-        endDate?: string | null | undefined;
-        channel?: string | null | undefined;
-        currencyCode?: string | null | undefined;
-        msisdn?: string | null | undefined;
-        payeeName?: string | null | undefined;
-        partnerReference?: string | null | undefined;
-        approvalStatus?: PayoutApprovalStatus | null | undefined;
-        minAmount?: number | null | undefined;
-        maxAmount?: number | null | undefined;
-    }, {
-        status?: PayoutStatus | null | undefined;
-        id?: string | null | undefined;
-        profileId?: string | null | undefined;
-        search?: string | null | undefined;
-        startDate?: string | null | undefined;
-        endDate?: string | null | undefined;
-        page?: number | undefined;
-        limit?: number | undefined;
-        channel?: string | null | undefined;
-        currencyCode?: string | null | undefined;
-        msisdn?: string | null | undefined;
-        payeeName?: string | null | undefined;
-        partnerReference?: string | null | undefined;
-        approvalStatus?: PayoutApprovalStatus | null | undefined;
-        sortBy?: string | undefined;
-        sortOrder?: "asc" | "desc" | undefined;
-        minAmount?: number | null | undefined;
-        maxAmount?: number | null | undefined;
-    }>;
-    readonly PayoutURLQueryParams: z.ZodObject<{
-        page: z.ZodOptional<z.ZodEffects<z.ZodString, number, string>>;
-        limit: z.ZodOptional<z.ZodEffects<z.ZodString, number, string>>;
-        sortBy: z.ZodDefault<z.ZodString>;
-        sortOrder: z.ZodDefault<z.ZodEnum<["asc", "desc"]>>;
-        startDate: z.ZodOptional<z.ZodString>;
-        endDate: z.ZodOptional<z.ZodString>;
-        payeeName: z.ZodOptional<z.ZodString>;
-        msisdn: z.ZodOptional<z.ZodString>;
-        profileId: z.ZodOptional<z.ZodString>;
-        id: z.ZodOptional<z.ZodString>;
-        partnerReference: z.ZodOptional<z.ZodString>;
-        channel: z.ZodOptional<z.ZodString>;
-        status: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, PayoutStatus, string>>;
-        approvalStatus: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, PayoutApprovalStatus, string>>;
-        minAmount: z.ZodOptional<z.ZodEffects<z.ZodString, number, string>>;
-        maxAmount: z.ZodOptional<z.ZodEffects<z.ZodString, number, string>>;
-        search: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        sortBy: string;
-        sortOrder: "asc" | "desc";
-        status?: PayoutStatus | undefined;
-        id?: string | undefined;
-        profileId?: string | undefined;
-        search?: string | undefined;
-        startDate?: string | undefined;
-        endDate?: string | undefined;
-        page?: number | undefined;
-        limit?: number | undefined;
-        channel?: string | undefined;
-        msisdn?: string | undefined;
-        payeeName?: string | undefined;
-        partnerReference?: string | undefined;
-        approvalStatus?: PayoutApprovalStatus | undefined;
-        minAmount?: number | undefined;
-        maxAmount?: number | undefined;
-    }, {
-        status?: string | undefined;
-        id?: string | undefined;
-        profileId?: string | undefined;
-        search?: string | undefined;
-        startDate?: string | undefined;
-        endDate?: string | undefined;
-        page?: string | undefined;
-        limit?: string | undefined;
-        channel?: string | undefined;
-        msisdn?: string | undefined;
-        payeeName?: string | undefined;
-        partnerReference?: string | undefined;
-        approvalStatus?: string | undefined;
-        sortBy?: string | undefined;
-        sortOrder?: "asc" | "desc" | undefined;
-        minAmount?: string | undefined;
-        maxAmount?: string | undefined;
-    }>;
-};
-/**
- * Export types for use in other parts of the application
- * These types can be used for type checking and documentation
- */
-export type { PayoutAuthorizerDTO as PayoutAuthorizer, PayoutDTO, PayoutInputDTO, PayoutFilters, PayoutURLQueryParams, };