yellowgrid-api-ts 3.2.289 → 3.2.290

package/dist/models/AgentEnum.d.ts

@@ -0,0 +1,48 @@
+export declare const AgentEnum: {
+    readonly ADAM_ALBISON: {
+        readonly name: "ADAM_ALBISON";
+        readonly value: 80003691891;
+        readonly publicValue: "Adam Albison";
+    };
+    readonly ADAM_CADMAN: {
+        readonly name: "ADAM_CADMAN";
+        readonly value: 80003691895;
+        readonly publicValue: "Adam Cadman";
+    };
+    readonly CRAIG_GRAHAM: {
+        readonly name: "CRAIG_GRAHAM";
+        readonly value: 80003691704;
+        readonly publicValue: "Craig Graham";
+    };
+    readonly DANIEL_BUTTERWORTH: {
+        readonly name: "DANIEL_BUTTERWORTH";
+        readonly value: 80005134852;
+        readonly publicValue: "Daniel Butterworth";
+    };
+    readonly DAVID_HOPE: {
+        readonly name: "DAVID_HOPE";
+        readonly value: 80053071801;
+        readonly publicValue: "David Hope";
+    };
+    readonly JACOB_BASQUILL: {
+        readonly name: "JACOB_BASQUILL";
+        readonly value: 80118862524;
+        readonly publicValue: "Jacob Basquill";
+    };
+    readonly JOSH_IRELAND: {
+        readonly name: "JOSH_IRELAND";
+        readonly value: 80090558320;
+        readonly publicValue: "Josh Ireland";
+    };
+    readonly PHILIP_SLATER: {
+        readonly name: "PHILIP_SLATER";
+        readonly value: 80007256845;
+        readonly publicValue: "Philip Slater";
+    };
+    readonly TOMI_OLUWAYOMI: {
+        readonly name: "TOMI_OLUWAYOMI";
+        readonly value: 80105333618;
+        readonly publicValue: "Tomi Oluwayomi";
+    };
+};
+export type AgentEnum = typeof AgentEnum;

package/dist/models/AgentEnum.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentEnum = void 0;
+exports.AgentEnum = {
+    "ADAM_ALBISON": {
+        "name": "ADAM_ALBISON",
+        "value": 80003691891,
+        "publicValue": "Adam Albison"
+    },
+    "ADAM_CADMAN": {
+        "name": "ADAM_CADMAN",
+        "value": 80003691895,
+        "publicValue": "Adam Cadman"
+    },
+    "CRAIG_GRAHAM": {
+        "name": "CRAIG_GRAHAM",
+        "value": 80003691704,
+        "publicValue": "Craig Graham"
+    },
+    "DANIEL_BUTTERWORTH": {
+        "name": "DANIEL_BUTTERWORTH",
+        "value": 80005134852,
+        "publicValue": "Daniel Butterworth"
+    },
+    "DAVID_HOPE": {
+        "name": "DAVID_HOPE",
+        "value": 80053071801,
+        "publicValue": "David Hope"
+    },
+    "JACOB_BASQUILL": {
+        "name": "JACOB_BASQUILL",
+        "value": 80118862524,
+        "publicValue": "Jacob Basquill"
+    },
+    "JOSH_IRELAND": {
+        "name": "JOSH_IRELAND",
+        "value": 80090558320,
+        "publicValue": "Josh Ireland"
+    },
+    "PHILIP_SLATER": {
+        "name": "PHILIP_SLATER",
+        "value": 80007256845,
+        "publicValue": "Philip Slater"
+    },
+    "TOMI_OLUWAYOMI": {
+        "name": "TOMI_OLUWAYOMI",
+        "value": 80105333618,
+        "publicValue": "Tomi Oluwayomi"
+    }
+};

package/docs/Class3CXInstallationWizardApi.md

