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

package/docs/OAuth20Api.md

@@ -157,7 +157,7 @@ const { status, data } = await apiInstance.postAccessToken(
 | **clientId** | [**string**] | OAuth 2.0 Client ID | (optional) defaults to undefined|
 | **clientSecret** | [**string**] | OAuth 2.0 Client Secret | (optional) defaults to undefined|
 | **grantType** | [**string**]**Array<&#39;client_credentials&#39; &#124; &#39;code&#39; &#124; &#39;refresh_token&#39; &#124; &#39;authorization_code&#39; &#124; &#39;ms_auth&#39; &#124; &#39;token_exchange&#39; &#124; &#39;password&#39;>** | OAuth 2.0 Grant Type | (optional) defaults to undefined|
-| **scope** | [**string**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;accounts.read&#39; &#124; &#39;accounts.write&#39; &#124; &#39;pricing.read&#39; &#124; &#39;orders.read&#39; &#124; &#39;orders.write&#39; &#124; &#39;products.read&#39; &#124; &#39;provisioning.read&#39; &#124; &#39;provisioning.write&#39; &#124; &#39;trunks.read&#39; &#124; &#39;trunks.write&#39; &#124; &#39;tcx_integrations.read&#39; &#124; &#39;tcx_integrations.write&#39; &#124; &#39;tcx_licence_details.read&#39; &#124; &#39;tcx_installations.read&#39; &#124; &#39;tcx_installations.write&#39; &#124; &#39;tcx_mt.read&#39; &#124; &#39;tcx_mt.write&#39; &#124; &#39;tickets.read&#39; &#124; &#39;tickets.write&#39;>** | OAuth 2.0 Scope | (optional) defaults to undefined|
+| **scope** | [**string**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;accounts.read&#39; &#124; &#39;accounts.write&#39; &#124; &#39;number_porting.read&#39; &#124; &#39;number_porting.write&#39; &#124; &#39;pricing.read&#39; &#124; &#39;orders.read&#39; &#124; &#39;orders.write&#39; &#124; &#39;products.read&#39; &#124; &#39;provisioning.read&#39; &#124; &#39;provisioning.write&#39; &#124; &#39;trunks.read&#39; &#124; &#39;trunks.write&#39; &#124; &#39;tcx_integrations.read&#39; &#124; &#39;tcx_integrations.write&#39; &#124; &#39;tcx_licence_details.read&#39; &#124; &#39;tcx_installations.read&#39; &#124; &#39;tcx_installations.write&#39; &#124; &#39;tcx_mt.read&#39; &#124; &#39;tcx_mt.write&#39; &#124; &#39;tickets.read&#39; &#124; &#39;tickets.write&#39;>** | OAuth 2.0 Scope | (optional) defaults to undefined|
 | **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
 | **code** | [**string**] | OAuth 2.0 Auth Code | (optional) defaults to undefined|
 | **refreshToken** | [**string**] | OAuth 2.0 Refresh Token | (optional) defaults to undefined|
@@ -210,7 +210,7 @@ const apiInstance = new OAuth20Api(configuration);
 
 let clientId: string; //OAuth 2.0 Client ID (default to undefined)
 let responseType: string; //OAuth 2.0 Response Type (default to 'code')
-let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'; //OAuth 2.0 Scope (default to undefined)
+let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'; //OAuth 2.0 Scope (default to undefined)
 let redirectUri: string; //OAuth 2.0 Redirect URI (optional) (default to undefined)
 let state: string; //OAuth 2.0 State (optional) (default to undefined)
 let codeChallenge: string; //OAuth 2.0 Code Challenge (optional) (default to undefined)
@@ -233,7 +233,7 @@ const { status, data } = await apiInstance.postAuthorise(
 |------------- | ------------- | ------------- | -------------|
 | **clientId** | [**string**] | OAuth 2.0 Client ID | defaults to undefined|
 | **responseType** | [**string**] | OAuth 2.0 Response Type | defaults to 'code'|
-| **scope** | [**&#39;*&#39; | &#39;fdps&#39; | &#39;scope&#39; | &#39;portal&#39; | &#39;tcx_wizard&#39; | &#39;accounts.read&#39; | &#39;accounts.write&#39; | &#39;pricing.read&#39; | &#39;orders.read&#39; | &#39;orders.write&#39; | &#39;products.read&#39; | &#39;provisioning.read&#39; | &#39;provisioning.write&#39; | &#39;trunks.read&#39; | &#39;trunks.write&#39; | &#39;tcx_integrations.read&#39; | &#39;tcx_integrations.write&#39; | &#39;tcx_licence_details.read&#39; | &#39;tcx_installations.read&#39; | &#39;tcx_installations.write&#39; | &#39;tcx_mt.read&#39; | &#39;tcx_mt.write&#39; | &#39;tickets.read&#39; | &#39;tickets.write&#39;**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;accounts.read&#39; &#124; &#39;accounts.write&#39; &#124; &#39;pricing.read&#39; &#124; &#39;orders.read&#39; &#124; &#39;orders.write&#39; &#124; &#39;products.read&#39; &#124; &#39;provisioning.read&#39; &#124; &#39;provisioning.write&#39; &#124; &#39;trunks.read&#39; &#124; &#39;trunks.write&#39; &#124; &#39;tcx_integrations.read&#39; &#124; &#39;tcx_integrations.write&#39; &#124; &#39;tcx_licence_details.read&#39; &#124; &#39;tcx_installations.read&#39; &#124; &#39;tcx_installations.write&#39; &#124; &#39;tcx_mt.read&#39; &#124; &#39;tcx_mt.write&#39; &#124; &#39;tickets.read&#39; &#124; &#39;tickets.write&#39;>** | OAuth 2.0 Scope | defaults to undefined|
+| **scope** | [**&#39;*&#39; | &#39;fdps&#39; | &#39;scope&#39; | &#39;portal&#39; | &#39;tcx_wizard&#39; | &#39;accounts.read&#39; | &#39;accounts.write&#39; | &#39;number_porting.read&#39; | &#39;number_porting.write&#39; | &#39;pricing.read&#39; | &#39;orders.read&#39; | &#39;orders.write&#39; | &#39;products.read&#39; | &#39;provisioning.read&#39; | &#39;provisioning.write&#39; | &#39;trunks.read&#39; | &#39;trunks.write&#39; | &#39;tcx_integrations.read&#39; | &#39;tcx_integrations.write&#39; | &#39;tcx_licence_details.read&#39; | &#39;tcx_installations.read&#39; | &#39;tcx_installations.write&#39; | &#39;tcx_mt.read&#39; | &#39;tcx_mt.write&#39; | &#39;tickets.read&#39; | &#39;tickets.write&#39;**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;accounts.read&#39; &#124; &#39;accounts.write&#39; &#124; &#39;number_porting.read&#39; &#124; &#39;number_porting.write&#39; &#124; &#39;pricing.read&#39; &#124; &#39;orders.read&#39; &#124; &#39;orders.write&#39; &#124; &#39;products.read&#39; &#124; &#39;provisioning.read&#39; &#124; &#39;provisioning.write&#39; &#124; &#39;trunks.read&#39; &#124; &#39;trunks.write&#39; &#124; &#39;tcx_integrations.read&#39; &#124; &#39;tcx_integrations.write&#39; &#124; &#39;tcx_licence_details.read&#39; &#124; &#39;tcx_installations.read&#39; &#124; &#39;tcx_installations.write&#39; &#124; &#39;tcx_mt.read&#39; &#124; &#39;tcx_mt.write&#39; &#124; &#39;tickets.read&#39; &#124; &#39;tickets.write&#39;>** | OAuth 2.0 Scope | defaults to undefined|
 | **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
 | **state** | [**string**] | OAuth 2.0 State | (optional) defaults to undefined|
 | **codeChallenge** | [**string**] | OAuth 2.0 Code Challenge | (optional) defaults to undefined|

package/docs/OrdersApi.md

@@ -4,8 +4,8 @@ All URIs are relative to *https://api.yellowgrid.local*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**deleteCreateShipment**](#deletecreateshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments | Delete Shipment (Admin)|
 |[**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)|
 |[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
 |[**getGetAdminOrderDetails**](#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)|
@@ -27,10 +27,10 @@ All URIs are relative to *https://api.yellowgrid.local*
 |[**putUpdateAdminOrder**](#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)|
 |[**putUpdateOrder**](#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)|
 
-# **deleteCreateShipment**
-> deleteCreateShipment()
+# **deleteDeleteBatch**
+> deleteDeleteBatch()
 
-Delete Shipment (Admin)
+Delete Batch (Admin)
 
 ### Example
 
@@ -45,12 +45,10 @@ 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.deleteCreateShipment(
+const { status, data } = await apiInstance.deleteDeleteBatch(
     id,
-    batchId,
-    shipmentId
+    batchId
 );
 ```
 
@@ -60,7 +58,6 @@ const { status, data } = await apiInstance.deleteCreateShipment(
 |------------- | ------------- | ------------- | -------------|
 | **id** | [**number**] | Order ID | defaults to undefined|
 | **batchId** | [**number**] | Batch ID | defaults to undefined|
-| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
 
 
 ### Return type
@@ -87,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)
 
-# **deleteDeleteBatch**
-> deleteDeleteBatch()
+# **deleteDeleteShipment**
+> deleteDeleteShipment()
 
-Delete Batch (Admin)
+Delete Shipment (Admin)
 
 ### Example
 
@@ -105,10 +102,12 @@ 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.deleteDeleteBatch(
+const { status, data } = await apiInstance.deleteDeleteShipment(
     id,
-    batchId
+    batchId,
+    shipmentId
 );
 ```
 
@@ -118,6 +117,7 @@ const { status, data } = await apiInstance.deleteDeleteBatch(
 |------------- | ------------- | ------------- | -------------|
 | **id** | [**number**] | Order ID | defaults to undefined|
 | **batchId** | [**number**] | Batch ID | defaults to undefined|
+| **shipmentId** | [**number**] | Shipment ID | defaults to undefined|
 
 
 ### Return type

package/docs/SIPTrunksApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://api.yellowgrid.local*
 |[**deleteGetSipTrunk**](#deletegetsiptrunk) | **DELETE** /sip/trunks/{id} | Delete SIP Trunk|
 |[**getCanDivert**](#getcandivert) | **GET** /sip/trunks/{id}/diverts/allowed | SIP Trunk Diverts Allowed|
 |[**getGetAddress**](#getgetaddress) | **GET** /sip/trunks/{id}/address | Get SIP Trunk Address|
+|[**getGetAdminSipTrunks**](#getgetadminsiptrunks) | **GET** /sip/trunks/admin | |
 |[**getGetAreaCodes**](#getgetareacodes) | **GET** /sip/trunks/area/codes | Get UK National Area Codes|
 |[**getGetCliFlexibility**](#getgetcliflexibility) | **GET** /sip/trunks/{id}/cli/flexibility | Get SIP Trunk CLI Flexibility Status|
 |[**getGetDdis**](#getgetddis) | **GET** /sip/trunks/{id}/ddis | Get SIP Trunk DDIs|
@@ -189,6 +190,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)
 
+# **getGetAdminSipTrunks**
+> Array<SipTrunkEntity> getGetAdminSipTrunks()
+
+Get SIP Trunks
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let customerId: number; //Customer ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetAdminSipTrunks(
+    customerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<SipTrunkEntity>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | SIP Trunks |  -  |
+|**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)
+
 # **getGetAreaCodes**
 > Array<AreaCodeModel> getGetAreaCodes()
 

package/docs/ShipmentDTO.md

@@ -7,6 +7,7 @@ Shipment
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **number** | ID | [optional] [default to undefined]
+**batchId** | **number** | Batch ID | [optional] [default to undefined]
 **courier** | **string** | Courier | [optional] [default to undefined]
 **reference** | **string** | Courier Reference | [optional] [default to undefined]
 **requestedDate** | **string** | Date Time | [optional] [default to undefined]
@@ -21,6 +22,7 @@ import { ShipmentDTO } from 'yellowgrid-api-ts';
 
 const instance: ShipmentDTO = {
     id,
+    batchId,
     courier,
     reference,
     requestedDate,

package/docs/SupportTicketModel.md

@@ -0,0 +1,41 @@
+# SupportTicketModel
+
+Telephony Support Ticket
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Ticket ID | [optional] [default to undefined]
+**status** | **string** | Ticket status | [optional] [default to undefined]
+**statusId** | **number** | Ticket status ID | [optional] [default to undefined]
+**subject** | **string** | Ticket subject | [optional] [default to undefined]
+**supportEmail** | **string** | Support email address | [optional] [default to undefined]
+**toEmails** | **Array<string>** | Recipient emails | [optional] [default to undefined]
+**description** | **string** | Ticket description (HTML) | [optional] [default to undefined]
+**descriptionText** | **string** | Ticket description (plain text) | [optional] [default to undefined]
+**createdAt** | **string** | Creation timestamp | [optional] [default to undefined]
+**attachments** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [optional] [default to undefined]
+**conversations** | [**Array<ConversationModel>**](ConversationModel.md) | Conversations | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SupportTicketModel } from 'yellowgrid-api-ts';
+
+const instance: SupportTicketModel = {
+    id,
+    status,
+    statusId,
+    subject,
+    supportEmail,
+    toEmails,
+    description,
+    descriptionText,
+    createdAt,
+    attachments,
+    conversations,
+};
+```
+
+[[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/TicketsApi.md

@@ -71,7 +71,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)
 
 # **getGetTicket**
-> TelephonySupportTicketModel getGetTicket()
+> SupportTicketModel getGetTicket()
 
 Retrieve a telephony support ticket
 
@@ -102,7 +102,7 @@ const { status, data } = await apiInstance.getGetTicket(
 
 ### Return type
 
-**TelephonySupportTicketModel**
+**SupportTicketModel**
 
 ### Authorization
 
@@ -125,7 +125,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)
 
 # **patchCloseTicket**
-> TelephonySupportTicketModel patchCloseTicket()
+> SupportTicketModel patchCloseTicket()
 
 Close a telephony support ticket
 
@@ -156,7 +156,7 @@ const { status, data } = await apiInstance.patchCloseTicket(
 
 ### Return type
 
-**TelephonySupportTicketModel**
+**SupportTicketModel**
 
 ### Authorization
 
@@ -179,7 +179,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)
 
 # **postCreateTicket**
-> TelephonySupportTicketModel postCreateTicket()
+> SupportTicketModel postCreateTicket()
 
 Create a new telephony support ticket
 
@@ -216,7 +216,7 @@ const { status, data } = await apiInstance.postCreateTicket(
 
 ### Return type
 
-**TelephonySupportTicketModel**
+**SupportTicketModel**
 
 ### Authorization
 
@@ -239,7 +239,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)
 
 # **postTicketReply**
-> TelephonySupportTicketModel postTicketReply()
+> SupportTicketModel postTicketReply()
 
 Reply to a telephony support ticket
 
@@ -276,7 +276,7 @@ const { status, data } = await apiInstance.postTicketReply(
 
 ### Return type
 
-**TelephonySupportTicketModel**
+**SupportTicketModel**
 
 ### Authorization
 

package/models/EventStatusEnum.ts

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

package/models/PortStatusEnum.ts

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

package/package.json

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