yellowgrid-api-ts 3.2.69-dev.0 → 3.2.71-dev.0

package/dist/models/EventStatusEnum.d.ts

@@ -0,0 +1,18 @@
+export declare const EventStatusEnum: {
+    readonly ONGOING: {
+        readonly name: "ONGOING";
+        readonly value: 0;
+        readonly publicValue: "Ongoing";
+    };
+    readonly RESOLVED: {
+        readonly name: "RESOLVED";
+        readonly value: 1;
+        readonly publicValue: "Resolved";
+    };
+    readonly ARCHIVED: {
+        readonly name: "ARCHIVED";
+        readonly value: 2;
+        readonly publicValue: "Archived";
+    };
+};
+export type EventStatusEnum = typeof EventStatusEnum;

package/dist/models/EventStatusEnum.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventStatusEnum = void 0;
+exports.EventStatusEnum = {
+    "ONGOING": {
+        "name": "ONGOING",
+        "value": 0,
+        "publicValue": "Ongoing"
+    },
+    "RESOLVED": {
+        "name": "RESOLVED",
+        "value": 1,
+        "publicValue": "Resolved"
+    },
+    "ARCHIVED": {
+        "name": "ARCHIVED",
+        "value": 2,
+        "publicValue": "Archived"
+    }
+};

package/dist/models/PortStatusEnum.d.ts

@@ -0,0 +1,18 @@
+export declare const PortStatusEnum: {
+    readonly DRAFT: {
+        readonly name: "DRAFT";
+        readonly value: 0;
+        readonly publicValue: "Draft";
+    };
+    readonly OPEN: {
+        readonly name: "OPEN";
+        readonly value: 1;
+        readonly publicValue: "Open";
+    };
+    readonly CLOSED: {
+        readonly name: "CLOSED";
+        readonly value: 2;
+        readonly publicValue: "Closed";
+    };
+};
+export type PortStatusEnum = typeof PortStatusEnum;

package/dist/models/PortStatusEnum.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PortStatusEnum = void 0;
+exports.PortStatusEnum = {
+    "DRAFT": {
+        "name": "DRAFT",
+        "value": 0,
+        "publicValue": "Draft"
+    },
+    "OPEN": {
+        "name": "OPEN",
+        "value": 1,
+        "publicValue": "Open"
+    },
+    "CLOSED": {
+        "name": "CLOSED",
+        "value": 2,
+        "publicValue": "Closed"
+    }
+};

package/docs/Class3CXMultiTenantApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://api.yellowgrid.local*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**deleteGetTenant**](#deletegettenant) | **DELETE** /tcx/mt/tenants/{reference} | Delete 3CX MT Tenant|
+|[**getGetAdminTenants**](#getgetadmintenants) | **GET** /tcx/mt/admin/tenants | Get 3CX MT Tenants|
 |[**getGetTenant**](#getgettenant) | **GET** /tcx/mt/tenants/{reference} | Get 3CX MT Tenant|
 |[**getGetTenants**](#getgettenants) | **GET** /tcx/mt/tenants | Get 3CX MT Tenants|
 |[**postAddMtDdi**](#postaddmtddi) | **POST** /tcx/mt/ddis | Add 3CX MT DDI|
@@ -66,6 +67,60 @@ No authorization required
 
 [[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)
 
+# **getGetAdminTenants**
+> Array<TcxMultiTenantModel> getGetAdminTenants()
+
+Get 3CX Starter Bundle Tenants
+
+### Example
+
+```typescript
+import {
+    Class3CXMultiTenantApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXMultiTenantApi(configuration);
+
+let customerId: number; // (default to undefined)
+
+const { status, data } = await apiInstance.getGetAdminTenants(
+    customerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **customerId** | [**number**] |  | defaults to undefined|
+
+
+### Return type
+
+**Array<TcxMultiTenantModel>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Starter Bundle Tenant |  -  |
+|**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)
+
 # **getGetTenant**
 > TcxMultiTenantModel getGetTenant()
 

package/docs/NumberPortDTO.md

@@ -0,0 +1,55 @@
+# 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]
+**customerId** | **number** | Reseller 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]
+**statusText** | **string** | Status Text | [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,
+    customerId,
+    customerName,
+    portDate,
+    numberRanges,
+    status,
+    statusText,
+    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)