diff options
Diffstat (limited to 'jb-ui/src/api_fsb/docs/ContestApi.md')
| -rw-r--r-- | jb-ui/src/api_fsb/docs/ContestApi.md | 234 |
1 files changed, 234 insertions, 0 deletions
diff --git a/jb-ui/src/api_fsb/docs/ContestApi.md b/jb-ui/src/api_fsb/docs/ContestApi.md new file mode 100644 index 0000000..57b11f4 --- /dev/null +++ b/jb-ui/src/api_fsb/docs/ContestApi.md @@ -0,0 +1,234 @@ +# ContestApi + +All URIs are relative to *https://fsb.generalresearch.com* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**getContestUserViewProductIdContestContestUuidUserProductUserIdGet**](#getcontestuserviewproductidcontestcontestuuiduserproductuseridget) | **GET** /{product_id}/contest/{contest_uuid}/user/{product_user_id}/ | Get Contest User View| +|[**listContestsUserEligibleProductIdContestUserProductUserIdEligibleGet**](#listcontestsusereligibleproductidcontestuserproductuserideligibleget) | **GET** /{product_id}/contest/user/{product_user_id}/eligible/ | List Contests User Eligible| +|[**listContestsUserEnteredProductIdContestUserProductUserIdEnteredGet**](#listcontestsuserenteredproductidcontestuserproductuseridenteredget) | **GET** /{product_id}/contest/user/{product_user_id}/entered/ | List Contests User Entered| +|[**listContestsUserWinnerProductIdContestUserProductUserIdWinnerGet**](#listcontestsuserwinnerproductidcontestuserproductuseridwinnerget) | **GET** /{product_id}/contest/user/{product_user_id}/winner/ | List Contests User Winner| + +# **getContestUserViewProductIdContestContestUuidUserProductUserIdGet** +> ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet getContestUserViewProductIdContestContestUuidUserProductUserIdGet() + +Gets a Contest. Includes several keys that are specific to the requesting user: e.g. user_winnings, user_amount. + +### Example + +```typescript +import { + ContestApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ContestApi(configuration); + +let productId: string; //The Brokerage Product ID provided by GRL. (default to undefined) +let contestUuid: string; // (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.getContestUserViewProductIdContestContestUuidUserProductUserIdGet( + productId, + contestUuid, + productUserId +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **productId** | [**string**] | The Brokerage Product ID provided by GRL. | defaults to undefined| +| **contestUuid** | [**string**] | | 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 + +**ResponseGetContestUserViewProductIdContestContestUuidUserProductUserIdGet** + +### 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) + +# **listContestsUserEligibleProductIdContestUserProductUserIdEligibleGet** +> Array<ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner> listContestsUserEligibleProductIdContestUserProductUserIdEligibleGet() + +Get contests the requesting user is eligible for. Contest eligibility may involve the user\'s country, which is determined by the ip address of THIS request. + +### Example + +```typescript +import { + ContestApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ContestApi(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.listContestsUserEligibleProductIdContestUserProductUserIdEligibleGet( + 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 + +**Array<ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner>** + +### 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) + +# **listContestsUserEnteredProductIdContestUserProductUserIdEnteredGet** +> Array<ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner> listContestsUserEnteredProductIdContestUserProductUserIdEnteredGet() + +Get contests the requesting user has entered. This includes contests such as milestone contests where the user was automatically entered by having a complete for instance. + +### Example + +```typescript +import { + ContestApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ContestApi(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.listContestsUserEnteredProductIdContestUserProductUserIdEnteredGet( + 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 + +**Array<ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner>** + +### 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) + +# **listContestsUserWinnerProductIdContestUserProductUserIdWinnerGet** +> Array<ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner> listContestsUserWinnerProductIdContestUserProductUserIdWinnerGet() + +Get contests the requesting user has won a prize for. + +### Example + +```typescript +import { + ContestApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new ContestApi(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.listContestsUserWinnerProductIdContestUserProductUserIdWinnerGet( + 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 + +**Array<ListContestsUserEnteredProductIdContestUserProductUserIdEnteredGet200ResponseInner>** + +### 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) + |