summaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/MilestoneUserView.md
blob: 2836ff383efd3dc5f8861ea6833ed4487c22e41d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# MilestoneUserView


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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]
**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]
**win_count** | **number** | The number of times the milestone has been reached. | [optional] [default to 0]
**user_amount** | **number** | The total amount for this user for this contest | [default to undefined]

## Example

```typescript
import { MilestoneUserView } from './api';

const instance: MilestoneUserView = {
    target_amount,
    entry_trigger,
    valid_for,
    valid_for_event,
    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,
    win_count,
    user_amount,
};
```

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)