Skip to content
popii

getBuiltInOptionsSchema()

Popii

Popii / getBuiltInOptionsSchema

Function: getBuiltInOptionsSchema()

Section titled “Function: getBuiltInOptionsSchema()”

getBuiltInOptionsSchema(id): ZodObject<{ provider: ZodEnum<{ openai: "openai"; gemini: "gemini"; anthropic: "anthropic"; deepseek: "deepseek"; }>; apiKey: ZodString; model: ZodOptional<ZodString>; systemPrompt: ZodOptional<ZodString>; locale: ZodOptional<ZodString>; }, $strict> | ZodObject<{ }, $strict> | ZodObject<{ maxAiChecksPerMinute: ZodOptional<ZodNumber>; maxAiChecksPerUserPerMinute: ZodOptional<ZodNumber>; }, $strict> | ZodObject<{ fontPath: ZodOptional<ZodString>; fontFamily: ZodOptional<ZodString>; }, $strict> | ZodObject<{ categoryId: ZodOptional<ZodString>; supportRoleId: ZodOptional<ZodString>; panelTitle: ZodOptional<ZodString>; panelMessage: ZodOptional<ZodString>; transcriptChannelId: ZodOptional<ZodString>; }, $strict> | ZodObject<{ currencyName: ZodOptional<ZodString>; dailyAmount: ZodOptional<ZodNumber>; }, $strict> | ZodObject<{ minBet: ZodOptional<ZodNumber>; maxBet: ZodOptional<ZodNumber>; cooldownMs: ZodOptional<ZodNumber>; slotSymbols: ZodOptional<ZodTuple<[ZodString, ZodString, ZodString, ZodString, ZodString, ZodString], null>>; }, $strict> | ZodObject<{ apiKey: ZodString; apiSecret: ZodString; scrobble: ZodOptional<ZodBoolean>; nowPlaying: ZodOptional<ZodBoolean>; }, $strict> | ZodObject<{ xpPerMessage: ZodOptional<ZodUnion<readonly [ZodNumber, ZodTuple<[ZodNumber, ZodNumber], null>]>>; cooldownMs: ZodOptional<ZodNumber>; onLevelUp: ZodOptional<ZodFunction<$ZodFunctionArgs, $ZodFunctionOut>>; }, $strict> | ZodObject<{ defaultReason: ZodOptional<ZodString>; }, $strict> | ZodObject<{ twitch: ZodOptional<ZodObject<{ clientId: ZodString; clientSecret: ZodString; pollIntervalMs: ZodOptional<ZodNumber>; }, $strict>>; youtube: ZodOptional<ZodObject<{ pollIntervalMs: ZodOptional<ZodNumber>; }, $strict>>; }, $strict> | ZodObject<{ patreon: ZodOptional<ZodObject<{ webhookSecret: ZodString; port: ZodOptional<ZodNumber>; path: ZodOptional<ZodString>; onPledgeCreate: ZodOptional<ZodFunction<$ZodFunctionArgs, $ZodFunctionOut>>; onPledgeUpdate: ZodOptional<ZodFunction<$ZodFunctionArgs, $ZodFunctionOut>>; onPledgeDelete: ZodOptional<ZodFunction<$ZodFunctionArgs, $ZodFunctionOut>>; }, $strict>>; kofi: ZodOptional<ZodObject<{ verificationToken: ZodString; port: ZodOptional<ZodNumber>; path: ZodOptional<ZodString>; onPayment: ZodOptional<ZodFunction<$ZodFunctionArgs, $ZodFunctionOut>>; }, $strict>>; }, $strict> | ZodObject<{ defaultThreshold: ZodOptional<ZodNumber>; defaultEmoji: ZodOptional<ZodString>; }, $strict> | ZodObject<{ successColor: ZodOptional<ZodNumber>; errorColor: ZodOptional<ZodNumber>; infoColor: ZodOptional<ZodNumber>; useSnapsForPagination: ZodOptional<ZodBoolean>; }, $strict>

Defined in: plugins/option-schemas.ts:20

Parameters

Section titled “Parameters”

id

Section titled “id”

