@gooday_corp/gooday-api-client 1.3.33 → 1.3.34

package/docs/CalendarApi.md

@@ -0,0 +1,726 @@
+# CalendarApi
+
+All URIs are relative to *http://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**calendarControllerAcceptCalendarInvite**](#calendarcontrolleracceptcalendarinvite) | **POST** /v1/calendar/invite/accept | |
+|[**calendarControllerCollaboratorsByCalendar**](#calendarcontrollercollaboratorsbycalendar) | **GET** /v1/calendar/{id}/collaborators | |
+|[**calendarControllerCreateSharedCalendar**](#calendarcontrollercreatesharedcalendar) | **POST** /v1/calendar | |
+|[**calendarControllerListCalendarsEvents**](#calendarcontrollerlistcalendarsevents) | **POST** /v1/calendar/list-events | |
+|[**calendarControllerListEvents**](#calendarcontrollerlistevents) | **POST** /v1/calendar/events | |
+|[**calendarControllerListMyCalendar**](#calendarcontrollerlistmycalendar) | **GET** /v1/calendar | |
+|[**calendarControllerListPrepaidServiceAvailableSlots**](#calendarcontrollerlistprepaidserviceavailableslots) | **POST** /v1/calendar/slots/prepaid-service | |
+|[**calendarControllerListSocialEvents**](#calendarcontrollerlistsocialevents) | **POST** /v1/calendar/social-events | |
+|[**calendarControllerListStandardBookingSlots**](#calendarcontrollerliststandardbookingslots) | **POST** /v1/calendar/slots/standard | |
+|[**calendarControllerListWhatsOnAvailableSlots**](#calendarcontrollerlistwhatsonavailableslots) | **POST** /v1/calendar/slots/whats-on | |
+|[**calendarControllerRejectCalendarInvite**](#calendarcontrollerrejectcalendarinvite) | **POST** /v1/calendar/invite/reject | |
+|[**calendarControllerRemoveCalendar**](#calendarcontrollerremovecalendar) | **DELETE** /v1/calendar | |
+|[**calendarControllerRenameCalendar**](#calendarcontrollerrenamecalendar) | **POST** /v1/calendar/rename | |
+|[**calendarControllerSendCalendarInvite**](#calendarcontrollersendcalendarinvite) | **POST** /v1/calendar/invite | |
+
+# **calendarControllerAcceptCalendarInvite**
+> CalendarDTO calendarControllerAcceptCalendarInvite(acceptCollaborateInvitePayload)
+
+
+### Example
+
+```typescript
+import {
+    CalendarApi,
+    Configuration,
+    AcceptCollaborateInvitePayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CalendarApi(configuration);
+
+let acceptCollaborateInvitePayload: AcceptCollaborateInvitePayload; //
+
+const { status, data } = await apiInstance.calendarControllerAcceptCalendarInvite(
+    acceptCollaborateInvitePayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **acceptCollaborateInvitePayload** | **AcceptCollaborateInvitePayload**|  | |
+
+
+### Return type
+
+**CalendarDTO**
+
+### 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)
+
+# **calendarControllerCollaboratorsByCalendar**
+> calendarControllerCollaboratorsByCalendar()
+
+
+### Example
+
+```typescript
+import {
+    CalendarApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CalendarApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.calendarControllerCollaboratorsByCalendar(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### 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)
+
+# **calendarControllerCreateSharedCalendar**
+> CalendarResponseDTO calendarControllerCreateSharedCalendar(createCalendarPayload)
+
+
+### Example
+
+```typescript
+import {
+    CalendarApi,
+    Configuration,
+    CreateCalendarPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CalendarApi(configuration);
+
+let createCalendarPayload: CreateCalendarPayload; //
+
+const { status, data } = await apiInstance.calendarControllerCreateSharedCalendar(
+    createCalendarPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createCalendarPayload** | **CreateCalendarPayload**|  | |
+
+
+### Return type
+
+**CalendarResponseDTO**
+
+### 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)
+
+# **calendarControllerListCalendarsEvents**
+> CalendarEventResponseDTO calendarControllerListCalendarsEvents(calendarEventsListPayload)
+
+
+### Example
+
+```typescript
+import {
+    CalendarApi,
+    Configuration,
+    CalendarEventsListPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CalendarApi(configuration);
+
+let calendarEventsListPayload: CalendarEventsListPayload; //
+
+const { status, data } = await apiInstance.calendarControllerListCalendarsEvents(
+    calendarEventsListPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **calendarEventsListPayload** | **CalendarEventsListPayload**|  | |
+
+
+### Return type
+
+**CalendarEventResponseDTO**
+
+### 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)
+
+# **calendarControllerListEvents**
+> CalendarEventsDTO calendarControllerListEvents(calendarEventsListPayload)
+
+
+### Example
+
+```typescript
+import {
+    CalendarApi,
+    Configuration,
+    CalendarEventsListPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CalendarApi(configuration);
+
+let calendarEventsListPayload: CalendarEventsListPayload; //
+
+const { status, data } = await apiInstance.calendarControllerListEvents(
+    calendarEventsListPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **calendarEventsListPayload** | **CalendarEventsListPayload**|  | |
+
+
+### Return type
+
+**CalendarEventsDTO**
+
+### 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)
+
+# **calendarControllerListMyCalendar**
+> CalendarListResponseDTO calendarControllerListMyCalendar()
+
+
+### Example
+
+```typescript
+import {
+    CalendarApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CalendarApi(configuration);
+
+const { status, data } = await apiInstance.calendarControllerListMyCalendar();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**CalendarListResponseDTO**
+
+### 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)
+
+# **calendarControllerListPrepaidServiceAvailableSlots**
+> CalendarSlotsDTO calendarControllerListPrepaidServiceAvailableSlots(whatsOnSlotsPayload)
+
+
+### Example
+
+```typescript
+import {
+    CalendarApi,
+    Configuration,
+    WhatsOnSlotsPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CalendarApi(configuration);
+
+let whatsOnSlotsPayload: WhatsOnSlotsPayload; //
+
+const { status, data } = await apiInstance.calendarControllerListPrepaidServiceAvailableSlots(
+    whatsOnSlotsPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **whatsOnSlotsPayload** | **WhatsOnSlotsPayload**|  | |
+
+
+### Return type
+
+**CalendarSlotsDTO**
+
+### 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)
+
+# **calendarControllerListSocialEvents**
+> CalendarSocialEventResponseDTO calendarControllerListSocialEvents(calendarEventsListPayload)
+
+
+### Example
+
+```typescript
+import {
+    CalendarApi,
+    Configuration,
+    CalendarEventsListPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CalendarApi(configuration);
+
+let calendarEventsListPayload: CalendarEventsListPayload; //
+
+const { status, data } = await apiInstance.calendarControllerListSocialEvents(
+    calendarEventsListPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **calendarEventsListPayload** | **CalendarEventsListPayload**|  | |
+
+
+### Return type
+
+**CalendarSocialEventResponseDTO**
+
+### 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)
+
+# **calendarControllerListStandardBookingSlots**
+> CalendarSlotsDTO calendarControllerListStandardBookingSlots(standardBookingSlotsPayload)
+
+
+### Example
+
+```typescript
+import {
+    CalendarApi,
+    Configuration,
+    StandardBookingSlotsPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CalendarApi(configuration);
+
+let standardBookingSlotsPayload: StandardBookingSlotsPayload; //
+
+const { status, data } = await apiInstance.calendarControllerListStandardBookingSlots(
+    standardBookingSlotsPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **standardBookingSlotsPayload** | **StandardBookingSlotsPayload**|  | |
+
+
+### Return type
+
+**CalendarSlotsDTO**
+
+### 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)
+
+# **calendarControllerListWhatsOnAvailableSlots**
+> CalendarSlotsDTO calendarControllerListWhatsOnAvailableSlots(whatsOnSlotsPayload)
+
+
+### Example
+
+```typescript
+import {
+    CalendarApi,
+    Configuration,
+    WhatsOnSlotsPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CalendarApi(configuration);
+
+let whatsOnSlotsPayload: WhatsOnSlotsPayload; //
+
+const { status, data } = await apiInstance.calendarControllerListWhatsOnAvailableSlots(
+    whatsOnSlotsPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **whatsOnSlotsPayload** | **WhatsOnSlotsPayload**|  | |
+
+
+### Return type
+
+**CalendarSlotsDTO**
+
+### 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)
+
+# **calendarControllerRejectCalendarInvite**
+> CalendarDTO calendarControllerRejectCalendarInvite(rejectCollaborateInvitePayload)
+
+
+### Example
+
+```typescript
+import {
+    CalendarApi,
+    Configuration,
+    RejectCollaborateInvitePayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CalendarApi(configuration);
+
+let rejectCollaborateInvitePayload: RejectCollaborateInvitePayload; //
+
+const { status, data } = await apiInstance.calendarControllerRejectCalendarInvite(
+    rejectCollaborateInvitePayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **rejectCollaborateInvitePayload** | **RejectCollaborateInvitePayload**|  | |
+
+
+### Return type
+
+**CalendarDTO**
+
+### 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)
+
+# **calendarControllerRemoveCalendar**
+> CalendarDTO calendarControllerRemoveCalendar(removeCalendarPayload)
+
+
+### Example
+
+```typescript
+import {
+    CalendarApi,
+    Configuration,
+    RemoveCalendarPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CalendarApi(configuration);
+
+let removeCalendarPayload: RemoveCalendarPayload; //
+
+const { status, data } = await apiInstance.calendarControllerRemoveCalendar(
+    removeCalendarPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **removeCalendarPayload** | **RemoveCalendarPayload**|  | |
+
+
+### Return type
+
+**CalendarDTO**
+
+### 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)
+
+# **calendarControllerRenameCalendar**
+> CalendarDTO calendarControllerRenameCalendar(renameCalendarPayload)
+
+
+### Example
+
+```typescript
+import {
+    CalendarApi,
+    Configuration,
+    RenameCalendarPayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CalendarApi(configuration);
+
+let renameCalendarPayload: RenameCalendarPayload; //
+
+const { status, data } = await apiInstance.calendarControllerRenameCalendar(
+    renameCalendarPayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **renameCalendarPayload** | **RenameCalendarPayload**|  | |
+
+
+### Return type
+
+**CalendarDTO**
+
+### 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)
+
+# **calendarControllerSendCalendarInvite**
+> CalendarDTO calendarControllerSendCalendarInvite(sendCollaborateInvitePayload)
+
+
+### Example
+
+```typescript
+import {
+    CalendarApi,
+    Configuration,
+    SendCollaborateInvitePayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CalendarApi(configuration);
+
+let sendCollaborateInvitePayload: SendCollaborateInvitePayload; //
+
+const { status, data } = await apiInstance.calendarControllerSendCalendarInvite(
+    sendCollaborateInvitePayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sendCollaborateInvitePayload** | **SendCollaborateInvitePayload**|  | |
+
+
+### Return type
+
+**CalendarDTO**
+
+### 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)
+