diff options
Diffstat (limited to 'jb-ui/src/api_fsb/docs/TaskStatusResponse.md')
| -rw-r--r-- | jb-ui/src/api_fsb/docs/TaskStatusResponse.md | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/TaskStatusResponse.md b/jb-ui/src/api_fsb/docs/TaskStatusResponse.md new file mode 100644 index 0000000..68baace --- /dev/null +++ b/jb-ui/src/api_fsb/docs/TaskStatusResponse.md @@ -0,0 +1,63 @@ +# TaskStatusResponse + +The status of a session + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tsid** | **string** | A unique identifier for the session | [default to undefined] +**product_id** | **string** | The BP ID of the associated respondent | [default to undefined] +**product_user_id** | **string** | A unique identifier for each user, which is set by the Supplier | [default to undefined] +**started** | **string** | When the session was started | [default to undefined] +**finished** | **string** | | [optional] [default to undefined] +**status** | **number** | The outcome of a session. - 0 - UNKNOWN - 1 - ENTER (the user has not yet returned) - 2 - INCOMPLETE (the user failed) - 3 - COMPLETE (the user completed the task) | [optional] [default to undefined] +**payout** | **number** | | [optional] [default to undefined] +**user_payout** | **number** | | [optional] [default to undefined] +**payout_format** | **string** | | [optional] [default to undefined] +**user_payout_string** | **string** | | [optional] [default to undefined] +**kwargs** | **{ [key: string]: string; }** | Any extra url params used in the offerwall request will be passed back here | [optional] [default to undefined] +**status_code_1** | **string** | | [optional] [default to undefined] +**status_code_2** | **string** | | [optional] [default to undefined] +**adjusted_status** | [**SessionAdjustedStatus**](SessionAdjustedStatus.md) | | [optional] [default to undefined] +**adjusted_timestamp** | **string** | | [optional] [default to undefined] +**adjusted_payout** | **number** | | [optional] [default to undefined] +**adjusted_user_payout** | **number** | | [optional] [default to undefined] +**adjusted_user_payout_string** | **string** | | [optional] [default to undefined] +**wall_events** | [**Array<WallOut>**](WallOut.md) | | [optional] [default to undefined] +**currency** | **string** | | [optional] [default to CurrencyEnum_Usd] +**final_status** | **number** | This is deprecated | [optional] [default to 0] +**bpuid** | **string** | | [readonly] [default to undefined] + +## Example + +```typescript +import { TaskStatusResponse } from './api'; + +const instance: TaskStatusResponse = { + tsid, + product_id, + product_user_id, + started, + finished, + status, + payout, + user_payout, + payout_format, + user_payout_string, + kwargs, + status_code_1, + status_code_2, + adjusted_status, + adjusted_timestamp, + adjusted_payout, + adjusted_user_payout, + adjusted_user_payout_string, + wall_events, + currency, + final_status, + bpuid, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
