yellowgrid-api-ts 3.2.169-dev.0 → 3.2.171-dev.0

package/docs/AddressDTO.md

@@ -0,0 +1,31 @@
+# AddressDTO
+
+Address
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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]
+**region** | **string** | Region | [optional] [default to undefined]
+**postalCode** | **string** | Postal Code | [optional] [default to undefined]
+**iso** | **string** | Country | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AddressDTO } from 'yellowgrid-api-ts';
+
+const instance: AddressDTO = {
+    addressLine1,
+    addressLine2,
+    city,
+    region,
+    postalCode,
+    iso,
+};
+```
+
+[[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/AdminUserModel.md

@@ -6,6 +6,7 @@ Admin User
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
 **firstName** | **string** | First Name | [optional] [default to undefined]
 **lastName** | **string** | Last Name | [optional] [default to undefined]
 **avatar** | **string** | Avatar | [optional] [default to undefined]
@@ -22,6 +23,7 @@ Name | Type | Description | Notes
 import { AdminUserModel } from 'yellowgrid-api-ts';
 
 const instance: AdminUserModel = {
+    id,
     firstName,
     lastName,
     avatar,

package/docs/CRMApi.md

@@ -4,7 +4,69 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**getGetCrmActivities**](#getgetcrmactivities) | **GET** /admin/crm/{id}/activities | |
 |[**getSearchByPhone**](#getsearchbyphone) | **GET** /crm/contact/search | |
+|[**postCreateCrmNote**](#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note | |
+
+# **getGetCrmActivities**
+> CrmActivitiesResponseDTO getGetCrmActivities()
+
+Get Customer CRM Activities
+
+### Example
+
+```typescript
+import {
+    CRMApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new CRMApi(configuration);
+
+let id: number; //Account ID (default to undefined)
+let type: 'alert' | 'call' | 'email' | 'note' | 'order' | 'quote' | 'tcx_order'; //Activity Type (optional) (default to undefined)
+let userId: number; //Activity Created By (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetCrmActivities(
+    id,
+    type,
+    userId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Account ID | defaults to undefined|
+| **type** | [**&#39;alert&#39; | &#39;call&#39; | &#39;email&#39; | &#39;note&#39; | &#39;order&#39; | &#39;quote&#39; | &#39;tcx_order&#39;**]**Array<&#39;alert&#39; &#124; &#39;call&#39; &#124; &#39;email&#39; &#124; &#39;note&#39; &#124; &#39;order&#39; &#124; &#39;quote&#39; &#124; &#39;tcx_order&#39;>** | Activity Type | (optional) defaults to undefined|
+| **userId** | [**number**] | Activity Created By | (optional) defaults to undefined|
+
+
+### Return type
+
+**CrmActivitiesResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | CRM Activities |  -  |
+|**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)
 
 # **getSearchByPhone**
 > CrmContactDTO getSearchByPhone()
@@ -53,3 +115,61 @@ 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)
 
+# **postCreateCrmNote**
+> CrmActivityDTO postCreateCrmNote()
+
+Create CRM Note
+
+### Example
+
+```typescript
+import {
+    CRMApi,
+    Configuration,
+    CreateCrmNoteBody
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new CRMApi(configuration);
+
+let id: number; //Account ID (default to undefined)
+let createCrmNoteBody: CreateCrmNoteBody; //CRM Note Request (optional)
+
+const { status, data } = await apiInstance.postCreateCrmNote(
+    id,
+    createCrmNoteBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createCrmNoteBody** | **CreateCrmNoteBody**| CRM Note Request | |
+| **id** | [**number**] | Account ID | defaults to undefined|
+
+
+### Return type
+
+**CrmActivityDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | CRM Activity |  -  |
+|**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/Class3CXApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**getGetLicenceDetails**](#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details|
+|[**getGetTcxExpiringKeys**](#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys|
 |[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
 
 # **getGetLicenceDetails**
@@ -61,6 +62,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)
 
+# **getGetTcxExpiringKeys**
+> string getGetTcxExpiringKeys()
+
+Get 3CX Expiring Keys
+
+### Example
+
+```typescript
+import {
+    Class3CXApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXApi(configuration);
+
+const { status, data } = await apiInstance.getGetTcxExpiringKeys();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**string**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/csv
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Expiring Key CSV |  -  |
+|**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)
+
 # **postGetBulkLicenceDetails**
 > TcxBulkLicenceDetailsModel postGetBulkLicenceDetails()
 

