diff options
Diffstat (limited to 'jb-ui/src/api_fsb/docs/ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet.md')
| -rw-r--r-- | jb-ui/src/api_fsb/docs/ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet.md | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet.md b/jb-ui/src/api_fsb/docs/ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet.md new file mode 100644 index 0000000..36fab3a --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet.md @@ -0,0 +1,86 @@ +# ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet + + +## 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_Milestone] +**end_condition** | [**MilestoneContestEndCondition**](MilestoneContestEndCondition.md) | | [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] +**entry_type** | **string** | | [optional] [default to EntryTypeEnum_Count] +**entry_rule** | [**ContestEntryRule**](ContestEntryRule.md) | | [optional] [default to undefined] +**current_amount** | [**CurrentAmount**](CurrentAmount.md) | | [optional] [default to undefined] +**current_participants** | **number** | Count of unique participants | [optional] [default to 0] +**user_amount** | **number** | The total amount for this user for this contest | [default to undefined] +**user_amount_today** | [**UserAmountToday**](UserAmountToday.md) | | [default to undefined] +**current_win_probability** | **number** | Probability of this user winning 1 or more prizes, if the contestended right now | [readonly] [default to undefined] +**projected_win_probability** | **number** | | [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] +**target_amount** | **number** | Each user \'wins\' (receives prizes) once this target amount is reached. | [default to undefined] +**entry_trigger** | [**ContestEntryTrigger**](ContestEntryTrigger.md) | | [optional] [default to undefined] +**valid_for** | **string** | | [optional] [default to undefined] +**valid_for_event** | **string** | | [optional] [default to undefined] +**win_count** | **number** | The number of times the milestone has been reached. | [optional] [default to 0] + +## Example + +```typescript +import { ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet } from './api'; + +const instance: ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet = { + 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, + entry_type, + entry_rule, + current_amount, + current_participants, + user_amount, + user_amount_today, + current_win_probability, + projected_win_probability, + leaderboard_key, + tie_break_strategy, + country_iso, + user_rank, + target_amount, + entry_trigger, + valid_for, + valid_for_event, + win_count, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
