diff options
Diffstat (limited to 'jb-ui/src/api_fsb/docs/TopNBucket.md')
| -rw-r--r-- | jb-ui/src/api_fsb/docs/TopNBucket.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/TopNBucket.md b/jb-ui/src/api_fsb/docs/TopNBucket.md new file mode 100644 index 0000000..e65619b --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TopNBucket.md @@ -0,0 +1,38 @@ +# TopNBucket + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier this particular bucket | [default to undefined] +**uri** | **string** | The URL to send a respondent into. Must not edit this URL in any way | [default to undefined] +**x** | **number** | For UI. Provides a dimensionality position for the bucket on the x-axis. | [optional] [default to 0] +**y** | **number** | For UI. Provides a dimensionality position for the bucket on the y-axis. | [optional] [default to 0] +**name** | **string** | Currently unused. Will always return empty string | [optional] [default to ''] +**description** | **string** | Currently unused. Will always return empty string | [optional] [default to ''] +**category** | [**Array<CategoryAssociation>**](CategoryAssociation.md) | | [optional] [default to undefined] +**duration** | [**DurationSummary**](DurationSummary.md) | | [default to undefined] +**payout** | [**PayoutSummary**](PayoutSummary.md) | | [default to undefined] +**quality_score** | **number** | A proprietary score to determine the overall quality of the tasks that are within the bucket. Higher is better. | [default to undefined] + +## Example + +```typescript +import { TopNBucket } from './api'; + +const instance: TopNBucket = { + id, + uri, + x, + y, + name, + description, + category, + duration, + payout, + quality_score, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
