ProviderOnboardingCheckSpec
Defined in: packages/core/src/types/onboarding.ts:31
Properties
Section titled “Properties”capabilityMethods?
Section titled “capabilityMethods?”
optionalcapabilityMethods?:string[]
Defined in: packages/core/src/types/onboarding.ts:47
Method names that must exist on provider instances. Used when kind === “capability”.
configKeys?
Section titled “configKeys?”
optionalconfigKeys?:string[]
Defined in: packages/core/src/types/onboarding.ts:42
Relative key paths under provider config (e.g. “apiKey”, “nested.token”). Used when kind === “config”.
description?
Section titled “description?”
optionaldescription?:string
Defined in: packages/core/src/types/onboarding.ts:34
id:
string
Defined in: packages/core/src/types/onboarding.ts:32
Defined in: packages/core/src/types/onboarding.ts:35
messageTypes?
Section titled “messageTypes?”
optionalmessageTypes?:MessageType[]
Defined in: packages/core/src/types/onboarding.ts:57
Message types the check prepares for. When set, doctor evaluates it only
for a provider that supports one of them, so an SMS-only configuration is
not held to AlimTalk prerequisites.
probeOperation?
Section titled “probeOperation?”
optionalprobeOperation?:ProviderOnboardingProbeOperation
Defined in: packages/core/src/types/onboarding.ts:51
Well-known probe operation used when kind === “api_probe”.
scopes
Section titled “scopes”scopes:
ProviderOnboardingScope[]
Defined in: packages/core/src/types/onboarding.ts:37
severity
Section titled “severity”severity:
ProviderOnboardingSeverity
Defined in: packages/core/src/types/onboarding.ts:36
title:
string
Defined in: packages/core/src/types/onboarding.ts:33