Skip to main content

References

Type Aliases

Type AliasDescription
AccountComplete on-chain account information returned by the Keyban API.
AccountAssignmentPending loyalty assignment created before an account exists.
AddressRepresents an Ethereum address in hexadecimal format.
ApplicationApplication configuration and metadata.
ApplicationFeatureString literal union of the supported application features.
ApplicationThemeModeString literal union describing the theme mode options.
AuthUserAuthenticated user profile.
CurrencyString literal union of supported loyalty currencies.
DppClaimPermissionPermission record allowing a specific user/email to claim a DPP.
DppClaimResultResult of a DPP claim operation.
DppProductSheetProduct sheet template for Digital Product Passports.
DppProductSheetStatusString literal union of the DPP product sheet statuses.
EvmNetworkAllowed EVM network identifiers.
HashRepresents a cryptographic hash value in hexadecimal format.
HexRepresents a hexadecimal value in blockchain-related contexts.
LoyaltyRewardTierLoyalty reward tier definition.
NetworkUnion across every supported blockchain runtime.
ObjectEnum-
ObjectPaths-
Prettify-
ProductSheetDetailStatsDetailed statistics for a DPP product sheet.
ProductSheetStatsAggregated statistics for all DPP product sheets at organization level.
StarknetNetworkAllowed Starknet network identifiers.
StellarNetworkAllowed Stellar network identifiers.
TimeSeriesDataPointTime series data point for tracking product sheet creation trends over time.

Variables

VariableDescription
ApplicationFeatureFlags describing which product surfaces (DPP or Loyalty) are enabled for a given application. Used throughout the SDK to flip UI and API capabilities.
ApplicationThemeModeEnumerates the supported UI presentation modes for hosted applications. Typedoc consumers rely on this union to toggle light/dark specific assets.
CurrencyLimited list of fiat currencies supported by the loyalty engine for point accrual and redemption calculations.
DppProductSheetStatusWorkflow states describing where a Digital Product Passport sheet sits in the publication lifecycle.
EvmNetworkCanonical blockchain network identifiers supported by Keyban across EVM, Starknet, and Stellar stacks. These unions align with backend configuration keys and Tilt profiles to prevent drift.
NetworkNormalized lookup that collapses duplicated enum values (e.g. both Starknet/Stellar define Mainnet) into a single Record consumable by Zod.
StarknetNetwork-
StellarNetwork-