yellowgrid-api-ts 3.0.79

package/docs/TelephonySupportTicketModel.md

@@ -0,0 +1,41 @@
+# TelephonySupportTicketModel
+
+Telephony Support Ticket
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Ticket ID | [optional] [default to undefined]
+**status** | **string** | Ticket status | [optional] [default to undefined]
+**statusId** | **number** | Ticket status ID | [optional] [default to undefined]
+**subject** | **string** | Ticket subject | [optional] [default to undefined]
+**supportEmail** | **string** | Support email address | [optional] [default to undefined]
+**toEmails** | **Array<string>** | Recipient emails | [optional] [default to undefined]
+**description** | **string** | Ticket description (HTML) | [optional] [default to undefined]
+**descriptionText** | **string** | Ticket description (plain text) | [optional] [default to undefined]
+**createdAt** | **string** | Creation timestamp | [optional] [default to undefined]
+**attachments** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [optional] [default to undefined]
+**conversations** | [**Array<ConversationModel>**](ConversationModel.md) | Conversations | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TelephonySupportTicketModel } from 'yellowgrid-api-ts';
+
+const instance: TelephonySupportTicketModel = {
+    id,
+    status,
+    statusId,
+    subject,
+    supportEmail,
+    toEmails,
+    description,
+    descriptionText,
+    createdAt,
+    attachments,
+    conversations,
+};
+```
+
+[[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/TicketSummaryModel.md

@@ -0,0 +1,35 @@
+# TicketSummaryModel
+
+Ticket Summary Model
+
+## 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]
+**statusText** | **string** | Status Text | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TicketSummaryModel } from 'yellowgrid-api-ts';
+
+const instance: TicketSummaryModel = {
+    id,
+    subject,
+    companyId,
+    groupId,
+    productId,
+    statusId,
+    lastUpdated,
+    statusText,
+};
+```
+
+[[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/TicketTimeDTO.md

@@ -0,0 +1,36 @@
+# TicketTimeDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
+**ticketUrl** | **string** | Ticket URL | [optional] [default to undefined]
+**created** | **string** | Date Time | [optional] [default to undefined]
+**contactName** | **string** | Contact Name | [optional] [default to undefined]
+**agentName** | **string** | Agent Name | [optional] [default to undefined]
+**status** | **string** | Status | [optional] [default to undefined]
+**subject** | **string** | Ticket Subject | [optional] [default to undefined]
+**supportBankTime** | **string** | Support Bank Time | [optional] [default to undefined]
+**fixedPriceTime** | **string** | Fixed Price Time | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TicketTimeDTO } from 'yellowgrid-api-ts';
+
+const instance: TicketTimeDTO = {
+    ticketId,
+    ticketUrl,
+    created,
+    contactName,
+    agentName,
+    status,
+    subject,
+    supportBankTime,
+    fixedPriceTime,
+};
+```
+
+[[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/TicketsApi.md

@@ -0,0 +1,300 @@
+# TicketsApi
+
+All URIs are relative to *http://api.yellowgrid.local*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getCreateTicket**](#getcreateticket) | **GET** /tickets/support | |
+|[**getGetTicket**](#getgetticket) | **GET** /tickets/support/{id} | |
+|[**patchCloseTicket**](#patchcloseticket) | **PATCH** /tickets/support/{id}/close | |
+|[**postCreateTicket**](#postcreateticket) | **POST** /tickets/support | |
+|[**postTicketReply**](#postticketreply) | **POST** /tickets/support/{id}/reply | |
+
+# **getCreateTicket**
+> FreshdeskCompanyTicketsModel getCreateTicket()
+
+Get all telephony support tickets for your company
+
+### Example
+
+```typescript
+import {
+    TicketsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new TicketsApi(configuration);
+
+let search: string; //Search (optional) (default to undefined)
+let pageSize: number; //Number Of Results (optional) (default to 20)
+let page: number; //Page Number (optional) (default to 1)
+
+const { status, data } = await apiInstance.getCreateTicket(
+    search,
+    pageSize,
+    page
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **search** | [**string**] | Search | (optional) defaults to undefined|
+| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
+| **page** | [**number**] | Page Number | (optional) defaults to 1|
+
+
+### Return type
+
+**FreshdeskCompanyTicketsModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Freshdesk Company Tickets |  -  |
+|**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)
+
+# **getGetTicket**
+> TelephonySupportTicketModel getGetTicket()
+
+Retrieve a telephony support ticket
+
+### Example
+
+```typescript
+import {
+    TicketsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new TicketsApi(configuration);
+
+let id: number; //Ticket ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetTicket(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Ticket ID | defaults to undefined|
+
+
+### Return type
+
+**TelephonySupportTicketModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Accounts |  -  |
+|**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)
+
+# **patchCloseTicket**
+> TelephonySupportTicketModel patchCloseTicket()
+
+Close a telephony support ticket
+
+### Example
+
+```typescript
+import {
+    TicketsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new TicketsApi(configuration);
+
+let id: number; //Ticket ID (default to undefined)
+
+const { status, data } = await apiInstance.patchCloseTicket(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Ticket ID | defaults to undefined|
+
+
+### Return type
+
+**TelephonySupportTicketModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Accounts |  -  |
+|**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)
+
+# **postCreateTicket**
+> TelephonySupportTicketModel postCreateTicket()
+
+Create a new telephony support ticket
+
+### Example
+
+```typescript
+import {
+    TicketsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new TicketsApi(configuration);
+
+let subject: string; //Ticket Subject (optional) (default to undefined)
+let message: string; //Ticket Message (optional) (default to undefined)
+let attachments: Array<File>; //Attachments (up to 20MB combined) (optional) (default to undefined)
+
+const { status, data } = await apiInstance.postCreateTicket(
+    subject,
+    message,
+    attachments
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **subject** | [**string**] | Ticket Subject | (optional) defaults to undefined|
+| **message** | [**string**] | Ticket Message | (optional) defaults to undefined|
+| **attachments** | **Array&lt;File&gt;** | Attachments (up to 20MB combined) | (optional) defaults to undefined|
+
+
+### Return type
+
+**TelephonySupportTicketModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Accounts |  -  |
+|**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)
+
+# **postTicketReply**
+> TelephonySupportTicketModel postTicketReply()
+
+Reply to a telephony support ticket
+
+### Example
+
+```typescript
+import {
+    TicketsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new TicketsApi(configuration);
+
+let id: number; //Ticket ID (default to undefined)
+let body: string; //Reply Body (optional) (default to undefined)
+let attachments: Array<File>; //Attachments (up to 20MB combined) (optional) (default to undefined)
+
+const { status, data } = await apiInstance.postTicketReply(
+    id,
+    body,
+    attachments
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Ticket ID | defaults to undefined|
+| **body** | [**string**] | Reply Body | (optional) defaults to undefined|
+| **attachments** | **Array&lt;File&gt;** | Attachments (up to 20MB combined) | (optional) defaults to undefined|
+
+
+### Return type
+
+**TelephonySupportTicketModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Accounts |  -  |
+|**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/TokenResponseModel.md

@@ -0,0 +1,25 @@
+# TokenResponseModel
+
+OAuth Token Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token_type** | **string** | Access Token Type | [optional] [default to 'Bearer']
+**expires_in** | **number** | Seconds until expiry | [optional] [default to undefined]
+**access_token** | **string** | Access Token | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TokenResponseModel } from 'yellowgrid-api-ts';
+
+const instance: TokenResponseModel = {
+    token_type,
+    expires_in,
+    access_token,
+};
+```
+
+[[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/UpgradeOrderResponseModel.md

@@ -0,0 +1,23 @@
+# UpgradeOrderResponseModel
+
+EdTechPro Upgrade Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Response Message | [optional] [default to undefined]
+**templateUrl** | **string** | Integration Template URL | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpgradeOrderResponseModel } from 'yellowgrid-api-ts';
+
+const instance: UpgradeOrderResponseModel = {
+    message,
+    templateUrl,
+};
+```
+
+[[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/UpgradeRequestModel.md

@@ -0,0 +1,27 @@
+# UpgradeRequestModel
+
+EdTechPro Upgrade Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clientId** | **number** | Client/Trust ID | [optional] [default to undefined]
+**schoolId** | **number** | School Id | [optional] [default to undefined]
+**licenceType** | **string** | Licence Type | [optional] [default to undefined]
+**schoolType** | **string** | School Type | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpgradeRequestModel } from 'yellowgrid-api-ts';
+
+const instance: UpgradeRequestModel = {
+    clientId,
+    schoolId,
+    licenceType,
+    schoolType,
+};
+```
+
+[[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/UserEntity.md

@@ -0,0 +1,39 @@
+# UserEntity
+
+UsersEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**realName** | **string** | realName | [optional] [default to undefined]
+**extNo** | **number** | extNo | [optional] [default to undefined]
+**username** | **string** | username | [optional] [default to undefined]
+**password** | **string** | password | [optional] [default to undefined]
+**email** | **string** | email | [optional] [default to undefined]
+**mobile** | **string** | mobile | [optional] [default to undefined]
+**level** | **number** | level | [optional] [default to undefined]
+**active** | **number** | active | [optional] [default to undefined]
+**image** | **string** | image | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserEntity } from 'yellowgrid-api-ts';
+
+const instance: UserEntity = {
+    id,
+    realName,
+    extNo,
+    username,
+    password,
+    email,
+    mobile,
+    level,
+    active,
+    image,
+};
+```
+
+[[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/WebhooksApi.md

@@ -0,0 +1,117 @@
+# WebhooksApi
+
+All URIs are relative to *http://api.yellowgrid.local*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteRevokeWebhook**](#deleterevokewebhook) | **DELETE** /webhooks/delete | Delete an authenticated webhook URL|
+|[**postAddWebhook**](#postaddwebhook) | **POST** /webhooks/add | Create an authenticated webhook URL|
+
+# **deleteRevokeWebhook**
+> deleteRevokeWebhook()
+
+Delete an authenticated webhook URL
+
+### Example
+
+```typescript
+import {
+    WebhooksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new WebhooksApi(configuration);
+
+let authKey: string; //Webhook Authentication Key (default to undefined)
+
+const { status, data } = await apiInstance.deleteRevokeWebhook(
+    authKey
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **authKey** | [**string**] | Webhook Authentication Key | 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 |
+|-------------|-------------|------------------|
+|**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)
+
+# **postAddWebhook**
+> PostAddWebhook200Response postAddWebhook()
+
+Create an authenticated webhook URL
+
+### Example
+
+```typescript
+import {
+    WebhooksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new WebhooksApi(configuration);
+
+let webhookUri: '/webhook/composer/install' | '/webhook/freshdesk/create' | '/webhook/freshdesk/update' | '/webhook/test' | '/webhook/xero/invoices' | '/webhook/tcx/phones/add'; //Webhook URI (default to undefined)
+
+const { status, data } = await apiInstance.postAddWebhook(
+    webhookUri
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **webhookUri** | [**&#39;/webhook/composer/install&#39; | &#39;/webhook/freshdesk/create&#39; | &#39;/webhook/freshdesk/update&#39; | &#39;/webhook/test&#39; | &#39;/webhook/xero/invoices&#39; | &#39;/webhook/tcx/phones/add&#39;**]**Array<&#39;/webhook/composer/install&#39; &#124; &#39;/webhook/freshdesk/create&#39; &#124; &#39;/webhook/freshdesk/update&#39; &#124; &#39;/webhook/test&#39; &#124; &#39;/webhook/xero/invoices&#39; &#124; &#39;/webhook/tcx/phones/add&#39;>** | Webhook URI | defaults to undefined|
+
+
+### Return type
+
+**PostAddWebhook200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Webhook URL |  -  |
+|**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/XeroLogEntity.md

@@ -0,0 +1,39 @@
+# XeroLogEntity
+
+XeroLogEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**url** | **string** | url | [optional] [default to undefined]
+**method** | **string** | method | [optional] [default to undefined]
+**response** | **number** | response | [optional] [default to undefined]
+**retry** | **number** | retry | [optional] [default to undefined]
+**minuteLimit** | **number** | minuteLimit | [optional] [default to undefined]
+**dayLimit** | **number** | dayLimit | [optional] [default to undefined]
+**requester** | **number** | requester | [optional] [default to undefined]
+**timestamp** | **string** | timestamp | [optional] [default to undefined]
+**clientId** | **string** | clientId | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { XeroLogEntity } from 'yellowgrid-api-ts';
+
+const instance: XeroLogEntity = {
+    id,
+    url,
+    method,
+    response,
+    retry,
+    minuteLimit,
+    dayLimit,
+    requester,
+    timestamp,
+    clientId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)