Home

export interface UserDetails {
    // User's country code
    country: string;
    // User's email address
    email: string;
    // Feature flags for user capabilities
    featureControl: string;
    // Latest terms acceptance status
    hasAcceptedLatestUsePolicy: boolean;
    // Unique user identifier
    id: string;
    // Multi-factor authentication status
    mfaStatus: boolean;
    // User's mobile phone number
    mobile: string;
    // KYC bypass flag for providers
    byPassKycProvider: boolean;
    // User's full name
    name: string;
    // Profile image URL path
    imagePath: string;
    // Employee code (if applicable)
    employeeCode?: string;
    // User's wallet information
    wallet: Wallet;
    // Associated enterprise identifier
    enterpriseId: string;
    // App and referral codes
    memberCodes: MemberCodes;
    // KYC verification status
    hasKyc: boolean;
    // Permission to display name publicly
    acceptShowName: boolean;
    // User's document information
    document: DocumentData;
    // Profile photo URL
    photo: string;
    // Account creation timestamp
    creationDate: Date;
    // Trusteeship profile flag
    trusteeshipProfile: boolean;
    // Onboarding validation status
    hasOnboardingValidation: string;
    // Application avatar URL
    appAvatar: string;
    // Message of the day content
    motd: Partial<Motd>;
    // User's nickname
    nickName: string;
    // Registration method used
    registerIdentifierType: RegisterIdentifierType;
    // User's address (optional)
    address?: Address;
    // White label configuration (optional)
    whitelabelConfig?: WhitelabelConfig;
    // White label profile (optional)
    whiteLabelProfile?: WhitelabelProfile;
}

export enum RegisterIdentifierType {
    // Registration via email
    EMAIL = 'email',
    // Registration via mobile number
    MOBILE = 'mobile',
}

export interface Wallet {
    // Internal blockchain wallet
    internal: WalletData;
    // External blockchain wallet
    external: WalletData;
}

export interface WalletData {
    // Blockchain public address
    publicAddress: string;
}

export interface MemberCodes {
    // Application-specific code
    appCode: string;
    // Referral code for invitations
    refCode: string;
}

export interface Motd {
    // Message banner image URL
    image: string;
    // Message title
    title: string;
    // Message content
    message: string;
    // Primary action button text
    primaryButtonText: string;
    // Primary action button URL
    primaryButtonLink: string;
    // Show support button flag
    supportButton: boolean;
}

export interface Address {
    // Postal/ZIP code
    cepCode: string;
    // State or province
    state: string;
    // City name
    city: string;
    // Neighborhood or district
    neighborhood: string;
    // Primary address line
    address01: string;
    // Secondary address line
    address02: string;
    // Additional address line
    address03: string;
    // Street number
    number: number;
}

export interface WhitelabelConfig {
    shopping?: {
        // Shopping redirect URL
        redirectUrl?: string;
    };
}

export interface WhitelabelProfile {
    // Profile identifier
    id?: string;
    // White label name
    name: string;
    // Profile image URL
    image: string;
    // White label code
    wlc: string;
    // Display order
    order: string;
    // Custom button text
    profileButtonText?: string;
    // Parent white label code
    parentWhiteLabelCode?: string;
    // Creation timestamp
    createdAt?: string;
}

export interface WalletBalance {
    // User's wallet balance details
    balance: Balance;
}

export interface Balance {
    // Promotional balance from marketing campaigns
    promotional?: string;
    // Main platform balance (primary currency)
    plataform: string;
    // Balance on internal blockchain network
    internalBlockchain?: string;
    // Balance on external blockchain networks
    externalBlockchain?: string;
}

export interface StartHome {
    // Main carousel slides (images or banner objects)
    slides?: Array<
        | string
        | Banner
    >;
    // Navigation grid buttons for main actions
    gridButtons?: Array<Banner>;
    // Home screen welcome description
    description?: string;
    // Promotional and marketing banners
    banners?: Array<Banner>;
    // Additional quick action buttons
    miniExtraButtons?: Array<Banner>;
    // Categorized banners by size type
    formattedBanners?: BannerType;
}

export interface Banner {
    // Display name for the banner
    name: string;
    // Banner image URL or asset path
    image: string;
    // Enable/disable banner interaction
    disabled?: boolean;
    // Custom height in pixels
    height?: number;
    // Size category (small, medium, large)
    size?: string;
    // Internal app route navigation
    internalUrl?: string;
    // External URL opened in webview
    externalUrlWebview?: {
        // Target URL
        url: string;
        // Webview title
        title?: string;
    };
    // External URL opened in browser
    externalUrl?: string;
    // Fragment-based internal navigation
    internalUrlFragment?: {
        // Base route
        base: string;
        // Fragment identifier
        frag: string;
    };
    // Custom background color (hex/rgb)
    backgroundColor?: string;
    // Custom border color (hex/rgb)
    borderColor?: string;
    // Custom icon color (hex/rgb)
    iconColor?: string;
}

export interface BannerType {
    // Small format promotional banners
    smallImages: Array<Banner>;
    // Standard format promotional banners
    normalImages: Array<Banner>;
}