@gooday_corp/gooday-api-client 1.3.33 → 1.3.35

package/docs/NotificationApi.md

@@ -0,0 +1,265 @@
+# NotificationApi
+
+All URIs are relative to *http://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**notificationControllerActionEventEmitter**](#notificationcontrolleractioneventemitter) | **POST** /v1/notification/action-event-emitter | |
+|[**notificationControllerGetNotification**](#notificationcontrollergetnotification) | **GET** /v1/notification | |
+|[**notificationControllerNotificationCount**](#notificationcontrollernotificationcount) | **POST** /v1/notification/count | |
+|[**notificationControllerReadMarkAllNotification**](#notificationcontrollerreadmarkallnotification) | **POST** /v1/notification/read-mark | |
+|[**notificationControllerReadNotification**](#notificationcontrollerreadnotification) | **POST** /v1/notification/read | |
+
+# **notificationControllerActionEventEmitter**
+> NotificationActionEventResponseDTO notificationControllerActionEventEmitter(notificationActionEventPayload)
+
+
+### Example
+
+```typescript
+import {
+    NotificationApi,
+    Configuration,
+    NotificationActionEventPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationApi(configuration);
+
+let notificationActionEventPayload: NotificationActionEventPayload; //
+
+const { status, data } = await apiInstance.notificationControllerActionEventEmitter(
+    notificationActionEventPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **notificationActionEventPayload** | **NotificationActionEventPayload**|  | |
+
+
+### Return type
+
+**NotificationActionEventResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**409** | No Listener 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)
+
+# **notificationControllerGetNotification**
+> GetNotificationDTO notificationControllerGetNotification()
+
+
+### Example
+
+```typescript
+import {
+    NotificationApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationApi(configuration);
+
+let page: number; // (default to undefined)
+let pageSize: number; // (default to undefined)
+let category: Array<'CALENDAR' | 'TASKS' | 'REMINDERS' | 'WAITLIST' | 'BOOKING' | 'INVITES' | 'GENERAL'>; // (default to undefined)
+
+const { status, data } = await apiInstance.notificationControllerGetNotification(
+    page,
+    pageSize,
+    category
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | defaults to undefined|
+| **pageSize** | [**number**] |  | defaults to undefined|
+| **category** | **Array<&#39;CALENDAR&#39; &#124; &#39;TASKS&#39; &#124; &#39;REMINDERS&#39; &#124; &#39;WAITLIST&#39; &#124; &#39;BOOKING&#39; &#124; &#39;INVITES&#39; &#124; &#39;GENERAL&#39;>** |  | defaults to undefined|
+
+
+### Return type
+
+**GetNotificationDTO**
+
+### 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)
+
+# **notificationControllerNotificationCount**
+> NotificationCountResponseDTO notificationControllerNotificationCount(notificationCountDTO)
+
+
+### Example
+
+```typescript
+import {
+    NotificationApi,
+    Configuration,
+    NotificationCountDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationApi(configuration);
+
+let notificationCountDTO: NotificationCountDTO; //
+
+const { status, data } = await apiInstance.notificationControllerNotificationCount(
+    notificationCountDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **notificationCountDTO** | **NotificationCountDTO**|  | |
+
+
+### Return type
+
+**NotificationCountResponseDTO**
+
+### 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)
+
+# **notificationControllerReadMarkAllNotification**
+> NotificationReadResponseDTO notificationControllerReadMarkAllNotification()
+
+
+### Example
+
+```typescript
+import {
+    NotificationApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationApi(configuration);
+
+const { status, data } = await apiInstance.notificationControllerReadMarkAllNotification();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**NotificationReadResponseDTO**
+
+### 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)
+
+# **notificationControllerReadNotification**
+> NotificationReadResponseDTO notificationControllerReadNotification(notificationReadDTO)
+
+
+### Example
+
+```typescript
+import {
+    NotificationApi,
+    Configuration,
+    NotificationReadDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new NotificationApi(configuration);
+
+let notificationReadDTO: NotificationReadDTO; //
+
+const { status, data } = await apiInstance.notificationControllerReadNotification(
+    notificationReadDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **notificationReadDTO** | **NotificationReadDTO**|  | |
+
+
+### Return type
+
+**NotificationReadResponseDTO**
+
+### 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/NotificationCountDTO.md

@@ -0,0 +1,20 @@
+# NotificationCountDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category** | **Array<string>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { NotificationCountDTO } from './api';
+
+const instance: NotificationCountDTO = {
+    category,
+};
+```
+
+[[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/NotificationCountResponseDTO.md

@@ -0,0 +1,22 @@
+# NotificationCountResponseDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**statusCode** | **number** | statusCode | [default to undefined]
+**data** | **number** | Response | [default to undefined]
+
+## Example
+
+```typescript
+import { NotificationCountResponseDTO } from './api';
+
+const instance: NotificationCountResponseDTO = {
+    statusCode,
+    data,
+};
+```
+
+[[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/NotificationEntity.md

@@ -0,0 +1,32 @@
+# NotificationEntity
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **string** | The title of the notification | [default to undefined]
+**title** | **string** | The title of the notification | [default to undefined]
+**content** | **string** | The message content of the notification | [default to undefined]
+**user** | **string** | The user associated with the notification | [default to undefined]
+**type** | **string** | The type of the notification (optional) | [optional] [default to undefined]
+**metadata** | **object** | Additional metadata associated with the notification (optional) | [optional] [default to undefined]
+**isRead** | **boolean** | Indicates if the notification has been read (optional) | [default to false]
+
+## Example
+
+```typescript
+import { NotificationEntity } from './api';
+
+const instance: NotificationEntity = {
+    _id,
+    title,
+    content,
+    user,
+    type,
+    metadata,
+    isRead,
+};
+```
+
+[[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/NotificationReadDTO.md

@@ -0,0 +1,20 @@
+# NotificationReadDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**notificationId** | **string** | Notification Id | [default to undefined]
+
+## Example
+
+```typescript
+import { NotificationReadDTO } from './api';
+
+const instance: NotificationReadDTO = {
+    notificationId,
+};
+```
+
+[[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/NotificationReadResponseDTO.md

@@ -0,0 +1,22 @@
+# NotificationReadResponseDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**statusCode** | **number** | statusCode | [default to undefined]
+**data** | **boolean** | Response | [default to undefined]
+
+## Example
+
+```typescript
+import { NotificationReadResponseDTO } from './api';
+
+const instance: NotificationReadResponseDTO = {
+    statusCode,
+    data,
+};
+```
+
+[[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/OAuthApi.md

@@ -0,0 +1,267 @@
+# OAuthApi
+
+All URIs are relative to *http://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**oAuthControllerValidateAppleBusinessToken**](#oauthcontrollervalidateapplebusinesstoken) | **POST** /v1/oauth/apple/business | |
+|[**oAuthControllerValidateAppleDashboardBusinessToken**](#oauthcontrollervalidateappledashboardbusinesstoken) | **POST** /v1/oauth/apple/dashboard/business | |
+|[**oAuthControllerValidateAppleToken**](#oauthcontrollervalidateappletoken) | **POST** /v1/oauth/apple | |
+|[**oAuthControllerValidateGoogleToken**](#oauthcontrollervalidategoogletoken) | **POST** /v1/oauth/google | |
+|[**oAuthControllerValidateGoogleTokenBusiness**](#oauthcontrollervalidategoogletokenbusiness) | **POST** /v1/oauth/google/business | |
+
+# **oAuthControllerValidateAppleBusinessToken**
+> AppleOAuthResponseDTO oAuthControllerValidateAppleBusinessToken(appleVerificationPayloadDTO)
+
+
+### Example
+
+```typescript
+import {
+    OAuthApi,
+    Configuration,
+    AppleVerificationPayloadDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new OAuthApi(configuration);
+
+let appleVerificationPayloadDTO: AppleVerificationPayloadDTO; //
+
+const { status, data } = await apiInstance.oAuthControllerValidateAppleBusinessToken(
+    appleVerificationPayloadDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appleVerificationPayloadDTO** | **AppleVerificationPayloadDTO**|  | |
+
+
+### Return type
+
+**AppleOAuthResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**0** | Apple User |  -  |
+
+[[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)
+
+# **oAuthControllerValidateAppleDashboardBusinessToken**
+> AppleOAuthResponseDTO oAuthControllerValidateAppleDashboardBusinessToken(appleDashboardPayloadDTO)
+
+
+### Example
+
+```typescript
+import {
+    OAuthApi,
+    Configuration,
+    AppleDashboardPayloadDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new OAuthApi(configuration);
+
+let appleDashboardPayloadDTO: AppleDashboardPayloadDTO; //
+
+const { status, data } = await apiInstance.oAuthControllerValidateAppleDashboardBusinessToken(
+    appleDashboardPayloadDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appleDashboardPayloadDTO** | **AppleDashboardPayloadDTO**|  | |
+
+
+### Return type
+
+**AppleOAuthResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**0** | Apple User |  -  |
+
+[[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)
+
+# **oAuthControllerValidateAppleToken**
+> AppleOAuthResponseDTO oAuthControllerValidateAppleToken(appleVerificationPayloadDTO)
+
+
+### Example
+
+```typescript
+import {
+    OAuthApi,
+    Configuration,
+    AppleVerificationPayloadDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new OAuthApi(configuration);
+
+let appleVerificationPayloadDTO: AppleVerificationPayloadDTO; //
+
+const { status, data } = await apiInstance.oAuthControllerValidateAppleToken(
+    appleVerificationPayloadDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appleVerificationPayloadDTO** | **AppleVerificationPayloadDTO**|  | |
+
+
+### Return type
+
+**AppleOAuthResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**0** | Apple User |  -  |
+
+[[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)
+
+# **oAuthControllerValidateGoogleToken**
+> GoogleOAuthResponseDTO oAuthControllerValidateGoogleToken(googleVerificationPayloadDTO)
+
+
+### Example
+
+```typescript
+import {
+    OAuthApi,
+    Configuration,
+    GoogleVerificationPayloadDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new OAuthApi(configuration);
+
+let googleVerificationPayloadDTO: GoogleVerificationPayloadDTO; //
+
+const { status, data } = await apiInstance.oAuthControllerValidateGoogleToken(
+    googleVerificationPayloadDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **googleVerificationPayloadDTO** | **GoogleVerificationPayloadDTO**|  | |
+
+
+### Return type
+
+**GoogleOAuthResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**0** | Google User |  -  |
+
+[[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)
+
+# **oAuthControllerValidateGoogleTokenBusiness**
+> GoogleOAuthResponseDTO oAuthControllerValidateGoogleTokenBusiness(googleVerificationPayloadDTO)
+
+
+### Example
+
+```typescript
+import {
+    OAuthApi,
+    Configuration,
+    GoogleVerificationPayloadDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new OAuthApi(configuration);
+
+let googleVerificationPayloadDTO: GoogleVerificationPayloadDTO; //
+
+const { status, data } = await apiInstance.oAuthControllerValidateGoogleTokenBusiness(
+    googleVerificationPayloadDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **googleVerificationPayloadDTO** | **GoogleVerificationPayloadDTO**|  | |
+
+
+### Return type
+
+**GoogleOAuthResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**0** | Google User |  -  |
+
+[[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/OnBoardingDTO.md

@@ -0,0 +1,30 @@
+# OnBoardingDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nickname** | **string** | nickname | [optional] [default to undefined]
+**assistant** | **string** | Assistant | [optional] [default to undefined]
+**profile** | **string** | Profile For user | [optional] [default to undefined]
+**plan** | [**UserPlanDTO**](UserPlanDTO.md) |  | [optional] [default to undefined]
+**dob** | **string** | Date of Birth | [optional] [default to undefined]
+**goals** | **Array<string>** | Goals | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OnBoardingDTO } from './api';
+
+const instance: OnBoardingDTO = {
+    nickname,
+    assistant,
+    profile,
+    plan,
+    dob,
+    goals,
+};
+```
+
+[[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/OnBoardingResponseDTO.md

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