diff options
Diffstat (limited to 'jb-ui/src/api_fsb/docs/UserWalletBalance.md')
| -rw-r--r-- | jb-ui/src/api_fsb/docs/UserWalletBalance.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/UserWalletBalance.md b/jb-ui/src/api_fsb/docs/UserWalletBalance.md new file mode 100644 index 0000000..dbfc71c --- /dev/null +++ b/jb-ui/src/api_fsb/docs/UserWalletBalance.md @@ -0,0 +1,28 @@ +# UserWalletBalance + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount** | **number** | (USD cents) The amount in the user\'s wallet. | [default to undefined] +**redeemable_amount** | **number** | (USD cents) The amount in the user\'s wallet this is currently redeemable. | [default to undefined] +**payout_format** | **string** | The format describing the str representation of a payout. Typically, this would be displayed to a user. The payout_format is similar to python format string with a subset of functionality supported. Only float with a precision are supported along with an optional comma for a thousands separator. In addition, a mathematical operator can be applied, such as dividing by 100. Examples are shown assuming payout = 100 (one dollar). - \"{payout*10:,.0f} Points\" -> \"1,000 Points\" - \"${payout/100:.2f}\" -> \"$1.00\" | [default to undefined] +**amount_string** | **string** | The \'amount\' with the payout_format applied. Can be displayed to the user. | [default to undefined] +**redeemable_amount_string** | **string** | The \'redeemable_amount\' with the payout_format applied. Can be displayed to the user. | [default to undefined] + +## Example + +```typescript +import { UserWalletBalance } from './api'; + +const instance: UserWalletBalance = { + amount, + redeemable_amount, + payout_format, + amount_string, + redeemable_amount_string, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |