yellowgrid-api-ts 3.0.79

package/docs/SupplierEntity.md

@@ -0,0 +1,37 @@
+# SupplierEntity
+
+SuppliersEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**name** | **string** | name | [optional] [default to undefined]
+**shortName** | **string** | nameShort | [optional] [default to undefined]
+**email** | **string** | email | [optional] [default to undefined]
+**phone** | **string** | phone | [optional] [default to undefined]
+**defaultCourier** | **string** | defaultCourier | [optional] [default to undefined]
+**defaultCarriage** | **number** | defaultCarriage | [optional] [default to undefined]
+**accountNumber** | **string** | account | [optional] [default to undefined]
+**xeroAccountNumber** | **string** | internalAccount | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SupplierEntity } from 'yellowgrid-api-ts';
+
+const instance: SupplierEntity = {
+    id,
+    name,
+    shortName,
+    email,
+    phone,
+    defaultCourier,
+    defaultCarriage,
+    accountNumber,
+    xeroAccountNumber,
+};
+```
+
+[[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/SupplierItemEntity.md

@@ -0,0 +1,35 @@
+# SupplierItemEntity
+
+SupplierItemsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**supplierId** | **number** | supplierId | [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]
+**itemPrice** | **number** | itemPrice | [optional] [default to undefined]
+**itemType** | **number** | itemType | [optional] [default to undefined]
+**supplierSku** | **string** | supplierSku | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SupplierItemEntity } from 'yellowgrid-api-ts';
+
+const instance: SupplierItemEntity = {
+    id,
+    supplierId,
+    sku,
+    title,
+    itemOptions,
+    itemPrice,
+    itemType,
+    supplierSku,
+};
+```
+
+[[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/SystemApi.md

@@ -0,0 +1,80 @@
+# SystemApi
+
+All URIs are relative to *http://api.yellowgrid.local*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getLogSearch**](#getlogsearch) | **GET** /system/logs/api/search | Search for logs|
+
+# **getLogSearch**
+> Array<ApiLogEntity> getLogSearch()
+
+Search for logs
+
+### Example
+
+```typescript
+import {
+    SystemApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SystemApi(configuration);
+
+let clientId: string; //Client ID (optional) (default to undefined)
+let clientIp: string; //Client IP (optional) (default to undefined)
+let responseCode: number; //HTTP code (optional) (default to undefined)
+let date: string; //Date of log creation (optional) (default to undefined)
+let filterOutDomain: string; //HTTP origin to filter out (optional) (default to undefined)
+let pageSize: number; //Number Of Results (optional) (default to undefined)
+let page: number; //Page Number (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getLogSearch(
+    clientId,
+    clientIp,
+    responseCode,
+    date,
+    filterOutDomain,
+    pageSize,
+    page
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clientId** | [**string**] | Client ID | (optional) defaults to undefined|
+| **clientIp** | [**string**] | Client IP | (optional) defaults to undefined|
+| **responseCode** | [**number**] | HTTP code | (optional) defaults to undefined|
+| **date** | **string** | Date of log creation | (optional) defaults to undefined|
+| **filterOutDomain** | [**string**] | HTTP origin to filter out | (optional) defaults to undefined|
+| **pageSize** | [**number**] | Number Of Results | (optional) defaults to undefined|
+| **page** | [**number**] | Page Number | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<ApiLogEntity>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Log |  -  |
+|**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/TcxBackupEntity.md

@@ -0,0 +1,37 @@
+# TcxBackupEntity
+
+3CX Wizard Restore From Backup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**path** | **string** | Backup Filename | [optional] [default to undefined]
+**password** | **string** | password | [optional] [default to undefined]
+**adminUsername** | **string** | adminUsername | [optional] [default to undefined]
+**httpPort** | **number** | HTTP Port | [optional] [default to undefined]
+**httpsPort** | **number** | HTTPS Port | [optional] [default to undefined]
+**sipPort** | **number** | SIP Port | [optional] [default to undefined]
+**tunnelPort** | **number** | 3CX Tunnel Port | [optional] [default to undefined]
+**schedule** | **string** | 3CX Wizard Build Schedule | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TcxBackupEntity } from 'yellowgrid-api-ts';
+
+const instance: TcxBackupEntity = {
+    id,
+    path,
+    password,
+    adminUsername,
+    httpPort,
+    httpsPort,
+    sipPort,
+    tunnelPort,
+    schedule,
+};
+```
+
+[[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/TcxBackupModel.md

@@ -0,0 +1,55 @@
+# TcxBackupModel
+
+3CX Wizard Restore From Backup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**path** | **string** | Backup Filename | [optional] [default to undefined]
+**password** | **string** | password | [optional] [default to undefined]
+**adminUsername** | **string** | adminUsername | [optional] [default to undefined]
+**httpPort** | **number** | HTTP Port | [optional] [default to undefined]
+**httpsPort** | **number** | HTTPS Port | [optional] [default to undefined]
+**sipPort** | **number** | SIP Port | [optional] [default to undefined]
+**tunnelPort** | **number** | 3CX Tunnel Port | [optional] [default to undefined]
+**schedule** | **string** | 3CX Wizard Build Schedule | [optional] [default to undefined]
+**size** | **number** | Backup Size | [optional] [default to undefined]
+**email** | **string** | 3CX Admin Email | [optional] [default to undefined]
+**version** | **string** | 3CX Version | [optional] [default to undefined]
+**fqdn** | **string** | FQDN | [optional] [default to undefined]
+**hostname** | **string** | 3CX Hostname | [optional] [default to undefined]
+**suffix** | **string** | 3CX DNS Suffix | [optional] [default to undefined]
+**licence** | **string** | 3CX Licence Key | [optional] [default to undefined]
+**extLength** | **number** | Extension Length | [optional] [default to undefined]
+**phone** | **string** | 3CX Licence Phone | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TcxBackupModel } from 'yellowgrid-api-ts';
+
+const instance: TcxBackupModel = {
+    id,
+    path,
+    password,
+    adminUsername,
+    httpPort,
+    httpsPort,
+    sipPort,
+    tunnelPort,
+    schedule,
+    size,
+    email,
+    version,
+    fqdn,
+    hostname,
+    suffix,
+    licence,
+    extLength,
+    phone,
+};
+```
+
+[[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/TcxBillingEntity.md

@@ -0,0 +1,39 @@
+# TcxBillingEntity
+
+TcxBillingEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**tcxId** | **number** | tcxId | [optional] [default to undefined]
+**method** | **string** | method | [optional] [default to undefined]
+**amount** | **number** | amount | [optional] [default to undefined]
+**currency** | **string** | currency | [optional] [default to undefined]
+**notes** | **string** | notes | [optional] [default to undefined]
+**invoicing** | **string** | invoicing | [optional] [default to undefined]
+**monthInterval** | **number** | monthInterval | [optional] [default to undefined]
+**startDate** | **string** | startDate | [optional] [default to undefined]
+**billTo** | **string** | billTo | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TcxBillingEntity } from 'yellowgrid-api-ts';
+
+const instance: TcxBillingEntity = {
+    id,
+    tcxId,
+    method,
+    amount,
+    currency,
+    notes,
+    invoicing,
+    monthInterval,
+    startDate,
+    billTo,
+};
+```
+
+[[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/TcxBulkLicenceDetailsModel.md

@@ -0,0 +1,23 @@
+# TcxBulkLicenceDetailsModel
+
+Bulk 3CX Licence Details
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**licenceDetails** | [**Array<TcxLicenceDetailsModel>**](TcxLicenceDetailsModel.md) | Licence Details | [optional] [default to undefined]
+**errors** | [**Array<TcxLicenceDetailsErrorModel>**](TcxLicenceDetailsErrorModel.md) | Licence Error Details | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TcxBulkLicenceDetailsModel } from 'yellowgrid-api-ts';
+
+const instance: TcxBulkLicenceDetailsModel = {
+    licenceDetails,
+    errors,
+};
+```
+
+[[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/TcxDeadLicenceEntity.md

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

@@ -0,0 +1,35 @@
+# TcxExtsEntity
+
+3CX Wizard Extension
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**extNo** | **string** | Extension Number | [optional] [default to undefined]
+**firstName** | **string** | First Name | [optional] [default to undefined]
+**lastName** | **string** | Last Name | [optional] [default to undefined]
+**email** | **string** | Email Address | [optional] [default to undefined]
+**ddi** | **string** | DDI | [optional] [default to undefined]
+**cli** | **string** | Outbound CLI | [optional] [default to undefined]
+**recording** | **boolean** | Recording Enabled | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TcxExtsEntity } from 'yellowgrid-api-ts';
+
+const instance: TcxExtsEntity = {
+    id,
+    extNo,
+    firstName,
+    lastName,
+    email,
+    ddi,
+    cli,
+    recording,
+};
+```
+
+[[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/TcxHostingPricingEntity.md

@@ -0,0 +1,35 @@
+# TcxHostingPricingEntity
+
+HostingPricingEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**title** | **string** | title | [optional] [default to undefined]
+**perSc** | **number** | perSc | [optional] [default to undefined]
+**perMultiTenantSc** | **number** | perMultiTenantSc | [optional] [default to undefined]
+**flatRate** | **number** | flatRate | [optional] [default to undefined]
+**maxFlatRateSc** | **number** | maxFlatRateSc | [optional] [default to undefined]
+**highScThreshold** | **number** | highScThreshold | [optional] [default to undefined]
+**highScDiscount** | **number** | highScDiscount | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TcxHostingPricingEntity } from 'yellowgrid-api-ts';
+
+const instance: TcxHostingPricingEntity = {
+    id,
+    title,
+    perSc,
+    perMultiTenantSc,
+    flatRate,
+    maxFlatRateSc,
+    highScThreshold,
+    highScDiscount,
+};
+```
+
+[[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/TcxInstallationDetailsModel.md

@@ -0,0 +1,45 @@
+# TcxInstallationDetailsModel
+
+3CX Installation Details
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ipAddress** | **string** | PBX IP Address | [optional] [default to undefined]
+**instanceId** | **string** | Instance ID | [optional] [default to undefined]
+**project** | **string** | Project ID | [optional] [default to undefined]
+**privateKey** | [**GenericFileModel**](GenericFileModel.md) |  | [optional] [default to undefined]
+**rootPassword** | **string** | Root Password | [optional] [default to undefined]
+**ownerExtension** | [**TcxUsersEntity**](TcxUsersEntity.md) |  | [optional] [default to undefined]
+**adminEmail** | **string** | Admin Email | [optional] [default to undefined]
+**url** | **string** | Console URL | [optional] [default to undefined]
+**adminUsername** | **string** | Admin Username | [optional] [default to undefined]
+**adminPassword** | **string** | Admin Password | [optional] [default to undefined]
+**ftpHost** | **string** | Config Backup FTP Host | [optional] [default to undefined]
+**ftpUsername** | **string** | Config Backup FTP Username | [optional] [default to undefined]
+**ftpPassword** | **string** | Config Backup FTP Password | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TcxInstallationDetailsModel } from 'yellowgrid-api-ts';
+
+const instance: TcxInstallationDetailsModel = {
+    ipAddress,
+    instanceId,
+    project,
+    privateKey,
+    rootPassword,
+    ownerExtension,
+    adminEmail,
+    url,
+    adminUsername,
+    adminPassword,
+    ftpHost,
+    ftpUsername,
+    ftpPassword,
+};
+```
+
+[[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/TcxInstallationModel.md

@@ -0,0 +1,75 @@
+# TcxInstallationModel
+
+3CX Installation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**wizardId** | **string** | Wizard ID | [optional] [default to undefined]
+**instanceId** | **string** | Instance ID | [optional] [default to undefined]
+**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
+**endUser** | **string** | End User | [optional] [default to undefined]
+**reseller** | **string** | Reseller | [optional] [default to undefined]
+**company** | **string** | Company Name | [optional] [default to undefined]
+**portalStatus** | **string** | Installation Status | [optional] [default to undefined]
+**creation** | **string** | Creation Date | [optional] [default to undefined]
+**installType** | **string** | Install Type | [optional] [default to undefined]
+**configType** | **string** | Config Type | [optional] [default to undefined]
+**fqdn** | **string** | FQDN | [optional] [default to undefined]
+**ipAddress** | **string** | PBX IP Address | [optional] [default to undefined]
+**reservedIpAddress** | **string** | Failover IP Address | [optional] [default to undefined]
+**tcxUrl** | **string** | 3CX Console URL | [optional] [default to undefined]
+**wizardUrl** | **string** | Wizard URL | [optional] [default to undefined]
+**credentialsUrl** | **string** | 3CX Credentials URL | [optional] [default to undefined]
+**price** | **number** | Hosting Price | [optional] [default to undefined]
+**offline** | **boolean** | Instance Offline | [optional] [default to undefined]
+**failedOver** | **boolean** | Instance Failed Over | [optional] [default to undefined]
+**suspended** | **boolean** | Instance Suspended | [optional] [default to undefined]
+**supported** | **boolean** | Instance Support Status | [optional] [default to undefined]
+**supportLevel** | **string** | Instance Support Level | [optional] [default to undefined]
+**supportDescription** | **string** | Instance Support Description | [optional] [default to undefined]
+**supportIcon** | **string** | Instance Support Icon | [optional] [default to undefined]
+**supportColour** | **string** | Instance Support Colour | [optional] [default to undefined]
+**version** | **string** | 3CX Software Version | [optional] [default to undefined]
+**disk** | **number** | Recordings Disk Size | [optional] [default to undefined]
+**flavour** | **string** | Instance Spec | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TcxInstallationModel } from 'yellowgrid-api-ts';
+
+const instance: TcxInstallationModel = {
+    wizardId,
+    instanceId,
+    licenceKey,
+    endUser,
+    reseller,
+    company,
+    portalStatus,
+    creation,
+    installType,
+    configType,
+    fqdn,
+    ipAddress,
+    reservedIpAddress,
+    tcxUrl,
+    wizardUrl,
+    credentialsUrl,
+    price,
+    offline,
+    failedOver,
+    suspended,
+    supported,
+    supportLevel,
+    supportDescription,
+    supportIcon,
+    supportColour,
+    version,
+    disk,
+    flavour,
+};
+```
+
+[[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/TcxInstallationsModel.md

@@ -0,0 +1,27 @@
+# TcxInstallationsModel
+
+3CX Installations
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<TcxInstallationModel>**](TcxInstallationModel.md) | Results | [optional] [default to undefined]
+**page** | **number** | Page | [optional] [default to undefined]
+**perPage** | **number** | Per Page | [optional] [default to undefined]
+**totalResults** | **number** | Total Results | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TcxInstallationsModel } from 'yellowgrid-api-ts';
+
+const instance: TcxInstallationsModel = {
+    results,
+    page,
+    perPage,
+    totalResults,
+};
+```
+
+[[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/TcxKeySummaryDTO.md

@@ -0,0 +1,29 @@
+# TcxKeySummaryDTO
+
+3CX Key Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**licenceKey** | **string** | Licence Key | [optional] [default to undefined]
+**endUser** | **string** | End User | [optional] [default to undefined]
+**sc** | **number** | Simultaneous Calls | [optional] [default to undefined]
+**edition** | **string** | Edition | [optional] [default to undefined]
+**expiry** | **string** | Date Time | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TcxKeySummaryDTO } from 'yellowgrid-api-ts';
+
+const instance: TcxKeySummaryDTO = {
+    licenceKey,
+    endUser,
+    sc,
+    edition,
+    expiry,
+};
+```
+
+[[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/TcxKeysEntity.md

@@ -0,0 +1,31 @@
+# TcxKeysEntity
+
+TcxKeysEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**customerId** | **number** | customerId | [optional] [default to undefined]
+**licenceKey** | **string** | licenceKey | [optional] [default to undefined]
+**name** | **string** | name | [optional] [default to undefined]
+**orderId** | **number** | orderId | [optional] [default to undefined]
+**updatedTime** | **string** | updatedTime | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TcxKeysEntity } from 'yellowgrid-api-ts';
+
+const instance: TcxKeysEntity = {
+    id,
+    customerId,
+    licenceKey,
+    name,
+    orderId,
+    updatedTime,
+};
+```
+
+[[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/TcxLicenceDetailsErrorModel.md

@@ -0,0 +1,27 @@
+# TcxLicenceDetailsErrorModel
+
+3CX Licence Details
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**licenceKey** | **string** | Licence Key | [optional] [default to undefined]
+**code** | **string** | Code | [optional] [default to undefined]
+**message** | **string** | Error Message | [optional] [default to undefined]
+**status** | **string** | Status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TcxLicenceDetailsErrorModel } from 'yellowgrid-api-ts';
+
+const instance: TcxLicenceDetailsErrorModel = {
+    licenceKey,
+    code,
+    message,
+    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)