Skip to main content

TypeAlias.Application

type Application = {
createdAt: string;
domains: string[];
dppSettings: {
tokens: {
address: string;
name: string;
network: | "EthereumAnvil"
| "PolygonAmoy"
| "StarknetDevnet"
| "StarknetSepolia"
| "StarknetMainnet"
| "StellarQuickstart"
| "StellarTestnet"
| "StellarMainnet";
symbol: string;
}[];
};
features: ("loyalty" | "dpp")[];
id: string;
loyaltySettings: {
app: {
onboarding?: | {
bgImageUrl?: string | null;
carousel?: {
images: {
description?: string;
title?: string;
url: string;
}[];
interval: number;
};
fontColor?: string;
qrCodeText?: string;
showTexts?: boolean;
subtitle?: string;
title?: string;
}
| null;
pointName?: string | null;
pointSymbol?: string | null;
};
appleWallet?: | {
bgColor?: string;
bgImageUrl?: string | null;
fgColor?: string;
iconUrl: string;
labelColor?: string;
logoUrl: string;
title: string;
}
| null;
currency?: "EUR" | "USD";
currencyToPointRatio?: number;
googleWallet?: | {
bgColor?: string;
bgImageUrl?: string | null;
detailsBody?: string;
detailsHeader?: string;
header: string;
logoUrl: string;
title: string;
}
| null;
pointsConversionThreshold?: number;
pointsConversionThresholdValue?: number;
tokens: {
address: string;
name: string;
network: | "EthereumAnvil"
| "PolygonAmoy"
| "StarknetDevnet"
| "StarknetSepolia"
| "StarknetMainnet"
| "StellarQuickstart"
| "StellarTestnet"
| "StellarMainnet";
symbol: string;
}[];
visitsWindowDays?: number;
welcomeBonus?: number;
};
name: string;
organization: string;
slug: string;
theme: {
bgImageUrl?: string;
customFontUrl?: string;
googleFont?: string;
logoUrl?: string;
mode?: "light" | "dark";
primaryColor?: string;
secondaryColor?: string;
title?: string;
};
updatedAt: string;
websiteUrl?: string;
};

Application configuration and metadata.

Defines an application (tenant) in the Keyban platform, including branding, enabled features, authorized domains, and settings for DPP and loyalty programs.

Type Declaration

NameTypeDefault value
createdAtstring-
domainsstring[]-
dppSettings{ tokens: { address: string; name: string; network: | "EthereumAnvil" | "PolygonAmoy" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarQuickstart" | "StellarTestnet" | "StellarMainnet"; symbol: string; }[]; }dppSettingsSchema
dppSettings.tokens{ address: string; name: string; network: | "EthereumAnvil" | "PolygonAmoy" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarQuickstart" | "StellarTestnet" | "StellarMainnet"; symbol: string; }[]-
features("loyalty" | "dpp")[]-
idstring-
loyaltySettings{ app: { onboarding?: | { bgImageUrl?: string | null; carousel?: { images: { description?: string; title?: string; url: string; }[]; interval: number; }; fontColor?: string; qrCodeText?: string; showTexts?: boolean; subtitle?: string; title?: string; } | null; pointName?: string | null; pointSymbol?: string | null; }; appleWallet?: | { bgColor?: string; bgImageUrl?: string | null; fgColor?: string; iconUrl: string; labelColor?: string; logoUrl: string; title: string; } | null; currency?: "EUR" | "USD"; currencyToPointRatio?: number; googleWallet?: | { bgColor?: string; bgImageUrl?: string | null; detailsBody?: string; detailsHeader?: string; header: string; logoUrl: string; title: string; } | null; pointsConversionThreshold?: number; pointsConversionThresholdValue?: number; tokens: { address: string; name: string; network: | "EthereumAnvil" | "PolygonAmoy" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarQuickstart" | "StellarTestnet" | "StellarMainnet"; symbol: string; }[]; visitsWindowDays?: number; welcomeBonus?: number; }loyaltySettingsSchema
loyaltySettings.app{ onboarding?: | { bgImageUrl?: string | null; carousel?: { images: { description?: string; title?: string; url: string; }[]; interval: number; }; fontColor?: string; qrCodeText?: string; showTexts?: boolean; subtitle?: string; title?: string; } | null; pointName?: string | null; pointSymbol?: string | null; }loyaltyAppSchema
loyaltySettings.app.onboarding?| { bgImageUrl?: string | null; carousel?: { images: { description?: string; title?: string; url: string; }[]; interval: number; }; fontColor?: string; qrCodeText?: string; showTexts?: boolean; subtitle?: string; title?: string; } | null-
loyaltySettings.app.pointName?string | null-
loyaltySettings.app.pointSymbol?string | null-
loyaltySettings.appleWallet?| { bgColor?: string; bgImageUrl?: string | null; fgColor?: string; iconUrl: string; labelColor?: string; logoUrl: string; title: string; } | null-
loyaltySettings.currency?"EUR" | "USD"-
loyaltySettings.currencyToPointRatio?number-
loyaltySettings.googleWallet?| { bgColor?: string; bgImageUrl?: string | null; detailsBody?: string; detailsHeader?: string; header: string; logoUrl: string; title: string; } | null-
loyaltySettings.pointsConversionThreshold?number-
loyaltySettings.pointsConversionThresholdValue?number-
loyaltySettings.tokens{ address: string; name: string; network: | "EthereumAnvil" | "PolygonAmoy" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarQuickstart" | "StellarTestnet" | "StellarMainnet"; symbol: string; }[]-
loyaltySettings.visitsWindowDays?number-
loyaltySettings.welcomeBonus?number-
namestring-
organizationstring-
slugstring-
theme{ bgImageUrl?: string; customFontUrl?: string; googleFont?: string; logoUrl?: string; mode?: "light" | "dark"; primaryColor?: string; secondaryColor?: string; title?: string; }-
theme.bgImageUrl?string-
theme.customFontUrl?string-
theme.googleFont?string-
theme.logoUrl?string-
theme.mode?"light" | "dark"-
theme.primaryColor?string-
theme.secondaryColor?string-
theme.title?string-
updatedAtstring-
websiteUrl?string-