yellowgrid-api-ts 3.2.188 → 3.2.189-dev.0

package/docs/Class3CXIntegrationsApi.md

@@ -1,6 +1,6 @@
 # Class3CXIntegrationsApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXMultiTenantApi.md

@@ -1,6 +1,6 @@
 # Class3CXMultiTenantApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/CrmActivityDTO.md

@@ -10,9 +10,9 @@ Name | Type | Description | Notes
 **timestamp** | **string** | Activity Timestamp | [optional] [default to undefined]
 **title** | **string** | Activity Title | [optional] [default to undefined]
 **description** | **string** | Activity Description | [optional] [default to undefined]
-**url** | **string** | Activity URL | [optional] [default to undefined]
 **user** | **string** | Activity User Name | [optional] [default to undefined]
 **contact** | **string** | Activity Contact Name | [optional] [default to undefined]
+**orderId** | **number** | Activity Order ID | [optional] [default to undefined]
 
 ## Example
 
@@ -24,9 +24,9 @@ const instance: CrmActivityDTO = {
     timestamp,
     title,
     description,
-    url,
     user,
     contact,
+    orderId,
 };
 ```
 

package/docs/GetCheckMacExists200Response.md

@@ -0,0 +1,20 @@
+# GetCheckMacExists200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**found** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetCheckMacExists200Response } from 'yellowgrid-api-ts';
+
+const instance: GetCheckMacExists200Response = {
+    found,
+};
+```
+
+[[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/MacAddressDTO.md

@@ -0,0 +1,23 @@
+# MacAddressDTO
+
+MAC Address DTO
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**groupId** | **number** | Group ID | [optional] [default to undefined]
+**macAddress** | **string** | MAC Address | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MacAddressDTO } from 'yellowgrid-api-ts';
+
+const instance: MacAddressDTO = {
+    groupId,
+    macAddress,
+};
+```
+
+[[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/MyPBXToolsApi.md

@@ -1,6 +1,6 @@
 # MyPBXToolsApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/NumberPortingApi.md

@@ -1,6 +1,6 @@
 # NumberPortingApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/OAuth20Api.md

@@ -1,6 +1,6 @@
 # OAuth20Api
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/OpayoRedirectDTO.md

@@ -0,0 +1,29 @@
+# OpayoRedirectDTO
+
+Opayo Redirect
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**acsUrl** | **string** | acsUrl | [optional] [default to undefined]
+**paReq** | **string** | paReq | [optional] [default to undefined]
+**transactionId** | **string** | Transaction ID | [optional] [default to undefined]
+**dsTranId** | **string** | dsTranId | [optional] [default to undefined]
+**cReq** | **string** | cReq | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OpayoRedirectDTO } from 'yellowgrid-api-ts';
+
+const instance: OpayoRedirectDTO = {
+    acsUrl,
+    paReq,
+    transactionId,
+    dsTranId,
+    cReq,
+};
+```
+
+[[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/OrdersApi.md

@@ -1,6 +1,6 @@
 # OrdersApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/PatchUpdateAccountNameRequest.md

@@ -0,0 +1,20 @@
+# PatchUpdateAccountNameRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Company Name | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchUpdateAccountNameRequest } from 'yellowgrid-api-ts';
+
+const instance: PatchUpdateAccountNameRequest = {
+    name,
+};
+```
+
+[[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/PricingApi.md

@@ -1,6 +1,6 @@
 # PricingApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ProductDetailedSummaryDTO.md

@@ -0,0 +1,41 @@
+# ProductDetailedSummaryDTO
+
+Product Detailed Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **string** | SKU | [optional] [default to undefined]
+**title** | **string** | Title | [optional] [default to undefined]
+**quantity** | **number** | Stock Quantity | [optional] [default to undefined]
+**stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
+**price** | **number** | Price | [optional] [default to undefined]
+**cartonSize** | **number** | Carton Size | [optional] [default to undefined]
+**rrp** | **number** | RRP Price | [optional] [default to undefined]
+**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) | 3CX Licence Details | [optional] [default to undefined]
+**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
+**dueDate** | **string** | Due Date | [optional] [default to undefined]
+**onOrder** | **number** | On Order | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductDetailedSummaryDTO } from 'yellowgrid-api-ts';
+
+const instance: ProductDetailedSummaryDTO = {
+    sku,
+    title,
+    quantity,
+    stockProduct,
+    price,
+    cartonSize,
+    rrp,
+    licenceDetails,
+    hosting,
+    dueDate,
+    onOrder,
+};
+```
+
+[[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/ProductSummaryDTO.md

@@ -10,7 +10,6 @@ Name | Type | Description | Notes
 **title** | **string** | Title | [optional] [default to undefined]
 **quantity** | **number** | Stock Quantity | [optional] [default to undefined]
 **stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
-**dueDate** | **string** | Due Date | [optional] [default to undefined]
 **price** | **number** | Price | [optional] [default to undefined]
 **cartonSize** | **number** | Carton Size | [optional] [default to undefined]
 **rrp** | **number** | RRP Price | [optional] [default to undefined]
@@ -27,7 +26,6 @@ const instance: ProductSummaryDTO = {
     title,
     quantity,
     stockProduct,
-    dueDate,
     price,
     cartonSize,
     rrp,

package/docs/ProductsApi.md

@@ -1,6 +1,6 @@
 # ProductsApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -422,7 +422,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)
 
 # **postGetProduct**
-> ProductSummaryDTO postGetProduct(postGetProductForCustomerRequest)
+> ProductDetailedSummaryDTO postGetProduct(postGetProductForCustomerRequest)
 
 Get Product
 
@@ -440,10 +440,12 @@ const apiInstance = new ProductsApi(configuration);
 
 let sku: string; //Product SKU (default to undefined)
 let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
+let orderId: number; //Order ID (optional) (default to undefined)
 
 const { status, data } = await apiInstance.postGetProduct(
     sku,
-    postGetProductForCustomerRequest
+    postGetProductForCustomerRequest,
+    orderId
 );
 ```
 
@@ -453,11 +455,12 @@ const { status, data } = await apiInstance.postGetProduct(
 |------------- | ------------- | ------------- | -------------|
 | **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
 | **sku** | [**string**] | Product SKU | defaults to undefined|
+| **orderId** | [**number**] | Order ID | (optional) defaults to undefined|
 
 
 ### Return type
 
-**ProductSummaryDTO**
+**ProductDetailedSummaryDTO**
 
 ### Authorization
 
@@ -480,7 +483,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)
 
 # **postGetProductForCustomer**
-> ProductSummaryDTO postGetProductForCustomer(postGetProductForCustomerRequest)
+> ProductDetailedSummaryDTO postGetProductForCustomer(postGetProductForCustomerRequest)
 
 Get Product For Customer
 
@@ -499,11 +502,13 @@ const apiInstance = new ProductsApi(configuration);
 let customerId: number; //Customer ID (default to undefined)
 let sku: string; //Product SKU (default to undefined)
 let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
+let orderId: number; //Order ID (optional) (default to undefined)
 
 const { status, data } = await apiInstance.postGetProductForCustomer(
     customerId,
     sku,
-    postGetProductForCustomerRequest
+    postGetProductForCustomerRequest,
+    orderId
 );
 ```
 
@@ -514,11 +519,12 @@ const { status, data } = await apiInstance.postGetProductForCustomer(
 | **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
 | **customerId** | [**number**] | Customer ID | defaults to undefined|
 | **sku** | [**string**] | Product SKU | defaults to undefined|
+| **orderId** | [**number**] | Order ID | (optional) defaults to undefined|
 
 
 ### Return type
 
-**ProductSummaryDTO**
+**ProductDetailedSummaryDTO**
 
 ### Authorization
 

package/docs/ProspectsApi.md

@@ -1,6 +1,6 @@
 # ProspectsApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ProvisioningApi.md

@@ -1,16 +1,19 @@
 # ProvisioningApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**deleteAddFanvilMac**](#deleteaddfanvilmac) | **DELETE** /provisioning/fanvil/groups/{id}/macs/{mac} | Remove MAC address from DB and FDPS group|
+|[**deleteCheckMacExists**](#deletecheckmacexists) | **DELETE** /admin/provisioning/fanvil/macs/{mac} | |
 |[**deleteDeleteFanvilGroup**](#deletedeletefanvilgroup) | **DELETE** /provisioning/fanvil/groups/{id} | Delete group from DB and FDPS|
+|[**getCheckMacExists**](#getcheckmacexists) | **GET** /admin/provisioning/fanvil/macs/{mac} | |
 |[**getGetFanvilEncryptionKey**](#getgetfanvilencryptionkey) | **GET** /provisioning/fanvil/groups/{id}/macs/{mac}/key | Get group Fanvil encryption key|
 |[**getGetFanvilGroupMacs**](#getgetfanvilgroupmacs) | **GET** /provisioning/fanvil/groups/{id}/macs | Get MAC addresses on group at FDPS|
 |[**getGetGroups**](#getgetgroups) | **GET** /provisioning/groups | Get all provisioning groups or filter by customer ID|
 |[**postAddFanvilGroup**](#postaddfanvilgroup) | **POST** /provisioning/fanvil/groups | Add group to DB and FDPS|
 |[**postAddFanvilMac**](#postaddfanvilmac) | **POST** /provisioning/fanvil/groups/{id}/macs/{mac} | Add MAC address to DB and FDPS group|
+|[**postCreateMac**](#postcreatemac) | **POST** /admin/provisioning/fanvil/macs | |
 
 # **deleteAddFanvilMac**
 > deleteAddFanvilMac()
@@ -69,6 +72,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)
 
+# **deleteCheckMacExists**
+> deleteCheckMacExists()
+
+Delete a MAC address in FDPS
+
+### Example
+
+```typescript
+import {
+    ProvisioningApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProvisioningApi(configuration);
+
+let mac: string; //MAC Address (default to undefined)
+
+const { status, data } = await apiInstance.deleteCheckMacExists(
+    mac
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **mac** | [**string**] | MAC Address | 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)
+
 # **deleteDeleteFanvilGroup**
 > deleteDeleteFanvilGroup()
 
@@ -123,6 +180,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)
 
+# **getCheckMacExists**
+> GetCheckMacExists200Response getCheckMacExists()
+
+Check if a MAC address exists in FDPS
+
+### Example
+
+```typescript
+import {
+    ProvisioningApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProvisioningApi(configuration);
+
+let mac: string; //MAC Address (default to undefined)
+
+const { status, data } = await apiInstance.getCheckMacExists(
+    mac
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **mac** | [**string**] | MAC Address | defaults to undefined|
+
+
+### Return type
+
+**GetCheckMacExists200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | MAC Address Found |  -  |
+|**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)
+
 # **getGetFanvilEncryptionKey**
 > string getGetFanvilEncryptionKey()
 
@@ -400,3 +511,58 @@ 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)
 
+# **postCreateMac**
+> MacAddressDTO postCreateMac()
+
+Create a MAC address in FDPS
+
+### Example
+
+```typescript
+import {
+    ProvisioningApi,
+    Configuration,
+    MacAddressDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProvisioningApi(configuration);
+
+let macAddressDTO: MacAddressDTO; //Mac Address (optional)
+
+const { status, data } = await apiInstance.postCreateMac(
+    macAddressDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **macAddressDTO** | **MacAddressDTO**| Mac Address | |
+
+
+### Return type
+
+**MacAddressDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | MAC Address Created |  -  |
+|**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/SIPTrunksApi.md

@@ -1,6 +1,6 @@
 # SIPTrunksApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/SMSApi.md

@@ -1,6 +1,6 @@
 # SMSApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ServicesApi.md

@@ -1,6 +1,6 @@
 # ServicesApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ShippingApi.md

@@ -1,6 +1,6 @@
 # ShippingApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/StockManagementApi.md

@@ -1,6 +1,6 @@
 # StockManagementApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/SystemApi.md

@@ -1,6 +1,6 @@
 # SystemApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/TcxInstallationModel.md

@@ -35,6 +35,8 @@ Name | Type | Description | Notes
 **disk** | **number** | Recordings Disk Size | [optional] [default to undefined]
 **flavour** | **string** | Instance Spec | [optional] [default to undefined]
 **autoFailover** | **boolean** | Auto Failover | [optional] [default to undefined]
+**extensions** | **number** | Extensions in Use | [optional] [default to undefined]
+**maxExtensions** | **number** | Max Allowed Extensions | [optional] [default to undefined]
 
 ## Example
 
@@ -71,6 +73,8 @@ const instance: TcxInstallationModel = {
     disk,
     flavour,
     autoFailover,
+    extensions,
+    maxExtensions,
 };
 ```
 

package/docs/TicketsApi.md

@@ -1,6 +1,6 @@
 # TicketsApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/WebhooksApi.md

@@ -1,6 +1,6 @@
 # WebhooksApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|