@gooday_corp/gooday-api-client 1.3.33 → 1.3.35

package/docs/WhatsOnAvailabilityPayloadDTO.md

@@ -0,0 +1,28 @@
+# WhatsOnAvailabilityPayloadDTO
+
+
+## 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 { WhatsOnAvailabilityPayloadDTO } from './api';
+
+const instance: WhatsOnAvailabilityPayloadDTO = {
+    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/WhatsOnAvailabilityResponseDTO.md

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

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

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

@@ -0,0 +1,74 @@
+# WhatsOnEntity
+
+
+## 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** | Event id | [default to undefined]
+**title** | **string** | Event name | [default to undefined]
+**photos** | **Array<string>** |  | [default to undefined]
+**price** | **number** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**capacity** | **number** |  | [default to undefined]
+**venue** | **string** | Business venue | [default to undefined]
+**business** | **string** | Business | [default to undefined]
+**tags** | **Array<string>** |  | [default to undefined]
+**email** | **string** |  | [default to undefined]
+**exceedMaximumPeople** | **boolean** |  | [default to undefined]
+**cancellationFees** | **number** |  | [default to undefined]
+**cancellationHours** | **string** |  | [default to undefined]
+**location** | [**WhatsOnLocationDTO**](WhatsOnLocationDTO.md) |  | [optional] [default to undefined]
+**rules** | [**BookingRulesEntity**](BookingRulesEntity.md) |  | [optional] [default to undefined]
+**bookingFee** | **number** |  | [default to undefined]
+**discount** | **Array<string>** |  | [default to undefined]
+**favorite** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WhatsOnEntity } from './api';
+
+const instance: WhatsOnEntity = {
+    isRecurring,
+    duration,
+    repeat,
+    startDate,
+    endDate,
+    pattern,
+    byDay,
+    byMonthDay,
+    byMonth,
+    repeatBy,
+    _id,
+    title,
+    photos,
+    price,
+    description,
+    capacity,
+    venue,
+    business,
+    tags,
+    email,
+    exceedMaximumPeople,
+    cancellationFees,
+    cancellationHours,
+    location,
+    rules,
+    bookingFee,
+    discount,
+    favorite,
+};
+```
+
+[[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/WhatsOnFavoriteCount.md

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

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

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

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

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

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

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

@@ -0,0 +1,26 @@
+# WhatsOnLocationDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [default to undefined]
+**coordinates** | **Array<number>** |  | [default to undefined]
+**distance** | **string** | Optional distance from a reference point. | [optional] [default to undefined]
+**meta** | [**WhatsOnLocationMetaDTO**](WhatsOnLocationMetaDTO.md) | Meta information about the location. | [default to undefined]
+
+## Example
+
+```typescript
+import { WhatsOnLocationDTO } from './api';
+
+const instance: WhatsOnLocationDTO = {
+    type,
+    coordinates,
+    distance,
+    meta,
+};
+```
+
+[[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/WhatsOnLocationMetaDTO.md

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

@@ -0,0 +1,66 @@
+# WhatsOnPayloadDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**startDate** | **string** | Start date of event | [default to undefined]
+**endDate** | **string** | End date of event | [default to undefined]
+**from** | **string** | Start hour of an event | [default to undefined]
+**to** | **string** | End hour of an event | [default to undefined]
+**repeat** | **string** |  | [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]
+**title** | **string** | Event name | [default to undefined]
+**photos** | **Array<string>** |  | [default to undefined]
+**price** | **number** |  | [default to undefined]
+**rules** | [**BookingRulesPayloadDTO**](BookingRulesPayloadDTO.md) | Booking rules | [default to undefined]
+**bookingFee** | **number** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**capacity** | **number** |  | [default to undefined]
+**venue** | **string** | Business venue | [default to undefined]
+**tags** | **Array<string>** |  | [default to undefined]
+**email** | **string** |  | [default to undefined]
+**exceedMaximumPeople** | **boolean** |  | [default to undefined]
+**cancellationFees** | **number** |  | [default to undefined]
+**cancellationHours** | **string** |  | [default to undefined]
+**location** | [**WhatsOnLocationDTO**](WhatsOnLocationDTO.md) |  | [optional] [default to undefined]
+**discounts** | [**Array<Discount>**](Discount.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { WhatsOnPayloadDTO } from './api';
+
+const instance: WhatsOnPayloadDTO = {
+    startDate,
+    endDate,
+    from,
+    to,
+    repeat,
+    byDay,
+    byMonthDay,
+    byMonth,
+    repeatBy,
+    title,
+    photos,
+    price,
+    rules,
+    bookingFee,
+    description,
+    capacity,
+    venue,
+    tags,
+    email,
+    exceedMaximumPeople,
+    cancellationFees,
+    cancellationHours,
+    location,
+    discounts,
+};
+```
+
+[[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/WhatsOnResponseDTO.md

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

@@ -0,0 +1,28 @@
+# WhatsOnSlotsPayload
+
+
+## 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]
+**collaborators** | **Array<string>** | List of collaborators associated with the booking | [default to undefined]
+**staffs** | **Array<string>** | List of staff associated with the booking | [default to undefined]
+**id** | **string** | WhatsOn ID | [default to undefined]
+
+## Example
+
+```typescript
+import { WhatsOnSlotsPayload } from './api';
+
+const instance: WhatsOnSlotsPayload = {
+    startDate,
+    endDate,
+    collaborators,
+    staffs,
+    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/WhatsOnUnFavoriteResponse.md

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

@@ -1,6 +1,6 @@
 {
   "name": "@gooday_corp/gooday-api-client",
-  "version": "1.3.33",
+  "version": "1.3.35",
   "description": "API client for Gooday",
   "main": "index.ts",
   "scripts": {},