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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.28-dev.0",
+  "version": "3.2.29",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {

package/docs/EventDTO.md

@@ -1,35 +0,0 @@
-# EventDTO
-
-Service Event DTO
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**title** | **string** | Service Event Title | [optional] [default to undefined]
-**type** | **number** | Service Event Type | [optional] [default to undefined]
-**service** | **number** | Service Impacted | [optional] [default to undefined]
-**statusName** | **string** | Event Status Description | [optional] [default to undefined]
-**typeName** | **string** | Event Type Description | [optional] [default to undefined]
-**id** | **number** | Service Event ID | [optional] [default to undefined]
-**status** | **number** | Service Event Status | [optional] [default to undefined]
-**updates** | [**Array<EventUpdateDTO>**](EventUpdateDTO.md) | Service Event Updates | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { EventDTO } from 'yellowgrid-api-ts';
-
-const instance: EventDTO = {
-    title,
-    type,
-    service,
-    statusName,
-    typeName,
-    id,
-    status,
-    updates,
-};
-```
-
-[[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/EventRequestDTO.md

@@ -1,25 +0,0 @@
-# EventRequestDTO
-
-Service Event Request DTO
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**title** | **string** | Service Event Title | [optional] [default to undefined]
-**type** | **number** | Service Event Type | [optional] [default to undefined]
-**service** | **number** | Service Impacted | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { EventRequestDTO } from 'yellowgrid-api-ts';
-
-const instance: EventRequestDTO = {
-    title,
-    type,
-    service,
-};
-```
-
-[[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/EventSubscriptionModel.md

@@ -1,23 +0,0 @@
-# EventSubscriptionModel
-
-Service Event Subscribption Model
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | id | [optional] [default to undefined]
-**email** | **string** | email | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { EventSubscriptionModel } from 'yellowgrid-api-ts';
-
-const instance: EventSubscriptionModel = {
-    id,
-    email,
-};
-```
-
-[[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/EventUpdateDTO.md

@@ -1,27 +0,0 @@
-# EventUpdateDTO
-
-Service Event Update DTO
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message** | **string** | Service Event Update Message | [optional] [default to undefined]
-**type** | **number** | Service Event Update Type | [optional] [default to undefined]
-**typeName** | **string** | Service Event Update Type Description | [optional] [default to undefined]
-**createdAt** | **string** | Date Time | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { EventUpdateDTO } from 'yellowgrid-api-ts';
-
-const instance: EventUpdateDTO = {
-    message,
-    type,
-    typeName,
-    createdAt,
-};
-```
-
-[[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/EventUpdateEntity.md

@@ -1,29 +0,0 @@
-# EventUpdateEntity
-
-Event Update Entity
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**eventId** | **number** | eventId | [optional] [default to undefined]
-**message** | **string** | message | [optional] [default to undefined]
-**type** | **number** | type | [optional] [default to undefined]
-**createdAt** | **string** | createdAt | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { EventUpdateEntity } from 'yellowgrid-api-ts';
-
-const instance: EventUpdateEntity = {
-    id,
-    eventId,
-    message,
-    type,
-    createdAt,
-};
-```
-
-[[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/EventUpdateRequestDTO.md

@@ -1,23 +0,0 @@
-# EventUpdateRequestDTO
-
-Service Event Update Request DTO
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message** | **string** | Service Event Update Message | [optional] [default to undefined]
-**type** | **number** | Service Event Update Type | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { EventUpdateRequestDTO } from 'yellowgrid-api-ts';
-
-const instance: EventUpdateRequestDTO = {
-    message,
-    type,
-};
-```
-
-[[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/IncidentDTO.md

@@ -1,35 +0,0 @@
-# IncidentDTO
-
-Incident DTO
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**title** | **string** | Incident Title | [optional] [default to undefined]
-**severity** | **number** | Incident Severity | [optional] [default to undefined]
-**service** | **number** | Service Impacted | [optional] [default to undefined]
-**statusName** | **string** | Incident Status Description | [optional] [default to undefined]
-**severityName** | **string** | Incident Severity Description | [optional] [default to undefined]
-**id** | **number** | Incident ID | [optional] [default to undefined]
-**status** | **number** | Incident Status | [optional] [default to undefined]
-**updates** | [**Array<IncidentUpdateDTO>**](IncidentUpdateDTO.md) | Incident Updates | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { IncidentDTO } from 'yellowgrid-api-ts';
-
-const instance: IncidentDTO = {
-    title,
-    severity,
-    service,
-    statusName,
-    severityName,
-    id,
-    status,
-    updates,
-};
-```
-
-[[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/IncidentRequestDTO.md

@@ -1,25 +0,0 @@
-# IncidentRequestDTO
-
-Incident Request DTO
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**title** | **string** | Incident Title | [optional] [default to undefined]
-**severity** | **number** | Incident Severity | [optional] [default to undefined]
-**service** | **number** | Service Impacted | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { IncidentRequestDTO } from 'yellowgrid-api-ts';
-
-const instance: IncidentRequestDTO = {
-    title,
-    severity,
-    service,
-};
-```
-
-[[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/IncidentSubscriptionModel.md

@@ -1,23 +0,0 @@
-# IncidentSubscriptionModel
-
-Incident Subscribption Model
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | id | [optional] [default to undefined]
-**email** | **string** | email | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { IncidentSubscriptionModel } from 'yellowgrid-api-ts';
-
-const instance: IncidentSubscriptionModel = {
-    id,
-    email,
-};
-```
-
-[[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/IncidentUpdateDTO.md

@@ -1,27 +0,0 @@
-# IncidentUpdateDTO
-
-Incident Update DTO
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message** | **string** | Incident Update Message | [optional] [default to undefined]
-**type** | **number** | Incident Update Type | [optional] [default to undefined]
-**typeName** | **string** | Incident Update Type Description | [optional] [default to undefined]
-**createdAt** | **string** | Date Time | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { IncidentUpdateDTO } from 'yellowgrid-api-ts';
-
-const instance: IncidentUpdateDTO = {
-    message,
-    type,
-    typeName,
-    createdAt,
-};
-```
-
-[[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/IncidentUpdateEntity.md

@@ -1,29 +0,0 @@
-# IncidentUpdateEntity
-
-IncidentUpdatesEntity
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**incidentId** | **number** | incidentId | [optional] [default to undefined]
-**message** | **string** | message | [optional] [default to undefined]
-**type** | **number** | type | [optional] [default to undefined]
-**createdAt** | **string** | createdAt | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { IncidentUpdateEntity } from 'yellowgrid-api-ts';
-
-const instance: IncidentUpdateEntity = {
-    id,
-    incidentId,
-    message,
-    type,
-    createdAt,
-};
-```
-
-[[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/IncidentUpdateRequestDTO.md

@@ -1,23 +0,0 @@
-# IncidentUpdateRequestDTO
-
-Incident Update Request DTO
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message** | **string** | Incident Update Message | [optional] [default to undefined]
-**type** | **number** | Incident Update Type | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { IncidentUpdateRequestDTO } from 'yellowgrid-api-ts';
-
-const instance: IncidentUpdateRequestDTO = {
-    message,
-    type,
-};
-```
-
-[[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/NumberPortDTO.md

@@ -1,51 +0,0 @@
-# NumberPortDTO
-
-Number Port Response
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**companyName** | **string** | Company Name | [optional] [default to undefined]
-**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
-**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
-**city** | **string** | City | [optional] [default to undefined]
-**postCode** | **string** | Post Code | [optional] [default to undefined]
-**trunkId** | **number** | Trunk ID | [optional] [default to undefined]
-**tenantId** | **string** | Starter Bundle ID | [optional] [default to undefined]
-**requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
-**asap** | **boolean** | Port Date ASAP | [optional] [default to undefined]
-**comment** | **string** | Comment | [optional] [default to undefined]
-**id** | **number** | Number Port ID | [optional] [default to undefined]
-**customerName** | **string** | Customer Name | [optional] [default to undefined]
-**portDate** | **string** | Porting Date | [optional] [default to undefined]
-**numberRanges** | [**Array<NumberPortRangeDTO>**](NumberPortRangeDTO.md) | Number Ranges | [optional] [default to undefined]
-**status** | **number** | Status | [optional] [default to undefined]
-**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { NumberPortDTO } from 'yellowgrid-api-ts';
-
-const instance: NumberPortDTO = {
-    companyName,
-    addressLine1,
-    addressLine2,
-    city,
-    postCode,
-    trunkId,
-    tenantId,
-    requestedPortDate,
-    asap,
-    comment,
-    id,
-    customerName,
-    portDate,
-    numberRanges,
-    status,
-    ticketId,
-};
-```
-
-[[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/NumberPortEntity.md

@@ -1,47 +0,0 @@
-# NumberPortEntity
-
-NumberPortsEntity
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | Number Port ID | [optional] [default to undefined]
-**customerId** | **number** | Customer ID | [optional] [default to undefined]
-**endUser** | **string** | End User | [optional] [default to undefined]
-**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
-**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
-**city** | **string** | City | [optional] [default to undefined]
-**postCode** | **string** | Post Code | [optional] [default to undefined]
-**trunkId** | **string** | Trunk ID | [optional] [default to undefined]
-**tenantId** | **string** | Tenant ID | [optional] [default to undefined]
-**requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
-**portDate** | **string** | Port Date | [optional] [default to undefined]
-**comment** | **string** | Comment | [optional] [default to undefined]
-**status** | **number** | Status | [optional] [default to undefined]
-**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { NumberPortEntity } from 'yellowgrid-api-ts';
-
-const instance: NumberPortEntity = {
-    id,
-    customerId,
-    endUser,
-    addressLine1,
-    addressLine2,
-    city,
-    postCode,
-    trunkId,
-    tenantId,
-    requestedPortDate,
-    portDate,
-    comment,
-    status,
-    ticketId,
-};
-```
-
-[[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/NumberPortModel.md

@@ -1,51 +0,0 @@
-# NumberPortModel
-
-Number Port Model
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | Number Port ID | [optional] [default to undefined]
-**customerId** | **number** | Customer ID | [optional] [default to undefined]
-**endUser** | **string** | End User | [optional] [default to undefined]
-**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
-**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
-**city** | **string** | City | [optional] [default to undefined]
-**postCode** | **string** | Post Code | [optional] [default to undefined]
-**trunkId** | **number** | Trunk ID | [optional] [default to undefined]
-**tenantId** | **string** | Tenant ID | [optional] [default to undefined]
-**requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
-**portDate** | **string** | Port Date | [optional] [default to undefined]
-**comment** | **string** | Comment | [optional] [default to undefined]
-**status** | **number** | Status | [optional] [default to undefined]
-**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
-**ranges** | **Array<any>** | Number Port Ranges | [optional] [default to undefined]
-**customerName** | **string** | Customer Company Name | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { NumberPortModel } from 'yellowgrid-api-ts';
-
-const instance: NumberPortModel = {
-    id,
-    customerId,
-    endUser,
-    addressLine1,
-    addressLine2,
-    city,
-    postCode,
-    trunkId,
-    tenantId,
-    requestedPortDate,
-    portDate,
-    comment,
-    status,
-    ticketId,
-    ranges,
-    customerName,
-};
-```
-
-[[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/NumberPortRangeDTO.md

@@ -1,33 +0,0 @@
-# NumberPortRangeDTO
-
-Number Port Range Response
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**rangeStart** | **string** | Range Start Number | [optional] [default to undefined]
-**rangeEnd** | **string** | Range End Number | [optional] [default to undefined]
-**lcp** | **string** | Losing Communications Provider | [optional] [default to undefined]
-**postCode** | **string** | Range Post Code | [optional] [default to undefined]
-**id** | **number** | Number Port Range ID | [optional] [default to undefined]
-**portId** | **number** | Number Port ID | [optional] [default to undefined]
-**rangeHolder** | **string** | Range Holder | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { NumberPortRangeDTO } from 'yellowgrid-api-ts';
-
-const instance: NumberPortRangeDTO = {
-    rangeStart,
-    rangeEnd,
-    lcp,
-    postCode,
-    id,
-    portId,
-    rangeHolder,
-};
-```
-
-[[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/NumberPortRangeRequestDTO.md

@@ -1,27 +0,0 @@
-# NumberPortRangeRequestDTO
-
-NumberPortRangeDTO
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**rangeStart** | **string** | Range Start Number | [optional] [default to undefined]
-**rangeEnd** | **string** | Range End Number | [optional] [default to undefined]
-**lcp** | **string** | Losing Communications Provider | [optional] [default to undefined]
-**postCode** | **string** | Range Post Code | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { NumberPortRangeRequestDTO } from 'yellowgrid-api-ts';
-
-const instance: NumberPortRangeRequestDTO = {
-    rangeStart,
-    rangeEnd,
-    lcp,
-    postCode,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)