diff options
Diffstat (limited to 'jb-ui/src/api_fsb/docs/Leaderboard.md')
| -rw-r--r-- | jb-ui/src/api_fsb/docs/Leaderboard.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/jb-ui/src/api_fsb/docs/Leaderboard.md b/jb-ui/src/api_fsb/docs/Leaderboard.md index adae56c..a735f49 100644 --- a/jb-ui/src/api_fsb/docs/Leaderboard.md +++ b/jb-ui/src/api_fsb/docs/Leaderboard.md @@ -6,18 +6,18 @@ A leaderboard exists independently for each product_id in each country. Each cou Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **string** | Unique ID for this leaderboard | [optional] [default to undefined] -**name** | **string** | Descriptive name for the leaderboard based on the board_code | [optional] [default to undefined] +**id** | **string** | | [optional] [default to undefined] +**name** | **string** | | [optional] [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] **bpid** | **string** | product_id | [default to undefined] **country_iso** | **string** | The country this leaderboard is for. | [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] -**timezone_name** | **string** | The timezone for the requested country | [optional] [default to undefined] +**timezone_name** | **string** | | [optional] [default to undefined] **sort_order** | **string** | | [optional] [default to SortOrderEnum_Descending] **row_count** | **number** | The total number of rows in the leaderboard. | [default to undefined] **rows** | [**Array<LeaderboardRow>**](LeaderboardRow.md) | | [optional] [default to undefined] **period_start_local** | **string** | The start of the time period covered by this board in local time, tz-aware | [default to undefined] -**period_end_local** | **string** | The end of the time period covered by this board in local time, tz-aware | [optional] [default to undefined] +**period_end_local** | **string** | | [optional] [default to undefined] **start_timestamp** | **number** | (unix timestamp) The start time of the time range this leaderboard covers. | [readonly] [default to undefined] **end_timestamp** | **number** | (unix timestamp) The end time of the time range this leaderboard covers. | [readonly] [default to undefined] **utc_offset** | **string** | The UTC offset for the timezone | [readonly] [default to undefined] |