diff options
Diffstat (limited to 'jb-ui/src/api_fsb/docs/PayoutTransformation.md')
| -rw-r--r-- | jb-ui/src/api_fsb/docs/PayoutTransformation.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/PayoutTransformation.md b/jb-ui/src/api_fsb/docs/PayoutTransformation.md new file mode 100644 index 0000000..378fde0 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/PayoutTransformation.md @@ -0,0 +1,23 @@ +# PayoutTransformation + +This model describe how the bp_payout is converted to the user_payout. If None, the user_payout is None. If the user_wallet_enabled is `False`, the user_payout is used to 1) know how to transform the expected payouts for offerwall buckets (if min_payout is requested, this is based on the user_payout) 2) show the user (using the payout_format) how much they made (in the Task Status Response). If the user_wallet_enabled is `True`, then in addition to the above, the user_payout is the amount actually paid to the user\'s wallet. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**f** | **string** | The name of the transformation function to use. | [default to undefined] +**kwargs** | [**PayoutTransformationPercentArgs**](PayoutTransformationPercentArgs.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { PayoutTransformation } from './api'; + +const instance: PayoutTransformation = { + f, + kwargs, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |