yellowgrid-api-ts 3.2.23 → 3.2.25-dev.0

package/docs/ServiceHealthDTO.md

@@ -0,0 +1,23 @@
+# ServiceHealthDTO
+
+Service Health DTO
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**services** | [**Array<ServiceStatusDTO>**](ServiceStatusDTO.md) |  | [optional] [default to undefined]
+**globalStatus** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ServiceHealthDTO } from 'yellowgrid-api-ts';
+
+const instance: ServiceHealthDTO = {
+    services,
+    globalStatus,
+};
+```
+
+[[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/ServiceStatusDTO.md

@@ -0,0 +1,25 @@
+# ServiceStatusDTO
+
+Service Status DTO
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**serviceName** | **string** | Service Name | [optional] [default to undefined]
+**status** | **number** | Service Status | [optional] [default to undefined]
+**incidents** | [**Array<IncidentDTO>**](IncidentDTO.md) | Service Incidents | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ServiceStatusDTO } from 'yellowgrid-api-ts';
+
+const instance: ServiceStatusDTO = {
+    serviceName,
+    status,
+    incidents,
+};
+```
+
+[[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/ServicesApi.md

@@ -0,0 +1,330 @@
+# ServicesApi
+
+All URIs are relative to *http://api.yellowgrid.local*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteUnsubscribe**](#deleteunsubscribe) | **DELETE** /services/incidents/unsubscribe | |
+|[**getGetServiceHealth**](#getgetservicehealth) | **GET** /services/health | |
+|[**patchArchiveIncident**](#patcharchiveincident) | **PATCH** /services/incidents/{id}/archive | |
+|[**postCreateIncident**](#postcreateincident) | **POST** /services/incidents | |
+|[**postCreateIncidentUpdate**](#postcreateincidentupdate) | **POST** /services/incidents/{id}/updates | |
+|[**postSubscribe**](#postsubscribe) | **POST** /services/incidents/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)
+
+# **patchArchiveIncident**
+> IncidentDTO patchArchiveIncident()
+
+
+### Example
+
+```typescript
+import {
+    ServicesApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ServicesApi(configuration);
+
+let id: string; //Group ID (default to undefined)
+
+const { status, data } = await apiInstance.patchArchiveIncident(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Group ID | defaults to undefined|
+
+
+### Return type
+
+**IncidentDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Incident 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)
+
+# **postCreateIncident**
+> IncidentDTO postCreateIncident()
+
+
+### Example
+
+```typescript
+import {
+    ServicesApi,
+    Configuration,
+    IncidentRequestDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ServicesApi(configuration);
+
+let incidentRequestDTO: IncidentRequestDTO; // (optional)
+
+const { status, data } = await apiInstance.postCreateIncident(
+    incidentRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **incidentRequestDTO** | **IncidentRequestDTO**|  | |
+
+
+### Return type
+
+**IncidentDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Incident 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)
+
+# **postCreateIncidentUpdate**
+> IncidentDTO postCreateIncidentUpdate()
+
+
+### Example
+
+```typescript
+import {
+    ServicesApi,
+    Configuration,
+    IncidentUpdateRequestDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ServicesApi(configuration);
+
+let id: string; //Group ID (default to undefined)
+let incidentUpdateRequestDTO: IncidentUpdateRequestDTO; // (optional)
+
+const { status, data } = await apiInstance.postCreateIncidentUpdate(
+    id,
+    incidentUpdateRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **incidentUpdateRequestDTO** | **IncidentUpdateRequestDTO**|  | |
+| **id** | [**string**] | Group ID | defaults to undefined|
+
+
+### Return type
+
+**IncidentDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Incident 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)
+

package/docs/SupportTicketModel.md

@@ -0,0 +1,41 @@
+# SupportTicketModel
+
+Telephony Support Ticket
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Ticket ID | [optional] [default to undefined]
+**status** | **string** | Ticket status | [optional] [default to undefined]
+**statusId** | **number** | Ticket status ID | [optional] [default to undefined]
+**subject** | **string** | Ticket subject | [optional] [default to undefined]
+**supportEmail** | **string** | Support email address | [optional] [default to undefined]
+**toEmails** | **Array<string>** | Recipient emails | [optional] [default to undefined]
+**description** | **string** | Ticket description (HTML) | [optional] [default to undefined]
+**descriptionText** | **string** | Ticket description (plain text) | [optional] [default to undefined]
+**createdAt** | **string** | Creation timestamp | [optional] [default to undefined]
+**attachments** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [optional] [default to undefined]
+**conversations** | [**Array<ConversationModel>**](ConversationModel.md) | Conversations | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SupportTicketModel } from 'yellowgrid-api-ts';
+
+const instance: SupportTicketModel = {
+    id,
+    status,
+    statusId,
+    subject,
+    supportEmail,
+    toEmails,
+    description,
+    descriptionText,
+    createdAt,
+    attachments,
+    conversations,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)