yellowgrid-api-ts 3.0.79

package/docs/Class3CXIntegrationsApi.md

@@ -0,0 +1,344 @@
+# Class3CXIntegrationsApi
+
+All URIs are relative to *http://api.yellowgrid.local*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getGetPrice**](#getgetprice) | **GET** /tcx/integrations/edtechpro/prices | |
+|[**getGetSchools**](#getgetschools) | **GET** /tcx/integrations/edtechpro/schools | |
+|[**getGetTrusts**](#getgettrusts) | **GET** /tcx/integrations/edtechpro/trusts | |
+|[**patchUpdateEtpOrderReference**](#patchupdateetporderreference) | **PATCH** /tcx/integrations/edtechpro/{clientId}/schools/{schoolId}/orderReference | |
+|[**postOrderEdTechPro**](#postorderedtechpro) | **POST** /tcx/integrations/edtechpro/orders | |
+|[**postUpgradeEdTechPro**](#postupgradeedtechpro) | **POST** /tcx/integrations/edtechpro/upgrades | |
+
+# **getGetPrice**
+> GetGetPrice200Response getGetPrice()
+
+Get EdTechPro Schools
+
+### Example
+
+```typescript
+import {
+    Class3CXIntegrationsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXIntegrationsApi(configuration);
+
+let licenceType: 'lite' | 'pro'; //EdTechPro Licence Type (default to undefined)
+let schoolType: 'primary' | 'secondary'; //EdTechPro School Type (default to undefined)
+
+const { status, data } = await apiInstance.getGetPrice(
+    licenceType,
+    schoolType
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **licenceType** | [**&#39;lite&#39; | &#39;pro&#39;**]**Array<&#39;lite&#39; &#124; &#39;pro&#39;>** | EdTechPro Licence Type | defaults to undefined|
+| **schoolType** | [**&#39;primary&#39; | &#39;secondary&#39;**]**Array<&#39;primary&#39; &#124; &#39;secondary&#39;>** | EdTechPro School Type | defaults to undefined|
+
+
+### Return type
+
+**GetGetPrice200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | EdTech Pro Licence Price |  -  |
+
+[[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)
+
+# **getGetSchools**
+> EdTechProSchoolsModel getGetSchools()
+
+Get EdTechPro Schools
+
+### Example
+
+```typescript
+import {
+    Class3CXIntegrationsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXIntegrationsApi(configuration);
+
+let pageSize: number; //Number Of Results (optional) (default to 20)
+let page: number; //Page Number (optional) (default to 1)
+let search: string; //Search (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetSchools(
+    pageSize,
+    page,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
+| **page** | [**number**] | Page Number | (optional) defaults to 1|
+| **search** | [**string**] | Search | (optional) defaults to undefined|
+
+
+### Return type
+
+**EdTechProSchoolsModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | EdTechPro Schools |  -  |
+|**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)
+
+# **getGetTrusts**
+> Array<EdTechProClientEntity> getGetTrusts()
+
+Get EdTechPro Trusts
+
+### Example
+
+```typescript
+import {
+    Class3CXIntegrationsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXIntegrationsApi(configuration);
+
+const { status, data } = await apiInstance.getGetTrusts();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<EdTechProClientEntity>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | EdTechPro Trusts |  -  |
+|**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)
+
+# **patchUpdateEtpOrderReference**
+> patchUpdateEtpOrderReference()
+
+Update EdTechPro School Order Reference
+
+### Example
+
+```typescript
+import {
+    Class3CXIntegrationsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXIntegrationsApi(configuration);
+
+let clientId: number; //ETP Client ID (default to undefined)
+let schoolId: number; //ETP School ID (default to undefined)
+let ref: string; //School Order Reference (default to undefined)
+
+const { status, data } = await apiInstance.patchUpdateEtpOrderReference(
+    clientId,
+    schoolId,
+    ref
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clientId** | [**number**] | ETP Client ID | defaults to undefined|
+| **schoolId** | [**number**] | ETP School ID | defaults to undefined|
+| **ref** | [**string**] | School Order Reference | 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)
+
+# **postOrderEdTechPro**
+> EdTechProSetupModel postOrderEdTechPro()
+
+Setup a new EdTechPro Integration
+
+### Example
+
+```typescript
+import {
+    Class3CXIntegrationsApi,
+    Configuration,
+    OrderRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXIntegrationsApi(configuration);
+
+let orderRequestModel: OrderRequestModel; //New EdTechPro Order Request (optional)
+
+const { status, data } = await apiInstance.postOrderEdTechPro(
+    orderRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **orderRequestModel** | **OrderRequestModel**| New EdTechPro Order Request | |
+
+
+### Return type
+
+**EdTechProSetupModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | New EdTechPro Order 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)
+
+# **postUpgradeEdTechPro**
+> UpgradeOrderResponseModel postUpgradeEdTechPro()
+
+Upgrade an existing EdTechPro Integration
+
+### Example
+
+```typescript
+import {
+    Class3CXIntegrationsApi,
+    Configuration,
+    UpgradeRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXIntegrationsApi(configuration);
+
+let upgradeRequestModel: UpgradeRequestModel; //New EdTechPro Upgrade Request (optional)
+
+const { status, data } = await apiInstance.postUpgradeEdTechPro(
+    upgradeRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **upgradeRequestModel** | **UpgradeRequestModel**| New EdTechPro Upgrade Request | |
+
+
+### Return type
+
+**UpgradeOrderResponseModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Upgrade 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)
+