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

package/docs/NumberPortingApi.md

@@ -0,0 +1,726 @@
+# NumberPortingApi
+
+All URIs are relative to *https://bitbucket.org*
+
+|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} | |
+|[**patchCloseAdminNumberPort**](#patchcloseadminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/close | |
+|[**postAddAdminNote**](#postaddadminnote) | **POST** /admin/sip/numbers/ports/{id}/notes | |
+|[**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**
+> AdminNumberPortDTO 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
+
+**AdminNumberPortDTO**
+
+### 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)
+
+# **patchCloseAdminNumberPort**
+> AdminNumberPortDTO patchCloseAdminNumberPort()
+
+
+### 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.patchCloseAdminNumberPort(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Number Port ID | defaults to undefined|
+
+
+### Return type
+
+**AdminNumberPortDTO**
+
+### 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)
+
+# **postAddAdminNote**
+> AdminNumberPortDTO postAddAdminNote(postAddAdminNoteRequest)
+
+
+### Example
+
+```typescript
+import {
+    NumberPortingApi,
+    Configuration,
+    PostAddAdminNoteRequest
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new NumberPortingApi(configuration);
+
+let id: number; //Number Port ID (default to undefined)
+let postAddAdminNoteRequest: PostAddAdminNoteRequest; //
+
+const { status, data } = await apiInstance.postAddAdminNote(
+    id,
+    postAddAdminNoteRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **postAddAdminNoteRequest** | **PostAddAdminNoteRequest**|  | |
+| **id** | [**number**] | Number Port ID | defaults to undefined|
+
+
+### Return type
+
+**AdminNumberPortDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Admin Number Port |  -  |
+|**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**
+> AdminNumberPortDTO putGetAdminNumberPort(numberPortDTO)
+
+
+### Example
+
+```typescript
+import {
+    NumberPortingApi,
+    Configuration,
+    NumberPortDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new NumberPortingApi(configuration);
+
+let id: number; //Number Port ID (default to undefined)
+let numberPortDTO: NumberPortDTO; //
+
+const { status, data } = await apiInstance.putGetAdminNumberPort(
+    id,
+    numberPortDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **numberPortDTO** | **NumberPortDTO**|  | |
+| **id** | [**number**] | Number Port ID | defaults to undefined|
+
+
+### Return type
+
+**AdminNumberPortDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+