yellowgrid-api-ts 3.2.103-dev.0 → 3.2.106-dev.0

package/docs/MyPBXToolsApi.md

@@ -1,6 +1,6 @@
 # MyPBXToolsApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

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/NumberPortingApi.md

@@ -1,6 +1,6 @@
 # NumberPortingApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/OAuth20Api.md

@@ -1,6 +1,6 @@
 # OAuth20Api
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/OrdersApi.md

@@ -1,6 +1,6 @@
 # OrdersApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -23,6 +23,7 @@ All URIs are relative to *https://localhost*
 |[**postGetOrders**](#postgetorders) | **POST** /orders | Create An Order (Beta)|
 |[**postIssueCredit**](#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)|
 |[**postPrintShippingLabel**](#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label|
+|[**postProcessTcxLicences**](#postprocesstcxlicences) | **POST** /admin/orders/{id}/batches/{batch_id}/licences/process | Process 3CX Licences (Admin)|
 |[**postSendOrderEmail**](#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email|
 |[**postSendShipmentEmail**](#postsendshipmentemail) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/send/email | Send Shipment Email (Admin)|
 |[**postSendSupplierEmail**](#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email|
@@ -1133,6 +1134,63 @@ 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)
 
+# **postProcessTcxLicences**
+> OrderDetailsDTO postProcessTcxLicences()
+
+Process 3CX Licences (Admin)
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration
+} 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)
+
+const { status, data } = await apiInstance.postProcessTcxLicences(
+    id,
+    batchId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Order ID | defaults to undefined|
+| **batchId** | [**number**] | Batch ID | defaults to undefined|
+
+
+### Return type
+
+**OrderDetailsDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Order Details |  -  |
+|**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)
+
 # **postSendOrderEmail**
 > postSendOrderEmail()
 

package/docs/PricingApi.md

@@ -1,6 +1,6 @@
 # PricingApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ProductsApi.md

@@ -1,6 +1,6 @@
 # ProductsApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ProvisioningApi.md

@@ -1,6 +1,6 @@
 # ProvisioningApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/SIPTrunksApi.md

@@ -1,6 +1,6 @@
 # SIPTrunksApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/SMSApi.md

@@ -1,6 +1,6 @@
 # SMSApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ServicesApi.md

@@ -1,6 +1,6 @@
 # ServicesApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ShippingApi.md

@@ -1,6 +1,6 @@
 # ShippingApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/StockManagementApi.md

@@ -1,6 +1,6 @@
 # StockManagementApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|