/** * Generated `ComponentApi` utility. * * THIS CODE IS AUTOMATICALLY GENERATED. * * To regenerate, run `npx convex dev`. * @module */ import type { FunctionReference } from "convex/server"; /** * A utility for referencing a Convex component's exposed API. * * Useful when expecting a parameter like `components.myComponent`. * Usage: * ```ts * async function myFunction(ctx: QueryCtx, component: ComponentApi) { * return ctx.runQuery(component.someFile.someQuery, { ...args }); * } * ``` */ export type ComponentApi = { lib: { cancelEmail: FunctionReference<"mutation", "internal", { emailId: string; }, null, Name>; cleanupAbandonedEmails: FunctionReference<"mutation", "internal", { olderThan?: number; }, null, Name>; cleanupOldEmails: FunctionReference<"mutation", "internal", { olderThan?: number; }, null, Name>; createManualEmail: FunctionReference<"mutation", "internal", { bcc?: Array | string; cc?: Array | string; from: string; headers?: Array<{ name: string; value: string; }>; replyTo?: Array; subject: string; to: Array | string; }, string, Name>; get: FunctionReference<"query", "internal", { emailId: string; }, { bcc?: Array; bounced?: boolean; cc?: Array; clicked?: boolean; complained: boolean; createdAt: number; deliveryDelayed?: boolean; errorMessage?: string; failed?: boolean; finalizedAt: number; from: string; headers?: Array<{ name: string; value: string; }>; html?: string; opened: boolean; replyTo: Array; resendId?: string; segment: number; status: "waiting" | "queued" | "cancelled" | "sent" | "delivered" | "delivery_delayed" | "bounced" | "failed"; subject?: string; template?: { id: string; variables?: Record; }; text?: string; to: Array; } | null, Name>; getStatus: FunctionReference<"query", "internal", { emailId: string; }, { bounced: boolean; clicked: boolean; complained: boolean; deliveryDelayed: boolean; errorMessage: string | null; failed: boolean; opened: boolean; status: "waiting" | "queued" | "cancelled" | "sent" | "delivered" | "delivery_delayed" | "bounced" | "failed"; } | null, Name>; handleEmailEvent: FunctionReference<"mutation", "internal", { event: any; }, null, Name>; sendEmail: FunctionReference<"mutation", "internal", { bcc?: Array; cc?: Array; from: string; headers?: Array<{ name: string; value: string; }>; html?: string; options: { apiKey: string; initialBackoffMs: number; onEmailEvent?: { fnHandle: string; }; retryAttempts: number; testMode: boolean; }; replyTo?: Array; subject?: string; template?: { id: string; variables?: Record; }; text?: string; to: Array; }, string, Name>; updateManualEmail: FunctionReference<"mutation", "internal", { emailId: string; errorMessage?: string; resendId?: string; status: "waiting" | "queued" | "cancelled" | "sent" | "delivered" | "delivery_delayed" | "bounced" | "failed"; }, null, Name>; }; }; //# sourceMappingURL=component.d.ts.map