diff options
| author | Max Nanis | 2026-02-18 20:42:03 -0500 |
|---|---|---|
| committer | Max Nanis | 2026-02-18 20:42:03 -0500 |
| commit | 3eaa56f0306ead818f64c3d99fc6d230d9b970a4 (patch) | |
| tree | 9fecc2f1456e6321572e0e65f57106916df173e2 /jb-ui/src/api_fsb/docs/LeaderboardWinner.md | |
| download | amt-jb-3eaa56f0306ead818f64c3d99fc6d230d9b970a4.tar.gz amt-jb-3eaa56f0306ead818f64c3d99fc6d230d9b970a4.zip | |
HERE WE GO, HERE WE GO, HERE WE GO
Diffstat (limited to 'jb-ui/src/api_fsb/docs/LeaderboardWinner.md')
| -rw-r--r-- | jb-ui/src/api_fsb/docs/LeaderboardWinner.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/LeaderboardWinner.md b/jb-ui/src/api_fsb/docs/LeaderboardWinner.md new file mode 100644 index 0000000..1abfaba --- /dev/null +++ b/jb-ui/src/api_fsb/docs/LeaderboardWinner.md @@ -0,0 +1,40 @@ +# LeaderboardWinner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rank** | **number** | The user\'s final rank in the leaderboard | [default to undefined] +**freq** | [**LeaderboardFrequency**](LeaderboardFrequency.md) | The time period range for the leaderboard. Allowed values: - __daily__ *(DAILY)*: UTC midnight to UTC midnight - __weekly__ *(WEEKLY)*: Sunday Midnight to Sunday Midnight UTC - __monthly__ *(MONTHLY)*: Jan 1 00:00:00 | [default to undefined] +**board_code** | [**LeaderboardCode**](LeaderboardCode.md) | The type of leaderboard. What the \"values\" represent. Allowed values: - __complete_count__ *(COMPLETE_COUNT)*: Number of Completes - __largest_user_payout__ *(LARGEST_PAYOUT)*: Largest Single Payout - __sum_user_payout__ *(SUM_PAYOUTS)*: (Sum of) Total Payouts | [default to undefined] +**country_iso** | **string** | The country this leaderboard is for. | [default to undefined] +**issued** | **string** | When the prize was issued. | [default to undefined] +**bpuid** | **string** | product_user_id | [default to undefined] +**description** | **string** | | [default to undefined] +**amount** | **number** | (USD cents) The reward amount | [default to undefined] +**amount_str** | **string** | The amount as a formatted string in USD. Can be displayed to the user. | [default to undefined] +**contest_start** | **string** | When the leaderboard started | [default to undefined] +**contest_end** | **string** | When the leaderboard ended | [default to undefined] + +## Example + +```typescript +import { LeaderboardWinner } from './api'; + +const instance: LeaderboardWinner = { + rank, + freq, + board_code, + country_iso, + issued, + bpuid, + description, + amount, + amount_str, + contest_start, + contest_end, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
