yellowgrid-api-ts 3.0.79

package/docs/InstanceMonitoringEntity.md

@@ -0,0 +1,25 @@
+# InstanceMonitoringEntity
+
+InstanceMonitoringEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**instanceId** | **string** | instanceId | [optional] [default to undefined]
+**port** | **number** | port | [optional] [default to undefined]
+**lastConnected** | **string** | lastConnected | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InstanceMonitoringEntity } from 'yellowgrid-api-ts';
+
+const instance: InstanceMonitoringEntity = {
+    instanceId,
+    port,
+    lastConnected,
+};
+```
+
+[[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/InstanceMonitoringLogEntity.md

@@ -0,0 +1,31 @@
+# InstanceMonitoringLogEntity
+
+InstanceMonitoringLogEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**instanceId** | **string** | instanceId | [optional] [default to undefined]
+**code** | **number** | code | [optional] [default to undefined]
+**error** | **string** | error | [optional] [default to undefined]
+**date** | **string** | date | [optional] [default to undefined]
+**timestamp** | **string** | timestamp | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InstanceMonitoringLogEntity } from 'yellowgrid-api-ts';
+
+const instance: InstanceMonitoringLogEntity = {
+    id,
+    instanceId,
+    code,
+    error,
+    date,
+    timestamp,
+};
+```
+
+[[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/InstanceScheduledTasksEntity.md

@@ -0,0 +1,31 @@
+# InstanceScheduledTasksEntity
+
+InstanceScheduledTasksEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**instanceId** | **string** | instanceId | [optional] [default to undefined]
+**task** | **string** | task | [optional] [default to undefined]
+**value** | **string** | value | [optional] [default to undefined]
+**time** | **string** | time | [optional] [default to undefined]
+**status** | **number** | status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InstanceScheduledTasksEntity } from 'yellowgrid-api-ts';
+
+const instance: InstanceScheduledTasksEntity = {
+    id,
+    instanceId,
+    task,
+    value,
+    time,
+    status,
+};
+```
+
+[[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/InstanceTcxDetailsEntity.md

@@ -0,0 +1,39 @@
+# InstanceTcxDetailsEntity
+
+InstanceTcxDetailsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**instanceId** | **string** | instanceId | [optional] [default to undefined]
+**version** | **string** | version | [optional] [default to undefined]
+**maxSimCalls** | **number** | maxSimCalls | [optional] [default to undefined]
+**fqdn** | **string** | fqdn | [optional] [default to undefined]
+**productCode** | **string** | productCode | [optional] [default to undefined]
+**resellerName** | **string** | resellerName | [optional] [default to undefined]
+**licenseKey** | **string** | licenseKey | [optional] [default to undefined]
+**adminEMail** | **string** | adminEMail | [optional] [default to undefined]
+**expirationDate** | **string** | expirationDate | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InstanceTcxDetailsEntity } from 'yellowgrid-api-ts';
+
+const instance: InstanceTcxDetailsEntity = {
+    id,
+    instanceId,
+    version,
+    maxSimCalls,
+    fqdn,
+    productCode,
+    resellerName,
+    licenseKey,
+    adminEMail,
+    expirationDate,
+};
+```
+
+[[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/InstanceUserCredentialsEntity.md

@@ -0,0 +1,29 @@
+# InstanceUserCredentialsEntity
+
+InstanceUserCredentialsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**instanceId** | **string** | instanceId | [optional] [default to undefined]
+**username** | **string** | username | [optional] [default to undefined]
+**password** | **string** | password | [optional] [default to undefined]
+**creationDate** | **string** | creationDate | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InstanceUserCredentialsEntity } from 'yellowgrid-api-ts';
+
+const instance: InstanceUserCredentialsEntity = {
+    id,
+    instanceId,
+    username,
+    password,
+    creationDate,
+};
+```
+
+[[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/ItemDTO.md

@@ -0,0 +1,41 @@
+# ItemDTO
+
+Order Item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
+**orderId** | **number** | Order ID | [optional] [default to undefined]
+**title** | **string** | Title | [optional] [default to undefined]
+**sku** | **string** | SKU | [optional] [default to undefined]
+**quantity** | **number** | Quantity | [optional] [default to undefined]
+**price** | **number** | Price | [optional] [default to undefined]
+**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
+**licenceExpiry** | **string** | Date Time | [optional] [default to undefined]
+**processDate** | **string** | Date Time | [optional] [default to undefined]
+**promoItem** | **boolean** | Promo Item | [optional] [default to undefined]
+**refunded** | **number** | Refunded | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ItemDTO } from 'yellowgrid-api-ts';
+
+const instance: ItemDTO = {
+    id,
+    orderId,
+    title,
+    sku,
+    quantity,
+    price,
+    licenceKey,
+    licenceExpiry,
+    processDate,
+    promoItem,
+    refunded,
+};
+```
+
+[[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/ItemEntity.md

@@ -0,0 +1,61 @@
+# ItemEntity
+
+ItemsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**orderId** | **number** | orderId | [optional] [default to undefined]
+**sku** | **string** | sku | [optional] [default to undefined]
+**title** | **string** | title | [optional] [default to undefined]
+**itemOptions** | **string** | itemOptions | [optional] [default to undefined]
+**quantity** | **number** | quantity | [optional] [default to undefined]
+**customOption** | **number** | customOption | [optional] [default to undefined]
+**itemPrice** | **number** | itemPrice | [optional] [default to undefined]
+**itemPriceGbp** | **number** | itemPriceGbp | [optional] [default to undefined]
+**itemTax** | **number** | itemTax | [optional] [default to undefined]
+**itemTaxGbp** | **number** | itemTaxGbp | [optional] [default to undefined]
+**itemShipping** | **number** | itemShipping | [optional] [default to undefined]
+**itemShippingGbp** | **number** | itemShippingGbp | [optional] [default to undefined]
+**shippingTax** | **number** | shippingTax | [optional] [default to undefined]
+**shippingTaxGbp** | **number** | shippingTaxGbp | [optional] [default to undefined]
+**customerRefunded** | **number** | customerRefunded | [optional] [default to undefined]
+**licencekey** | **string** | licencekey | [optional] [default to undefined]
+**addHosting** | **number** | addHosting | [optional] [default to undefined]
+**licenceExpiryDate** | **string** | licenceExpiryDate | [optional] [default to undefined]
+**processDate** | **string** | processDate | [optional] [default to undefined]
+**promoItem** | **number** | promo | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ItemEntity } from 'yellowgrid-api-ts';
+
+const instance: ItemEntity = {
+    id,
+    orderId,
+    sku,
+    title,
+    itemOptions,
+    quantity,
+    customOption,
+    itemPrice,
+    itemPriceGbp,
+    itemTax,
+    itemTaxGbp,
+    itemShipping,
+    itemShippingGbp,
+    shippingTax,
+    shippingTaxGbp,
+    customerRefunded,
+    licencekey,
+    addHosting,
+    licenceExpiryDate,
+    processDate,
+    promoItem,
+};
+```
+
+[[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/MFARequiredModel.md

@@ -0,0 +1,23 @@
+# MFARequiredModel
+
+MFA Required
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**secret** | **string** | MFA Secret | [optional] [default to undefined]
+**png** | **string** | QR Code | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MFARequiredModel } from 'yellowgrid-api-ts';
+
+const instance: MFARequiredModel = {
+    secret,
+    png,
+};
+```
+
+[[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/MonthlyUsageModel.md

@@ -0,0 +1,23 @@
+# MonthlyUsageModel
+
+Monthly Contract Usage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**month** | **string** | Month | [optional] [default to undefined]
+**used** | **number** | Used | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MonthlyUsageModel } from 'yellowgrid-api-ts';
+
+const instance: MonthlyUsageModel = {
+    month,
+    used,
+};
+```
+
+[[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/MultiTenantChangeResponseModel.md

@@ -0,0 +1,27 @@
+# MultiTenantChangeResponseModel
+
+Multi-Tenant Change Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**progress** | **number** | Progress | [optional] [default to undefined]
+**changeId** | **string** | ID | [optional] [default to undefined]
+**type** | **string** | Type | [optional] [default to undefined]
+**provider** | **number** | Provider | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MultiTenantChangeResponseModel } from 'yellowgrid-api-ts';
+
+const instance: MultiTenantChangeResponseModel = {
+    progress,
+    changeId,
+    type,
+    provider,
+};
+```
+
+[[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

@@ -0,0 +1,65 @@
+# MyPBXToolsApi
+
+All URIs are relative to *http://api.yellowgrid.local*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getGetRecording**](#getgetrecording) | **GET** /mypbxtools/recordings | Fetch recording from a 3CX instance|
+
+# **getGetRecording**
+> GetGetRecording200Response getGetRecording()
+
+Get 3CX Installation Details
+
+### Example
+
+```typescript
+import {
+    MyPBXToolsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new MyPBXToolsApi(configuration);
+
+let licenceKey: string; //Licence Key (default to undefined)
+let fileName: string; //File Name (default to undefined)
+
+const { status, data } = await apiInstance.getGetRecording(
+    licenceKey,
+    fileName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **licenceKey** | [**string**] | Licence Key | defaults to undefined|
+| **fileName** | [**string**] | File Name | defaults to undefined|
+
+
+### Return type
+
+**GetGetRecording200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Installation 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)
+

package/docs/NavigationModel.md

@@ -0,0 +1,27 @@
+# NavigationModel
+
+Navigation Endpoint
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Navigation Endpoint Title | [optional] [default to undefined]
+**path** | **string** | Navigation Endpoint Path | [optional] [default to undefined]
+**icon** | **string** | Navigation Endpoint Icon | [optional] [default to undefined]
+**openNewPage** | **boolean** | Navigation Behaviour | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NavigationModel } from 'yellowgrid-api-ts';
+
+const instance: NavigationModel = {
+    title,
+    path,
+    icon,
+    openNewPage,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)