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.
Action-
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.
AuthMethod-
AuthUserAuthenticated user profile.
CertificationKeyHistoryItemHistorical certification key item. Includes status, activation dates, and registered networks.
CertificationKeyResponseCertification key response with on-chain registration status. Includes registration status, registered networks, and rotation progress.
CertificationKeyStatusCertification key status enum. - active: Currently used for signing - pending: Awaiting on-chain rotation to complete - rotated: Replaced by a newer key, kept for verification - revoked: Compromised or manually revoked
CertificationKeyStatus-
ChatRole-
CreateInvestFund-
CreateInvestIdentity-
CreateInvestLockup-
CreateInvestNav-
CurrencyString literal union of supported loyalty currencies.
DppApplicationMetricsDPP metrics for a specific application.
DppClaimResultResult of a DPP claim operation.
DppMetricsDPP metrics for tracking Digital Product Passport lifecycle.
DppMetricsByOrgDPP metrics grouped by organization.
DppPassport-
DppProductProduct template for Digital Product Passports.
DppProductStatusString literal union of the DPP product statuses.
DynamicFieldDef-
DynamicFieldsType-
DynamicFieldType-
EvmNetworkAllowed EVM network identifiers.
GoogleGeminiModel-
HashRepresents a cryptographic hash value in hexadecimal format.
HexRepresents a hexadecimal value in blockchain-related contexts.
ImportErrorDetailed error record for a failed product import.
ImportStatus-
InvestFundInvestment fund definition.
InvestFundStatusString literal union of the invest fund statuses.
InvestIdentityInvestor identity with KYC lifecycle tracking.
InvestIdentityStatusString literal union of the invest identity statuses.
InvestLockupCustom lockup period for an investor in a specific fund.
InvestNavNAV (Net Asset Value) record for an investment fund.
LlmModelPricing-
LlmProvider-
LlmUsageByModel-
LlmUsageByOrganization-
LlmUsageByProvider-
LlmUsageMeta-
LlmUsageMetadata-
LlmUsageRecord-
LlmUsageResponse-
LlmUsageTimeline-
LoyaltyApplicationMetricsLoyalty metrics for a specific application.
LoyaltyMetricsLoyalty metrics for tracking program engagement and customer behavior.
LoyaltyMetricsByOrgLoyalty metrics grouped by organization.
LoyaltyRewardTier-
Module-
NetworkUnion across every supported blockchain runtime.
ObjectEnum-
ObjectPaths-
OnChainStatusOn-chain certifier status. - registered: Key is registered and valid on at least one network - pending: Key exists but not yet registered on-chain
OnChainStatus-
OrderLoyalty order returned by the indexer.
OrderItemIndividual item within a loyalty order.
Organization-
Permission-
Plan-
PlanFeature-
PlanPrice-
Prettify-
ProblemDetailsRFC 7807 Problem Details for HTTP APIs.
ProductDetailStatsDetailed statistics for a DPP product sheet.
ProductImportItemSingle product item for bulk import.
ProductImportJobListItemSummary item for listing bulk import jobs.
ProductImportJobStatusFull status of a bulk import job including progress and options.
ProductImportOptionsOptions for bulk product import operation.
ProductImportProgressReal-time progress tracking for bulk import operation.
ProductImportResultResult of a single product import within a bulk operation.
ProductStatsAggregated statistics for all DPP product sheets at organization level.
QuotaEntity-
QuotaLimit-
QuotaOperation-
QuotaOrganization-
QuotaThreshold-
QuotaUsage-
RotateCertificationKeyResponseResponse from the certification key rotation endpoint. Includes new key details and number of on-chain rotation jobs queued.
ShopifyPassportFields-
ShopifyProductFields-
ShopifyShop-
StarknetNetworkAllowed Starknet network identifiers.
StellarNetworkAllowed Stellar network identifiers.
TierDistributionTier distribution representing customer spread across loyalty tiers.
TimeSeriesDataPointTime series data point for tracking product sheet creation trends over time.
UpdateInvestFund-
UpdateInvestIdentity-
UpdateInvestLockup-

Variables

VariableDescription
ApplicationFeatureFlags describing which product surfaces (DPP, Loyalty, or Invest) 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.
AuthMethod-
ChatRoleChat message role
CurrencyLimited list of fiat currencies supported by the loyalty engine for point accrual and redemption calculations.
DppProductStatusWorkflow 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.
GoogleGeminiModelGoogle Gemini models supported in MVP Note: Gemini 1.5 models were retired in 2025, using 2.5 series
ImportStatus-
InvestFundStatusStatus of an investment fund in the platform lifecycle.
InvestIdentityStatusStatus of an investor identity through the KYC lifecycle.
LlmProviderSupported LLM providers
NetworkNormalized lookup that collapses duplicated enum values (e.g. both Starknet/Stellar define Mainnet) into a single Record consumable by Zod.
permissionStatement-
QuotaEntity-
QuotaLimit-
QuotaOperation-
QuotaThreshold-
roleStatements-
StarknetNetwork-
StellarNetwork-