@gooday_corp/gooday-api-client 1.3.32 → 1.3.34

package/docs/FriendsApi.md

@@ -0,0 +1,575 @@
+# FriendsApi
+
+All URIs are relative to *http://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**friendControllerApproveFriendRequest**](#friendcontrollerapprovefriendrequest) | **POST** /v1/friend/approve-request | |
+|[**friendControllerCreateMutualFriend**](#friendcontrollercreatemutualfriend) | **POST** /v1/friend/mutual | |
+|[**friendControllerDeclineFriendRequest**](#friendcontrollerdeclinefriendrequest) | **POST** /v1/friend/decline-request | |
+|[**friendControllerFindFriends**](#friendcontrollerfindfriends) | **GET** /v1/friend/find | |
+|[**friendControllerFindMutualFriends**](#friendcontrollerfindmutualfriends) | **POST** /v1/friend/mutual/list | |
+|[**friendControllerGetFriendshipStatus**](#friendcontrollergetfriendshipstatus) | **POST** /v1/friend/status | |
+|[**friendControllerListMyFriends**](#friendcontrollerlistmyfriends) | **POST** /v1/friend/list | |
+|[**friendControllerRemoveFriendById**](#friendcontrollerremovefriendbyid) | **POST** /v1/friend/remove | |
+|[**friendControllerRemoveMutualFriend**](#friendcontrollerremovemutualfriend) | **DELETE** /v1/friend/mutual/{id} | |
+|[**friendControllerSendFriendRequest**](#friendcontrollersendfriendrequest) | **POST** /v1/friend/send-request | |
+|[**friendControllerTodayAvailableFriends**](#friendcontrollertodayavailablefriends) | **GET** /v1/friend/today/available/friends | |
+
+# **friendControllerApproveFriendRequest**
+> FriendsResponseDTO friendControllerApproveFriendRequest(approveFriendshipRequestPayload)
+
+
+### Example
+
+```typescript
+import {
+    FriendsApi,
+    Configuration,
+    ApproveFriendshipRequestPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new FriendsApi(configuration);
+
+let approveFriendshipRequestPayload: ApproveFriendshipRequestPayload; //
+
+const { status, data } = await apiInstance.friendControllerApproveFriendRequest(
+    approveFriendshipRequestPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **approveFriendshipRequestPayload** | **ApproveFriendshipRequestPayload**|  | |
+
+
+### Return type
+
+**FriendsResponseDTO**
+
+### 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)
+
+# **friendControllerCreateMutualFriend**
+> MutualFriendDTO friendControllerCreateMutualFriend(mutualFriendPayload)
+
+
+### Example
+
+```typescript
+import {
+    FriendsApi,
+    Configuration,
+    MutualFriendPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new FriendsApi(configuration);
+
+let mutualFriendPayload: MutualFriendPayload; //
+
+const { status, data } = await apiInstance.friendControllerCreateMutualFriend(
+    mutualFriendPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **mutualFriendPayload** | **MutualFriendPayload**|  | |
+
+
+### Return type
+
+**MutualFriendDTO**
+
+### 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)
+
+# **friendControllerDeclineFriendRequest**
+> FriendsResponseDTO friendControllerDeclineFriendRequest(declineFriendshipRequestPayload)
+
+
+### Example
+
+```typescript
+import {
+    FriendsApi,
+    Configuration,
+    DeclineFriendshipRequestPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new FriendsApi(configuration);
+
+let declineFriendshipRequestPayload: DeclineFriendshipRequestPayload; //
+
+const { status, data } = await apiInstance.friendControllerDeclineFriendRequest(
+    declineFriendshipRequestPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **declineFriendshipRequestPayload** | **DeclineFriendshipRequestPayload**|  | |
+
+
+### Return type
+
+**FriendsResponseDTO**
+
+### 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)
+
+# **friendControllerFindFriends**
+> FriendsDTO friendControllerFindFriends()
+
+
+### Example
+
+```typescript
+import {
+    FriendsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new FriendsApi(configuration);
+
+let page: number; // (default to undefined)
+let pageSize: number; // (default to undefined)
+let query: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.friendControllerFindFriends(
+    page,
+    pageSize,
+    query
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | defaults to undefined|
+| **pageSize** | [**number**] |  | defaults to undefined|
+| **query** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**FriendsDTO**
+
+### 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)
+
+# **friendControllerFindMutualFriends**
+> MutualFriendsListDTO friendControllerFindMutualFriends(mutualFindFriendRequestPayload)
+
+
+### Example
+
+```typescript
+import {
+    FriendsApi,
+    Configuration,
+    MutualFindFriendRequestPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new FriendsApi(configuration);
+
+let mutualFindFriendRequestPayload: MutualFindFriendRequestPayload; //
+
+const { status, data } = await apiInstance.friendControllerFindMutualFriends(
+    mutualFindFriendRequestPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **mutualFindFriendRequestPayload** | **MutualFindFriendRequestPayload**|  | |
+
+
+### Return type
+
+**MutualFriendsListDTO**
+
+### 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)
+
+# **friendControllerGetFriendshipStatus**
+> FriendshipStatusDTO friendControllerGetFriendshipStatus(friendshipStatusCheck)
+
+
+### Example
+
+```typescript
+import {
+    FriendsApi,
+    Configuration,
+    FriendshipStatusCheck
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new FriendsApi(configuration);
+
+let friendshipStatusCheck: FriendshipStatusCheck; //
+
+const { status, data } = await apiInstance.friendControllerGetFriendshipStatus(
+    friendshipStatusCheck
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **friendshipStatusCheck** | **FriendshipStatusCheck**|  | |
+
+
+### Return type
+
+**FriendshipStatusDTO**
+
+### 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)
+
+# **friendControllerListMyFriends**
+> FriendsDTO friendControllerListMyFriends(findMyFriendRequestPayload)
+
+
+### Example
+
+```typescript
+import {
+    FriendsApi,
+    Configuration,
+    FindMyFriendRequestPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new FriendsApi(configuration);
+
+let findMyFriendRequestPayload: FindMyFriendRequestPayload; //
+
+const { status, data } = await apiInstance.friendControllerListMyFriends(
+    findMyFriendRequestPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **findMyFriendRequestPayload** | **FindMyFriendRequestPayload**|  | |
+
+
+### Return type
+
+**FriendsDTO**
+
+### 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)
+
+# **friendControllerRemoveFriendById**
+> FriendsResponseDTO friendControllerRemoveFriendById(removeFriendshipRequestPayload)
+
+
+### Example
+
+```typescript
+import {
+    FriendsApi,
+    Configuration,
+    RemoveFriendshipRequestPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new FriendsApi(configuration);
+
+let removeFriendshipRequestPayload: RemoveFriendshipRequestPayload; //
+
+const { status, data } = await apiInstance.friendControllerRemoveFriendById(
+    removeFriendshipRequestPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **removeFriendshipRequestPayload** | **RemoveFriendshipRequestPayload**|  | |
+
+
+### Return type
+
+**FriendsResponseDTO**
+
+### 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)
+
+# **friendControllerRemoveMutualFriend**
+> MutualFriendDTO friendControllerRemoveMutualFriend()
+
+
+### Example
+
+```typescript
+import {
+    FriendsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new FriendsApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.friendControllerRemoveMutualFriend(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**MutualFriendDTO**
+
+### 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)
+
+# **friendControllerSendFriendRequest**
+> FriendsResponseDTO friendControllerSendFriendRequest(sendFriendshipRequestPayload)
+
+
+### Example
+
+```typescript
+import {
+    FriendsApi,
+    Configuration,
+    SendFriendshipRequestPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new FriendsApi(configuration);
+
+let sendFriendshipRequestPayload: SendFriendshipRequestPayload; //
+
+const { status, data } = await apiInstance.friendControllerSendFriendRequest(
+    sendFriendshipRequestPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sendFriendshipRequestPayload** | **SendFriendshipRequestPayload**|  | |
+
+
+### Return type
+
+**FriendsResponseDTO**
+
+### 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)
+
+# **friendControllerTodayAvailableFriends**
+> FriendsDTO friendControllerTodayAvailableFriends()
+
+
+### Example
+
+```typescript
+import {
+    FriendsApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new FriendsApi(configuration);
+
+const { status, data } = await apiInstance.friendControllerTodayAvailableFriends();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**FriendsDTO**
+
+### 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)
+

package/docs/FriendsDTO.md

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

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

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

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