summaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/LeaderboardContestUserView.md
diff options
context:
space:
mode:
Diffstat (limited to 'jb-ui/src/api_fsb/docs/LeaderboardContestUserView.md')
-rw-r--r--jb-ui/src/api_fsb/docs/LeaderboardContestUserView.md60
1 files changed, 60 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/LeaderboardContestUserView.md b/jb-ui/src/api_fsb/docs/LeaderboardContestUserView.md
new file mode 100644
index 0000000..609f69d
--- /dev/null
+++ b/jb-ui/src/api_fsb/docs/LeaderboardContestUserView.md
@@ -0,0 +1,60 @@
+# LeaderboardContestUserView
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of contest. Can be displayed to user. | [default to undefined]
+**description** | **string** | | [optional] [default to undefined]
+**contest_type** | **string** | | [optional] [default to ContestTypeEnum_Leaderboard]
+**end_condition** | [**ContestEndCondition**](ContestEndCondition.md) | | [optional] [default to undefined]
+**prizes** | [**Array<ContestPrize>**](ContestPrize.md) | | [optional] [default to undefined]
+**starts_at** | **string** | When the contest starts | [optional] [default to undefined]
+**terms_and_conditions** | **string** | | [optional] [default to undefined]
+**status** | [**ContestStatus**](ContestStatus.md) | | [optional] [default to undefined]
+**country_isos** | **string** | | [optional] [default to undefined]
+**uuid** | **string** | | [optional] [default to undefined]
+**product_id** | **string** | Contest applies only to a single BP | [default to undefined]
+**created_at** | **string** | When this contest was created | [optional] [default to undefined]
+**updated_at** | **string** | When this contest was last modified. Does not include entries being created/modified | [optional] [default to undefined]
+**ended_at** | **string** | | [optional] [default to undefined]
+**end_reason** | [**ContestEndReason**](ContestEndReason.md) | | [optional] [default to undefined]
+**product_user_id** | **string** | | [default to undefined]
+**user_winnings** | [**Array<ContestWinner>**](ContestWinner.md) | The prizes won in this contest by the requested user | [optional] [default to undefined]
+**leaderboard_key** | **string** | The specific leaderboard instance this contest is connected to | [default to undefined]
+**tie_break_strategy** | **string** | | [optional] [default to TieBreakStrategyEnum_SplitPrizePool]
+**country_iso** | **string** | | [readonly] [default to undefined]
+**user_rank** | **number** | | [default to undefined]
+
+## Example
+
+```typescript
+import { LeaderboardContestUserView } from './api';
+
+const instance: LeaderboardContestUserView = {
+ name,
+ description,
+ contest_type,
+ end_condition,
+ prizes,
+ starts_at,
+ terms_and_conditions,
+ status,
+ country_isos,
+ uuid,
+ product_id,
+ created_at,
+ updated_at,
+ ended_at,
+ end_reason,
+ product_user_id,
+ user_winnings,
+ leaderboard_key,
+ tie_break_strategy,
+ country_iso,
+ user_rank,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)