@gooday_corp/gooday-api-client 1.3.32 → 1.3.34

package/docs/BookingConfirmPayload.md

@@ -0,0 +1,22 @@
+# BookingConfirmPayload
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** | Status of the booking | [default to undefined]
+**bookingId** | **string** | Status of the booking | [default to undefined]
+
+## Example
+
+```typescript
+import { BookingConfirmPayload } from './api';
+
+const instance: BookingConfirmPayload = {
+    status,
+    bookingId,
+};
+```
+
+[[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/BookingDurationEntity.md

@@ -0,0 +1,24 @@
+# BookingDurationEntity
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier for the Booking duration | [default to undefined]
+**title** | **string** | Title of the Booking duration | [default to undefined]
+**value** | **string** | Value of the Booking duration | [default to undefined]
+
+## Example
+
+```typescript
+import { BookingDurationEntity } from './api';
+
+const instance: BookingDurationEntity = {
+    id,
+    title,
+    value,
+};
+```
+
+[[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/BookingDurationListResponse.md

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

@@ -0,0 +1,72 @@
+# BookingEntity
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **string** | Unique identifier for the booking | [default to undefined]
+**title** | **string** | Title of the booking | [default to undefined]
+**startDate** | **string** | Start date of the booking | [default to undefined]
+**endDate** | **string** | End date of the booking | [default to undefined]
+**venue** | **string** | Venue associated with the booking | [default to undefined]
+**business** | [**BusinessEntity**](BusinessEntity.md) | Business associated with the booking | [default to undefined]
+**collaborators** | **Array<object>** | List of collaborators in the booking | [default to undefined]
+**customers** | [**Array<CustomerEntity>**](CustomerEntity.md) | List of customers in the booking | [default to undefined]
+**users** | **Array<string>** | Users associated with the booking | [default to undefined]
+**staffs** | [**Array<BusinessStaffEntity>**](BusinessStaffEntity.md) | Staff members involved in the booking | [default to undefined]
+**selectedStaff** | [**BusinessStaffEntity**](BusinessStaffEntity.md) | Staff members involved in the booking | [default to undefined]
+**space** | **string** | Space for the booking | [default to undefined]
+**createdBy** | **string** | Creator of the booking | [default to undefined]
+**notes** | **string** | Notes related to the booking | [default to undefined]
+**status** | **string** | Status of the booking | [default to undefined]
+**occasion** | **string** | Occasion for the booking | [default to undefined]
+**calendar** | **Array<string>** | Calendar associated with the booking | [default to undefined]
+**paymentMethodId** | **string** | Payment method ID for the booking | [default to undefined]
+**method** | **string** | Booking method used | [default to undefined]
+**favorite** | [**BusinessVenueDTO**](BusinessVenueDTO.md) | Business venue favorite | [optional] [default to undefined]
+**icon** | **string** | Booking Icon | [optional] [default to undefined]
+**quantity** | **number** |  | [default to undefined]
+**serviceId** | [**PrepaidServiceEntity**](PrepaidServiceEntity.md) |  | [default to undefined]
+**paymentMethod** | [**BookingPaymentCreateResponse**](BookingPaymentCreateResponse.md) |  | [default to undefined]
+**tags** | [**Array<TagsResponse>**](TagsResponse.md) |  | [default to undefined]
+**whatsOn** | [**WhatsOnEntity**](WhatsOnEntity.md) |  | [default to undefined]
+**cancellationFee** | **object** | Cancellation fee | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BookingEntity } from './api';
+
+const instance: BookingEntity = {
+    _id,
+    title,
+    startDate,
+    endDate,
+    venue,
+    business,
+    collaborators,
+    customers,
+    users,
+    staffs,
+    selectedStaff,
+    space,
+    createdBy,
+    notes,
+    status,
+    occasion,
+    calendar,
+    paymentMethodId,
+    method,
+    favorite,
+    icon,
+    quantity,
+    serviceId,
+    paymentMethod,
+    tags,
+    whatsOn,
+    cancellationFee,
+};
+```
+
+[[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/BookingPaymentCreateResponse.md

@@ -0,0 +1,36 @@
+# BookingPaymentCreateResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**paymentId** | **string** | Payment method ID | [default to undefined]
+**paymentIntent** | **string** | Payment intent ID | [default to undefined]
+**ephemeralKey** | **string** |  | [default to undefined]
+**customer** | **string** |  | [default to undefined]
+**subscriptionId** | **string** | Only available if payment is recurring | [optional] [default to undefined]
+**price** | **number** | Final booking price shown to customer | [default to undefined]
+**frequency** | **string** | Only available if payment is recurring | [optional] [default to undefined]
+**currency** | **string** |  | [default to 'aud']
+**currencySymbol** | **string** |  | [default to 'A$']
+
+## Example
+
+```typescript
+import { BookingPaymentCreateResponse } from './api';
+
+const instance: BookingPaymentCreateResponse = {
+    paymentId,
+    paymentIntent,
+    ephemeralKey,
+    customer,
+    subscriptionId,
+    price,
+    frequency,
+    currency,
+    currencySymbol,
+};
+```
+
+[[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/BookingPaymentCreateResponseDTO.md

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

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

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

@@ -0,0 +1,62 @@
+# BookingResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **string** | The unique identifier of the customer | [default to undefined]
+**title** | **string** | The title of the booking | [default to 'Default Booking Title']
+**startDate** | **string** | The start date of the booking | [default to undefined]
+**endDate** | **string** | The end date of the booking | [default to undefined]
+**venue** | [**BusinessVenueDTO**](BusinessVenueDTO.md) | The venue of the booking | [default to undefined]
+**business** | [**BusinessEntity**](BusinessEntity.md) | The business associated with the booking | [default to undefined]
+**users** | [**Array<UserEntity>**](UserEntity.md) | The user details | [default to undefined]
+**createdBy** | [**UserEntity**](UserEntity.md) | The user details | [optional] [default to undefined]
+**notes** | **string** | Notes attached with booking | [default to undefined]
+**occasion** | **string** | Occasion id | [default to undefined]
+**calendar** | **Array<string>** | Calendar attached with booking | [default to undefined]
+**paymentMethodId** | **string** | Payment method Id | [default to undefined]
+**collaborators** | [**Array<CreateBookingCollaboratorPayload>**](CreateBookingCollaboratorPayload.md) | The list of collaborators associated with the booking | [default to undefined]
+**method** | **string** | Booking method | [default to MethodEnum_App]
+**favorite** | [**BusinessVenueDTO**](BusinessVenueDTO.md) | Business venue favorite | [optional] [default to undefined]
+**icon** | **string** | Booking Icon | [optional] [default to undefined]
+**status** | **string** | Status of the booking | [default to undefined]
+**quantity** | **number** |  | [default to undefined]
+**serviceId** | [**PrepaidServiceEntity**](PrepaidServiceEntity.md) |  | [default to undefined]
+**paymentMethod** | [**BookingPaymentCreateResponse**](BookingPaymentCreateResponse.md) |  | [default to undefined]
+**whatsOn** | **string** |  | [default to undefined]
+**selectedStaff** | [**BusinessStaffEntity**](BusinessStaffEntity.md) | Staff members involved in the booking | [default to undefined]
+
+## Example
+
+```typescript
+import { BookingResponse } from './api';
+
+const instance: BookingResponse = {
+    _id,
+    title,
+    startDate,
+    endDate,
+    venue,
+    business,
+    users,
+    createdBy,
+    notes,
+    occasion,
+    calendar,
+    paymentMethodId,
+    collaborators,
+    method,
+    favorite,
+    icon,
+    status,
+    quantity,
+    serviceId,
+    paymentMethod,
+    whatsOn,
+    selectedStaff,
+};
+```
+
+[[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/BookingResponseDTO.md

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

@@ -0,0 +1,22 @@
+# BookingRulesEntity
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**finalBookingTimeRelative** | **string** | Final booking relative time | [default to undefined]
+**finalBookingTimeAbsolute** | **string** | Final booking absolute time | [default to undefined]
+
+## Example
+
+```typescript
+import { BookingRulesEntity } from './api';
+
+const instance: BookingRulesEntity = {
+    finalBookingTimeRelative,
+    finalBookingTimeAbsolute,
+};
+```
+
+[[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/BookingRulesPayloadDTO.md

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