@gooday_corp/gooday-api-client 1.3.33 → 1.3.34

package/docs/CreateEventPayloadDTO.md

@@ -0,0 +1,50 @@
+# CreateEventPayloadDTO
+
+
+## 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]
+**_id** | **string** | The unique identifier of the customer | [optional] [default to undefined]
+**title** | **string** | The title of the event | [default to 'Default Event Title']
+**note** | **string** | Notes attached with booking | [default to undefined]
+**calendar** | **Array<string>** | Calendar attached with booking | [default to undefined]
+**collaborators** | [**Array<CreateEventCollaboratorPayload>**](CreateEventCollaboratorPayload.md) | The list of collaborators associated with the event | [default to undefined]
+**location** | [**LocationDTO**](LocationDTO.md) |  | [default to undefined]
+**images** | **Array<string>** | Event images | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateEventPayloadDTO } from './api';
+
+const instance: CreateEventPayloadDTO = {
+    startDate,
+    endDate,
+    from,
+    to,
+    repeat,
+    byDay,
+    byMonthDay,
+    byMonth,
+    repeatBy,
+    _id,
+    title,
+    note,
+    calendar,
+    collaborators,
+    location,
+    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/CreatePaymentLinkDTO.md

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

@@ -0,0 +1,22 @@
+# CreateTaskPayload
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**todo** | **string** | ID of the associated todo item | [default to undefined]
+**content** | **string** | Content of the task | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateTaskPayload } from './api';
+
+const instance: CreateTaskPayload = {
+    todo,
+    content,
+};
+```
+
+[[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/CreateTodoPayload.md

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

@@ -0,0 +1,30 @@
+# CreateWaitlistBookingCollaboratorPayload
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **string** | The unique identifier of the customer | [optional] [default to undefined]
+**name** | **string** | The name of the customer | [optional] [default to 'John Doe']
+**mobile** | **string** | The mobile phone number of the customer | [optional] [default to '+11234567890']
+**email** | **string** | The email address of the customer | [optional] [default to 'example@example.com']
+**goodayId** | **string** | The goodayId for the customer | [optional] [default to 'default-gooday-id']
+**status** | **string** | Status of the  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateWaitlistBookingCollaboratorPayload } from './api';
+
+const instance: CreateWaitlistBookingCollaboratorPayload = {
+    _id,
+    name,
+    mobile,
+    email,
+    goodayId,
+    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/CustomerApi.md

@@ -0,0 +1,268 @@
+# CustomerApi
+
+All URIs are relative to *http://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**customerControllerAddCustomer**](#customercontrolleraddcustomer) | **POST** /v2/customer | |
+|[**customerControllerDeleteCustomer**](#customercontrollerdeletecustomer) | **DELETE** /v2/customer/{id} | |
+|[**customerControllerFindCustomer**](#customercontrollerfindcustomer) | **GET** /v2/customer/{id} | |
+|[**customerControllerFindCustomersList**](#customercontrollerfindcustomerslist) | **POST** /v2/customer/list | |
+|[**customerControllerUpdateCustomer**](#customercontrollerupdatecustomer) | **PUT** /v2/customer/{id} | |
+
+# **customerControllerAddCustomer**
+> CustomerResponseDTO customerControllerAddCustomer(createCustomerPayloadDTO)
+
+
+### Example
+
+```typescript
+import {
+    CustomerApi,
+    Configuration,
+    CreateCustomerPayloadDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CustomerApi(configuration);
+
+let createCustomerPayloadDTO: CreateCustomerPayloadDTO; //
+
+const { status, data } = await apiInstance.customerControllerAddCustomer(
+    createCustomerPayloadDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createCustomerPayloadDTO** | **CreateCustomerPayloadDTO**|  | |
+
+
+### Return type
+
+**CustomerResponseDTO**
+
+### 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)
+
+# **customerControllerDeleteCustomer**
+> CustomerDeleteResponseDTO customerControllerDeleteCustomer()
+
+
+### Example
+
+```typescript
+import {
+    CustomerApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CustomerApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.customerControllerDeleteCustomer(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**CustomerDeleteResponseDTO**
+
+### 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)
+
+# **customerControllerFindCustomer**
+> CustomerResponseDTO customerControllerFindCustomer()
+
+
+### Example
+
+```typescript
+import {
+    CustomerApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CustomerApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.customerControllerFindCustomer(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**CustomerResponseDTO**
+
+### 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)
+
+# **customerControllerFindCustomersList**
+> FineCustomerResponseDTO customerControllerFindCustomersList(customerFilter)
+
+
+### Example
+
+```typescript
+import {
+    CustomerApi,
+    Configuration,
+    CustomerFilter
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CustomerApi(configuration);
+
+let customerFilter: CustomerFilter; //
+
+const { status, data } = await apiInstance.customerControllerFindCustomersList(
+    customerFilter
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **customerFilter** | **CustomerFilter**|  | |
+
+
+### Return type
+
+**FineCustomerResponseDTO**
+
+### 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)
+
+# **customerControllerUpdateCustomer**
+> CustomerResponseDTO customerControllerUpdateCustomer(createCustomerPayloadDTO)
+
+
+### Example
+
+```typescript
+import {
+    CustomerApi,
+    Configuration,
+    CreateCustomerPayloadDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new CustomerApi(configuration);
+
+let id: string; // (default to undefined)
+let createCustomerPayloadDTO: CreateCustomerPayloadDTO; //
+
+const { status, data } = await apiInstance.customerControllerUpdateCustomer(
+    id,
+    createCustomerPayloadDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createCustomerPayloadDTO** | **CreateCustomerPayloadDTO**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**CustomerResponseDTO**
+
+### 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)
+

package/docs/CustomerBookingResponseDTO.md

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

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

@@ -0,0 +1,38 @@
+# CustomerEntity
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **string** |  | [default to undefined]
+**firstName** | **string** |  | [default to undefined]
+**lastName** | **string** |  | [default to undefined]
+**email** | **string** |  | [default to undefined]
+**mobileNumber** | **string** |  | [default to undefined]
+**notes** | **string** |  | [default to undefined]
+**goodayId** | **string** |  | [default to undefined]
+**tags** | [**Array<TagsResponse>**](TagsResponse.md) |  | [default to undefined]
+**business** | [**BusinessEntity**](BusinessEntity.md) |  | [default to undefined]
+**venue** | [**BusinessVenueDetailsEntity**](BusinessVenueDetailsEntity.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CustomerEntity } from './api';
+
+const instance: CustomerEntity = {
+    _id,
+    firstName,
+    lastName,
+    email,
+    mobileNumber,
+    notes,
+    goodayId,
+    tags,
+    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/CustomerFilter.md

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

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

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

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

@@ -0,0 +1,59 @@
+# DeviceApi
+
+All URIs are relative to *http://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deviceControllerAddDevice**](#devicecontrolleradddevice) | **POST** /v1/device | |
+
+# **deviceControllerAddDevice**
+> DeviceAddResponse deviceControllerAddDevice(addDevicePayload)
+
+
+### Example
+
+```typescript
+import {
+    DeviceApi,
+    Configuration,
+    AddDevicePayload
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new DeviceApi(configuration);
+
+let addDevicePayload: AddDevicePayload; //
+
+const { status, data } = await apiInstance.deviceControllerAddDevice(
+    addDevicePayload
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **addDevicePayload** | **AddDevicePayload**|  | |
+
+
+### Return type
+
+**DeviceAddResponse**
+
+### 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/DeviceEntity.md

@@ -0,0 +1,28 @@
+# DeviceEntity
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of the device | [default to undefined]
+**identifier** | **string** | Unique identifier for the device | [default to undefined]
+**lastUsed** | **string** | Last used date of the device | [default to undefined]
+**token** | **string** | Token associated with the device | [default to undefined]
+**status** | **string** | Activation status of the device | [default to undefined]
+
+## Example
+
+```typescript
+import { DeviceEntity } from './api';
+
+const instance: DeviceEntity = {
+    name,
+    identifier,
+    lastUsed,
+    token,
+    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)