import * as z from "zod/v3"; import { ClosedEnum } from "../../types/enums.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; /** * Filter the list of payouts by their corresponding status. */ export declare const ListPayoutsQueryParamStatus: { readonly Pending: "pending"; readonly Processing: "processing"; readonly Processed: "processed"; readonly Sent: "sent"; readonly Completed: "completed"; readonly Failed: "failed"; readonly Canceled: "canceled"; }; /** * Filter the list of payouts by their corresponding status. */ export type ListPayoutsQueryParamStatus = ClosedEnum; /** * The field to sort the list of payouts by. */ export declare const ListPayoutsQueryParamSortBy: { readonly Amount: "amount"; readonly InitiatedAt: "initiatedAt"; readonly PaidAt: "paidAt"; }; /** * The field to sort the list of payouts by. */ export type ListPayoutsQueryParamSortBy = ClosedEnum; /** * The sort order for the list of payouts. */ export declare const ListPayoutsQueryParamSortOrder: { readonly Asc: "asc"; readonly Desc: "desc"; }; /** * The sort order for the list of payouts. */ export type ListPayoutsQueryParamSortOrder = ClosedEnum; export type ListPayoutsRequest = { /** * Filter the list of payouts by their corresponding status. */ status?: ListPayoutsQueryParamStatus | undefined; /** * Filter the list of payouts by the associated partner. When specified, takes precedence over `tenantId`. */ partnerId?: string | undefined; /** * Filter the list of payouts by the associated partner's `tenantId` (their unique ID within your database). */ tenantId?: string | undefined; /** * Filter the list of payouts by invoice ID (the unique ID of the invoice you receive for each batch payout you process on Dub). Pending payouts will not have an invoice ID. */ invoiceId?: string | undefined; /** * The field to sort the list of payouts by. */ sortBy?: ListPayoutsQueryParamSortBy | undefined; /** * The sort order for the list of payouts. */ sortOrder?: ListPayoutsQueryParamSortOrder | undefined; /** * The page number for pagination. */ page?: number | undefined; /** * The number of items per page. */ pageSize?: number | undefined; }; export declare const ListPayoutsStatus: { readonly Pending: "pending"; readonly Processing: "processing"; readonly Processed: "processed"; readonly Sent: "sent"; readonly Completed: "completed"; readonly Failed: "failed"; readonly Canceled: "canceled"; }; export type ListPayoutsStatus = ClosedEnum; export declare const ListPayoutsMode: { readonly Internal: "internal"; readonly External: "external"; }; export type ListPayoutsMode = ClosedEnum; export declare const Method: { readonly Connect: "connect"; readonly Stablecoin: "stablecoin"; readonly Paypal: "paypal"; }; export type Method = ClosedEnum; /** * The partner's default payout method. Connect: Bank account payouts via Stripe Connect; Stablecoin: USDC payouts directly to a crypto wallet; PayPal: Payouts via PayPal */ export declare const ListPayoutsDefaultPayoutMethod: { readonly Connect: "connect"; readonly Stablecoin: "stablecoin"; readonly Paypal: "paypal"; }; /** * The partner's default payout method. Connect: Bank account payouts via Stripe Connect; Stablecoin: USDC payouts directly to a crypto wallet; PayPal: Payouts via PayPal */ export type ListPayoutsDefaultPayoutMethod = ClosedEnum; export type ListPayoutsPartner = { /** * The partner's unique ID on Dub. */ id: string; /** * The partner's full legal name. */ name: string; /** * The partner's email address. Should be a unique value across Dub. */ email: string | null; /** * The partner's avatar image. */ image: string | null; /** * The partner's default payout method. Connect: Bank account payouts via Stripe Connect; Stablecoin: USDC payouts directly to a crypto wallet; PayPal: Payouts via PayPal */ defaultPayoutMethod: ListPayoutsDefaultPayoutMethod | null; /** * The date when the partner enabled payouts. */ payoutsEnabledAt: string | null; /** * The partner's country (required for tax purposes). */ country: string | null; /** * The partner's group ID on Dub. */ groupId?: string | null | undefined; /** * The partner's unique ID within your database. Can be useful for associating the partner with a user in your database and retrieving/update their data in the future. */ tenantId: string | null; }; export type User = { id: string; name: string | null; email: string | null; image: string | null; }; export type ListPayoutsResponseBody = { id: string; invoiceId: string | null; amount: number; currency: string; status: ListPayoutsStatus; description?: string | null | undefined; periodStart: string | null; periodEnd: string | null; createdAt: string; updatedAt?: string | undefined; initiatedAt: string | null; paidAt: string | null; failureReason?: string | null | undefined; mode: ListPayoutsMode | null; method: Method | null; traceId?: string | null | undefined; partner: ListPayoutsPartner; user?: User | null | undefined; }; /** @internal */ export declare const ListPayoutsQueryParamStatus$outboundSchema: z.ZodNativeEnum; /** @internal */ export declare const ListPayoutsQueryParamSortBy$outboundSchema: z.ZodNativeEnum; /** @internal */ export declare const ListPayoutsQueryParamSortOrder$outboundSchema: z.ZodNativeEnum; /** @internal */ export type ListPayoutsRequest$Outbound = { status?: string | undefined; partnerId?: string | undefined; tenantId?: string | undefined; invoiceId?: string | undefined; sortBy: string; sortOrder: string; page?: number | undefined; pageSize: number; }; /** @internal */ export declare const ListPayoutsRequest$outboundSchema: z.ZodType; export declare function listPayoutsRequestToJSON(listPayoutsRequest: ListPayoutsRequest): string; /** @internal */ export declare const ListPayoutsStatus$inboundSchema: z.ZodNativeEnum; /** @internal */ export declare const ListPayoutsMode$inboundSchema: z.ZodNativeEnum; /** @internal */ export declare const Method$inboundSchema: z.ZodNativeEnum; /** @internal */ export declare const ListPayoutsDefaultPayoutMethod$inboundSchema: z.ZodNativeEnum; /** @internal */ export declare const ListPayoutsPartner$inboundSchema: z.ZodType; export declare function listPayoutsPartnerFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const User$inboundSchema: z.ZodType; export declare function userFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const ListPayoutsResponseBody$inboundSchema: z.ZodType; export declare function listPayoutsResponseBodyFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=listpayouts.d.ts.map