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

package/docs/AdminNumberPortDTO.md

@@ -0,0 +1,57 @@
+# AdminNumberPortDTO
+
+Admin 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]
+**notes** | [**Array<NumberPortNoteDTO>**](NumberPortNoteDTO.md) | Notes | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdminNumberPortDTO } from 'yellowgrid-api-ts';
+
+const instance: AdminNumberPortDTO = {
+    companyName,
+    addressLine1,
+    addressLine2,
+    city,
+    postCode,
+    trunkId,
+    tenantId,
+    requestedPortDate,
+    asap,
+    comment,
+    id,
+    customerId,
+    customerName,
+    portDate,
+    numberRanges,
+    status,
+    statusText,
+    ticketId,
+    notes,
+};
+```
+
+[[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/NumberPortNoteDTO.md

@@ -0,0 +1,29 @@
+# NumberPortNoteDTO
+
+Number Port Note DTO
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**portId** | **number** | portId | [optional] [default to undefined]
+**note** | **string** | note | [optional] [default to undefined]
+**user** | **string** | user | [optional] [default to undefined]
+**timestamp** | **string** | timestamp | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NumberPortNoteDTO } from 'yellowgrid-api-ts';
+
+const instance: NumberPortNoteDTO = {
+    id,
+    portId,
+    note,
+    user,
+    timestamp,
+};
+```
+
+[[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/NumberPortingApi.md

@@ -10,6 +10,7 @@ All URIs are relative to *https://api.yellowgrid.local*
 |[**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} | |
@@ -128,7 +129,7 @@ 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)
 
 # **getGetAdminNumberPort**
-> NumberPortDTO getGetAdminNumberPort()
+> AdminNumberPortDTO getGetAdminNumberPort()
 
 
 ### Example
@@ -158,7 +159,7 @@ const { status, data } = await apiInstance.getGetAdminNumberPort(
 
 ### Return type
 
-**NumberPortDTO**
+**AdminNumberPortDTO**
 
 ### Authorization
 
@@ -293,7 +294,7 @@ 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)
 
 # **patchCloseAdminNumberPort**
-> NumberPortDTO patchCloseAdminNumberPort()
+> AdminNumberPortDTO patchCloseAdminNumberPort()
 
 
 ### Example
@@ -323,7 +324,7 @@ const { status, data } = await apiInstance.patchCloseAdminNumberPort(
 
 ### Return type
 
-**NumberPortDTO**
+**AdminNumberPortDTO**
 
 ### Authorization
 
@@ -345,6 +346,62 @@ 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)
 
+# **postAddAdminNote**
+> AdminNumberPortDTO postAddAdminNote(body)
+
+
+### 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 body: string; //
+
+const { status, data } = await apiInstance.postAddAdminNote(
+    id,
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **string**|  | |
+| **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()
 
@@ -610,7 +667,7 @@ 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)
 
 # **putGetAdminNumberPort**
-> NumberPortDTO putGetAdminNumberPort(numberPortDTO)
+> AdminNumberPortDTO putGetAdminNumberPort(numberPortDTO)
 
 
 ### Example
@@ -644,7 +701,7 @@ const { status, data } = await apiInstance.putGetAdminNumberPort(
 
 ### Return type
 
-**NumberPortDTO**
+**AdminNumberPortDTO**
 
 ### Authorization
 

package/docs/OrdersApi.md

@@ -5,8 +5,8 @@ All URIs are relative to *https://api.yellowgrid.local*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**deleteDeleteBatch**](#deletedeletebatch) | **DELETE** /admin/orders/{id}/batches/{batch_id} | |
-|[**deleteDeleteShipment**](#deletedeleteshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Delete Shipment (Admin)|
 |[**deleteUpdateOrder**](#deleteupdateorder) | **DELETE** /orders/{id} | Delete Orders (Beta)|
+|[**deleteUpdateShipment**](#deleteupdateshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Delete Shipment (Admin)|
 |[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
 |[**getGetAdminOrderDetails**](#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)|
 |[**getGetEditableOrder**](#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)|
@@ -23,9 +23,9 @@ All URIs are relative to *https://api.yellowgrid.local*
 |[**postSendSupplierEmail**](#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email|
 |[**postSplitOrder**](#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order|
 |[**putAllocateItems**](#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier|
-|[**putCreateShipment**](#putcreateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments | Update Shipment (Admin)|
 |[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
 |[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)|
+|[**putUpdateShipment**](#putupdateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Update Shipment (Admin)|
 
 # **deleteDeleteBatch**
 > deleteDeleteBatch()
@@ -84,10 +84,10 @@ 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)
 
-# **deleteDeleteShipment**
-> deleteDeleteShipment()
+# **deleteUpdateOrder**
+> deleteUpdateOrder()
 
-Delete Shipment (Admin)
+Delete Orders (Beta)
 
 ### Example
 
@@ -101,13 +101,9 @@ const configuration = new Configuration();
 const apiInstance = new OrdersApi(configuration);
 
 let id: number; //Order ID (default to undefined)
-let batchId: number; //Batch ID (default to undefined)
-let shipmentId: number; //Shipment ID (default to undefined)
 
-const { status, data } = await apiInstance.deleteDeleteShipment(
-    id,
-    batchId,
-    shipmentId
+const { status, data } = await apiInstance.deleteUpdateOrder(
+    id
 );
 ```
 
@@ -116,8 +112,6 @@ const { status, data } = await apiInstance.deleteDeleteShipment(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **id** | [**number**] | Order ID | defaults to undefined|
-| **batchId** | [**number**] | Batch ID | defaults to undefined|
-| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
 
 
 ### Return type
@@ -144,10 +138,10 @@ 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)
 
-# **deleteUpdateOrder**
-> deleteUpdateOrder()
+# **deleteUpdateShipment**
+> deleteUpdateShipment()
 
-Delete Orders (Beta)
+Delete Shipment (Admin)
 
 ### Example
 
@@ -161,9 +155,13 @@ const configuration = new Configuration();
 const apiInstance = new OrdersApi(configuration);
 
 let id: number; //Order ID (default to undefined)
+let batchId: number; //Batch ID (default to undefined)
+let shipmentId: number; //Shipment ID (default to undefined)
 
-const { status, data } = await apiInstance.deleteUpdateOrder(
-    id
+const { status, data } = await apiInstance.deleteUpdateShipment(
+    id,
+    batchId,
+    shipmentId
 );
 ```
 
@@ -172,6 +170,8 @@ const { status, data } = await apiInstance.deleteUpdateOrder(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **id** | [**number**] | Order ID | defaults to undefined|
+| **batchId** | [**number**] | Batch ID | defaults to undefined|
+| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
 
 
 ### Return type
@@ -1133,10 +1133,10 @@ 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)
 
-# **putCreateShipment**
-> ShipmentModel putCreateShipment()
+# **putUpdateAdminOrder**
+> Array<OrderSummaryDTO> putUpdateAdminOrder()
 
-Update Shipment (Admin)
+Update An Order (Admin)
 
 ### Example
 
@@ -1144,22 +1144,20 @@ Update Shipment (Admin)
 import {
     OrdersApi,
     Configuration,
-    ShipmentRequestDTO
+    AdminOrderRequestDTO
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new OrdersApi(configuration);
 
 let id: number; //Order ID (default to undefined)
-let batchId: number; //Batch ID (default to undefined)
-let shipmentId: number; //Shipment ID (default to undefined)
-let shipmentRequestDTO: ShipmentRequestDTO; //Shipment Request (optional)
+let readonly: boolean; //Readonly Order (optional) (default to undefined)
+let adminOrderRequestDTO: AdminOrderRequestDTO; //Order Request (optional)
 
-const { status, data } = await apiInstance.putCreateShipment(
+const { status, data } = await apiInstance.putUpdateAdminOrder(
     id,
-    batchId,
-    shipmentId,
-    shipmentRequestDTO
+    readonly,
+    adminOrderRequestDTO
 );
 ```
 
@@ -1167,15 +1165,14 @@ const { status, data } = await apiInstance.putCreateShipment(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **shipmentRequestDTO** | **ShipmentRequestDTO**| Shipment Request | |
+| **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Order Request | |
 | **id** | [**number**] | Order ID | defaults to undefined|
-| **batchId** | [**number**] | Batch ID | defaults to undefined|
-| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
+| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
 
 
 ### Return type
 
-**ShipmentModel**
+**Array<OrderSummaryDTO>**
 
 ### Authorization
 
@@ -1190,17 +1187,17 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Shipment |  -  |
+|**200** | Order Summaries |  -  |
 |**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)
 
-# **putUpdateAdminOrder**
-> Array<OrderSummaryDTO> putUpdateAdminOrder()
+# **putUpdateOrder**
+> Array<OrderSummaryDTO> putUpdateOrder()
 
-Update An Order (Admin)
+Update An Order (Beta)
 
 ### Example
 
@@ -1208,7 +1205,7 @@ Update An Order (Admin)
 import {
     OrdersApi,
     Configuration,
-    AdminOrderRequestDTO
+    CustomerOrderRequestDTO
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
@@ -1216,12 +1213,12 @@ const apiInstance = new OrdersApi(configuration);
 
 let id: number; //Order ID (default to undefined)
 let readonly: boolean; //Readonly Order (optional) (default to undefined)
-let adminOrderRequestDTO: AdminOrderRequestDTO; //Order Request (optional)
+let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
 
-const { status, data } = await apiInstance.putUpdateAdminOrder(
+const { status, data } = await apiInstance.putUpdateOrder(
     id,
     readonly,
-    adminOrderRequestDTO
+    customerOrderRequestDTO
 );
 ```
 
@@ -1229,7 +1226,7 @@ const { status, data } = await apiInstance.putUpdateAdminOrder(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **adminOrderRequestDTO** | **AdminOrderRequestDTO**| Order Request | |
+| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
 | **id** | [**number**] | Order ID | defaults to undefined|
 | **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
 
@@ -1258,10 +1255,10 @@ 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)
 
-# **putUpdateOrder**
-> Array<OrderSummaryDTO> putUpdateOrder()
+# **putUpdateShipment**
+> ShipmentModel putUpdateShipment()
 
-Update An Order (Beta)
+Update Shipment (Admin)
 
 ### Example
 
@@ -1269,20 +1266,22 @@ Update An Order (Beta)
 import {
     OrdersApi,
     Configuration,
-    CustomerOrderRequestDTO
+    ShipmentRequestDTO
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new OrdersApi(configuration);
 
 let id: number; //Order ID (default to undefined)
-let readonly: boolean; //Readonly Order (optional) (default to undefined)
-let customerOrderRequestDTO: CustomerOrderRequestDTO; //Order Request (optional)
+let batchId: number; //Batch ID (default to undefined)
+let shipmentId: number; //Shipment ID (default to undefined)
+let shipmentRequestDTO: ShipmentRequestDTO; //Shipment Request (optional)
 
-const { status, data } = await apiInstance.putUpdateOrder(
+const { status, data } = await apiInstance.putUpdateShipment(
     id,
-    readonly,
-    customerOrderRequestDTO
+    batchId,
+    shipmentId,
+    shipmentRequestDTO
 );
 ```
 
@@ -1290,14 +1289,15 @@ const { status, data } = await apiInstance.putUpdateOrder(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **customerOrderRequestDTO** | **CustomerOrderRequestDTO**| Order Request | |
+| **shipmentRequestDTO** | **ShipmentRequestDTO**| Shipment Request | |
 | **id** | [**number**] | Order ID | defaults to undefined|
-| **readonly** | [**boolean**] | Readonly Order | (optional) defaults to undefined|
+| **batchId** | [**number**] | Batch ID | defaults to undefined|
+| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
 
 
 ### Return type
 
-**Array<OrderSummaryDTO>**
+**ShipmentModel**
 
 ### Authorization
 
@@ -1312,7 +1312,7 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Order Summaries |  -  |
+|**200** | Shipment |  -  |
 |**400** | Bad Request |  -  |
 |**401** | Unauthorised |  -  |
 |**403** | Access Denied |  -  |

package/package.json

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