summaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/TopNPlusBucket.md
diff options
context:
space:
mode:
Diffstat (limited to 'jb-ui/src/api_fsb/docs/TopNPlusBucket.md')
-rw-r--r--jb-ui/src/api_fsb/docs/TopNPlusBucket.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/TopNPlusBucket.md b/jb-ui/src/api_fsb/docs/TopNPlusBucket.md
new file mode 100644
index 0000000..a50e140
--- /dev/null
+++ b/jb-ui/src/api_fsb/docs/TopNPlusBucket.md
@@ -0,0 +1,46 @@
+# TopNPlusBucket
+
+
+## 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]
+**contents** | [**Array<BucketTask>**](BucketTask.md) | | [default to undefined]
+**duration** | [**DurationSummary**](DurationSummary.md) | | [default to undefined]
+**payout** | [**PayoutSummary**](PayoutSummary.md) | | [default to undefined]
+**quality_score** | **number** | | [default to undefined]
+**currency** | **string** | This will always be \'USD\' | [optional] [default to 'USD']
+**eligibility_criteria** | [**Array<SurveyEligibilityCriterion>**](SurveyEligibilityCriterion.md) | The reasons the user is eligible for tasks in this bucket | [optional] [default to undefined]
+**eligibility_explanation** | **string** | | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TopNPlusBucket } from './api';
+
+const instance: TopNPlusBucket = {
+ id,
+ uri,
+ x,
+ y,
+ name,
+ description,
+ category,
+ contents,
+ duration,
+ payout,
+ quality_score,
+ currency,
+ eligibility_criteria,
+ eligibility_explanation,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)