@@ -25,7 +25,13 @@ All URIs are relative to *https://bitbucket.org*
 |[**patchAddNumbers**](#patchaddnumbers) | **PATCH** /tcx/wizards/numbers | Update 3CX Installation Wizard Numbers|
 |[**patchAddPhones**](#patchaddphones) | **PATCH** /tcx/wizards/phones | Update 3CX Installation Wizard Phones|
 |[**patchAddSbcs**](#patchaddsbcs) | **PATCH** /tcx/wizards/sbcs | Update 3CX Installation Wizard SBCs|
+|[**patchAllocateEngineer**](#patchallocateengineer) | **PATCH** /tcx/wizards/engineering/engineer | |
 |[**patchGetWizard**](#patchgetwizard) | **PATCH** /tcx/wizards | Update 3CX Installation Wizard|
+|[**patchMarkEngineerTaskAsComplete**](#patchmarkengineertaskascomplete) | **PATCH** /tcx/wizards/engineering/tasks/{task_id}/complete | |
+|[**patchUpdateEngineerTaskNote**](#patchupdateengineertasknote) | **PATCH** /tcx/wizards/engineering/tasks/{task_id}/note | |
+|[**patchUpdateGoLiveDate**](#patchupdategolivedate) | **PATCH** /tcx/wizards/engineering/go_live_date | |
+|[**patchUpdateNote**](#patchupdatenote) | **PATCH** /tcx/wizards/engineering/note | |
+|[**patchUpdateSpec**](#patchupdatespec) | **PATCH** /tcx/wizards/engineering/spec | |
 |[**postAddExtensions**](#postaddextensions) | **POST** /tcx/wizards/extensions | Add Extensions To 3CX Installation Wizard|
 |[**postAddNumbers**](#postaddnumbers) | **POST** /tcx/wizards/numbers | Add Numbers To 3CX Installation Wizard|
 |[**postAddPhones**](#postaddphones) | **POST** /tcx/wizards/phones | Add Phones To 3CX Installation Wizard|
@@ -1127,6 +1133,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)
 
+# **patchAllocateEngineer**
+> patchAllocateEngineer()
+
+Allocate Wizard Engineer
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let engineerId: number; //Engineer ID (default to undefined)
+
+const { status, data } = await apiInstance.patchAllocateEngineer(
+    engineerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **engineerId** | [**number**] | Engineer 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)
+
 # **patchGetWizard**
 > TcxWizardModel patchGetWizard()
 
@@ -1182,6 +1242,282 @@ 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)
 
+# **patchMarkEngineerTaskAsComplete**
+> patchMarkEngineerTaskAsComplete()
+
+Update Wizard Engineer Task Complete Status
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let taskId: number; //Task ID (default to undefined)
+let complete: 'true' | 'false'; //Complete Status (default to undefined)
+
+const { status, data } = await apiInstance.patchMarkEngineerTaskAsComplete(
+    taskId,
+    complete
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | [**number**] | Task ID | defaults to undefined|
+| **complete** | [**&#39;true&#39; | &#39;false&#39;**]**Array<&#39;true&#39; &#124; &#39;false&#39;>** | Complete Status | 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)
+
+# **patchUpdateEngineerTaskNote**
+> patchUpdateEngineerTaskNote()
+
+Update Wizard Engineer Task Note
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let taskId: number; //Task ID (default to undefined)
+let note: string; //note (default to undefined)
+
+const { status, data } = await apiInstance.patchUpdateEngineerTaskNote(
+    taskId,
+    note
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | [**number**] | Task ID | defaults to undefined|
+| **note** | [**string**] | note | 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)
+
+# **patchUpdateGoLiveDate**
+> patchUpdateGoLiveDate()
+
+Update Wizard Go Live Date
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let goLiveDate: string; //Go Live Date (default to undefined)
+
+const { status, data } = await apiInstance.patchUpdateGoLiveDate(
+    goLiveDate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **goLiveDate** | [**string**] | Go Live Date | 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)
+
+# **patchUpdateNote**
+> patchUpdateNote()
+
+Update Wizard Engineer Note
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let note: string; //Note (default to undefined)
+
+const { status, data } = await apiInstance.patchUpdateNote(
+    note
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **note** | [**string**] | Note | 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)
+
+# **patchUpdateSpec**
+> patchUpdateSpec()
+
+Update Wizard Engineer Spec
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+let spec: string; //Spec (default to undefined)
+
+const { status, data } = await apiInstance.patchUpdateSpec(
+    spec
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **spec** | [**string**] | Spec | 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)
+
 # **postAddExtensions**
 > Array<TcxExtsEntity> postAddExtensions()
 

package/docs/EngineeredWizardRequestModel.md

@@ -0,0 +1,25 @@
+# EngineeredWizardRequestModel
+
+Engineered Wizard Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer** | **string** | Customer Name | [default to undefined]
+**engineerId** | **number** | Engineer ID | [default to undefined]
+**licenceKey** | **string** | Licence Key | [default to undefined]
+
+## Example
+
+```typescript
+import { EngineeredWizardRequestModel } from 'yellowgrid-api-ts';
+
+const instance: EngineeredWizardRequestModel = {
+    customer,
+    engineerId,
+    licenceKey,
+};
+```
+
+[[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/OAuth20Api.md

@@ -164,7 +164,7 @@ const { status, data } = await apiInstance.postAccessToken(
 | **refreshToken** | [**string**] | OAuth 2.0 Refresh Token | (optional) defaults to undefined|
 | **codeVerifier** | [**string**] | OAuth 2.0 Code Verifier | (optional) defaults to undefined|
 | **token** | [**string**] | OAuth 2.0 Token (Only used in Token Exchange) | (optional) defaults to undefined|
-| **tokenExchangeType** | [**string**]**Array<&#39;tcx_wizard&#39; &#124; &#39;portal&#39;>** | Token Exchange Type (Only used in Token Exchange) | (optional) defaults to undefined|
+| **tokenExchangeType** | [**string**]**Array<&#39;tcx_wizard&#39; &#124; &#39;tcx_wizard_admin&#39; &#124; &#39;portal&#39;>** | Token Exchange Type (Only used in Token Exchange) | (optional) defaults to undefined|
 | **licenceKey** | [**string**] | 3CX Licence Key (Only used in Token Exchange) | (optional) defaults to undefined|
 | **endUser** | [**boolean**] | End User (Only used in Token Exchange) | (optional) defaults to undefined|
 

package/docs/OrdersApi.md

@@ -22,6 +22,7 @@ All URIs are relative to *https://bitbucket.org*
 |[**postCreateConsignment**](#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment|
 |[**postCreatePortalOrderLegacy**](#postcreateportalorderlegacy) | **POST** /orders/portal/legacy | Create an order via the legacy portal|
 |[**postCreateShipment**](#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)|
+|[**postCreateWizardFromOrder**](#postcreatewizardfromorder) | **POST** /admin/orders/{id}/wizard | |
 |[**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|
@@ -1071,6 +1072,64 @@ 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)
 
+# **postCreateWizardFromOrder**
+> TcxSummaryDTO postCreateWizardFromOrder()
+
+Create Engineered Wizard
+
+### Example
+
+```typescript
+import {
+    OrdersApi,
+    Configuration,
+    EngineeredWizardRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OrdersApi(configuration);
+
+let id: number; //Order ID (default to undefined)
+let engineeredWizardRequestModel: EngineeredWizardRequestModel; //Engineered Wizard Request (optional)
+
+const { status, data } = await apiInstance.postCreateWizardFromOrder(
+    id,
+    engineeredWizardRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **engineeredWizardRequestModel** | **EngineeredWizardRequestModel**| Engineered Wizard Request | |
+| **id** | [**number**] | Order ID | defaults to undefined|
+
+
+### Return type
+
+**TcxSummaryDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Wizard 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)
+
 # **postGetOrders**
 > Array<OrderSummaryDTO> postGetOrders()
 

package/docs/TcxEngineerTaskDTO.md

@@ -0,0 +1,29 @@
+# TcxEngineerTaskDTO
+
+3CX Engineer Task
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**taskId** | **number** | Task ID | [default to undefined]
+**title** | **string** | Title | [default to undefined]
+**description** | **string** | Description | [default to undefined]
+**complete** | **boolean** | Completion Status | [default to undefined]
+**note** | **string** | Note | [default to undefined]
+
+## Example
+
+```typescript
+import { TcxEngineerTaskDTO } from 'yellowgrid-api-ts';
+
+const instance: TcxEngineerTaskDTO = {
+    taskId,
+    title,
+    description,
+    complete,
+    note,
+};
+```
+
+[[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/TcxEngineeringDTO.md

@@ -0,0 +1,37 @@
+# TcxEngineeringDTO
+
+3CX Engineering
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Engineering ID | [default to undefined]
+**wizardId** | **number** | Wizard ID | [default to undefined]
+**engineerId** | **number** | Engineer ID | [default to undefined]
+**engineerName** | **string** | Engineer Name | [default to undefined]
+**ticketUrl** | **string** | Ticket URL | [default to undefined]
+**goLiveDate** | **string** | Date Time | [optional] [default to undefined]
+**spec** | **string** | Spec | [optional] [default to undefined]
+**note** | **string** | Note | [optional] [default to undefined]
+**tasks** | [**Array<TcxEngineerTaskDTO>**](TcxEngineerTaskDTO.md) | Tasks | [default to undefined]
+
+## Example
+
+```typescript
+import { TcxEngineeringDTO } from 'yellowgrid-api-ts';
+
+const instance: TcxEngineeringDTO = {
+    id,
+    wizardId,
+    engineerId,
+    engineerName,
+    ticketUrl,
+    goLiveDate,
+    spec,
+    note,
+    tasks,
+};
+```
+
+[[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/TcxSummaryDTO.md

@@ -0,0 +1,23 @@
+# TcxSummaryDTO
+
+3CX Wizard Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Wizard ID | [default to undefined]
+**licenceKey** | **string** | Licence Key | [default to undefined]
+
+## Example
+
+```typescript
+import { TcxSummaryDTO } from 'yellowgrid-api-ts';
+
+const instance: TcxSummaryDTO = {
+    id,
+    licenceKey,
+};
+```
+
+[[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/TcxWizardModel.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **sbcs** | [**Array<TcxSbcModel>**](TcxSbcModel.md) |  | [optional] [default to undefined]
 **sipTrunk** | [**TcxSipTrunksEntity**](TcxSipTrunksEntity.md) |  | [optional] [default to undefined]
 **installationStatus** | **string** |  | [optional] [default to undefined]
+**engineering** | [**TcxEngineeringDTO**](TcxEngineeringDTO.md) |  | [optional] [default to undefined]
 **setup** | [**TcxSetupEntity**](TcxSetupEntity.md) |  | [optional] [default to undefined]
 **endUserView** | **boolean** | End User Wizard View | [optional] [default to undefined]
 
@@ -39,6 +40,7 @@ const instance: TcxWizardModel = {
     sbcs,
     sipTrunk,
     installationStatus,
+    engineering,
     setup,
     endUserView,
 };