yellowgrid-api-ts 3.2.31-dev.0 → 3.2.32

package/docs/ServicesApi.md

@@ -1,330 +0,0 @@
-# ServicesApi
-
-All URIs are relative to *http://api.yellowgrid.local*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**deleteUnsubscribe**](#deleteunsubscribe) | **DELETE** /services/events/unsubscribe | |
-|[**getGetServiceHealth**](#getgetservicehealth) | **GET** /services/health | |
-|[**patchArchiveEvent**](#patcharchiveevent) | **PATCH** /services/events/{id}/archive | |
-|[**postCreateEvent**](#postcreateevent) | **POST** /services/events | |
-|[**postCreateEventUpdate**](#postcreateeventupdate) | **POST** /services/events/{id}/updates | |
-|[**postSubscribe**](#postsubscribe) | **POST** /services/events/subscribe | |
-
-# **deleteUnsubscribe**
-> deleteUnsubscribe()
-
-
-### Example
-
-```typescript
-import {
-    ServicesApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new ServicesApi(configuration);
-
-let id: string; //Unsubscribe Email ID (optional) (default to undefined)
-let email: string; //Unsubscribe Email Address (optional) (default to undefined)
-
-const { status, data } = await apiInstance.deleteUnsubscribe(
-    id,
-    email
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] | Unsubscribe Email ID | (optional) defaults to undefined|
-| **email** | [**string**] | Unsubscribe Email Address | (optional) defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | No Response |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-
-# **getGetServiceHealth**
-> ServiceHealthDTO getGetServiceHealth()
-
-
-### Example
-
-```typescript
-import {
-    ServicesApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new ServicesApi(configuration);
-
-const { status, data } = await apiInstance.getGetServiceHealth();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**ServiceHealthDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Service Health DTO |  -  |
-|**400** | Bad Request |  -  |
-
-[[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)
-
-# **patchArchiveEvent**
-> EventDTO patchArchiveEvent()
-
-
-### Example
-
-```typescript
-import {
-    ServicesApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new ServicesApi(configuration);
-
-let id: number; //Group ID (default to undefined)
-
-const { status, data } = await apiInstance.patchArchiveEvent(
-    id
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**number**] | Group ID | defaults to undefined|
-
-
-### Return type
-
-**EventDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Service Event DTO |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-
-# **postCreateEvent**
-> EventDTO postCreateEvent()
-
-
-### Example
-
-```typescript
-import {
-    ServicesApi,
-    Configuration,
-    EventRequestDTO
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new ServicesApi(configuration);
-
-let eventRequestDTO: EventRequestDTO; // (optional)
-
-const { status, data } = await apiInstance.postCreateEvent(
-    eventRequestDTO
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **eventRequestDTO** | **EventRequestDTO**|  | |
-
-
-### Return type
-
-**EventDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Service Event DTO |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-
-# **postCreateEventUpdate**
-> EventDTO postCreateEventUpdate()
-
-
-### Example
-
-```typescript
-import {
-    ServicesApi,
-    Configuration,
-    EventUpdateRequestDTO
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new ServicesApi(configuration);
-
-let id: number; //Group ID (default to undefined)
-let eventUpdateRequestDTO: EventUpdateRequestDTO; // (optional)
-
-const { status, data } = await apiInstance.postCreateEventUpdate(
-    id,
-    eventUpdateRequestDTO
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **eventUpdateRequestDTO** | **EventUpdateRequestDTO**|  | |
-| **id** | [**number**] | Group ID | defaults to undefined|
-
-
-### Return type
-
-**EventDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Service Event DTO |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-
-# **postSubscribe**
-> postSubscribe()
-
-
-### Example
-
-```typescript
-import {
-    ServicesApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new ServicesApi(configuration);
-
-let email: string; //Subscription Email Address (optional) (default to undefined)
-
-const { status, data } = await apiInstance.postSubscribe(
-    email
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **email** | [**string**] | Subscription Email Address | (optional) defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | No Response |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[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)
-