# @plandalf/sdk

The browser entrypoint starts at [the `plandalf` object](https://plandalf.com/docs/sdk). For a direct call, open [`present()`](https://plandalf.com/docs/sdk/present) or [`mount()`](https://plandalf.com/docs/sdk/mount); both pages show their options inline. Common types: [`FlowOpenOptions`](https://plandalf.com/docs/packages/sdk/interfaces/FlowOpenOptions), [`MountOptions`](https://plandalf.com/docs/packages/sdk/interfaces/MountOptions), [`FlowHandle`](https://plandalf.com/docs/packages/sdk/interfaces/FlowHandle), and [`FlowResult`](https://plandalf.com/docs/packages/sdk/interfaces/FlowResult).

## Classes

- [Plandalf](https://plandalf.com/docs/packages/sdk/classes/Plandalf)

## Interfaces

- [BlockConstraint](https://plandalf.com/docs/packages/sdk/interfaces/BlockConstraint)
- [BlockDefinition](https://plandalf.com/docs/packages/sdk/interfaces/BlockDefinition)
- [Cart](https://plandalf.com/docs/packages/sdk/interfaces/Cart)
- [CartItem](https://plandalf.com/docs/packages/sdk/interfaces/CartItem)
- [CheckoutModule](https://plandalf.com/docs/packages/sdk/interfaces/CheckoutModule)
- [CheckoutSessionPayload](https://plandalf.com/docs/packages/sdk/interfaces/CheckoutSessionPayload)
- [Customer](https://plandalf.com/docs/packages/sdk/interfaces/Customer)
- [Flow](https://plandalf.com/docs/packages/sdk/interfaces/Flow)
- [FlowContext](https://plandalf.com/docs/packages/sdk/interfaces/FlowContext)
- [FlowEvent](https://plandalf.com/docs/packages/sdk/interfaces/FlowEvent)
- [FlowHandle](https://plandalf.com/docs/packages/sdk/interfaces/FlowHandle)
- [FlowOpenOptions](https://plandalf.com/docs/packages/sdk/interfaces/FlowOpenOptions)
- [FlowResult](https://plandalf.com/docs/packages/sdk/interfaces/FlowResult)
- [FlowStartOptions](https://plandalf.com/docs/packages/sdk/interfaces/FlowStartOptions)
- [FlowState](https://plandalf.com/docs/packages/sdk/interfaces/FlowState)
- [FlowTemplate](https://plandalf.com/docs/packages/sdk/interfaces/FlowTemplate)
- [FrameConfig](https://plandalf.com/docs/packages/sdk/interfaces/FrameConfig)
- [GateDefinition](https://plandalf.com/docs/packages/sdk/interfaces/GateDefinition)
- [GateResult](https://plandalf.com/docs/packages/sdk/interfaces/GateResult)
- [HarnessDefinition](https://plandalf.com/docs/packages/sdk/interfaces/HarnessDefinition)
- [HarnessHooks](https://plandalf.com/docs/packages/sdk/interfaces/HarnessHooks)
- [MountOptions](https://plandalf.com/docs/packages/sdk/interfaces/MountOptions)
- [PageDefinition](https://plandalf.com/docs/packages/sdk/interfaces/PageDefinition)
- [PaymentIntent](https://plandalf.com/docs/packages/sdk/interfaces/PaymentIntent)
- [PaymentResult](https://plandalf.com/docs/packages/sdk/interfaces/PaymentResult)
- [PlandalfConfig](https://plandalf.com/docs/packages/sdk/interfaces/PlandalfConfig)
- [PlandalfSDK](https://plandalf.com/docs/packages/sdk/interfaces/PlandalfSDK)
- [PortalModule](https://plandalf.com/docs/packages/sdk/interfaces/PortalModule)
- [PortalMountOptions](https://plandalf.com/docs/packages/sdk/interfaces/PortalMountOptions)
- [PortalOpenOptions](https://plandalf.com/docs/packages/sdk/interfaces/PortalOpenOptions)
- [PromoContext](https://plandalf.com/docs/packages/sdk/interfaces/PromoContext)
- [StepDefinition](https://plandalf.com/docs/packages/sdk/interfaces/StepDefinition)
- [ThemeConfig](https://plandalf.com/docs/packages/sdk/interfaces/ThemeConfig)
- [ValidationResult](https://plandalf.com/docs/packages/sdk/interfaces/ValidationResult)
- [VisitorIdentity](https://plandalf.com/docs/packages/sdk/interfaces/VisitorIdentity)
- [WidgetMountOptions](https://plandalf.com/docs/packages/sdk/interfaces/WidgetMountOptions)
- [WidgetsModule](https://plandalf.com/docs/packages/sdk/interfaces/WidgetsModule)

## Type Aliases

- [EventCallback](https://plandalf.com/docs/packages/sdk/type-aliases/EventCallback)
- [FlowEventType](https://plandalf.com/docs/packages/sdk/type-aliases/FlowEventType)
- [FlowHandleEvent](https://plandalf.com/docs/packages/sdk/type-aliases/FlowHandleEvent)
- [FlowHandleEventType](https://plandalf.com/docs/packages/sdk/type-aliases/FlowHandleEventType)
- [FlowResultStatus](https://plandalf.com/docs/packages/sdk/type-aliases/FlowResultStatus)
- [FlowStatus](https://plandalf.com/docs/packages/sdk/type-aliases/FlowStatus)
- [FrameMode](https://plandalf.com/docs/packages/sdk/type-aliases/FrameMode)
- [GateCheck](https://plandalf.com/docs/packages/sdk/type-aliases/GateCheck)
- [GateResultStatus](https://plandalf.com/docs/packages/sdk/type-aliases/GateResultStatus)
- [GateSyncCallback](https://plandalf.com/docs/packages/sdk/type-aliases/GateSyncCallback)

## Variables

- [FlowHandleEventType](https://plandalf.com/docs/packages/sdk/variables/FlowHandleEventType)
- [FlowResultStatus](https://plandalf.com/docs/packages/sdk/variables/FlowResultStatus)
- [GateResultStatus](https://plandalf.com/docs/packages/sdk/variables/GateResultStatus)

## Functions

- [createApiClient](https://plandalf.com/docs/packages/sdk/functions/createApiClient)
- [getInstance](https://plandalf.com/docs/packages/sdk/functions/getInstance)
- [init](https://plandalf.com/docs/packages/sdk/functions/init)
- [isLoaded](https://plandalf.com/docs/packages/sdk/functions/isLoaded)
- [loadCheckout](https://plandalf.com/docs/packages/sdk/functions/loadCheckout)
- [loadPortal](https://plandalf.com/docs/packages/sdk/functions/loadPortal)
- [loadWidgets](https://plandalf.com/docs/packages/sdk/functions/loadWidgets)
- [preload](https://plandalf.com/docs/packages/sdk/functions/preload)
- [preloadAll](https://plandalf.com/docs/packages/sdk/functions/preloadAll)
- [reset](https://plandalf.com/docs/packages/sdk/functions/reset)

Source: https://plandalf.com/docs/packages/sdk