@gooday_corp/gooday-api-client 1.3.32 → 1.3.34

package/docs/PrepaidServiceApi.md

@@ -0,0 +1,416 @@
+# PrepaidServiceApi
+
+All URIs are relative to *http://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**prepaidServiceControllerCategories**](#prepaidservicecontrollercategories) | **GET** /v1/prepaid-service/categories | |
+|[**prepaidServiceControllerCreateService**](#prepaidservicecontrollercreateservice) | **POST** /v1/prepaid-service | |
+|[**prepaidServiceControllerDeleteService**](#prepaidservicecontrollerdeleteservice) | **PUT** /v1/prepaid-service/delete/{id} | |
+|[**prepaidServiceControllerDiscountCodeApply**](#prepaidservicecontrollerdiscountcodeapply) | **POST** /v1/prepaid-service/discount | |
+|[**prepaidServiceControllerFindService**](#prepaidservicecontrollerfindservice) | **POST** /v1/prepaid-service/list | |
+|[**prepaidServiceControllerPrepaidServiceAvailability**](#prepaidservicecontrollerprepaidserviceavailability) | **POST** /v1/prepaid-service/availability | |
+|[**prepaidServiceControllerServiceById**](#prepaidservicecontrollerservicebyid) | **GET** /v1/prepaid-service/{id} | |
+|[**prepaidServiceControllerUpdateTagById**](#prepaidservicecontrollerupdatetagbyid) | **PUT** /v1/prepaid-service/{id} | |
+
+# **prepaidServiceControllerCategories**
+> PrepaidServiceCategoriesDTO prepaidServiceControllerCategories()
+
+
+### Example
+
+```typescript
+import {
+    PrepaidServiceApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PrepaidServiceApi(configuration);
+
+const { status, data } = await apiInstance.prepaidServiceControllerCategories();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**PrepaidServiceCategoriesDTO**
+
+### 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)
+
+# **prepaidServiceControllerCreateService**
+> PrepaidServiceDTO prepaidServiceControllerCreateService(prepaidServicePayloadDTO)
+
+
+### Example
+
+```typescript
+import {
+    PrepaidServiceApi,
+    Configuration,
+    PrepaidServicePayloadDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PrepaidServiceApi(configuration);
+
+let prepaidServicePayloadDTO: PrepaidServicePayloadDTO; //
+
+const { status, data } = await apiInstance.prepaidServiceControllerCreateService(
+    prepaidServicePayloadDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **prepaidServicePayloadDTO** | **PrepaidServicePayloadDTO**|  | |
+
+
+### Return type
+
+**PrepaidServiceDTO**
+
+### 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)
+
+# **prepaidServiceControllerDeleteService**
+> PrepaidServiceDTO prepaidServiceControllerDeleteService()
+
+
+### Example
+
+```typescript
+import {
+    PrepaidServiceApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PrepaidServiceApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.prepaidServiceControllerDeleteService(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**PrepaidServiceDTO**
+
+### 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)
+
+# **prepaidServiceControllerDiscountCodeApply**
+> PrepaidServiceDiscountCodeResponseDTO prepaidServiceControllerDiscountCodeApply(prepaidServiceDiscountCodePayloadDTO)
+
+
+### Example
+
+```typescript
+import {
+    PrepaidServiceApi,
+    Configuration,
+    PrepaidServiceDiscountCodePayloadDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PrepaidServiceApi(configuration);
+
+let prepaidServiceDiscountCodePayloadDTO: PrepaidServiceDiscountCodePayloadDTO; //
+
+const { status, data } = await apiInstance.prepaidServiceControllerDiscountCodeApply(
+    prepaidServiceDiscountCodePayloadDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **prepaidServiceDiscountCodePayloadDTO** | **PrepaidServiceDiscountCodePayloadDTO**|  | |
+
+
+### Return type
+
+**PrepaidServiceDiscountCodeResponseDTO**
+
+### 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)
+
+# **prepaidServiceControllerFindService**
+> PrepaidServiceResponseDTO prepaidServiceControllerFindService(prepaidServiceFindDTO)
+
+
+### Example
+
+```typescript
+import {
+    PrepaidServiceApi,
+    Configuration,
+    PrepaidServiceFindDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PrepaidServiceApi(configuration);
+
+let prepaidServiceFindDTO: PrepaidServiceFindDTO; //
+
+const { status, data } = await apiInstance.prepaidServiceControllerFindService(
+    prepaidServiceFindDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **prepaidServiceFindDTO** | **PrepaidServiceFindDTO**|  | |
+
+
+### Return type
+
+**PrepaidServiceResponseDTO**
+
+### 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)
+
+# **prepaidServiceControllerPrepaidServiceAvailability**
+> PrepaidServiceAvailabilityResponseDTO prepaidServiceControllerPrepaidServiceAvailability(prepaidServiceAvailabilityPayloadDTO)
+
+
+### Example
+
+```typescript
+import {
+    PrepaidServiceApi,
+    Configuration,
+    PrepaidServiceAvailabilityPayloadDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PrepaidServiceApi(configuration);
+
+let prepaidServiceAvailabilityPayloadDTO: PrepaidServiceAvailabilityPayloadDTO; //
+
+const { status, data } = await apiInstance.prepaidServiceControllerPrepaidServiceAvailability(
+    prepaidServiceAvailabilityPayloadDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **prepaidServiceAvailabilityPayloadDTO** | **PrepaidServiceAvailabilityPayloadDTO**|  | |
+
+
+### Return type
+
+**PrepaidServiceAvailabilityResponseDTO**
+
+### 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)
+
+# **prepaidServiceControllerServiceById**
+> PrepaidServiceDTO prepaidServiceControllerServiceById()
+
+
+### Example
+
+```typescript
+import {
+    PrepaidServiceApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PrepaidServiceApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.prepaidServiceControllerServiceById(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**PrepaidServiceDTO**
+
+### 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)
+
+# **prepaidServiceControllerUpdateTagById**
+> PrepaidServiceDTO prepaidServiceControllerUpdateTagById(prepaidServicePayloadDTO)
+
+
+### Example
+
+```typescript
+import {
+    PrepaidServiceApi,
+    Configuration,
+    PrepaidServicePayloadDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new PrepaidServiceApi(configuration);
+
+let id: string; // (default to undefined)
+let prepaidServicePayloadDTO: PrepaidServicePayloadDTO; //
+
+const { status, data } = await apiInstance.prepaidServiceControllerUpdateTagById(
+    id,
+    prepaidServicePayloadDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **prepaidServicePayloadDTO** | **PrepaidServicePayloadDTO**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**PrepaidServiceDTO**
+
+### 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/PrepaidServiceAvailabilityPayloadDTO.md

@@ -0,0 +1,28 @@
+# PrepaidServiceAvailabilityPayloadDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**startDate** | **string** | Start date for the events | [default to undefined]
+**endDate** | **string** | End date for the events | [default to undefined]
+**staff** | **string** | Staff id for this event | [optional] [default to undefined]
+**noOfPeople** | **number** | No of people for this booking | [default to undefined]
+**id** | **string** | Whats On Id | [default to undefined]
+
+## Example
+
+```typescript
+import { PrepaidServiceAvailabilityPayloadDTO } from './api';
+
+const instance: PrepaidServiceAvailabilityPayloadDTO = {
+    startDate,
+    endDate,
+    staff,
+    noOfPeople,
+    id,
+};
+```
+
+[[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/PrepaidServiceAvailabilityResponseDTO.md

@@ -0,0 +1,22 @@
+# PrepaidServiceAvailabilityResponseDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**isBookingAllowed** | **boolean** | Flag to indicate whether user can do booking or not | [default to undefined]
+**message** | **string** |  | [default to 'Prepaid service is fully booked']
+
+## Example
+
+```typescript
+import { PrepaidServiceAvailabilityResponseDTO } from './api';
+
+const instance: PrepaidServiceAvailabilityResponseDTO = {
+    isBookingAllowed,
+    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)

package/docs/PrepaidServiceCategoriesDTO.md

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

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

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

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

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

@@ -0,0 +1,78 @@
+# PrepaidServiceEntity
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**isRecurring** | **boolean** | Is recurring event | [default to undefined]
+**duration** | **number** | Duration in minutes | [default to undefined]
+**repeat** | **string** | Repeat interval for event | [default to undefined]
+**startDate** | **string** | Start date of an event | [default to undefined]
+**endDate** | **string** | End date of an event | [default to undefined]
+**pattern** | **string** | Recurrence pattern | [optional] [default to undefined]
+**byDay** | **string** |  | [optional] [default to undefined]
+**byMonthDay** | **string** |  | [optional] [default to undefined]
+**byMonth** | **string** |  | [optional] [default to undefined]
+**repeatBy** | **string** |  | [optional] [default to undefined]
+**_id** | **string** | Tag id | [default to undefined]
+**name** | **string** | Service name | [default to undefined]
+**category** | **string** |  | [default to undefined]
+**capacity** | **number** |  | [default to undefined]
+**allowSelectGoodayStaff** | **boolean** |  | [default to undefined]
+**individualPricingPerStaff** | **boolean** |  | [default to undefined]
+**price** | **number** |  | [default to undefined]
+**staffs** | [**Array<BusinessStaffEntity>**](BusinessStaffEntity.md) |  | [default to undefined]
+**rules** | [**BookingRulesEntity**](BookingRulesEntity.md) |  | [default to undefined]
+**staffPrice** | [**Array<StaffPrice>**](StaffPrice.md) |  | [default to undefined]
+**venue** | **string** | Business venue | [default to undefined]
+**business** | **string** | Business | [default to undefined]
+**bookingFee** | **number** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**exceedMaximumPeople** | **boolean** |  | [default to undefined]
+**recurringPayment** | **boolean** |  | [default to undefined]
+**email** | **string** |  | [default to undefined]
+**discount** | **Array<string>** |  | [default to undefined]
+**cancellationFees** | **number** |  | [default to undefined]
+**cancellationHours** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PrepaidServiceEntity } from './api';
+
+const instance: PrepaidServiceEntity = {
+    isRecurring,
+    duration,
+    repeat,
+    startDate,
+    endDate,
+    pattern,
+    byDay,
+    byMonthDay,
+    byMonth,
+    repeatBy,
+    _id,
+    name,
+    category,
+    capacity,
+    allowSelectGoodayStaff,
+    individualPricingPerStaff,
+    price,
+    staffs,
+    rules,
+    staffPrice,
+    venue,
+    business,
+    bookingFee,
+    description,
+    exceedMaximumPeople,
+    recurringPayment,
+    email,
+    discount,
+    cancellationFees,
+    cancellationHours,
+};
+```
+
+[[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/PrepaidServiceFindDTO.md

@@ -0,0 +1,26 @@
+# PrepaidServiceFindDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | **number** |  | [default to undefined]
+**pageSize** | **number** |  | [default to undefined]
+**venue** | **string** |  | [optional] [default to undefined]
+**category** | **string** | Category | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PrepaidServiceFindDTO } from './api';
+
+const instance: PrepaidServiceFindDTO = {
+    page,
+    pageSize,
+    venue,
+    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)