yellowgrid-api-ts 3.2.263 → 3.2.264-dev.0

package/docs/CallBarringModel.md

@@ -6,11 +6,11 @@ Call Barring
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**blockPremiumCalls** | **boolean** | Block Premium Calls | [optional] [default to true]
-**blockMobileCalls** | **boolean** | Block Mobile Calls | [optional] [default to false]
-**blockInternationalCalls** | **boolean** | Block International Calls | [optional] [default to false]
-**block084Calls** | **boolean** | Block 084 Calls | [optional] [default to false]
-**block087Calls** | **boolean** | Block 087 Calls | [optional] [default to false]
+**blockPremiumCalls** | **boolean** | Block Premium Calls | [default to true]
+**blockMobileCalls** | **boolean** | Block Mobile Calls | [default to false]
+**blockInternationalCalls** | **boolean** | Block International Calls | [default to false]
+**block084Calls** | **boolean** | Block 084 Calls | [default to false]
+**block087Calls** | **boolean** | Block 087 Calls | [default to false]
 
 ## Example
 

package/docs/CallJournalRequestModel.md

@@ -0,0 +1,35 @@
+# CallJournalRequestModel
+
+Call Journal Request Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**userEmail** | **string** | User Email | [default to undefined]
+**note** | **string** | Call Note | [default to undefined]
+**timestamp** | **string** | Call Timestamp | [default to undefined]
+**duration** | **string** | Call Duration | [default to undefined]
+**recordingUrl** | **string** | Call Recording URL | [default to undefined]
+**transcription** | **string** | Call Transcription | [default to undefined]
+**summary** | **string** | Call Summary | [default to undefined]
+**sentiment** | **number** | Call Sentiment | [default to undefined]
+
+## Example
+
+```typescript
+import { CallJournalRequestModel } from 'yellowgrid-api-ts';
+
+const instance: CallJournalRequestModel = {
+    userEmail,
+    note,
+    timestamp,
+    duration,
+    recordingUrl,
+    transcription,
+    summary,
+    sentiment,
+};
+```
+
+[[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/Class3CXApi.md

@@ -1,9 +1,10 @@
 # Class3CXApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**getGetCCDevices**](#getgetccdevices) | **GET** /tcx/cc/devices | |
 |[**getGetLicenceDetails**](#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details|
 |[**getGetTcxCreditStatus**](#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status|
 |[**getGetTcxExpiringKeys**](#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys|
@@ -11,6 +12,53 @@ All URIs are relative to *https://bitbucket.org*
 |[**getGetTcxPartners**](#getgettcxpartners) | **GET** /tcx/admin/partners | Get 3CX Partners|
 |[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
 
+# **getGetCCDevices**
+> Array<DeviceModel> getGetCCDevices()
+
+Get a list of 3CX call control devices
+
+### Example
+
+```typescript
+import {
+    Class3CXApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXApi(configuration);
+
+const { status, data } = await apiInstance.getGetCCDevices();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<DeviceModel>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Devices |  -  |
+|**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)
+
 # **getGetLicenceDetails**
 > TcxLicenceDetailsModel getGetLicenceDetails()
 

package/docs/Class3CXInstallationWizardApi.md

@@ -1,6 +1,6 @@
 # Class3CXInstallationWizardApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -16,6 +16,7 @@ All URIs are relative to *https://bitbucket.org*
 |[**getGetHostingRegions**](#getgethostingregions) | **GET** /tcx/wizards/regions | Get 3CX Hosting Regions|
 |[**getGetInstallStatus**](#getgetinstallstatus) | **GET** /tcx/wizard/build/status | Get 3CX Instance Install Status|
 |[**getGetInstanceInstallStatus**](#getgetinstanceinstallstatus) | **GET** /tcx/wizards/instances/build/status | Get 3CX Instance Install Status|
+|[**getGetOrderItems**](#getgetorderitems) | **GET** /tcx/wizards/order/items | Get all items on the order linked to this wizard\'s licence key|
 |[**getGetPbxIpAddress**](#getgetpbxipaddress) | **GET** /tcx/wizards/instances/ip | Get PBX IP Address|
 |[**getGetSipTrunkTcxWizard**](#getgetsiptrunktcxwizard) | **GET** /tcx/wizards/sip/trunks/{id} | Get SIP Trunk|
 |[**getGetSipTrunksTcxWizard**](#getgetsiptrunkstcxwizard) | **GET** /tcx/wizards/sip/trunks | Get SIP Trunks|
@@ -24,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|
@@ -654,6 +661,53 @@ 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)
 
+# **getGetOrderItems**
+> Array<ItemEntity> getGetOrderItems()
+
+Get all items on the order linked to the wizard licence key
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+const { status, data } = await apiInstance.getGetOrderItems();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<ItemEntity>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Order Items |  -  |
+|**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)
+
 # **getGetPbxIpAddress**
 > string getGetPbxIpAddress()
 
@@ -1079,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()
 
@@ -1134,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/Class3CXInstallationsApi.md

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

package/docs/Class3CXIntegrationsApi.md

@@ -1,12 +1,13 @@
 # Class3CXIntegrationsApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**getGetPrice**](#getgetprice) | **GET** /tcx/integrations/edtechpro/prices | |
 |[**getGetSchools**](#getgetschools) | **GET** /tcx/integrations/edtechpro/schools | |
 |[**getGetTrusts**](#getgettrusts) | **GET** /tcx/integrations/edtechpro/trusts | |
+|[**getSearchSchools**](#getsearchschools) | **GET** /tcx/integrations/edtechpro/search/schools | |
 |[**patchUpdateEtpOrderReference**](#patchupdateetporderreference) | **PATCH** /tcx/integrations/edtechpro/{clientId}/schools/{schoolId}/orderReference | |
 |[**postOrderEdTechPro**](#postorderedtechpro) | **POST** /tcx/integrations/edtechpro/orders | |
 |[**postUpgradeEdTechPro**](#postupgradeedtechpro) | **POST** /tcx/integrations/edtechpro/upgrades | |
@@ -172,6 +173,57 @@ 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)
 
+# **getSearchSchools**
+> Array<SearchSchoolModel> getSearchSchools()
+
+Seach EdTechPro Schools
+
+### Example
+
+```typescript
+import {
+    Class3CXIntegrationsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXIntegrationsApi(configuration);
+
+let search: string; //School Name, Dfe code or URN (default to undefined)
+
+const { status, data } = await apiInstance.getSearchSchools(
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **search** | [**string**] | School Name, Dfe code or URN | defaults to undefined|
+
+
+### Return type
+
+**Array<SearchSchoolModel>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | EdTechPro Schools |  -  |
+
+[[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)
+
 # **patchUpdateEtpOrderReference**
 > patchUpdateEtpOrderReference()
 

package/docs/Class3CXMultiTenantApi.md

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

package/docs/ClientDetailsModel.md

@@ -6,13 +6,13 @@ Client Details
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**clientId** | **string** | Client ID | [optional] [default to undefined]
-**userId** | **number** | User ID | [optional] [default to undefined]
-**email** | **string** | Email Address | [optional] [default to undefined]
-**customerId** | **number** | Customer ID | [optional] [default to undefined]
-**xeroId** | **string** | Xero ID | [optional] [default to undefined]
-**firstName** | **string** | User First Name | [optional] [default to undefined]
-**lastName** | **string** | User Last Name | [optional] [default to undefined]
+**clientId** | **string** | Client ID | [default to undefined]
+**userId** | **number** | User ID | [default to undefined]
+**email** | **string** | Email Address | [default to undefined]
+**customerId** | **number** | Customer ID | [default to undefined]
+**xeroId** | **string** | Xero ID | [default to undefined]
+**firstName** | **string** | User First Name | [default to undefined]
+**lastName** | **string** | User Last Name | [default to undefined]
 
 ## Example
 

package/docs/ClientModel.md

@@ -6,10 +6,10 @@ OAuth client details
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**scopes** | **Array<string>** | OAuth 2.0 Scopes | [optional] [default to undefined]
-**client_id** | **string** | OAuth 2.0 Client ID | [optional] [default to undefined]
-**client_secret** | **string** | OAuth 2.0 Client Secret | [optional] [default to undefined]
-**created** | **string** | Creation Date | [optional] [default to undefined]
+**scopes** | **Array<string>** | OAuth 2.0 Scopes | [default to undefined]
+**client_id** | **string** | OAuth 2.0 Client ID | [default to undefined]
+**client_secret** | **string** | OAuth 2.0 Client Secret | [default to undefined]
+**created** | **string** | Creation Date | [default to undefined]
 
 ## Example