Class default

Index

Constructors

constructor

new default(): default
Returns default

Methods

`Static` addPrize

addPrize<T>(id, data): AxiosPromise<default<T>>
Add a prize tier to a raffle (Game Owner).
Type Parameters
- T
Parameters
- id: string
- data: object
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:66

`Static` analytics

analytics<T>(id): AxiosPromise<default<T>>
Get viral loop analytics (K-Factor, Cost Per Entry).
Type Parameters
- T
Parameters
- id: string
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:129

`Static` create

create<T>(data): AxiosPromise<default<T>>
Create a new raffle (Game Owner).
Type Parameters
- T
Parameters
- data: object
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:17

`Static` disqualify

disqualify<T>(id, entry_id, data): AxiosPromise<default<T>>
Disqualify a specific entry (Game Owner).
Type Parameters
- T
Parameters
- id: string
- entry_id: string
- data: {
  reason: string;
  }
  - reason: string
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:115

`Static` drawWinners

drawWinners<T>(id): AxiosPromise<default<T>>
Trigger the automated drawing process (Game Owner).
Type Parameters
- T
Parameters
- id: string
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:73

`Static` enter

enter<T>(id, data): AxiosPromise<default<T>>
Enter a raffle (User/Player). Requires Steam ID.
Type Parameters
- T
Parameters
- id: string
- data: {
      device_fingerprint?: string;
      opt_in_playtesting?: boolean;
      referral_code?: string;
  }
  - Optional device_fingerprint?: string
  - Optional opt_in_playtesting?: boolean
  - Optional referral_code?: string
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:31

`Static` escrowStatus

escrowStatus<T>(id): AxiosPromise<default<T>>
Check if the raffle is fully funded in the community ledger.
Type Parameters
- T
Parameters
- id: string
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:122

`Static` fulfillPrize

fulfillPrize<T>(entry_id, data): AxiosPromise<default<T>>
Update shipping/tracking info for a prize (Game Owner).
Type Parameters
- T
Parameters
- entry_id: string
- data: {
  shipping_carrier: string;
  tracking_number: string;
  }
  - shipping_carrier: string
  - tracking_number: string
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:101

`Static` inviteFriend

inviteFriend<T>(id, data): AxiosPromise<default<T>>
Send an invitation email to a friend.
Type Parameters
- T
Parameters
- id: string
- data: {
  email: string;
  }
  - email: string
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:59

`Static` list

list<T>(params?): AxiosPromise<default<T>>
List all raffles with optional filters.
Type Parameters
- T
Parameters
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:10

`Static` me

me<T>(id): AxiosPromise<default<T>>
Get the authenticated user's entry status for a specific raffle.
Type Parameters
- T
Parameters
- id: string
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:38

`Static` participants

participants<T>(id, params?): AxiosPromise<default<T>>
List all participants/entries for a raffle (Game Owner).
Type Parameters
- T
Parameters
- id: string
- Optional params: Record<string, any>
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:94

`Static` performAction

performAction<T>(id, data): AxiosPromise<default<T>>
Record a viral action (e.g., Steam Wishlist, Social Share).
Type Parameters
- T
Parameters
- id: string
- data: {
      action_type: string;
      platform?: string;
      reference_id?: string;
  }
  - action_type: string
  - Optional platform?: string
  - Optional reference_id?: string
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:45

`Static` pickWinner

pickWinner<T>(id, data): AxiosPromise<default<T>>
Manually select a winner for a specific prize (Live Event Mode).
Type Parameters
- T
Parameters
- id: string
- data: {
  entry_id: string;
  prize_id: string;
  }
  - entry_id: string
  - prize_id: string
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:80

`Static` shareSocially

shareSocially<T>(id, data): AxiosPromise<default<T>>
Post raffle content to social media via Glitch API.
Type Parameters
- T
Parameters
- id: string
- data: {
  content: string;
  platform: string;
  }
  - content: string
  - platform: string
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:52

`Static` update

update<T>(id, data): AxiosPromise<default<T>>
Update a raffle (Game Owner). Handles status transitions (e.g., moving from draft to active).
Type Parameters
- T
Parameters
- id: string
- data: object
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:137

`Static` updateAddress

updateAddress<T>(entry_id, data): AxiosPromise<default<T>>
Submit shipping address for a won prize (User/Winner).
Type Parameters
- T
Parameters
- entry_id: string
- data: object
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:108

`Static` view

view<T>(id): AxiosPromise<default<T>>
Retrieve details for a specific raffle.
Type Parameters
- T
Parameters
- id: string
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:24

`Static` winners

winners<T>(id): AxiosPromise<default<T>>
Get the public list of winners for a completed raffle.
Type Parameters
- T
Parameters
- id: string
Returns AxiosPromise<default<T>>
- Defined in api/Raffles.ts:87

Generated using TypeDoc