@gooday_corp/gooday-api-client 1.3.32 → 1.3.34

package/docs/BlockoutApi.md

@@ -0,0 +1,273 @@
+# BlockoutApi
+
+All URIs are relative to *http://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**blockoutControllerCreateBlockout**](#blockoutcontrollercreateblockout) | **POST** /v1/blockout | |
+|[**blockoutControllerDeleteBlockout**](#blockoutcontrollerdeleteblockout) | **DELETE** /v1/blockout/{id} | |
+|[**blockoutControllerFindBlockout**](#blockoutcontrollerfindblockout) | **GET** /v1/blockout | |
+|[**blockoutControllerFindBlockoutById**](#blockoutcontrollerfindblockoutbyid) | **GET** /v1/blockout/{id} | |
+|[**blockoutControllerUpdateById**](#blockoutcontrollerupdatebyid) | **PUT** /v1/blockout/{id} | |
+
+# **blockoutControllerCreateBlockout**
+> BlockoutDTO blockoutControllerCreateBlockout(blockoutPayloadDTO)
+
+
+### Example
+
+```typescript
+import {
+    BlockoutApi,
+    Configuration,
+    BlockoutPayloadDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BlockoutApi(configuration);
+
+let blockoutPayloadDTO: BlockoutPayloadDTO; //
+
+const { status, data } = await apiInstance.blockoutControllerCreateBlockout(
+    blockoutPayloadDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **blockoutPayloadDTO** | **BlockoutPayloadDTO**|  | |
+
+
+### Return type
+
+**BlockoutDTO**
+
+### 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)
+
+# **blockoutControllerDeleteBlockout**
+> BlockoutDeleteResponseDTO blockoutControllerDeleteBlockout()
+
+
+### Example
+
+```typescript
+import {
+    BlockoutApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BlockoutApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.blockoutControllerDeleteBlockout(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**BlockoutDeleteResponseDTO**
+
+### 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)
+
+# **blockoutControllerFindBlockout**
+> BlockoutResponseDTO blockoutControllerFindBlockout()
+
+
+### Example
+
+```typescript
+import {
+    BlockoutApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BlockoutApi(configuration);
+
+let page: number; // (default to undefined)
+let pageSize: number; // (default to undefined)
+let venue: Array<string>; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.blockoutControllerFindBlockout(
+    page,
+    pageSize,
+    venue
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] |  | defaults to undefined|
+| **pageSize** | [**number**] |  | defaults to undefined|
+| **venue** | **Array&lt;string&gt;** |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**BlockoutResponseDTO**
+
+### 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)
+
+# **blockoutControllerFindBlockoutById**
+> BlockoutDTO blockoutControllerFindBlockoutById()
+
+
+### Example
+
+```typescript
+import {
+    BlockoutApi,
+    Configuration
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BlockoutApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.blockoutControllerFindBlockoutById(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**BlockoutDTO**
+
+### 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)
+
+# **blockoutControllerUpdateById**
+> BlockoutDTO blockoutControllerUpdateById(blockoutPayloadDTO)
+
+
+### Example
+
+```typescript
+import {
+    BlockoutApi,
+    Configuration,
+    BlockoutPayloadDTO
+} from './api';
+
+const configuration = new Configuration();
+const apiInstance = new BlockoutApi(configuration);
+
+let id: string; // (default to undefined)
+let blockoutPayloadDTO: BlockoutPayloadDTO; //
+
+const { status, data } = await apiInstance.blockoutControllerUpdateById(
+    id,
+    blockoutPayloadDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **blockoutPayloadDTO** | **BlockoutPayloadDTO**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**BlockoutDTO**
+
+### 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/BlockoutDTO.md

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

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

@@ -0,0 +1,46 @@
+# BlockoutEntity
+
+
+## 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]
+**venue** | [**Array<BusinessVenueDetailsEntity>**](BusinessVenueDetailsEntity.md) |  | [default to undefined]
+**business** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BlockoutEntity } from './api';
+
+const instance: BlockoutEntity = {
+    isRecurring,
+    duration,
+    repeat,
+    startDate,
+    endDate,
+    pattern,
+    byDay,
+    byMonthDay,
+    byMonth,
+    repeatBy,
+    _id,
+    title,
+    venue,
+    business,
+};
+```
+
+[[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/BlockoutPayloadDTO.md

@@ -0,0 +1,40 @@
+# BlockoutPayloadDTO
+
+
+## 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** | Name of block | [default to undefined]
+**venue** | **string** | Business Venue Id | [default to undefined]
+
+## Example
+
+```typescript
+import { BlockoutPayloadDTO } from './api';
+
+const instance: BlockoutPayloadDTO = {
+    startDate,
+    endDate,
+    from,
+    to,
+    repeat,
+    byDay,
+    byMonthDay,
+    byMonth,
+    repeatBy,
+    title,
+    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/BlockoutResponseDTO.md

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