yellowgrid-api-ts 3.2.27-dev.0 → 3.2.28-dev.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/.openapi-generator/FILES +6 -6
  2. package/README.md +11 -11
  3. package/api.ts +222 -222
  4. package/dist/api.d.ts +186 -186
  5. package/dist/api.js +66 -66
  6. package/docs/EventDTO.md +35 -0
  7. package/docs/EventRequestDTO.md +25 -0
  8. package/docs/EventSubscriptionModel.md +23 -0
  9. package/docs/EventUpdateDTO.md +27 -0
  10. package/docs/EventUpdateEntity.md +29 -0
  11. package/docs/EventUpdateRequestDTO.md +23 -0
  12. package/docs/ServiceStatusDTO.md +2 -2
  13. package/docs/ServicesApi.md +28 -28
  14. package/package.json +1 -1
package/docs/ServicesApi.md CHANGED
@@ -4,12 +4,12 @@ All URIs are relative to *http://api.yellowgrid.local*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
- |[**deleteUnsubscribe**](#deleteunsubscribe) | **DELETE** /services/incidents/unsubscribe | |
7
+ |[**deleteUnsubscribe**](#deleteunsubscribe) | **DELETE** /services/events/unsubscribe | |
8
8
  |[**getGetServiceHealth**](#getgetservicehealth) | **GET** /services/health | |
9
- |[**patchArchiveIncident**](#patcharchiveincident) | **PATCH** /services/incidents/{id}/archive | |
10
- |[**postCreateIncident**](#postcreateincident) | **POST** /services/incidents | |
11
- |[**postCreateIncidentUpdate**](#postcreateincidentupdate) | **POST** /services/incidents/{id}/updates | |
12
- |[**postSubscribe**](#postsubscribe) | **POST** /services/incidents/subscribe | |
9
+ |[**patchArchiveEvent**](#patcharchiveevent) | **PATCH** /services/events/{id}/archive | |
10
+ |[**postCreateEvent**](#postcreateevent) | **POST** /services/events | |
11
+ |[**postCreateEventUpdate**](#postcreateeventupdate) | **POST** /services/events/{id}/updates | |
12
+ |[**postSubscribe**](#postsubscribe) | **POST** /services/events/subscribe | |
13
13
 
14
14
  # **deleteUnsubscribe**
15
15
  > deleteUnsubscribe()
@@ -111,8 +111,8 @@ No authorization required
111
111
 
112
112
  [[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)
113
113
 
114
- # **patchArchiveIncident**
115
- > IncidentDTO patchArchiveIncident()
114
+ # **patchArchiveEvent**
115
+ > EventDTO patchArchiveEvent()
116
116
 
117
117
 
118
118
  ### Example
@@ -128,7 +128,7 @@ const apiInstance = new ServicesApi(configuration);
128
128
 
129
129
  let id: string; //Group ID (default to undefined)
130
130
 
131
- const { status, data } = await apiInstance.patchArchiveIncident(
131
+ const { status, data } = await apiInstance.patchArchiveEvent(
132
132
  id
133
133
  );
134
134
  ```
@@ -142,7 +142,7 @@ const { status, data } = await apiInstance.patchArchiveIncident(
142
142
 
143
143
  ### Return type
144
144
 
145
- **IncidentDTO**
145
+ **EventDTO**
146
146
 
147
147
  ### Authorization
148
148
 
@@ -157,15 +157,15 @@ No authorization required
157
157
  ### HTTP response details
158
158
  | Status code | Description | Response headers |
159
159
  |-------------|-------------|------------------|
160
- |**200** | Incident DTO | - |
160
+ |**200** | Service Event DTO | - |
161
161
  |**400** | Bad Request | - |
162
162
  |**401** | Unauthorised | - |
163
163
  |**403** | Access Denied | - |
164
164
 
165
165
  [[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)
166
166
 
167
- # **postCreateIncident**
168
- > IncidentDTO postCreateIncident()
167
+ # **postCreateEvent**
168
+ > EventDTO postCreateEvent()
169
169
 
170
170
 
171
171
  ### Example
@@ -174,16 +174,16 @@ No authorization required
174
174
  import {
175
175
  ServicesApi,
176
176
  Configuration,
177
- IncidentRequestDTO
177
+ EventRequestDTO
178
178
  } from 'yellowgrid-api-ts';
179
179
 
180
180
  const configuration = new Configuration();
181
181
  const apiInstance = new ServicesApi(configuration);
182
182
 
183
- let incidentRequestDTO: IncidentRequestDTO; // (optional)
183
+ let eventRequestDTO: EventRequestDTO; // (optional)
184
184
 
185
- const { status, data } = await apiInstance.postCreateIncident(
186
- incidentRequestDTO
185
+ const { status, data } = await apiInstance.postCreateEvent(
186
+ eventRequestDTO
187
187
  );
188
188
  ```
189
189
 
@@ -191,12 +191,12 @@ const { status, data } = await apiInstance.postCreateIncident(
191
191
 
192
192
  |Name | Type | Description | Notes|
193
193
  |------------- | ------------- | ------------- | -------------|
194
- | **incidentRequestDTO** | **IncidentRequestDTO**| | |
194
+ | **eventRequestDTO** | **EventRequestDTO**| | |
195
195
 
196
196
 
197
197
  ### Return type
198
198
 
199
- **IncidentDTO**
199
+ **EventDTO**
200
200
 
201
201
  ### Authorization
202
202
 
@@ -211,15 +211,15 @@ No authorization required
211
211
  ### HTTP response details
212
212
  | Status code | Description | Response headers |
213
213
  |-------------|-------------|------------------|
214
- |**200** | Incident DTO | - |
214
+ |**200** | Service Event DTO | - |
215
215
  |**400** | Bad Request | - |
216
216
  |**401** | Unauthorised | - |
217
217
  |**403** | Access Denied | - |
218
218
 
219
219
  [[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)
220
220
 
221
- # **postCreateIncidentUpdate**
222
- > IncidentDTO postCreateIncidentUpdate()
221
+ # **postCreateEventUpdate**
222
+ > EventDTO postCreateEventUpdate()
223
223
 
224
224
 
225
225
  ### Example
@@ -228,18 +228,18 @@ No authorization required
228
228
  import {
229
229
  ServicesApi,
230
230
  Configuration,
231
- IncidentUpdateRequestDTO
231
+ EventUpdateRequestDTO
232
232
  } from 'yellowgrid-api-ts';
233
233
 
234
234
  const configuration = new Configuration();
235
235
  const apiInstance = new ServicesApi(configuration);
236
236
 
237
237
  let id: string; //Group ID (default to undefined)
238
- let incidentUpdateRequestDTO: IncidentUpdateRequestDTO; // (optional)
238
+ let eventUpdateRequestDTO: EventUpdateRequestDTO; // (optional)
239
239
 
240
- const { status, data } = await apiInstance.postCreateIncidentUpdate(
240
+ const { status, data } = await apiInstance.postCreateEventUpdate(
241
241
  id,
242
- incidentUpdateRequestDTO
242
+ eventUpdateRequestDTO
243
243
  );
244
244
  ```
245
245
 
@@ -247,13 +247,13 @@ const { status, data } = await apiInstance.postCreateIncidentUpdate(
247
247
 
248
248
  |Name | Type | Description | Notes|
249
249
  |------------- | ------------- | ------------- | -------------|
250
- | **incidentUpdateRequestDTO** | **IncidentUpdateRequestDTO**| | |
250
+ | **eventUpdateRequestDTO** | **EventUpdateRequestDTO**| | |
251
251
  | **id** | [**string**] | Group ID | defaults to undefined|
252
252
 
253
253
 
254
254
  ### Return type
255
255
 
256
- **IncidentDTO**
256
+ **EventDTO**
257
257
 
258
258
  ### Authorization
259
259
 
@@ -268,7 +268,7 @@ No authorization required
268
268
  ### HTTP response details
269
269
  | Status code | Description | Response headers |
270
270
  |-------------|-------------|------------------|
271
- |**200** | Incident DTO | - |
271
+ |**200** | Service Event DTO | - |
272
272
  |**400** | Bad Request | - |
273
273
  |**401** | Unauthorised | - |
274
274
  |**403** | Access Denied | - |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.27-dev.0",
3
+ "version": "3.2.28-dev.0",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {