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/ProductUserApi.md | 179 +++++++++++++++++++++++++++++++ 1 file changed, 179 insertions(+) create mode 100644 jb-ui/src/api_fsb/docs/ProductUserApi.md (limited to 'jb-ui/src/api_fsb/docs/ProductUserApi.md') diff --git a/jb-ui/src/api_fsb/docs/ProductUserApi.md b/jb-ui/src/api_fsb/docs/ProductUserApi.md new file mode 100644 index 0000000..be0f30e --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ProductUserApi.md @@ -0,0 +1,179 @@ +# ProductUserApi + +All URIs are relative to *https://fsb.generalresearch.com* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**userProfileFilterByMarketplacePidProductIdUserByMarketplacePidGet**](#userprofilefilterbymarketplacepidproductiduserbymarketplacepidget) | **GET** /{product_id}/user/by-marketplace-pid/ | User Profile Filter By Marketplace Pid| +|[**userProfileProductIdUserProductUserIdProfileGet**](#userprofileproductiduserproductuseridprofileget) | **GET** /{product_id}/user/{product_user_id}/profile/ | User Profile| +|[**userProfileUpdateProductIdUserProductUserIdProfilePatch**](#userprofileupdateproductiduserproductuseridprofilepatch) | **PATCH** /{product_id}/user/{product_user_id}/profile/ | User Profile Update| + +# **userProfileFilterByMarketplacePidProductIdUserByMarketplacePidGet** +> UserProfilesResponse userProfileFilterByMarketplacePidProductIdUserByMarketplacePidGet() + + +### Example + +```typescript +import { + ProductUserApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ProductUserApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let source: Source; //The marketplace to search (default to undefined) +let pid: Array; //The user\'s marketplace PID. Supports multiple params (default to undefined) + +const { status, data } = await apiInstance.userProfileFilterByMarketplacePidProductIdUserByMarketplacePidGet( + productId, + source, + pid +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **source** | **Source** | The marketplace to search | defaults to undefined| +| **pid** | **Array<string>** | The user\'s marketplace PID. Supports multiple params | defaults to undefined| + + +### Return type + +**UserProfilesResponse** + +### 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) + +# **userProfileProductIdUserProductUserIdProfileGet** +> UserProfileResponse userProfileProductIdUserProductUserIdProfileGet() + + +### Example + +```typescript +import { + ProductUserApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ProductUserApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let productUserId: 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) + +const { status, data } = await apiInstance.userProfileProductIdUserProductUserIdProfileGet( + productId, + productUserId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **productUserId** | [**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| + + +### Return type + +**UserProfileResponse** + +### 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) + +# **userProfileUpdateProductIdUserProductUserIdProfilePatch** +> StatusResponse userProfileUpdateProductIdUserProductUserIdProfilePatch(userProfileUpdateRequest) + + +### Example + +```typescript +import { + ProductUserApi, + Configuration, + UserProfileUpdateRequest +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ProductUserApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let productUserId: 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 userProfileUpdateRequest: UserProfileUpdateRequest; // + +const { status, data } = await apiInstance.userProfileUpdateProductIdUserProductUserIdProfilePatch( + productId, + productUserId, + userProfileUpdateRequest +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **userProfileUpdateRequest** | **UserProfileUpdateRequest**| | | +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **productUserId** | [**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| + + +### Return type + +**StatusResponse** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + -- cgit v1.2.3