yellowgrid-api-ts 3.0.79

package/docs/CustomerSummaryReportDTO.md

@@ -0,0 +1,31 @@
+# CustomerSummaryReportDTO
+
+Customer Summary Report
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**companyName** | **string** | Company Name | [optional] [default to undefined]
+**contract** | [**CompanyContractModel**](CompanyContractModel.md) |  | [optional] [default to undefined]
+**monthlyUsages** | [**Array<MonthlyUsageModel>**](MonthlyUsageModel.md) | Contract Use by Month | [optional] [default to undefined]
+**ticketTimes** | [**Array<TicketTimeDTO>**](TicketTimeDTO.md) | Time Entries | [optional] [default to undefined]
+**supportBankTimeTotal** | **string** | Time Entries | [optional] [default to undefined]
+**fixedPriceTimeTotal** | **string** | Time Entries | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CustomerSummaryReportDTO } from 'yellowgrid-api-ts';
+
+const instance: CustomerSummaryReportDTO = {
+    companyName,
+    contract,
+    monthlyUsages,
+    ticketTimes,
+    supportBankTimeTotal,
+    fixedPriceTimeTotal,
+};
+```
+
+[[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/DdiRangeRequestModel.md

@@ -0,0 +1,25 @@
+# DdiRangeRequestModel
+
+DDI Range
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**areaCode** | **string** | UK Area Code | [optional] [default to '161']
+**quantity** | **number** | Number of DDIs | [optional] [default to 1]
+**consecutive** | **boolean** | Consecutive Numbers | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DdiRangeRequestModel } from 'yellowgrid-api-ts';
+
+const instance: DdiRangeRequestModel = {
+    areaCode,
+    quantity,
+    consecutive,
+};
+```
+
+[[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/DdiRangesRequestModel.md

@@ -0,0 +1,21 @@
+# DdiRangesRequestModel
+
+DDI Range Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ranges** | [**Array<DdiRangeRequestModel>**](DdiRangeRequestModel.md) | DDI Ranges | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DdiRangesRequestModel } from 'yellowgrid-api-ts';
+
+const instance: DdiRangesRequestModel = {
+    ranges,
+};
+```
+
+[[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/DivertRequestModel.md

@@ -0,0 +1,23 @@
+# DivertRequestModel
+
+Divert Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**numbers** | **Array<string>** | Numbers to divert | [optional] [default to undefined]
+**destination** | **string** | Destination | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DivertRequestModel } from 'yellowgrid-api-ts';
+
+const instance: DivertRequestModel = {
+    numbers,
+    destination,
+};
+```
+
+[[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/DivertResponseModel.md

@@ -0,0 +1,25 @@
+# DivertResponseModel
+
+Divert
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**number** | **string** | Number | [optional] [default to undefined]
+**destination** | **string** | Divert Destination | [optional] [default to undefined]
+**status** | **string** | Divert Status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DivertResponseModel } from 'yellowgrid-api-ts';
+
+const instance: DivertResponseModel = {
+    number,
+    destination,
+    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/EdTechProClientEntity.md

@@ -0,0 +1,29 @@
+# EdTechProClientEntity
+
+EdTechPro Trusts
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
+**clientId** | **number** | Client ID | [optional] [default to undefined]
+**customerId** | **number** | Customer ID | [optional] [default to undefined]
+**clientName** | **string** | Client/Trust Name | [optional] [default to undefined]
+**apiKey** | **string** | Client API Key | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EdTechProClientEntity } from 'yellowgrid-api-ts';
+
+const instance: EdTechProClientEntity = {
+    id,
+    clientId,
+    customerId,
+    clientName,
+    apiKey,
+};
+```
+
+[[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/EdTechProSchoolModel.md

@@ -0,0 +1,47 @@
+# EdTechProSchoolModel
+
+EdTechPro School
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
+**clientId** | **number** | Client/Trust ID | [optional] [default to undefined]
+**schoolId** | **number** | School ID | [optional] [default to undefined]
+**schoolName** | **string** | School Name | [optional] [default to undefined]
+**sku** | **string** | Product Sku | [optional] [default to undefined]
+**orderReference** | **string** | Order Reference | [optional] [default to undefined]
+**creationDate** | **string** | Creation Date | [optional] [default to undefined]
+**** | **string** | Template URL | [optional] [default to undefined]
+**price** | **number** | School Annual Price | [optional] [default to undefined]
+**rrp** | **number** | School Annual Price (RRP) | [optional] [default to undefined]
+**templateUrl** | **string** | Integration Template URL | [optional] [default to undefined]
+**clientName** | **string** | Client/Trust Name | [optional] [default to undefined]
+**customerId** | **number** | Customer ID | [optional] [default to undefined]
+**apiKey** | **string** | API Key | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EdTechProSchoolModel } from 'yellowgrid-api-ts';
+
+const instance: EdTechProSchoolModel = {
+    id,
+    clientId,
+    schoolId,
+    schoolName,
+    sku,
+    orderReference,
+    creationDate,
+    ,
+    price,
+    rrp,
+    templateUrl,
+    clientName,
+    customerId,
+    apiKey,
+};
+```
+
+[[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/EdTechProSchoolsModel.md

@@ -0,0 +1,27 @@
+# EdTechProSchoolsModel
+
+EdTechPro Schools
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<EdTechProSchoolModel>**](EdTechProSchoolModel.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 { EdTechProSchoolsModel } from 'yellowgrid-api-ts';
+
+const instance: EdTechProSchoolsModel = {
+    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/EdTechProSetupModel.md

@@ -0,0 +1,29 @@
+# EdTechProSetupModel
+
+EdTechPro Setup Details
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clientId** | **number** | Client ID | [optional] [default to undefined]
+**schoolName** | **string** | School Name | [optional] [default to undefined]
+**apiKey** | **string** | API Key | [optional] [default to undefined]
+**templateUrl** | **string** | Template Url | [optional] [default to undefined]
+**installed** | **boolean** | installed | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EdTechProSetupModel } from 'yellowgrid-api-ts';
+
+const instance: EdTechProSetupModel = {
+    clientId,
+    schoolName,
+    apiKey,
+    templateUrl,
+    installed,
+};
+```
+
+[[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/FraudManagementModel.md

@@ -0,0 +1,23 @@
+# FraudManagementModel
+
+Fraud Management
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dailyLimit** | **number** | Daily call spend (£) | [optional] [default to 50]
+**weeklyLimit** | **number** | Monthly call spend (£) | [optional] [default to 100]
+
+## Example
+
+```typescript
+import { FraudManagementModel } from 'yellowgrid-api-ts';
+
+const instance: FraudManagementModel = {
+    dailyLimit,
+    weeklyLimit,
+};
+```
+
+[[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/FreshdeskCompanyTicketsModel.md

@@ -0,0 +1,27 @@
+# FreshdeskCompanyTicketsModel
+
+Freshdesk Company Tickets
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<TicketSummaryModel>**](TicketSummaryModel.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 { FreshdeskCompanyTicketsModel } from 'yellowgrid-api-ts';
+
+const instance: FreshdeskCompanyTicketsModel = {
+    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/FreshdeskTicketEntity.md

@@ -0,0 +1,33 @@
+# FreshdeskTicketEntity
+
+FreshdeskTicketsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**subject** | **string** | subject | [optional] [default to undefined]
+**companyId** | **number** | companyId | [optional] [default to undefined]
+**groupId** | **number** | groupId | [optional] [default to undefined]
+**productId** | **number** | productId | [optional] [default to undefined]
+**statusId** | **number** | status | [optional] [default to undefined]
+**lastUpdated** | **string** | lastUpdated | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FreshdeskTicketEntity } from 'yellowgrid-api-ts';
+
+const instance: FreshdeskTicketEntity = {
+    id,
+    subject,
+    companyId,
+    groupId,
+    productId,
+    statusId,
+    lastUpdated,
+};
+```
+
+[[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/FtpAccountsEntity.md

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

@@ -0,0 +1,25 @@
+# GenericFileModel
+
+Generic File
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **string** | File Content | [optional] [default to undefined]
+**name** | **string** | File Name | [optional] [default to undefined]
+**type** | **string** | File Type | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GenericFileModel } from 'yellowgrid-api-ts';
+
+const instance: GenericFileModel = {
+    content,
+    name,
+    type,
+};
+```
+
+[[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/GetGetPasswordHash200Response.md

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

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

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

@@ -0,0 +1,29 @@
+# HostingChangeResponseModel
+
+Change Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**instanceId** | **string** | ID | [optional] [default to undefined]
+**type** | **string** | Type | [optional] [default to undefined]
+**progress** | **number** | Progress | [optional] [default to undefined]
+**status** | **string** | Status | [optional] [default to undefined]
+**provider** | **number** | Hosting Provider | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { HostingChangeResponseModel } from 'yellowgrid-api-ts';
+
+const instance: HostingChangeResponseModel = {
+    instanceId,
+    type,
+    progress,
+    status,
+    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/InstanceAutoFailoverEntity.md

@@ -0,0 +1,29 @@
+# InstanceAutoFailoverEntity
+
+InstanceFailoverIpsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**instanceId** | **string** | instanceId | [optional] [default to undefined]
+**reservedIp** | **string** | reservedIp | [optional] [default to undefined]
+**region** | **string** | region | [optional] [default to undefined]
+**price** | **number** | price | [optional] [default to undefined]
+**status** | **string** | status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InstanceAutoFailoverEntity } from 'yellowgrid-api-ts';
+
+const instance: InstanceAutoFailoverEntity = {
+    instanceId,
+    reservedIp,
+    region,
+    price,
+    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/InstanceDeletionScheduleEntity.md

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

@@ -0,0 +1,59 @@
+# InstanceEntity
+
+InstancesEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**instanceId** | **string** | instanceId | [optional] [default to undefined]
+**project** | **string** | project | [optional] [default to undefined]
+**region** | **string** | region | [optional] [default to undefined]
+**name** | **string** | name | [optional] [default to undefined]
+**hostname** | **string** | hostname | [optional] [default to undefined]
+**ipAddress** | **string** | ipAddress | [optional] [default to undefined]
+**flavor** | **string** | flavor | [optional] [default to undefined]
+**sshPassword** | **string** | sshPassword | [optional] [default to undefined]
+**putty** | **string** | putty | [optional] [default to undefined]
+**pkcs8** | **string** | pkcs8 | [optional] [default to undefined]
+**recordingsPath** | **string** | recordingsPath | [optional] [default to undefined]
+**additionalDisk** | **number** | additionalDisk | [optional] [default to undefined]
+**ahsayUser** | **string** | ahsayUser | [optional] [default to undefined]
+**ahsayPass** | **string** | ahsayPass | [optional] [default to undefined]
+**ahsayKey** | **string** | ahsayKey | [optional] [default to undefined]
+**scriptsStarted** | **string** | scriptsStarted | [optional] [default to undefined]
+**scriptFinished** | **string** | scriptFinished | [optional] [default to undefined]
+**creationDate** | **string** | creationDate | [optional] [default to undefined]
+**status** | **string** | status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InstanceEntity } from 'yellowgrid-api-ts';
+
+const instance: InstanceEntity = {
+    id,
+    instanceId,
+    project,
+    region,
+    name,
+    hostname,
+    ipAddress,
+    flavor,
+    sshPassword,
+    putty,
+    pkcs8,
+    recordingsPath,
+    additionalDisk,
+    ahsayUser,
+    ahsayPass,
+    ahsayKey,
+    scriptsStarted,
+    scriptFinished,
+    creationDate,
+    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/InstanceFailoverEntity.md

@@ -0,0 +1,41 @@
+# InstanceFailoverEntity
+
+InstanceFailoverEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**creation** | **string** | creation | [optional] [default to undefined]
+**instanceId** | **string** | instanceId | [optional] [default to undefined]
+**failoverInstanceId** | **string** | failoverInstanceId | [optional] [default to undefined]
+**platform** | **string** | platform | [optional] [default to undefined]
+**name** | **string** | name | [optional] [default to undefined]
+**ipAddress** | **string** | ipAddress | [optional] [default to undefined]
+**flavor** | **string** | flavor | [optional] [default to undefined]
+**image** | **string** | image | [optional] [default to undefined]
+**status** | **string** | status | [optional] [default to undefined]
+**failback** | **string** | failback | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InstanceFailoverEntity } from 'yellowgrid-api-ts';
+
+const instance: InstanceFailoverEntity = {
+    id,
+    creation,
+    instanceId,
+    failoverInstanceId,
+    platform,
+    name,
+    ipAddress,
+    flavor,
+    image,
+    status,
+    failback,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)