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

package/docs/NumberPortingApi.md

@@ -1,658 +0,0 @@
-# NumberPortingApi
-
-All URIs are relative to *http://api.yellowgrid.local*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**deleteGetAdminNumberPort**](#deletegetadminnumberport) | **DELETE** /admin/sip/numbers/ports/{id} | |
-|[**getCreateNumberPort**](#getcreatenumberport) | **GET** /sip/numbers/ports | |
-|[**getGetAdminNumberPort**](#getgetadminnumberport) | **GET** /admin/sip/numbers/ports/{id} | |
-|[**getGetAdminNumberPorts**](#getgetadminnumberports) | **GET** /admin/sip/numbers/ports | |
-|[**getUpdateNumberPort**](#getupdatenumberport) | **GET** /sip/numbers/ports/{id} | |
-|[**postCreateNumberPort**](#postcreatenumberport) | **POST** /sip/numbers/ports | |
-|[**postSubmitNumberPort**](#postsubmitnumberport) | **POST** /sip/numbers/ports/{id}/submit | |
-|[**postUpdateNumberPort**](#postupdatenumberport) | **POST** /sip/numbers/ports/{id} | |
-|[**putGetAdminNumberPort**](#putgetadminnumberport) | **PUT** /admin/sip/numbers/ports/{id} | |
-
-# **deleteGetAdminNumberPort**
-> deleteGetAdminNumberPort()
-
-
-### Example
-
-```typescript
-import {
-    NumberPortingApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new NumberPortingApi(configuration);
-
-let id: number; //Number Port ID (default to undefined)
-
-const { status, data } = await apiInstance.deleteGetAdminNumberPort(
-    id
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**number**] | Number Port ID | 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 |
-|-------------|-------------|------------------|
-|**204** | 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)
-
-# **getCreateNumberPort**
-> NumberPortsModel getCreateNumberPort()
-
-
-### Example
-
-```typescript
-import {
-    NumberPortingApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new NumberPortingApi(configuration);
-
-let pageSize: number; //Number Of Results (optional) (default to 20)
-let page: number; //Page Number (optional) (default to 1)
-let search: string; //Search (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getCreateNumberPort(
-    pageSize,
-    page,
-    search
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
-| **page** | [**number**] | Page Number | (optional) defaults to 1|
-| **search** | [**string**] | Search | (optional) defaults to undefined|
-
-
-### Return type
-
-**NumberPortsModel**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Number Ports |  -  |
-|**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)
-
-# **getGetAdminNumberPort**
-> NumberPortDTO getGetAdminNumberPort()
-
-
-### Example
-
-```typescript
-import {
-    NumberPortingApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new NumberPortingApi(configuration);
-
-let id: number; //Number Port ID (default to undefined)
-
-const { status, data } = await apiInstance.getGetAdminNumberPort(
-    id
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**number**] | Number Port ID | defaults to undefined|
-
-
-### Return type
-
-**NumberPortDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | NumberPortDTO |  -  |
-|**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)
-
-# **getGetAdminNumberPorts**
-> NumberPortsModel getGetAdminNumberPorts()
-
-
-### Example
-
-```typescript
-import {
-    NumberPortingApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new NumberPortingApi(configuration);
-
-let pageSize: number; //Number Of Results (optional) (default to 20)
-let page: number; //Page Number (optional) (default to 1)
-let search: string; //Search (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getGetAdminNumberPorts(
-    pageSize,
-    page,
-    search
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
-| **page** | [**number**] | Page Number | (optional) defaults to 1|
-| **search** | [**string**] | Search | (optional) defaults to undefined|
-
-
-### Return type
-
-**NumberPortsModel**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Number Ports |  -  |
-|**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)
-
-# **getUpdateNumberPort**
-> NumberPortDTO getUpdateNumberPort()
-
-
-### Example
-
-```typescript
-import {
-    NumberPortingApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new NumberPortingApi(configuration);
-
-let id: number; //Number Port ID (default to undefined)
-
-const { status, data } = await apiInstance.getUpdateNumberPort(
-    id
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**number**] | Number Port ID | defaults to undefined|
-
-
-### Return type
-
-**NumberPortDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | NumberPortResponseDTO |  -  |
-|**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)
-
-# **postCreateNumberPort**
-> NumberPortDTO postCreateNumberPort()
-
-
-### Example
-
-```typescript
-import {
-    NumberPortingApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new NumberPortingApi(configuration);
-
-let companyName: string; //Company Name (optional) (default to undefined)
-let addressLine1: string; //Address Line 1 (optional) (default to undefined)
-let addressLine2: string; //Address Line 2 (optional) (default to undefined)
-let city: string; //City (optional) (default to undefined)
-let postCode: string; //Post Code (optional) (default to undefined)
-let trunkId: number; //Trunk ID (optional) (default to undefined)
-let tenantId: string; //Starter Bundle ID (optional) (default to undefined)
-let requestedPortDate: string; //Requested Port Date (optional) (default to undefined)
-let asap: boolean; //Port Date ASAP (optional) (default to undefined)
-let comment: string; //Comment (optional) (default to undefined)
-let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (optional) (default to undefined)
-let cloa: File; //CLOA (only provide on submission) (optional) (default to undefined)
-
-const { status, data } = await apiInstance.postCreateNumberPort(
-    companyName,
-    addressLine1,
-    addressLine2,
-    city,
-    postCode,
-    trunkId,
-    tenantId,
-    requestedPortDate,
-    asap,
-    comment,
-    numberRanges,
-    cloa
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **companyName** | [**string**] | Company Name | (optional) defaults to undefined|
-| **addressLine1** | [**string**] | Address Line 1 | (optional) defaults to undefined|
-| **addressLine2** | [**string**] | Address Line 2 | (optional) defaults to undefined|
-| **city** | [**string**] | City | (optional) defaults to undefined|
-| **postCode** | [**string**] | Post Code | (optional) defaults to undefined|
-| **trunkId** | [**number**] | Trunk ID | (optional) defaults to undefined|
-| **tenantId** | [**string**] | Starter Bundle ID | (optional) defaults to undefined|
-| **requestedPortDate** | [**string**] | Requested Port Date | (optional) defaults to undefined|
-| **asap** | [**boolean**] | Port Date ASAP | (optional) defaults to undefined|
-| **comment** | [**string**] | Comment | (optional) defaults to undefined|
-| **numberRanges** | **Array&lt;NumberPortRangeRequestDTO&gt;** | Number Ranges | (optional) defaults to undefined|
-| **cloa** | [**File**] | CLOA (only provide on submission) | (optional) defaults to undefined|
-
-
-### Return type
-
-**NumberPortDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | NumberPortResponseDTO |  -  |
-|**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)
-
-# **postSubmitNumberPort**
-> NumberPortDTO postSubmitNumberPort()
-
-
-### Example
-
-```typescript
-import {
-    NumberPortingApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new NumberPortingApi(configuration);
-
-let id: number; //Number Port ID (default to undefined)
-let companyName: string; //Company Name (optional) (default to undefined)
-let addressLine1: string; //Address Line 1 (optional) (default to undefined)
-let addressLine2: string; //Address Line 2 (optional) (default to undefined)
-let city: string; //City (optional) (default to undefined)
-let postCode: string; //Post Code (optional) (default to undefined)
-let trunkId: number; //Trunk ID (optional) (default to undefined)
-let tenantId: string; //Starter Bundle ID (optional) (default to undefined)
-let requestedPortDate: string; //Requested Port Date (optional) (default to undefined)
-let asap: boolean; //Port Date ASAP (optional) (default to undefined)
-let comment: string; //Comment (optional) (default to undefined)
-let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (optional) (default to undefined)
-let cloa: File; //CLOA (only provide on submission) (optional) (default to undefined)
-
-const { status, data } = await apiInstance.postSubmitNumberPort(
-    id,
-    companyName,
-    addressLine1,
-    addressLine2,
-    city,
-    postCode,
-    trunkId,
-    tenantId,
-    requestedPortDate,
-    asap,
-    comment,
-    numberRanges,
-    cloa
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**number**] | Number Port ID | defaults to undefined|
-| **companyName** | [**string**] | Company Name | (optional) defaults to undefined|
-| **addressLine1** | [**string**] | Address Line 1 | (optional) defaults to undefined|
-| **addressLine2** | [**string**] | Address Line 2 | (optional) defaults to undefined|
-| **city** | [**string**] | City | (optional) defaults to undefined|
-| **postCode** | [**string**] | Post Code | (optional) defaults to undefined|
-| **trunkId** | [**number**] | Trunk ID | (optional) defaults to undefined|
-| **tenantId** | [**string**] | Starter Bundle ID | (optional) defaults to undefined|
-| **requestedPortDate** | [**string**] | Requested Port Date | (optional) defaults to undefined|
-| **asap** | [**boolean**] | Port Date ASAP | (optional) defaults to undefined|
-| **comment** | [**string**] | Comment | (optional) defaults to undefined|
-| **numberRanges** | **Array&lt;NumberPortRangeRequestDTO&gt;** | Number Ranges | (optional) defaults to undefined|
-| **cloa** | [**File**] | CLOA (only provide on submission) | (optional) defaults to undefined|
-
-
-### Return type
-
-**NumberPortDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | NumberPortResponseDTO |  -  |
-|**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)
-
-# **postUpdateNumberPort**
-> NumberPortDTO postUpdateNumberPort()
-
-
-### Example
-
-```typescript
-import {
-    NumberPortingApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new NumberPortingApi(configuration);
-
-let id: number; //Number Port ID (default to undefined)
-let companyName: string; //Company Name (optional) (default to undefined)
-let addressLine1: string; //Address Line 1 (optional) (default to undefined)
-let addressLine2: string; //Address Line 2 (optional) (default to undefined)
-let city: string; //City (optional) (default to undefined)
-let postCode: string; //Post Code (optional) (default to undefined)
-let trunkId: number; //Trunk ID (optional) (default to undefined)
-let tenantId: string; //Starter Bundle ID (optional) (default to undefined)
-let requestedPortDate: string; //Requested Port Date (optional) (default to undefined)
-let asap: boolean; //Port Date ASAP (optional) (default to undefined)
-let comment: string; //Comment (optional) (default to undefined)
-let numberRanges: Array<NumberPortRangeRequestDTO>; //Number Ranges (optional) (default to undefined)
-let cloa: File; //CLOA (only provide on submission) (optional) (default to undefined)
-
-const { status, data } = await apiInstance.postUpdateNumberPort(
-    id,
-    companyName,
-    addressLine1,
-    addressLine2,
-    city,
-    postCode,
-    trunkId,
-    tenantId,
-    requestedPortDate,
-    asap,
-    comment,
-    numberRanges,
-    cloa
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**number**] | Number Port ID | defaults to undefined|
-| **companyName** | [**string**] | Company Name | (optional) defaults to undefined|
-| **addressLine1** | [**string**] | Address Line 1 | (optional) defaults to undefined|
-| **addressLine2** | [**string**] | Address Line 2 | (optional) defaults to undefined|
-| **city** | [**string**] | City | (optional) defaults to undefined|
-| **postCode** | [**string**] | Post Code | (optional) defaults to undefined|
-| **trunkId** | [**number**] | Trunk ID | (optional) defaults to undefined|
-| **tenantId** | [**string**] | Starter Bundle ID | (optional) defaults to undefined|
-| **requestedPortDate** | [**string**] | Requested Port Date | (optional) defaults to undefined|
-| **asap** | [**boolean**] | Port Date ASAP | (optional) defaults to undefined|
-| **comment** | [**string**] | Comment | (optional) defaults to undefined|
-| **numberRanges** | **Array&lt;NumberPortRangeRequestDTO&gt;** | Number Ranges | (optional) defaults to undefined|
-| **cloa** | [**File**] | CLOA (only provide on submission) | (optional) defaults to undefined|
-
-
-### Return type
-
-**NumberPortDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | NumberPortResponseDTO |  -  |
-|**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)
-
-# **putGetAdminNumberPort**
-> NumberPortDTO putGetAdminNumberPort()
-
-
-### Example
-
-```typescript
-import {
-    NumberPortingApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new NumberPortingApi(configuration);
-
-let id: number; //Number Port ID (default to undefined)
-let companyName: string; //Company Name (optional) (default to undefined)
-let addressLine1: string; //Address Line 1 (optional) (default to undefined)
-let addressLine2: string; //Address Line 2 (optional) (default to undefined)
-let city: string; //City (optional) (default to undefined)
-let postCode: string; //Post Code (optional) (default to undefined)
-let trunkId: number; //Trunk ID (optional) (default to undefined)
-let tenantId: string; //Starter Bundle ID (optional) (default to undefined)
-let requestedPortDate: string; //Requested Port Date (optional) (default to undefined)
-let asap: boolean; //Port Date ASAP (optional) (default to undefined)
-let comment: string; //Comment (optional) (default to undefined)
-let id2: number; //Number Port ID (optional) (default to undefined)
-let customerName: string; //Customer Name (optional) (default to undefined)
-let portDate: string; //Porting Date (optional) (default to undefined)
-let numberRanges: Array<NumberPortRangeDTO>; //Number Ranges (optional) (default to undefined)
-let status: number; //Status (optional) (default to undefined)
-let ticketId: number; //Ticket ID (optional) (default to undefined)
-
-const { status, data } = await apiInstance.putGetAdminNumberPort(
-    id,
-    companyName,
-    addressLine1,
-    addressLine2,
-    city,
-    postCode,
-    trunkId,
-    tenantId,
-    requestedPortDate,
-    asap,
-    comment,
-    id2,
-    customerName,
-    portDate,
-    numberRanges,
-    status,
-    ticketId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**number**] | Number Port ID | defaults to undefined|
-| **companyName** | [**string**] | Company Name | (optional) defaults to undefined|
-| **addressLine1** | [**string**] | Address Line 1 | (optional) defaults to undefined|
-| **addressLine2** | [**string**] | Address Line 2 | (optional) defaults to undefined|
-| **city** | [**string**] | City | (optional) defaults to undefined|
-| **postCode** | [**string**] | Post Code | (optional) defaults to undefined|
-| **trunkId** | [**number**] | Trunk ID | (optional) defaults to undefined|
-| **tenantId** | [**string**] | Starter Bundle ID | (optional) defaults to undefined|
-| **requestedPortDate** | [**string**] | Requested Port Date | (optional) defaults to undefined|
-| **asap** | [**boolean**] | Port Date ASAP | (optional) defaults to undefined|
-| **comment** | [**string**] | Comment | (optional) defaults to undefined|
-| **id2** | [**number**] | Number Port ID | (optional) defaults to undefined|
-| **customerName** | [**string**] | Customer Name | (optional) defaults to undefined|
-| **portDate** | [**string**] | Porting Date | (optional) defaults to undefined|
-| **numberRanges** | **Array&lt;NumberPortRangeDTO&gt;** | Number Ranges | (optional) defaults to undefined|
-| **status** | [**number**] | Status | (optional) defaults to undefined|
-| **ticketId** | [**number**] | Ticket ID | (optional) defaults to undefined|
-
-
-### Return type
-
-**NumberPortDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: multipart/form-data
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | NumberPortResponseDTO |  -  |
-|**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/NumberPortsModel.md

@@ -1,27 +0,0 @@
-# NumberPortsModel
-
-Number Ports
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**results** | [**Array<NumberPortDTO>**](NumberPortDTO.md) | Results | [optional] [default to undefined]
-**page** | **number** | Page | [optional] [default to undefined]
-**perPage** | **number** | Per Page | [optional] [default to undefined]
-**totalResults** | **number** | Total Results | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { NumberPortsModel } from 'yellowgrid-api-ts';
-
-const instance: NumberPortsModel = {
-    results,
-    page,
-    perPage,
-    totalResults,
-};
-```
-
-[[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/ServiceHealthDTO.md

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