@gooday_corp/gooday-api-client 1.3.33 → 1.3.35

package/docs/UsersApi.md

@@ -0,0 +1,549 @@
+# UsersApi
+
+All URIs are relative to *http://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**usersControllerAccountDelete**](#userscontrolleraccountdelete) | **DELETE** /v1/user/delete | |
+|[**usersControllerAddToWaitingList**](#userscontrolleraddtowaitinglist) | **POST** /v1/user/joining-list | |
+|[**usersControllerDeactivateAccount**](#userscontrollerdeactivateaccount) | **DELETE** /v1/user/deactivate | |
+|[**usersControllerGetMe**](#userscontrollergetme) | **GET** /v1/user/me | |
+|[**usersControllerGetUser**](#userscontrollergetuser) | **POST** /v1/user/get-user | |
+|[**usersControllerOnBoarded**](#userscontrolleronboarded) | **POST** /v1/user/onboarding | |
+|[**usersControllerStreak**](#userscontrollerstreak) | **POST** /v1/user/streak | |
+|[**usersControllerSyncUserInfo**](#userscontrollersyncuserinfo) | **POST** /v1/user/sync-info | |
+|[**usersControllerSyncUserPermissions**](#userscontrollersyncuserpermissions) | **PUT** /v1/user/permissions | |
+|[**usersControllerUserActivity**](#userscontrolleruseractivity) | **GET** /v1/user/analytics/activity | |
+|[**usersControllerUserHangout**](#userscontrolleruserhangout) | **PUT** /v1/user/hangout | |
+
+# **usersControllerAccountDelete**
+> OnBoardingResponseDTO usersControllerAccountDelete()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+const { status, data } = await apiInstance.usersControllerAccountDelete();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**OnBoardingResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[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)
+
+# **usersControllerAddToWaitingList**
+> UserWaitingListResponseDTO usersControllerAddToWaitingList(userWaitingListPayloadDTO)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    UserWaitingListPayloadDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let userWaitingListPayloadDTO: UserWaitingListPayloadDTO; //
+
+const { status, data } = await apiInstance.usersControllerAddToWaitingList(
+    userWaitingListPayloadDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userWaitingListPayloadDTO** | **UserWaitingListPayloadDTO**|  | |
+
+
+### Return type
+
+**UserWaitingListResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[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)
+
+# **usersControllerDeactivateAccount**
+> OnBoardingResponseDTO usersControllerDeactivateAccount()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+const { status, data } = await apiInstance.usersControllerDeactivateAccount();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**OnBoardingResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[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)
+
+# **usersControllerGetMe**
+> UserMeDTO usersControllerGetMe()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+const { status, data } = await apiInstance.usersControllerGetMe();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**UserMeDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** | User is not found |  -  |
+
+[[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)
+
+# **usersControllerGetUser**
+> OnBoardingResponseDTO usersControllerGetUser(getUserDTO)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    GetUserDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let getUserDTO: GetUserDTO; //
+
+const { status, data } = await apiInstance.usersControllerGetUser(
+    getUserDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **getUserDTO** | **GetUserDTO**|  | |
+
+
+### Return type
+
+**OnBoardingResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** | Requested User is not found |  -  |
+
+[[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)
+
+# **usersControllerOnBoarded**
+> OnBoardingResponseDTO usersControllerOnBoarded(onBoardingDTO)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    OnBoardingDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let onBoardingDTO: OnBoardingDTO; //
+
+const { status, data } = await apiInstance.usersControllerOnBoarded(
+    onBoardingDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **onBoardingDTO** | **OnBoardingDTO**|  | |
+
+
+### Return type
+
+**OnBoardingResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** | User is not found |  -  |
+
+[[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)
+
+# **usersControllerStreak**
+> UserMeDTO usersControllerStreak()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+const { status, data } = await apiInstance.usersControllerStreak();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**UserMeDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[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)
+
+# **usersControllerSyncUserInfo**
+> OnBoardingResponseDTO usersControllerSyncUserInfo(userSyncDTO)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    UserSyncDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let userSyncDTO: UserSyncDTO; //
+
+const { status, data } = await apiInstance.usersControllerSyncUserInfo(
+    userSyncDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userSyncDTO** | **UserSyncDTO**|  | |
+
+
+### Return type
+
+**OnBoardingResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[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)
+
+# **usersControllerSyncUserPermissions**
+> OnBoardingResponseDTO usersControllerSyncUserPermissions(userPermissionDTO)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    UserPermissionDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let userPermissionDTO: UserPermissionDTO; //
+
+const { status, data } = await apiInstance.usersControllerSyncUserPermissions(
+    userPermissionDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userPermissionDTO** | **UserPermissionDTO**|  | |
+
+
+### Return type
+
+**OnBoardingResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[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)
+
+# **usersControllerUserActivity**
+> ActivityDTO usersControllerUserActivity()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let id: string; //User id (default to undefined)
+
+const { status, data } = await apiInstance.usersControllerUserActivity(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | User id | defaults to undefined|
+
+
+### Return type
+
+**ActivityDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[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)
+
+# **usersControllerUserHangout**
+> UserMeDTO usersControllerUserHangout(userHangout)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    UserHangout
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let userHangout: UserHangout; //
+
+const { status, data } = await apiInstance.usersControllerUserHangout(
+    userHangout
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userHangout** | **UserHangout**|  | |
+
+
+### Return type
+
+**UserMeDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[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)
+

package/docs/VerificationLinkResponseDTO.md

@@ -0,0 +1,22 @@
+# VerificationLinkResponseDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**link** | **string** | Verification link | [default to undefined]
+**expires** | **number** | Expiration when link will be invalid | [default to undefined]
+
+## Example
+
+```typescript
+import { VerificationLinkResponseDTO } from './api';
+
+const instance: VerificationLinkResponseDTO = {
+    link,
+    expires,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/VerifyOTPPayloadDTO.md

@@ -0,0 +1,22 @@
+# VerifyOTPPayloadDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**otp** | **string** | 6 digit otp from mail | [default to undefined]
+**email** | **string** | Email of user | [default to undefined]
+
+## Example
+
+```typescript
+import { VerifyOTPPayloadDTO } from './api';
+
+const instance: VerifyOTPPayloadDTO = {
+    otp,
+    email,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/VerifyOTPResponseDTO.md

@@ -0,0 +1,22 @@
+# VerifyOTPResponseDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**statusCode** | **number** | The HTTP status code | [default to undefined]
+**message** | **string** | The  | [default to undefined]
+
+## Example
+
+```typescript
+import { VerifyOTPResponseDTO } from './api';
+
+const instance: VerifyOTPResponseDTO = {
+    statusCode,
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)