@playlive/fundraiser-data
    Preparing search index...

    Interface FundraiserDataConfig

    Endpoints + identifiers shared by every fetcher in this package.

    interface FundraiserDataConfig {
        causeId?: string;
        donationTrainApiUrl?: string;
        donorSpotlightApiUrl?: string;
        leaderboardApiUrl?: string;
        lifetimeApiUrl?: string;
        scheduleApiUrl?: string;
        tiltifyProxyUrl: string;
        twitchServiceUrl?: string;
    }
    Index
    causeId? donationTrainApiUrl? donorSpotlightApiUrl? leaderboardApiUrl? lifetimeApiUrl? scheduleApiUrl? tiltifyProxyUrl twitchServiceUrl?
    causeId?: string

    Default cause ID the campaign fetcher validates against (St. Jude UUID in production).

    donationTrainApiUrl?: string

    Base URL of the Play Live donation train service that serves the /get-trains-for-campaign/{id}, /process-donations/, /campaign-rulesets/{id} … endpoints. Omit if the app never touches the donation-train surface.

    donorSpotlightApiUrl?: string

    Base URL of the Play Live donor spotlight API that serves GET /spotlight/overview (baseline for the useDonorSpotlight REST + WS-store fusion view). Omit if the app never touches the donor-spotlight surface.

    leaderboardApiUrl?: string

    Base URL of the Play Live leaderboard API that serves the exclusion CRUD (/leaderboard-exclusions/{id}) and the filtered leaderboard (/leaderboard-with-exclusions/{id}). Omit if the app never touches the leaderboard surface.

    lifetimeApiUrl?: string

    Base URL of the Play Live lifetime API that serves GET /getLifetimeRaised and GET /getPreviousYearTotals. Omit if the app never touches the lifetime surface.

    scheduleApiUrl?: string

    Base URL of the Play Live schedule API that serves GET /schedules/campaigns/{id}/raised (baseline for the useCurrentBlockRaised REST + WS-delta view). Omit if the app never touches the schedule surface.

    tiltifyProxyUrl: string

    Base URL of the Play Live Tiltify proxy (e.g. https://api.experience.stjude.org/tiltify). Forwarded to the tiltify singleton's UseProxy().

    twitchServiceUrl?: string

    Base URL of the Twitch charity service (omitted when only Tiltify is in use).

    Settings
    Member Visibility

    On This Page
    Properties