@gooday_corp/gooday-api-client 1.3.32 → 1.3.34

package/docs/BusinessConnectedAccount.md

@@ -0,0 +1,22 @@
+# BusinessConnectedAccount
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Account ID | [default to undefined]
+**status** | **string** | Flag indicates account has been verified or not | [default to undefined]
+
+## Example
+
+```typescript
+import { BusinessConnectedAccount } from './api';
+
+const instance: BusinessConnectedAccount = {
+    id,
+    status,
+};
+```
+
+[[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/BusinessDetailsPayloadDTO.md

@@ -0,0 +1,42 @@
+# BusinessDetailsPayloadDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**businessType** | **string** | Business Type | [optional] [default to undefined]
+**businessCategory** | **string** | Business Category | [optional] [default to undefined]
+**venues** | [**BusinessVenueDTO**](BusinessVenueDTO.md) | Business Venue | [optional] [default to undefined]
+**policies** | **string** | Business policies | [optional] [default to undefined]
+**name** | **string** | Business Name | [optional] [default to undefined]
+**cancellationFee** | **number** | Business cancellationFee | [optional] [default to undefined]
+**businessID** | **string** | Business ID | [optional] [default to undefined]
+**businessCountry** | **string** | Business Country | [optional] [default to undefined]
+**assistant** | **string** | Assistant ID | [optional] [default to undefined]
+**cancellationDuration** | **string** |  | [optional] [default to undefined]
+**business** | **string** | Business | [optional] [default to undefined]
+**venue** | **string** | Business venue | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BusinessDetailsPayloadDTO } from './api';
+
+const instance: BusinessDetailsPayloadDTO = {
+    businessType,
+    businessCategory,
+    venues,
+    policies,
+    name,
+    cancellationFee,
+    businessID,
+    businessCountry,
+    assistant,
+    cancellationDuration,
+    business,
+    venue,
+};
+```
+
+[[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/BusinessEntity.md

@@ -0,0 +1,44 @@
+# BusinessEntity
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **string** | Unique identifier for the Business | [default to undefined]
+**policies** | **string** | Business policies | [optional] [default to undefined]
+**name** | **string** | Business Name | [optional] [default to undefined]
+**cancellationFee** | **number** | Business cancellationFee | [optional] [default to undefined]
+**cancellationDuration** | **string** | Business cancellationDuration | [optional] [default to undefined]
+**businessID** | **string** | Business ID | [optional] [default to undefined]
+**businessCountry** | **string** | Business Country | [optional] [default to undefined]
+**venues** | **Array<string>** | Business Venue | [optional] [default to undefined]
+**businessType** | **string** | Business Type | [optional] [default to undefined]
+**userId** | **string** | User Id | [optional] [default to undefined]
+**businessCategory** | **string** | Business Category | [optional] [default to undefined]
+**accountId** | **string** | Connected business account ID | [optional] [default to undefined]
+**status** | **string** | Business verification status | [default to undefined]
+
+## Example
+
+```typescript
+import { BusinessEntity } from './api';
+
+const instance: BusinessEntity = {
+    _id,
+    policies,
+    name,
+    cancellationFee,
+    cancellationDuration,
+    businessID,
+    businessCountry,
+    venues,
+    businessType,
+    userId,
+    businessCategory,
+    accountId,
+    status,
+};
+```
+
+[[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/BusinessFavoriteCount.md

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

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

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

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

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

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

@@ -0,0 +1,38 @@
+# BusinessOnBoardingDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**venues** | [**Array<BusinessVenueDTO>**](BusinessVenueDTO.md) | Business Venue | [optional] [default to undefined]
+**policies** | **string** | Business policies | [optional] [default to undefined]
+**name** | **string** | Business Name | [optional] [default to undefined]
+**cancellationFee** | **number** | Business cancellationFee | [optional] [default to undefined]
+**businessID** | **string** | Business ID | [optional] [default to undefined]
+**businessCountry** | **string** | Business Country | [optional] [default to undefined]
+**businessType** | **string** | Business Type | [optional] [default to undefined]
+**businessCategory** | **string** | Business Category | [optional] [default to undefined]
+**assistant** | **string** | Assistant ID | [optional] [default to undefined]
+**cancellationDuration** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BusinessOnBoardingDTO } from './api';
+
+const instance: BusinessOnBoardingDTO = {
+    venues,
+    policies,
+    name,
+    cancellationFee,
+    businessID,
+    businessCountry,
+    businessType,
+    businessCategory,
+    assistant,
+    cancellationDuration,
+};
+```
+
+[[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/BusinessOnBoardingResponseDTO.md

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

@@ -0,0 +1,48 @@
+# BusinessStaffDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**firstName** | **string** | First name of the staff | [default to undefined]
+**lastName** | **string** | Last name of the staff | [default to undefined]
+**gender** | **string** | Gender of the staff | [default to undefined]
+**dob** | **string** | Date associated with the staff | [default to undefined]
+**email** | **string** | Email of the staff | [default to undefined]
+**phoneNumber** | **string** | Phone number of the staff | [default to undefined]
+**goodayId** | **string** | Gooday ID of the staff | [default to undefined]
+**role** | **string** | Role of the staff | [default to undefined]
+**venue** | **string** | Venue ID of the staff | [default to undefined]
+**admin** | **string** | Admin name for the staff | [default to undefined]
+**country** | **string** | Country of the staff | [default to undefined]
+**address** | **string** | Address of the staff | [default to undefined]
+**profilePicture** | **string** | Profile picture URL | [default to undefined]
+**additionalDocument** | **Array<string>** | Additional documents URLs | [default to undefined]
+**availability** | [**Array<AvailabilityDayDto>**](AvailabilityDayDto.md) | Availability details of the staff | [default to undefined]
+
+## Example
+
+```typescript
+import { BusinessStaffDTO } from './api';
+
+const instance: BusinessStaffDTO = {
+    firstName,
+    lastName,
+    gender,
+    dob,
+    email,
+    phoneNumber,
+    goodayId,
+    role,
+    venue,
+    admin,
+    country,
+    address,
+    profilePicture,
+    additionalDocument,
+    availability,
+};
+```
+
+[[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/BusinessStaffDeleteResponseDTO.md

@@ -0,0 +1,22 @@
+# BusinessStaffDeleteResponseDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**statusCode** | **number** | Status code of the response | [default to undefined]
+**message** | **string** | Staff deleted successfully | [default to undefined]
+
+## Example
+
+```typescript
+import { BusinessStaffDeleteResponseDTO } from './api';
+
+const instance: BusinessStaffDeleteResponseDTO = {
+    statusCode,
+    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/BusinessStaffEntity.md

@@ -0,0 +1,50 @@
+# BusinessStaffEntity
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **string** | Unique identifier for the business staff | [default to undefined]
+**firstName** | **string** | First name of the staff member | [default to undefined]
+**lastName** | **string** | Last name of the staff member | [default to undefined]
+**gender** | **string** | Gender of the staff member | [optional] [default to undefined]
+**dob** | **string** | Date of birth of the staff member | [optional] [default to undefined]
+**email** | **string** | Email of the staff member | [optional] [default to undefined]
+**phoneNumber** | **string** | Phone number of the staff member | [optional] [default to undefined]
+**goodayId** | **string** | Gooday ID of the staff member | [default to undefined]
+**role** | **string** | Role of the staff member | [default to undefined]
+**venue** | **object** | Associated business venue | [default to undefined]
+**admin** | **string** | Admin ID managing the staff | [optional] [default to undefined]
+**country** | **string** | Country of the staff member | [optional] [default to undefined]
+**address** | **string** | Address of the staff member | [optional] [default to undefined]
+**profilePicture** | **string** | Profile picture URL | [default to undefined]
+**additionalDocument** | **Array<string>** | Additional documents provided by staff | [default to undefined]
+**availability** | **Array<object>** | Availability of the staff member | [default to undefined]
+
+## Example
+
+```typescript
+import { BusinessStaffEntity } from './api';
+
+const instance: BusinessStaffEntity = {
+    _id,
+    firstName,
+    lastName,
+    gender,
+    dob,
+    email,
+    phoneNumber,
+    goodayId,
+    role,
+    venue,
+    admin,
+    country,
+    address,
+    profilePicture,
+    additionalDocument,
+    availability,
+};
+```
+
+[[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/BusinessStaffResponseDTO.md

@@ -0,0 +1,22 @@
+# BusinessStaffResponseDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**statusCode** | **number** | Status code of the response | [default to undefined]
+**data** | [**BusinessStaffEntity**](BusinessStaffEntity.md) | Response Message | [default to undefined]
+
+## Example
+
+```typescript
+import { BusinessStaffResponseDTO } from './api';
+
+const instance: BusinessStaffResponseDTO = {
+    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/BusinessStaffsResponseDTO.md

@@ -0,0 +1,22 @@
+# BusinessStaffsResponseDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**statusCode** | **number** | Status code of the response | [default to undefined]
+**data** | [**Array<BusinessStaffEntity>**](BusinessStaffEntity.md) | Response Message | [default to undefined]
+
+## Example
+
+```typescript
+import { BusinessStaffsResponseDTO } from './api';
+
+const instance: BusinessStaffsResponseDTO = {
+    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/BusinessTime.md

@@ -0,0 +1,24 @@
+# BusinessTime
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**openAt** | **string** | Business open time | [default to undefined]
+**closeAt** | **string** | Business close time | [default to undefined]
+**finalBookingTime** | **string** | Business close time | [default to undefined]
+
+## Example
+
+```typescript
+import { BusinessTime } from './api';
+
+const instance: BusinessTime = {
+    openAt,
+    closeAt,
+    finalBookingTime,
+};
+```
+
+[[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/BusinessTiming.md

@@ -0,0 +1,24 @@
+# BusinessTiming
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**time** | [**Array<BusinessTime>**](BusinessTime.md) |  | [optional] [default to undefined]
+**day** | **string** | Day name | [default to undefined]
+**isClose** | **boolean** | Business close flag | [default to undefined]
+
+## Example
+
+```typescript
+import { BusinessTiming } from './api';
+
+const instance: BusinessTiming = {
+    time,
+    day,
+    isClose,
+};
+```
+
+[[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/BusinessTypeEntity.md

@@ -0,0 +1,26 @@
+# BusinessTypeEntity
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **string** | Unique identifier for the business type | [default to undefined]
+**name** | **string** | name of the business type | [default to undefined]
+**backgroundColor** | **string** | Image background color | [default to undefined]
+**images** | [**BusinessTypeImageDTO**](BusinessTypeImageDTO.md) | Business Image | [default to undefined]
+
+## Example
+
+```typescript
+import { BusinessTypeEntity } from './api';
+
+const instance: BusinessTypeEntity = {
+    _id,
+    name,
+    backgroundColor,
+    images,
+};
+```
+
+[[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/BusinessTypeImageDTO.md

@@ -0,0 +1,22 @@
+# BusinessTypeImageDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**small** | **string** | Business Type Image Small | [default to undefined]
+**large** | **string** | Business Type Image Large | [default to undefined]
+
+## Example
+
+```typescript
+import { BusinessTypeImageDTO } from './api';
+
+const instance: BusinessTypeImageDTO = {
+    small,
+    large,
+};
+```
+
+[[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/BusinessTypeListResponse.md

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

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

@@ -0,0 +1,46 @@
+# BusinessVenueDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**coverPhoto** | **Array<string>** | coverPhots | [default to undefined]
+**timing** | [**Array<BusinessTiming>**](BusinessTiming.md) | Business Timing | [optional] [default to undefined]
+**priceRange** | **string** |  | [default to undefined]
+**location** | [**LocationDTO**](LocationDTO.md) |  | [default to undefined]
+**numberOfEmployee** | **string** |  | [default to undefined]
+**keywords** | **Array<string>** |  | [default to undefined]
+**socialMedia** | [**SocialMedia**](SocialMedia.md) |  | [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**phone** | **string** |  | [optional] [default to undefined]
+**website** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [default to undefined]
+**averageBookingDuration** | **string** |  | [default to undefined]
+**furtherInstructions** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BusinessVenueDTO } from './api';
+
+const instance: BusinessVenueDTO = {
+    coverPhoto,
+    timing,
+    priceRange,
+    location,
+    numberOfEmployee,
+    keywords,
+    socialMedia,
+    email,
+    phone,
+    website,
+    name,
+    description,
+    averageBookingDuration,
+    furtherInstructions,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)