Skip to main content

Function.useKeybanApplication

function useKeybanApplication(): UsePromiseResult<{
createdAt: string;
domains: string[];
dppSettings: {
tokens: {
address: string;
name: string;
network: | "EthereumAnvil"
| "PolygonAmoy"
| "StarknetDevnet"
| "StarknetSepolia"
| "StarknetMainnet"
| "StellarMainnet"
| "StellarQuickstart"
| "StellarTestnet";
symbol: string;
}[];
};
features: ("dpp" | "loyalty" | "invest")[];
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;
};
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"
| "StellarMainnet"
| "StellarQuickstart"
| "StellarTestnet";
symbol: string;
}[];
visitsWindowDays?: number;
welcomeBonus?: number;
};
name: string;
organization: {
createdAt: string;
id: string;
logo: string | null;
metadata?: {
[key: string]: unknown;
};
name: string;
settings: {
authConfig: {
auth0: | {
clientId: string;
domain: string;
enabled: true;
}
| {
enabled: false;
};
email-otp: | {
enabled: true;
}
| {
enabled: false;
};
google: | {
enabled: true;
}
| {
enabled: false;
};
phone-otp: | {
enabled: true;
}
| {
enabled: false;
};
};
};
slug: string;
};
shopifyShop?: {
application: string | null;
createdAt: string;
domain: string | null;
id: string;
name: string;
network: | "EthereumAnvil"
| "PolygonAmoy"
| "StarknetDevnet"
| "StarknetSepolia"
| "StarknetMainnet"
| "StellarMainnet"
| "StellarQuickstart"
| "StellarTestnet"
| null;
organization: string;
updatedAt: 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;
}, true>;

Retrives application details.

Returns

UsePromiseResult<{ createdAt: string; domains: string[]; dppSettings: { tokens: { address: string; name: string; network: | "EthereumAnvil" | "PolygonAmoy" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; symbol: string; }[]; }; features: ("dpp" | "loyalty" | "invest")[]; 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; }; 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" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet"; symbol: string; }[]; visitsWindowDays?: number; welcomeBonus?: number; }; name: string; organization: { createdAt: string; id: string; logo: string | null; metadata?: { [key: string]: unknown; }; name: string; settings: { authConfig: { auth0: | { clientId: string; domain: string; enabled: true; } | { enabled: false; }; email-otp: | { enabled: true; } | { enabled: false; }; google: | { enabled: true; } | { enabled: false; }; phone-otp: | { enabled: true; } | { enabled: false; }; }; }; slug: string; }; shopifyShop?: { application: string | null; createdAt: string; domain: string | null; id: string; name: string; network: | "EthereumAnvil" | "PolygonAmoy" | "StarknetDevnet" | "StarknetSepolia" | "StarknetMainnet" | "StellarMainnet" | "StellarQuickstart" | "StellarTestnet" | null; organization: string; updatedAt: 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; }, true>

  • The result containing the application or an error.