Interface IRaffleClient

Interface for the Raffle Client that provides functionality for managing raffles and viewing raffle pulls.

interface IRaffleClient {
    pullRaffle(): Promise<boolean>;
    setRaffleEntrants(entrants: string[]): Promise<boolean>;
    viewEntrants(userId: string): Promise<ViewEntrantsResponse>;
    viewMostRecentPull(): Promise<RafflePull>;
    viewRaffleOwners(): Promise<ViewRaffleOwnersResponse>;
    viewUserPull(userId: string, pullId: string): Promise<RafflePull>;
    viewUserPulls(userId: string): Promise<ViewPullsResponse>;
}

Implemented by

RaffleClient

Index

Methods

pullRaffle setRaffleEntrants viewEntrants viewMostRecentPull viewRaffleOwners viewUserPull viewUserPulls

Methods

pullRaffle

pullRaffle(): Promise<boolean>
Performs a raffle pull to select a winner.

Returns Promise<boolean>
Promise resolving to true if successful
- Defined in clients/miscellaneous/raffle/abstract/IRaffleClient.ts:19

setRaffleEntrants

setRaffleEntrants(entrants: string[]): Promise<boolean>
Sets the list of entrants for the raffle.
Parameters
- entrants: string[]
  Array of entrant names
Returns Promise<boolean>
Promise resolving to true if successful
- Defined in clients/miscellaneous/raffle/abstract/IRaffleClient.ts:13

viewEntrants

viewEntrants(userId: string): Promise<ViewEntrantsResponse>
Retrieves the list of entrants for a specific user's raffle.
Parameters
- userId: string
  ID of the user whose raffle entrants to view
Returns Promise<ViewEntrantsResponse>
Promise resolving to array of entrant names
- Defined in clients/miscellaneous/raffle/abstract/IRaffleClient.ts:32

viewMostRecentPull

viewMostRecentPull(): Promise<RafflePull>
Retrieves the most recent raffle pull by finding the one with the highest ID.

Returns Promise<RafflePull>
Promise resolving to the most recent pull details
- Defined in clients/miscellaneous/raffle/abstract/IRaffleClient.ts:25

viewRaffleOwners

viewRaffleOwners(): Promise<ViewRaffleOwnersResponse>
Retrieves the list of all raffle owners.

Returns Promise<ViewRaffleOwnersResponse>
Promise resolving to array of user IDs
- Defined in clients/miscellaneous/raffle/abstract/IRaffleClient.ts:53

viewUserPull

viewUserPull(userId: string, pullId: string): Promise<RafflePull>
Retrieves details of a specific raffle pull for a user.
Parameters
- userId: string
  ID of the user whose pull to view
- pullId: string
  ID of the pull to view
Returns Promise<RafflePull>
Promise resolving to pull details
- Defined in clients/miscellaneous/raffle/abstract/IRaffleClient.ts:40

viewUserPulls

viewUserPulls(userId: string): Promise<ViewPullsResponse>
Retrieves all raffle pulls for a specific user.
Parameters
- userId: string
  ID of the user whose pulls to view
Returns Promise<ViewPullsResponse>
Promise resolving to an object containing array of pulls
- Defined in clients/miscellaneous/raffle/abstract/IRaffleClient.ts:47