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

package/docs/IncidentDTO.md

@@ -0,0 +1,35 @@
+# 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

@@ -0,0 +1,25 @@
+# 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

@@ -0,0 +1,23 @@
+# 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

@@ -0,0 +1,27 @@
+# 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

@@ -0,0 +1,29 @@
+# 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

@@ -0,0 +1,23 @@
+# 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

@@ -0,0 +1,51 @@
+# 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

@@ -0,0 +1,47 @@
+# 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

@@ -0,0 +1,51 @@
+# 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

@@ -0,0 +1,33 @@
+# 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

@@ -0,0 +1,27 @@
+# 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)