summaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/Leaderboard.md
diff options
context:
space:
mode:
Diffstat (limited to 'jb-ui/src/api_fsb/docs/Leaderboard.md')
-rw-r--r--jb-ui/src/api_fsb/docs/Leaderboard.md55
1 files changed, 55 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/Leaderboard.md b/jb-ui/src/api_fsb/docs/Leaderboard.md
new file mode 100644
index 0000000..adae56c
--- /dev/null
+++ b/jb-ui/src/api_fsb/docs/Leaderboard.md
@@ -0,0 +1,55 @@
+# Leaderboard
+
+A leaderboard exists independently for each product_id in each country. Each country is associated with a single timezone. There is a daily, weekly, and monthly leaderboard.
+
+## Properties
+
+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]
+**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]
+**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]
+**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]
+**local_start_time** | **string** | The start time of the time range this leaderboard covers (local time, in the leaderboard\'s timezone). | [readonly] [default to undefined]
+**local_end_time** | **string** | The end time of the time range this leaderboard covers (local time, in the leaderboard\'s timezone). | [readonly] [default to undefined]
+**start_end_str** | **string** | A formatted string for time period covered by this leaderboard. Can be used to display to users. | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { Leaderboard } from './api';
+
+const instance: Leaderboard = {
+ id,
+ name,
+ board_code,
+ bpid,
+ country_iso,
+ freq,
+ timezone_name,
+ sort_order,
+ row_count,
+ rows,
+ period_start_local,
+ period_end_local,
+ start_timestamp,
+ end_timestamp,
+ utc_offset,
+ local_start_time,
+ local_end_time,
+ start_end_str,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)