From e7e5b5f8bf81e78e417ecdb9dd6ab1616e722fa0 Mon Sep 17 00:00:00 2001 From: Max Nanis Date: Wed, 9 Sep 2026 20:03:48 -0700 Subject: new api_fsb generated files --- jb-ui/src/api_fsb/docs/OfferwallApi.md | 243 --------------------------------- 1 file changed, 243 deletions(-) (limited to 'jb-ui/src/api_fsb/docs/OfferwallApi.md') diff --git a/jb-ui/src/api_fsb/docs/OfferwallApi.md b/jb-ui/src/api_fsb/docs/OfferwallApi.md index 8e7591d..4b77589 100644 --- a/jb-ui/src/api_fsb/docs/OfferwallApi.md +++ b/jb-ui/src/api_fsb/docs/OfferwallApi.md @@ -10,12 +10,9 @@ All URIs are relative to *https://fsb.generalresearch.com* |[**offerwallSoftpairPostProductIdOfferwall37d1da64OfferwallIdPost**](#offerwallsoftpairpostproductidofferwall37d1da64offerwallidpost) | **POST** /{product_id}/offerwall/37d1da64/{offerwall_id}/ | Offerwall Softpair Post| |[**offerwallSoftpairProductIdOfferwall37d1da64Get**](#offerwallsoftpairproductidofferwall37d1da64get) | **GET** /{product_id}/offerwall/37d1da64/ | Offerwall Softpair| |[**oneShotOfferwallProductIdOfferwall6f27b1aeGet**](#oneshotofferwallproductidofferwall6f27b1aeget) | **GET** /{product_id}/offerwall/6f27b1ae/ | One Shot Offerwall| -|[**singleOfferwallProductIdOfferwall5fl8bpv5Get**](#singleofferwallproductidofferwall5fl8bpv5get) | **GET** /{product_id}/offerwall/5fl8bpv5/ | Single Offerwall| -|[**starwallOfferwallProductIdOfferwallB59a2d2bGet**](#starwallofferwallproductidofferwallb59a2d2bget) | **GET** /{product_id}/offerwall/b59a2d2b/ | Starwall Offerwall| |[**starwallPlusBlockOfferwallProductIdOfferwall7fa1b3f4Get**](#starwallplusblockofferwallproductidofferwall7fa1b3f4get) | **GET** /{product_id}/offerwall/7fa1b3f4/ | Starwall Plus Block Offerwall| |[**starwallPlusBlockRecontactOfferwallProductIdOfferwall630db2a4Get**](#starwallplusblockrecontactofferwallproductidofferwall630db2a4get) | **GET** /{product_id}/offerwall/630db2a4/ | Starwall Plus Block Recontact Offerwall| |[**starwallPlusOfferwallProductIdOfferwall5481f322Get**](#starwallplusofferwallproductidofferwall5481f322get) | **GET** /{product_id}/offerwall/5481f322/ | Starwall Plus Offerwall| -|[**topNOfferwallProductIdOfferwall45b7228a7Get**](#topnofferwallproductidofferwall45b7228a7get) | **GET** /{product_id}/offerwall/45b7228a7/ | Topn Offerwall| |[**topNPlusBlockOfferwallProductIdOfferwallD48cce47Get**](#topnplusblockofferwallproductidofferwalld48cce47get) | **GET** /{product_id}/offerwall/d48cce47/ | Topn Plus Block Offerwall| |[**topNPlusBlockRecontactOfferwallProductIdOfferwall1e5f0af8Get**](#topnplusblockrecontactofferwallproductidofferwall1e5f0af8get) | **GET** /{product_id}/offerwall/1e5f0af8/ | Topn Plus Block Recontact Offerwall| |[**topNPlusOfferwallProductIdOfferwallB145b803Get**](#topnplusofferwallproductidofferwallb145b803get) | **GET** /{product_id}/offerwall/b145b803/ | Topn Plus Offerwall| @@ -468,164 +465,6 @@ No authorization required - **Accept**: application/json -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -|**200** | Successful Response | - | -|**422** | Validation Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **singleOfferwallProductIdOfferwall5fl8bpv5Get** -> SingleEntryOfferWallResponse singleOfferwallProductIdOfferwall5fl8bpv5Get() - -Only returns a single bucket with the top scoring tasks. - -### Example - -```typescript -import { - OfferwallApi, - Configuration -} from './api'; - -const configuration = new Configuration(); -const apiInstance = new OfferwallApi(configuration); - -let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) -let bpuid: string; //A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. (default to undefined) -let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) -let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) -let languages: Array; //Respondent\'s desired languages (ISO 639-2/B, lowercase) (optional) (default to undefined) -let behavior: string; //Allows using custom scoring functions. Please discuss directly with GRL. (optional) (default to undefined) -let minPayout: string; //Decimal representation of the minimum amount of USD that any of the tasks will pay (optional) (default to undefined) -let duration: number; //Maximum length of desired task (in seconds). (optional) (default to undefined) -let minBinSize: number; //Minimum number of tasks that need to be in a bucket (optional) (default to 3) - -const { status, data } = await apiInstance.singleOfferwallProductIdOfferwall5fl8bpv5Get( - productId, - bpuid, - ip, - countryIso, - languages, - behavior, - minPayout, - duration, - minBinSize -); -``` - -### Parameters - -|Name | Type | Description | Notes| -|------------- | ------------- | ------------- | -------------| -| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| -| **bpuid** | [**string**] | A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. | defaults to undefined| -| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| -| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| -| **languages** | **Array<string>** | Respondent\'s desired languages (ISO 639-2/B, lowercase) | (optional) defaults to undefined| -| **behavior** | [**string**] | Allows using custom scoring functions. Please discuss directly with GRL. | (optional) defaults to undefined| -| **minPayout** | [**string**] | Decimal representation of the minimum amount of USD that any of the tasks will pay | (optional) defaults to undefined| -| **duration** | [**number**] | Maximum length of desired task (in seconds). | (optional) defaults to undefined| -| **minBinSize** | [**number**] | Minimum number of tasks that need to be in a bucket | (optional) defaults to 3| - - -### Return type - -**SingleEntryOfferWallResponse** - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -|**200** | Successful Response | - | -|**422** | Validation Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **starwallOfferwallProductIdOfferwallB59a2d2bGet** -> StarwallOfferWallResponse starwallOfferwallProductIdOfferwallB59a2d2bGet() - -Returns an offerwall with buckets that are clustered by setting as seeds the highest scoring surveys for each bin, then the rest are distributed according to their Euclidean distance using the bucket\'s features. - -### Example - -```typescript -import { - OfferwallApi, - Configuration -} from './api'; - -const configuration = new Configuration(); -const apiInstance = new OfferwallApi(configuration); - -let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) -let bpuid: string; //A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. (default to undefined) -let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) -let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) -let languages: Array; //Respondent\'s desired languages (ISO 639-2/B, lowercase) (optional) (default to undefined) -let behavior: string; //Allows using custom scoring functions. Please discuss directly with GRL. (optional) (default to undefined) -let minPayout: string; //Decimal representation of the minimum amount of USD that any of the tasks will pay (optional) (default to undefined) -let duration: number; //Maximum length of desired task (in seconds). (optional) (default to undefined) -let nBins: number; //Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. (optional) (default to 1) -let minBinSize: number; //Minimum number of tasks that need to be in a bucket (optional) (default to 3) -let splitBy: 'payout' | 'duration'; //Cluster tasks by payout or duration (optional) (default to 'payout') - -const { status, data } = await apiInstance.starwallOfferwallProductIdOfferwallB59a2d2bGet( - productId, - bpuid, - ip, - countryIso, - languages, - behavior, - minPayout, - duration, - nBins, - minBinSize, - splitBy -); -``` - -### Parameters - -|Name | Type | Description | Notes| -|------------- | ------------- | ------------- | -------------| -| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| -| **bpuid** | [**string**] | A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. | defaults to undefined| -| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| -| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| -| **languages** | **Array<string>** | Respondent\'s desired languages (ISO 639-2/B, lowercase) | (optional) defaults to undefined| -| **behavior** | [**string**] | Allows using custom scoring functions. Please discuss directly with GRL. | (optional) defaults to undefined| -| **minPayout** | [**string**] | Decimal representation of the minimum amount of USD that any of the tasks will pay | (optional) defaults to undefined| -| **duration** | [**number**] | Maximum length of desired task (in seconds). | (optional) defaults to undefined| -| **nBins** | [**number**] | Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. | (optional) defaults to 1| -| **minBinSize** | [**number**] | Minimum number of tasks that need to be in a bucket | (optional) defaults to 3| -| **splitBy** | [**'payout' | 'duration'**]**Array<'payout' | 'duration'>** | Cluster tasks by payout or duration | (optional) defaults to 'payout'| - - -### Return type - -**StarwallOfferWallResponse** - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| @@ -872,88 +711,6 @@ No authorization required - **Accept**: application/json -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -|**200** | Successful Response | - | -|**422** | Validation Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **topNOfferwallProductIdOfferwall45b7228a7Get** -> TopNOfferWallResponse topNOfferwallProductIdOfferwall45b7228a7Get() - -Returns an offerwall with buckets that are clustered by the `split_by` argument using KMeans clustering. - -### Example - -```typescript -import { - OfferwallApi, - Configuration -} from './api'; - -const configuration = new Configuration(); -const apiInstance = new OfferwallApi(configuration); - -let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) -let bpuid: string; //A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. (default to undefined) -let ip: string; //Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. (optional) (default to undefined) -let countryIso: string; //Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) (optional) (default to undefined) -let languages: Array; //Respondent\'s desired languages (ISO 639-2/B, lowercase) (optional) (default to undefined) -let behavior: string; //Allows using custom scoring functions. Please discuss directly with GRL. (optional) (default to undefined) -let minPayout: string; //Decimal representation of the minimum amount of USD that any of the tasks will pay (optional) (default to undefined) -let duration: number; //Maximum length of desired task (in seconds). (optional) (default to undefined) -let nBins: number; //Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. (optional) (default to 1) -let minBinSize: number; //Minimum number of tasks that need to be in a bucket (optional) (default to 3) -let splitBy: 'payout' | 'duration'; //Cluster tasks by payout or duration (optional) (default to 'payout') - -const { status, data } = await apiInstance.topNOfferwallProductIdOfferwall45b7228a7Get( - productId, - bpuid, - ip, - countryIso, - languages, - behavior, - minPayout, - duration, - nBins, - minBinSize, - splitBy -); -``` - -### Parameters - -|Name | Type | Description | Notes| -|------------- | ------------- | ------------- | -------------| -| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| -| **bpuid** | [**string**] | A unique identifier for each user, which is set by the Supplier. Must be consistent across respondent entrances and unique to the platform. It should not contain any sensitive information like email or names, and should avoid using any incrementing values. | defaults to undefined| -| **ip** | [**string**] | Respondent\'s IP address (IPv4 or IPv6). Either \'ip\' must be provided, or \'country_iso\' must be provided if \'ip\' is not provided. | (optional) defaults to undefined| -| **countryIso** | [**string**] | Respondent\'s country code (ISO 3166-1 alpha-2, lowercase) | (optional) defaults to undefined| -| **languages** | **Array<string>** | Respondent\'s desired languages (ISO 639-2/B, lowercase) | (optional) defaults to undefined| -| **behavior** | [**string**] | Allows using custom scoring functions. Please discuss directly with GRL. | (optional) defaults to undefined| -| **minPayout** | [**string**] | Decimal representation of the minimum amount of USD that any of the tasks will pay | (optional) defaults to undefined| -| **duration** | [**number**] | Maximum length of desired task (in seconds). | (optional) defaults to undefined| -| **nBins** | [**number**] | Number of bins requested in the offerwall. If n_bins=1 there is no grouping and you get all duration + payout metrics on across all (as shown by the availability_count). n_bins=0 will return back an empty bucket array, however, the availability_count will still show the total opportunities available for that bpuid + passed in parameter settings. n_bins=∞ (or any positive integer) will return back the total number of bins capable of being uniquely split. | (optional) defaults to 1| -| **minBinSize** | [**number**] | Minimum number of tasks that need to be in a bucket | (optional) defaults to 3| -| **splitBy** | [**'payout' | 'duration'**]**Array<'payout' | 'duration'>** | Cluster tasks by payout or duration | (optional) defaults to 'payout'| - - -### Return type - -**TopNOfferWallResponse** - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -- cgit v1.2.3