package/docs/Class3CXInstallationsApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |------------- | ------------- | -------------|
 |[**getGetDetails**](#getgetdetails) | **GET** /tcx/installations/{wizard_id}/details | Get 3CX Installation Details|
 |[**getGetInstallations**](#getgetinstallations) | **GET** /tcx/installations | Get 3CX Installations|
+|[**getGetRecordingBackupStorage**](#getgetrecordingbackupstorage) | **GET** /tcx/installations/{instance_id}/recordings/backup | Get Recording Backup Storage|
 |[**patchChangeInstanceOwner**](#patchchangeinstanceowner) | **PATCH** /tcx/installations/{instance_id}/owner | Change instance owner|
 |[**patchUpdateAutoFailover**](#patchupdateautofailover) | **PATCH** /tcx/installations/{instance_id}/failover/auto | Update 3CX Instance Auto Failover|
 |[**postAddDisk**](#postadddisk) | **POST** /tcx/installations/{instance_id}/disk | Add additional disk on 3CX Instance|
@@ -150,6 +151,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)
 
+# **getGetRecordingBackupStorage**
+> RecordingBackupAzureModel getGetRecordingBackupStorage()
+
+Get Recording Backup Storage
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationsApi(configuration);
+
+let instanceId: string; //Instance ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetRecordingBackupStorage(
+    instanceId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **instanceId** | [**string**] | Instance ID | defaults to undefined|
+
+
+### Return type
+
+**RecordingBackupAzureModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Recordings Backup Storage |  -  |
+|**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)
+
 # **patchChangeInstanceOwner**
 > patchChangeInstanceOwner()
 

package/docs/CreateCrmNoteBody.md

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

@@ -27,6 +27,8 @@ Name | Type | Description | Notes
 **resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
 **creationDate** | **string** | Creation Date | [optional] [default to undefined]
 **prizePromo** | **boolean** | Prize Promo Enabled | [optional] [default to undefined]
+**portalAccess** | **boolean** | Portal Access | [optional] [default to undefined]
+**cname** | **string** | CNAME | [optional] [default to undefined]
 
 ## Example
 
@@ -55,6 +57,8 @@ const instance: CreditAccountEntity = {
     resellerId,
     creationDate,
     prizePromo,
+    portalAccess,
+    cname,
 };
 ```
 

package/docs/CrmActivitiesResponseDTO.md

@@ -0,0 +1,23 @@
+# CrmActivitiesResponseDTO
+
+CRM Activities Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dates** | [**Array<CrmDateActivitiesDTO>**](CrmDateActivitiesDTO.md) | Dates | [optional] [default to undefined]
+**agents** | [**Array<AdminUserModel>**](AdminUserModel.md) | Agents | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CrmActivitiesResponseDTO } from 'yellowgrid-api-ts';
+
+const instance: CrmActivitiesResponseDTO = {
+    dates,
+    agents,
+};
+```
+
+[[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/CrmActivityDTO.md

@@ -0,0 +1,33 @@
+# CrmActivityDTO
+
+CRM Activity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** | Activity Type | [optional] [default to undefined]
+**timestamp** | **string** | Date Time | [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]
+
+## Example
+
+```typescript
+import { CrmActivityDTO } from 'yellowgrid-api-ts';
+
+const instance: CrmActivityDTO = {
+    type,
+    timestamp,
+    title,
+    description,
+    url,
+    user,
+    contact,
+};
+```
+
+[[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/CrmDateActivitiesDTO.md

@@ -0,0 +1,23 @@
+# CrmDateActivitiesDTO
+
+CRM Date Activities
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date** | **string** | Date Time | [optional] [default to undefined]
+**activities** | [**Array<CrmActivityDTO>**](CrmActivityDTO.md) | Activities | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CrmDateActivitiesDTO } from 'yellowgrid-api-ts';
+
+const instance: CrmDateActivitiesDTO = {
+    date,
+    activities,
+};
+```
+
+[[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/CrmNoteEntity.md

@@ -0,0 +1,39 @@
+# CrmNoteEntity
+
+CrmNotesEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**customerId** | **string** | customerId | [optional] [default to undefined]
+**userId** | **number** | userId | [optional] [default to undefined]
+**type** | **string** | type | [optional] [default to undefined]
+**note** | **string** | note | [optional] [default to undefined]
+**timestamp** | **string** | timestamp | [optional] [default to undefined]
+**journalTime** | **string** | journalTime | [optional] [default to undefined]
+**duration** | **string** | duration | [optional] [default to undefined]
+**callType** | **string** | callType | [optional] [default to undefined]
+**callId** | **number** | callId | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CrmNoteEntity } from 'yellowgrid-api-ts';
+
+const instance: CrmNoteEntity = {
+    id,
+    customerId,
+    userId,
+    type,
+    note,
+    timestamp,
+    journalTime,
+    duration,
+    callType,
+    callId,
+};
+```
+
+[[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/CrmNoteModel.md

@@ -0,0 +1,39 @@
+# CrmNoteModel
+
+CrmNotesEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**customerId** | **string** | customerId | [optional] [default to undefined]
+**userId** | **number** | userId | [optional] [default to undefined]
+**type** | **string** | type | [optional] [default to undefined]
+**note** | **string** | note | [optional] [default to undefined]
+**timestamp** | **string** | timestamp | [optional] [default to undefined]
+**journalTime** | **string** | journalTime | [optional] [default to undefined]
+**duration** | **string** | duration | [optional] [default to undefined]
+**callType** | **string** | callType | [optional] [default to undefined]
+**callId** | **number** | callId | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CrmNoteModel } from 'yellowgrid-api-ts';
+
+const instance: CrmNoteModel = {
+    id,
+    customerId,
+    userId,
+    type,
+    note,
+    timestamp,
+    journalTime,
+    duration,
+    callType,
+    callId,
+};
+```
+
+[[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/CustomerListAccountDTO.md

@@ -0,0 +1,45 @@
+# CustomerListAccountDTO
+
+Customer List Account
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
+**xeroId** | **string** | Xero ID | [optional] [default to undefined]
+**accountNumber** | **string** | Account Number | [optional] [default to undefined]
+**company** | **string** | Company Name | [optional] [default to undefined]
+**domains** | **Array<string>** | Associated Email Domains | [optional] [default to undefined]
+**telephone** | **string** | Telephone | [optional] [default to undefined]
+**vatNumber** | **string** | VAT Number | [optional] [default to undefined]
+**companyNumber** | **string** | Company Number | [optional] [default to undefined]
+**cname** | **string** | Wizard CNAME | [optional] [default to undefined]
+**partnerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
+**status** | **boolean** | Account Status | [optional] [default to undefined]
+**portalAccess** | **boolean** | Portal Access | [optional] [default to undefined]
+**prizePromo** | **boolean** | Prize Promo | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CustomerListAccountDTO } from 'yellowgrid-api-ts';
+
+const instance: CustomerListAccountDTO = {
+    id,
+    xeroId,
+    accountNumber,
+    company,
+    domains,
+    telephone,
+    vatNumber,
+    companyNumber,
+    cname,
+    partnerId,
+    status,
+    portalAccess,
+    prizePromo,
+};
+```
+
+[[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/NumberPortAdminNoteBody.md

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

@@ -401,7 +401,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)
 
 # **postAddAdminNote**
-> AdminNumberPortDTO postAddAdminNote(postAddAdminNoteRequest)
+> AdminNumberPortDTO postAddAdminNote(numberPortAdminNoteBody)
 
 
 ### Example
@@ -410,18 +410,18 @@ No authorization required
 import {
     NumberPortingApi,
     Configuration,
-    PostAddAdminNoteRequest
+    NumberPortAdminNoteBody
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new NumberPortingApi(configuration);
 
 let id: number; //Number Port ID (default to undefined)
-let postAddAdminNoteRequest: PostAddAdminNoteRequest; //
+let numberPortAdminNoteBody: NumberPortAdminNoteBody; //Number Port Note Request
 
 const { status, data } = await apiInstance.postAddAdminNote(
     id,
-    postAddAdminNoteRequest
+    numberPortAdminNoteBody
 );
 ```
 
@@ -429,7 +429,7 @@ const { status, data } = await apiInstance.postAddAdminNote(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **postAddAdminNoteRequest** | **PostAddAdminNoteRequest**|  | |
+| **numberPortAdminNoteBody** | **NumberPortAdminNoteBody**| Number Port Note Request | |
 | **id** | [**number**] | Number Port ID | defaults to undefined|
 
 

package/docs/OAuth20Api.md

@@ -9,6 +9,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**postAccessToken**](#postaccesstoken) | **POST** /oauth2/access_token | Validates client credentials and returns access token|
 |[**postAuthorise**](#postauthorise) | **POST** /oauth2/authorise | Get OAuth2.0 Auth Code|
 |[**postGetIdentity**](#postgetidentity) | **POST** /oauth2/me | Get Token Identity|
+|[**postLogout**](#postlogout) | **POST** /oauth2/logout | |
 |[**postPortalLogin**](#postportallogin) | **POST** /oauth2/portal/login | Portal Login|
 
 # **getGetMfaQrCode**
@@ -311,6 +312,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)
 
+# **postLogout**
+> postLogout()
+
+Remove Oauth 2.0 Cookies
+
+### Example
+
+```typescript
+import {
+    OAuth20Api,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OAuth20Api(configuration);
+
+const { status, data } = await apiInstance.postLogout();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### 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 |
+|-------------|-------------|------------------|
+|**200** | 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)
+
 # **postPortalLogin**
 > AuthCodeResponseModel postPortalLogin()