@gooday_corp/gooday-api-client 1.3.32 → 1.3.34

package/docs/BookingApi.md

@@ -0,0 +1,740 @@
+# BookingApi
+
+All URIs are relative to *http://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**bookingControllerAcceptBookingInvite**](#bookingcontrolleracceptbookinginvite) | **POST** /v1/booking/accept | |
+|[**bookingControllerBookingConfirmation**](#bookingcontrollerbookingconfirmation) | **POST** /v1/booking/confirmation | |
+|[**bookingControllerCancelBooking**](#bookingcontrollercancelbooking) | **POST** /v1/booking/cancel-booking | |
+|[**bookingControllerCreateBooking**](#bookingcontrollercreatebooking) | **POST** /v1/booking | |
+|[**bookingControllerGetBooking**](#bookingcontrollergetbooking) | **GET** /v1/booking/{id} | |
+|[**bookingControllerLeaveBooking**](#bookingcontrollerleavebooking) | **POST** /v1/booking/leave-booking | |
+|[**bookingControllerListBookings**](#bookingcontrollerlistbookings) | **POST** /v1/booking/list | |
+|[**bookingControllerListCustomerBooking**](#bookingcontrollerlistcustomerbooking) | **POST** /v1/booking/customer/list | |
+|[**bookingControllerListPrepaidServiceBooking**](#bookingcontrollerlistprepaidservicebooking) | **POST** /v1/booking/prepaid-service/list | |
+|[**bookingControllerListWhatsOnBooking**](#bookingcontrollerlistwhatsonbooking) | **POST** /v1/booking/whats-on/list | |
+|[**bookingControllerRegularBookingAvailability**](#bookingcontrollerregularbookingavailability) | **POST** /v1/booking/availability | |
+|[**bookingControllerRejectBookingInvite**](#bookingcontrollerrejectbookinginvite) | **POST** /v1/booking/reject | |
+|[**bookingControllerRescheduleBooking**](#bookingcontrollerreschedulebooking) | **PUT** /v1/booking/reschedule/{id} | |
+|[**bookingControllerUpdateBooking**](#bookingcontrollerupdatebooking) | **PUT** /v1/booking/{id} | |
+
+# **bookingControllerAcceptBookingInvite**
+> BookingRequestResponseDTO bookingControllerAcceptBookingInvite(acceptBookingInvitePayload)
+
+
+### Example
+
+```typescript
+import {
+    BookingApi,
+    Configuration,
+    AcceptBookingInvitePayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BookingApi(configuration);
+
+let acceptBookingInvitePayload: AcceptBookingInvitePayload; //
+
+const { status, data } = await apiInstance.bookingControllerAcceptBookingInvite(
+    acceptBookingInvitePayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **acceptBookingInvitePayload** | **AcceptBookingInvitePayload**|  | |
+
+
+### Return type
+
+**BookingRequestResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**0** |  |  -  |
+
+[[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)
+
+# **bookingControllerBookingConfirmation**
+> CustomerBookingResponseDTO bookingControllerBookingConfirmation(bookingConfirmPayload)
+
+
+### Example
+
+```typescript
+import {
+    BookingApi,
+    Configuration,
+    BookingConfirmPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BookingApi(configuration);
+
+let bookingConfirmPayload: BookingConfirmPayload; //
+
+const { status, data } = await apiInstance.bookingControllerBookingConfirmation(
+    bookingConfirmPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **bookingConfirmPayload** | **BookingConfirmPayload**|  | |
+
+
+### Return type
+
+**CustomerBookingResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**0** |  |  -  |
+
+[[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)
+
+# **bookingControllerCancelBooking**
+> CancelBookingResponseDTO bookingControllerCancelBooking(cancelBookingDTO)
+
+
+### Example
+
+```typescript
+import {
+    BookingApi,
+    Configuration,
+    CancelBookingDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BookingApi(configuration);
+
+let cancelBookingDTO: CancelBookingDTO; //
+
+const { status, data } = await apiInstance.bookingControllerCancelBooking(
+    cancelBookingDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cancelBookingDTO** | **CancelBookingDTO**|  | |
+
+
+### Return type
+
+**CancelBookingResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**0** |  |  -  |
+
+[[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)
+
+# **bookingControllerCreateBooking**
+> BookingResponseDTO bookingControllerCreateBooking(createBookingPayload)
+
+
+### Example
+
+```typescript
+import {
+    BookingApi,
+    Configuration,
+    CreateBookingPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BookingApi(configuration);
+
+let createBookingPayload: CreateBookingPayload; //
+
+const { status, data } = await apiInstance.bookingControllerCreateBooking(
+    createBookingPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createBookingPayload** | **CreateBookingPayload**|  | |
+
+
+### Return type
+
+**BookingResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**0** |  |  -  |
+
+[[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)
+
+# **bookingControllerGetBooking**
+> BookingResponseDTO bookingControllerGetBooking()
+
+
+### Example
+
+```typescript
+import {
+    BookingApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BookingApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.bookingControllerGetBooking(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**BookingResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**0** |  |  -  |
+
+[[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)
+
+# **bookingControllerLeaveBooking**
+> LeaveBookingResponseDTO bookingControllerLeaveBooking(leaveBookingDTO)
+
+
+### Example
+
+```typescript
+import {
+    BookingApi,
+    Configuration,
+    LeaveBookingDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BookingApi(configuration);
+
+let leaveBookingDTO: LeaveBookingDTO; //
+
+const { status, data } = await apiInstance.bookingControllerLeaveBooking(
+    leaveBookingDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **leaveBookingDTO** | **LeaveBookingDTO**|  | |
+
+
+### Return type
+
+**LeaveBookingResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**0** |  |  -  |
+
+[[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)
+
+# **bookingControllerListBookings**
+> FindBookingResponseDTO bookingControllerListBookings(findBookingPayload)
+
+
+### Example
+
+```typescript
+import {
+    BookingApi,
+    Configuration,
+    FindBookingPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BookingApi(configuration);
+
+let findBookingPayload: FindBookingPayload; //
+
+const { status, data } = await apiInstance.bookingControllerListBookings(
+    findBookingPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **findBookingPayload** | **FindBookingPayload**|  | |
+
+
+### Return type
+
+**FindBookingResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**0** |  |  -  |
+
+[[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)
+
+# **bookingControllerListCustomerBooking**
+> FindBookingResponseDTO bookingControllerListCustomerBooking(findCustomerBookingPayload)
+
+
+### Example
+
+```typescript
+import {
+    BookingApi,
+    Configuration,
+    FindCustomerBookingPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BookingApi(configuration);
+
+let findCustomerBookingPayload: FindCustomerBookingPayload; //
+
+const { status, data } = await apiInstance.bookingControllerListCustomerBooking(
+    findCustomerBookingPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **findCustomerBookingPayload** | **FindCustomerBookingPayload**|  | |
+
+
+### Return type
+
+**FindBookingResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**0** |  |  -  |
+
+[[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)
+
+# **bookingControllerListPrepaidServiceBooking**
+> FindBookingResponseDTO bookingControllerListPrepaidServiceBooking(findWhatsOnAndPrepaidService)
+
+
+### Example
+
+```typescript
+import {
+    BookingApi,
+    Configuration,
+    FindWhatsOnAndPrepaidService
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BookingApi(configuration);
+
+let findWhatsOnAndPrepaidService: FindWhatsOnAndPrepaidService; //
+
+const { status, data } = await apiInstance.bookingControllerListPrepaidServiceBooking(
+    findWhatsOnAndPrepaidService
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **findWhatsOnAndPrepaidService** | **FindWhatsOnAndPrepaidService**|  | |
+
+
+### Return type
+
+**FindBookingResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**0** |  |  -  |
+
+[[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)
+
+# **bookingControllerListWhatsOnBooking**
+> FindBookingResponseDTO bookingControllerListWhatsOnBooking(findWhatsOnAndPrepaidService)
+
+
+### Example
+
+```typescript
+import {
+    BookingApi,
+    Configuration,
+    FindWhatsOnAndPrepaidService
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BookingApi(configuration);
+
+let findWhatsOnAndPrepaidService: FindWhatsOnAndPrepaidService; //
+
+const { status, data } = await apiInstance.bookingControllerListWhatsOnBooking(
+    findWhatsOnAndPrepaidService
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **findWhatsOnAndPrepaidService** | **FindWhatsOnAndPrepaidService**|  | |
+
+
+### Return type
+
+**FindBookingResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**0** |  |  -  |
+
+[[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)
+
+# **bookingControllerRegularBookingAvailability**
+> RegularBookingAvailabilityResponseDTO bookingControllerRegularBookingAvailability(regularBookingAvailabilityPayloadDTO)
+
+
+### Example
+
+```typescript
+import {
+    BookingApi,
+    Configuration,
+    RegularBookingAvailabilityPayloadDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BookingApi(configuration);
+
+let regularBookingAvailabilityPayloadDTO: RegularBookingAvailabilityPayloadDTO; //
+
+const { status, data } = await apiInstance.bookingControllerRegularBookingAvailability(
+    regularBookingAvailabilityPayloadDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **regularBookingAvailabilityPayloadDTO** | **RegularBookingAvailabilityPayloadDTO**|  | |
+
+
+### Return type
+
+**RegularBookingAvailabilityResponseDTO**
+
+### 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)
+
+# **bookingControllerRejectBookingInvite**
+> BookingRequestResponseDTO bookingControllerRejectBookingInvite(rejectBookingInvitePayload)
+
+
+### Example
+
+```typescript
+import {
+    BookingApi,
+    Configuration,
+    RejectBookingInvitePayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BookingApi(configuration);
+
+let rejectBookingInvitePayload: RejectBookingInvitePayload; //
+
+const { status, data } = await apiInstance.bookingControllerRejectBookingInvite(
+    rejectBookingInvitePayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rejectBookingInvitePayload** | **RejectBookingInvitePayload**|  | |
+
+
+### Return type
+
+**BookingRequestResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**0** |  |  -  |
+
+[[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)
+
+# **bookingControllerRescheduleBooking**
+> BookingResponseDTO bookingControllerRescheduleBooking(rescheduleBookingPayload)
+
+
+### Example
+
+```typescript
+import {
+    BookingApi,
+    Configuration,
+    RescheduleBookingPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BookingApi(configuration);
+
+let id: string; // (default to undefined)
+let rescheduleBookingPayload: RescheduleBookingPayload; //
+
+const { status, data } = await apiInstance.bookingControllerRescheduleBooking(
+    id,
+    rescheduleBookingPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rescheduleBookingPayload** | **RescheduleBookingPayload**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**BookingResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**0** |  |  -  |
+
+[[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)
+
+# **bookingControllerUpdateBooking**
+> BookingResponseDTO bookingControllerUpdateBooking(createBookingPayload)
+
+
+### Example
+
+```typescript
+import {
+    BookingApi,
+    Configuration,
+    CreateBookingPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BookingApi(configuration);
+
+let id: string; // (default to undefined)
+let createBookingPayload: CreateBookingPayload; //
+
+const { status, data } = await apiInstance.bookingControllerUpdateBooking(
+    id,
+    createBookingPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createBookingPayload** | **CreateBookingPayload**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**BookingResponseDTO**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**0** |  |  -  |
+
+[[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)
+