From 3eaa56f0306ead818f64c3d99fc6d230d9b970a4 Mon Sep 17 00:00:00 2001 From: Max Nanis Date: Wed, 18 Feb 2026 20:42:03 -0500 Subject: HERE WE GO, HERE WE GO, HERE WE GO --- jb-ui/src/api_fsb/docs/Product.md | 72 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 jb-ui/src/api_fsb/docs/Product.md (limited to 'jb-ui/src/api_fsb/docs/Product.md') diff --git a/jb-ui/src/api_fsb/docs/Product.md b/jb-ui/src/api_fsb/docs/Product.md new file mode 100644 index 0000000..3dfe1d3 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/Product.md @@ -0,0 +1,72 @@ +# Product + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **string** | Unique identifier of the Brokerage Product | [optional] [default to undefined] +**name** | **string** | Name of the Brokerage Product. Must be unique within a Team | [default to undefined] +**enabled** | **boolean** | This is only used to hard block a Product in order to immediately & safely protect against fraud entrances. | [optional] [default to true] +**payments_enabled** | **boolean** | This is only to determine if ACH or Wire payments should be made to the Produce. | [optional] [default to true] +**created** | **string** | | [optional] [default to undefined] +**team_id** | **string** | | [optional] [default to undefined] +**business_id** | **string** | | [optional] [default to undefined] +**tags** | [**Set<SupplierTag>**](SupplierTag.md) | Tags which are used to annotate supplier traffic | [optional] [default to undefined] +**commission_pct** | **string** | | [optional] [default to '0.05'] +**redirect_url** | **string** | Where to redirect the user after finishing a session. When a user get redirected back to the supplier, a query param will be added with the name \'tsid\', and the value of the TSID for the session. For example: callback_uri: \'https://www.example.com/test/?a=1&b=2\' might result in the user getting redirected to: \'https://www.example.com/grl-callback/?a=1&b=2&tsid=c6ab6ba1e75b44e2bf5aab00fc68e3b7\'. | [default to undefined] +**harmonizer_domain** | **string** | This is the domain that is used for the GRS (General Research Survey) platform. This is a simple javascript application which may profile the respondent for anyprofiling questions, along with collecting any browserbased security information. The value is a scheme+domain only (no path). | [optional] [default to 'https://profile.generalresearch.com/'] +**sources_config** | [**SourcesConfig**](SourcesConfig.md) | | [optional] [default to undefined] +**session_config** | [**SessionConfig**](SessionConfig.md) | | [optional] [default to undefined] +**payout_config** | [**PayoutConfig**](PayoutConfig.md) | | [optional] [default to undefined] +**user_wallet_config** | [**UserWalletConfig**](UserWalletConfig.md) | | [optional] [default to undefined] +**user_create_config** | [**UserCreateConfig**](UserCreateConfig.md) | | [optional] [default to undefined] +**offerwall_config** | **object** | | [optional] [default to undefined] +**profiling_config** | [**ProfilingConfig**](ProfilingConfig.md) | | [optional] [default to undefined] +**user_health_config** | [**UserHealthConfig**](UserHealthConfig.md) | | [optional] [default to undefined] +**yield_man_config** | [**YieldManConfig**](YieldManConfig.md) | | [optional] [default to undefined] +**balance** | [**ProductBalances**](ProductBalances.md) | | [optional] [default to undefined] +**payouts_total_str** | **string** | | [optional] [default to undefined] +**payouts_total** | **number** | | [optional] [default to undefined] +**payouts** | [**Array<BrokerageProductPayoutEvent>**](BrokerageProductPayoutEvent.md) | | [optional] [default to undefined] +**pop_financial** | [**Array<POPFinancial>**](POPFinancial.md) | | [optional] [default to undefined] +**bp_account** | [**LedgerAccount**](LedgerAccount.md) | | [optional] [default to undefined] +**user_wallet** | [**UserWalletConfig**](UserWalletConfig.md) | | [readonly] [default to undefined] + +## Example + +```typescript +import { Product } from './api'; + +const instance: Product = { + id, + name, + enabled, + payments_enabled, + created, + team_id, + business_id, + tags, + commission_pct, + redirect_url, + harmonizer_domain, + sources_config, + session_config, + payout_config, + user_wallet_config, + user_create_config, + offerwall_config, + profiling_config, + user_health_config, + yield_man_config, + balance, + payouts_total_str, + payouts_total, + payouts, + pop_financial, + bp_account, + user_wallet, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) -- cgit v1.2.3