@osise/api-client 0.0.1 → 0.0.2

package/dist/types/types/admin-payout.d.ts

@@ -0,0 +1,180 @@
+/**
+ * Admin Payout Types
+ * Types for managing artisan payouts (admin operations)
+ */
+import { PayoutStatus } from './enums';
+import { PaginationParams, DateRange } from './common';
+/** Process weekly payouts request */
+export interface ProcessWeeklyPayoutsDto {
+    /** Period start date (defaults to last week's Monday) */
+    periodStart?: string;
+    /** Period end date (defaults to last week's Sunday) */
+    periodEnd?: string;
+    /** Specific artisan IDs to process (optional, processes all if not provided) */
+    artisanIds?: string[];
+    /** Whether to actually process or just preview */
+    dryRun?: boolean;
+}
+/** Weekly payout processing response */
+export interface WeeklyPayoutResultDto {
+    periodStart: string;
+    periodEnd: string;
+    processedAt: string;
+    isDryRun: boolean;
+    totalArtisans: number;
+    totalPayouts: number;
+    totalAmount: number;
+    totalFees: number;
+    currency: string;
+    successCount: number;
+    failedCount: number;
+    skippedCount: number;
+    payouts: PayoutResultItemDto[];
+    errors: PayoutErrorDto[];
+}
+/** Individual payout result */
+export interface PayoutResultItemDto {
+    payoutId: string;
+    artisanId: string;
+    artisanName: string;
+    bankName: string;
+    accountNumberMask: string;
+    grossAmount: number;
+    fees: number;
+    netAmount: number;
+    jobCount: number;
+    status: PayoutStatus;
+    paystackTransferCode?: string;
+    message?: string;
+}
+/** Payout error */
+export interface PayoutErrorDto {
+    artisanId: string;
+    artisanName: string;
+    errorCode: string;
+    errorMessage: string;
+    retryable: boolean;
+}
+/** Pending payout summary */
+export interface PendingPayoutDto {
+    artisanId: string;
+    artisanName: string;
+    artisanPhone: string;
+    bankName: string;
+    accountNumberMask: string;
+    accountName: string;
+    pendingAmount: number;
+    pendingJobCount: number;
+    oldestJobDate: string;
+    currency: string;
+    isBankVerified: boolean;
+    canProcess: boolean;
+    blockingReason?: string;
+}
+/** Pending payouts filter */
+export interface PendingPayoutsFilterDto extends PaginationParams {
+    minAmount?: number;
+    artisanId?: string;
+    canProcessOnly?: boolean;
+}
+/** Pending payouts response */
+export interface PendingPayoutsResponseDto {
+    totalArtisans: number;
+    totalPendingAmount: number;
+    processableArtisans: number;
+    processableAmount: number;
+    currency: string;
+    payouts: PendingPayoutDto[];
+}
+/** Payout list item (history) */
+export interface AdminPayoutListItemDto {
+    id: string;
+    reference: string;
+    artisanId: string;
+    artisanName: string;
+    periodStart: string;
+    periodEnd: string;
+    grossAmount: number;
+    fees: number;
+    netAmount: number;
+    jobCount: number;
+    status: PayoutStatus;
+    processedAt?: string;
+    completedAt?: string;
+    failedAt?: string;
+    createdAt: string;
+}
+/** Payout detail (admin) */
+export interface AdminPayoutDetailDto {
+    id: string;
+    reference: string;
+    status: PayoutStatus;
+    artisanId: string;
+    artisanName: string;
+    artisanPhone: string;
+    bankName: string;
+    bankCode: string;
+    accountNumber: string;
+    accountName: string;
+    periodStart: string;
+    periodEnd: string;
+    grossAmount: number;
+    fees: number;
+    netAmount: number;
+    currency: string;
+    jobCount: number;
+    jobs: PayoutJobDto[];
+    paystackTransferCode?: string;
+    paystackRecipientCode?: string;
+    paystackTransferStatus?: string;
+    processedAt?: string;
+    completedAt?: string;
+    failedAt?: string;
+    failureReason?: string;
+    retryCount: number;
+    lastRetryAt?: string;
+    createdAt: string;
+    updatedAt: string;
+    canRetry: boolean;
+    canReverse: boolean;
+}
+/** Job included in payout */
+export interface PayoutJobDto {
+    jobId: string;
+    jobReference: string;
+    title: string;
+    serviceCategory: string;
+    completedAt: string;
+    laborAmount: number;
+    materialsAmount: number;
+    tipAmount: number;
+    grossAmount: number;
+    commission: number;
+    netAmount: number;
+    consumerName: string;
+}
+/** Retry failed payout request */
+export interface RetryPayoutDto {
+    /** Override bank account ID if needed */
+    bankAccountId?: string;
+    /** Force retry even if max retries reached */
+    force?: boolean;
+}
+/** Retry payout response */
+export interface PayoutRetryResultDto {
+    payoutId: string;
+    reference: string;
+    status: PayoutStatus;
+    retryCount: number;
+    message: string;
+    paystackTransferCode?: string;
+    retriedAt: string;
+}
+/** Payout history filter */
+export interface PayoutHistoryFilterDto extends PaginationParams, DateRange {
+    artisanId?: string;
+    status?: PayoutStatus | PayoutStatus[];
+    minAmount?: number;
+    maxAmount?: number;
+}
+//# sourceMappingURL=admin-payout.d.ts.map

package/dist/types/types/admin-payout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin-payout.d.ts","sourceRoot":"","sources":["../../../src/types/admin-payout.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAIvD,qCAAqC;AACrC,MAAM,WAAW,uBAAuB;IACtC,yDAAyD;IACzD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uDAAuD;IACvD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gFAAgF;IAChF,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,kDAAkD;IAClD,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,wCAAwC;AACxC,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAElB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IAEjB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IAErB,OAAO,EAAE,mBAAmB,EAAE,CAAC;IAC/B,MAAM,EAAE,cAAc,EAAE,CAAC;CAC1B;AAED,+BAA+B;AAC/B,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,mBAAmB;AACnB,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;CACpB;AAID,6BAA6B;AAC7B,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IAEpB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IAEjB,cAAc,EAAE,OAAO,CAAC;IACxB,UAAU,EAAE,OAAO,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,6BAA6B;AAC7B,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,+BAA+B;AAC/B,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,gBAAgB,EAAE,CAAC;CAC7B;AAID,iCAAiC;AACjC,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,4BAA4B;AAC5B,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,YAAY,CAAC;IAErB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IAErB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IAEpB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IAEjB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,YAAY,EAAE,CAAC;IAErB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAElB,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,6BAA6B;AAC7B,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;CACtB;AAID,kCAAkC;AAClC,MAAM,WAAW,cAAc;IAC7B,yCAAyC;IACzC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,4BAA4B;AAC5B,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,YAAY,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;CACnB;AAID,4BAA4B;AAC5B,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB,EAAE,SAAS;IACzE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,YAAY,GAAG,YAAY,EAAE,CAAC;IACvC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}