summaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/SessionConfig.md
diff options
context:
space:
mode:
Diffstat (limited to 'jb-ui/src/api_fsb/docs/SessionConfig.md')
-rw-r--r--jb-ui/src/api_fsb/docs/SessionConfig.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/SessionConfig.md b/jb-ui/src/api_fsb/docs/SessionConfig.md
new file mode 100644
index 0000000..1df61d8
--- /dev/null
+++ b/jb-ui/src/api_fsb/docs/SessionConfig.md
@@ -0,0 +1,25 @@
+# SessionConfig
+
+Stores configuration related to the Session, a session being a users experience attempting to do work.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**max_session_len** | **number** | The amount of time (in seconds) that a respondent may spend attempting to get into a survey within a session.If NULL, there is no limit. | [optional] [default to 600]
+**max_session_hard_retry** | **number** | The number of surveys that a respondent may attempt within a session before the session is terminated. | [optional] [default to 5]
+**min_payout** | **string** | The minimum amount the user should be paid for a complete. If no payout transformation is defined, the value is based on the BP\'s payout. If a payout transformation is defined, the min_payout is applied on the user\'s payout. Note, this is separate and distinct from the payout transformation\'s min payout. The payout transformation\'s min_payout does not care what the task\'s actual payout was. This min_payout will prevent the user from being show any tasks that would pay below this amount. | [optional] [default to '0.14']
+
+## Example
+
+```typescript
+import { SessionConfig } from './api';
+
+const instance: SessionConfig = {
+ max_session_len,
+ max_session_hard_retry,
+ min_payout,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)