"popii-ai" | "popii-audit-log" | "popii-autorole" | "popii-gdpr" | "popii-giveaway" | "popii-poll" | "popii-reaction-roles" | "popii-reminders" | "popii-rss" | "popii-snapshots" | "popii-suggestions" | "popii-welcome" | "popii-automod" | "popii-canvas" | "popii-desk" | "popii-economy" | "popii-games" | "popii-lastfm" | "popii-levels" | "popii-moderation" | "popii-notify" | "popii-pay" | "popii-starboard" | "popii-ui"

Returns

Section titled “Returns”

ZodObject<{ provider: ZodEnum<{ openai: "openai"; gemini: "gemini"; anthropic: "anthropic"; deepseek: "deepseek"; }>; apiKey: ZodString; model: ZodOptional<ZodString>; systemPrompt: ZodOptional<ZodString>; locale: ZodOptional<ZodString>; }, $strict> | ZodObject<{ }, $strict> | ZodObject<{ maxAiChecksPerMinute: ZodOptional<ZodNumber>; maxAiChecksPerUserPerMinute: ZodOptional<ZodNumber>; }, $strict> | ZodObject<{ fontPath: ZodOptional<ZodString>; fontFamily: ZodOptional<ZodString>; }, $strict> | ZodObject<{ categoryId: ZodOptional<ZodString>; supportRoleId: ZodOptional<ZodString>; panelTitle: ZodOptional<ZodString>; panelMessage: ZodOptional<ZodString>; transcriptChannelId: ZodOptional<ZodString>; }, $strict> | ZodObject<{ currencyName: ZodOptional<ZodString>; dailyAmount: ZodOptional<ZodNumber>; }, $strict> | ZodObject<{ minBet: ZodOptional<ZodNumber>; maxBet: ZodOptional<ZodNumber>; cooldownMs: ZodOptional<ZodNumber>; slotSymbols: ZodOptional<ZodTuple<[ZodString, ZodString, ZodString, ZodString, ZodString, ZodString], null>>; }, $strict> | ZodObject<{ apiKey: ZodString; apiSecret: ZodString; scrobble: ZodOptional<ZodBoolean>; nowPlaying: ZodOptional<ZodBoolean>; }, $strict> | ZodObject<{ xpPerMessage: ZodOptional<ZodUnion<readonly [ZodNumber, ZodTuple<[ZodNumber, ZodNumber], null>]>>; cooldownMs: ZodOptional<ZodNumber>; onLevelUp: ZodOptional<ZodFunction<$ZodFunctionArgs, $ZodFunctionOut>>; }, $strict> | ZodObject<{ defaultReason: ZodOptional<ZodString>; }, $strict> | ZodObject<{ twitch: ZodOptional<ZodObject<{ clientId: ZodString; clientSecret: ZodString; pollIntervalMs: ZodOptional<ZodNumber>; }, $strict>>; youtube: ZodOptional<ZodObject<{ pollIntervalMs: ZodOptional<ZodNumber>; }, $strict>>; }, $strict> | ZodObject<{ patreon: ZodOptional<ZodObject<{ webhookSecret: ZodString; port: ZodOptional<ZodNumber>; path: ZodOptional<ZodString>; onPledgeCreate: ZodOptional<ZodFunction<$ZodFunctionArgs, $ZodFunctionOut>>; onPledgeUpdate: ZodOptional<ZodFunction<$ZodFunctionArgs, $ZodFunctionOut>>; onPledgeDelete: ZodOptional<ZodFunction<$ZodFunctionArgs, $ZodFunctionOut>>; }, $strict>>; kofi: ZodOptional<ZodObject<{ verificationToken: ZodString; port: ZodOptional<ZodNumber>; path: ZodOptional<ZodString>; onPayment: ZodOptional<ZodFunction<$ZodFunctionArgs, $ZodFunctionOut>>; }, $strict>>; }, $strict> | ZodObject<{ defaultThreshold: ZodOptional<ZodNumber>; defaultEmoji: ZodOptional<ZodString>; }, $strict> | ZodObject<{ successColor: ZodOptional<ZodNumber>; errorColor: ZodOptional<ZodNumber>; infoColor: ZodOptional<ZodNumber>; useSnapsForPagination: ZodOptional<ZodBoolean>; }, $strict>