yellowgrid-api-ts 3.2.256 → 3.2.257-dev.0

package/docs/BrandedVideosApi.md

@@ -0,0 +1,424 @@
+# BrandedVideosApi
+
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteDeleteVideoRequest**](#deletedeletevideorequest) | **DELETE** /marketing/videos/{id} | |
+|[**getDownloadLogo**](#getdownloadlogo) | **GET** /marketing/videos/logo | |
+|[**getGetBrandedVideos**](#getgetbrandedvideos) | **GET** /marketing/videos | |
+|[**getGetThumbnails**](#getgetthumbnails) | **GET** /marketing/videos/thumbnails | |
+|[**postDownloadLogo**](#postdownloadlogo) | **POST** /marketing/videos/logo | |
+|[**postSendBrandedVideoEmail**](#postsendbrandedvideoemail) | **POST** /marketing/videos/{id}/send | |
+|[**postUploadVideo**](#postuploadvideo) | **POST** /marketing/videos/{id}/upload | |
+
+# **deleteDeleteVideoRequest**
+> deleteDeleteVideoRequest()
+
+Send Branded Video Email
+
+### Example
+
+```typescript
+import {
+    BrandedVideosApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BrandedVideosApi(configuration);
+
+let id: number; //Video ID (default to undefined)
+let customerId: number; //Customer ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.deleteDeleteVideoRequest(
+    id,
+    customerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Video ID | defaults to undefined|
+| **customerId** | [**number**] | Customer ID | (optional) 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)
+
+# **getDownloadLogo**
+> string getDownloadLogo()
+
+Get Customer Logo
+
+### Example
+
+```typescript
+import {
+    BrandedVideosApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BrandedVideosApi(configuration);
+
+let customerId: number; //Customer ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getDownloadLogo(
+    customerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
+
+
+### Return type
+
+**string**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Logo 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)
+
+# **getGetBrandedVideos**
+> BrandedVideosSummariesModel getGetBrandedVideos()
+
+Get Branded Videos
+
+### Example
+
+```typescript
+import {
+    BrandedVideosApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BrandedVideosApi(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)
+let type: 'paid' | 'reward' | 'sample'; //Type (optional) (default to undefined)
+let outstanding: boolean; //Outstanding (optional) (default to undefined)
+let overdue: boolean; //Overdue (optional) (default to undefined)
+let customerId: number; //Customer ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetBrandedVideos(
+    pageSize,
+    page,
+    search,
+    type,
+    outstanding,
+    overdue,
+    customerId
+);
+```
+
+### 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|
+| **type** | [**&#39;paid&#39; | &#39;reward&#39; | &#39;sample&#39;**]**Array<&#39;paid&#39; &#124; &#39;reward&#39; &#124; &#39;sample&#39;>** | Type | (optional) defaults to undefined|
+| **outstanding** | [**boolean**] | Outstanding | (optional) defaults to undefined|
+| **overdue** | [**boolean**] | Overdue | (optional) defaults to undefined|
+| **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
+
+
+### Return type
+
+**BrandedVideosSummariesModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Branded Video Summaries |  -  |
+|**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)
+
+# **getGetThumbnails**
+> Array<ThumbnailDTO> getGetThumbnails()
+
+Get Thumbnails
+
+### Example
+
+```typescript
+import {
+    BrandedVideosApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BrandedVideosApi(configuration);
+
+const { status, data } = await apiInstance.getGetThumbnails();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<ThumbnailDTO>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Thumbnails |  -  |
+|**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)
+
+# **postDownloadLogo**
+> postDownloadLogo()
+
+Upload logo
+
+### Example
+
+```typescript
+import {
+    BrandedVideosApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BrandedVideosApi(configuration);
+
+let logo: File; //Logo (default to undefined)
+let customerId: number; //Customer ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.postDownloadLogo(
+    logo,
+    customerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **logo** | [**File**] | Logo | defaults to undefined|
+| **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **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)
+
+# **postSendBrandedVideoEmail**
+> postSendBrandedVideoEmail()
+
+Send Branded Video Email
+
+### Example
+
+```typescript
+import {
+    BrandedVideosApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BrandedVideosApi(configuration);
+
+let email: string; //Email (default to undefined)
+let id: number; //Video ID (default to undefined)
+let customerId: number; //Customer ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.postSendBrandedVideoEmail(
+    email,
+    id,
+    customerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **email** | [**string**] | Email | defaults to undefined|
+| **id** | [**number**] | Video ID | defaults to undefined|
+| **customerId** | [**number**] | Customer ID | (optional) 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)
+
+# **postUploadVideo**
+> BrandedVideoSummaryDTO postUploadVideo()
+
+Upload Video
+
+### Example
+
+```typescript
+import {
+    BrandedVideosApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BrandedVideosApi(configuration);
+
+let thumbnailId: string; //Thumbnail ID (default to undefined)
+let id: number; //Video ID (default to undefined)
+let video: File; //Video (default to undefined)
+let customerId: number; //Customer ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.postUploadVideo(
+    thumbnailId,
+    id,
+    video,
+    customerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **thumbnailId** | [**string**] | Thumbnail ID | defaults to undefined|
+| **id** | [**number**] | Video ID | defaults to undefined|
+| **video** | [**File**] | Video | defaults to undefined|
+| **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
+
+
+### Return type
+
+**BrandedVideoSummaryDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Branded Video Summary |  -  |
+|**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/BrandedVideosSummariesModel.md

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

@@ -1,6 +1,6 @@
 # CRMApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/CallBarringModel.md

@@ -6,11 +6,11 @@ Call Barring
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**blockPremiumCalls** | **boolean** | Block Premium Calls | [optional] [default to true]
-**blockMobileCalls** | **boolean** | Block Mobile Calls | [optional] [default to false]
-**blockInternationalCalls** | **boolean** | Block International Calls | [optional] [default to false]
-**block084Calls** | **boolean** | Block 084 Calls | [optional] [default to false]
-**block087Calls** | **boolean** | Block 087 Calls | [optional] [default to false]
+**blockPremiumCalls** | **boolean** | Block Premium Calls | [default to true]
+**blockMobileCalls** | **boolean** | Block Mobile Calls | [default to false]
+**blockInternationalCalls** | **boolean** | Block International Calls | [default to false]
+**block084Calls** | **boolean** | Block 084 Calls | [default to false]
+**block087Calls** | **boolean** | Block 087 Calls | [default to false]
 
 ## Example
 

package/docs/Class3CXApi.md

@@ -1,6 +1,6 @@
 # Class3CXApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXInstallationWizardApi.md

@@ -1,6 +1,6 @@
 # Class3CXInstallationWizardApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -16,6 +16,7 @@ All URIs are relative to *https://bitbucket.org*
 |[**getGetHostingRegions**](#getgethostingregions) | **GET** /tcx/wizards/regions | Get 3CX Hosting Regions|
 |[**getGetInstallStatus**](#getgetinstallstatus) | **GET** /tcx/wizard/build/status | Get 3CX Instance Install Status|
 |[**getGetInstanceInstallStatus**](#getgetinstanceinstallstatus) | **GET** /tcx/wizards/instances/build/status | Get 3CX Instance Install Status|
+|[**getGetOrderItems**](#getgetorderitems) | **GET** /tcx/wizards/order/items | Get all items on the order linked to this wizard\'s licence key|
 |[**getGetPbxIpAddress**](#getgetpbxipaddress) | **GET** /tcx/wizards/instances/ip | Get PBX IP Address|
 |[**getGetSipTrunkTcxWizard**](#getgetsiptrunktcxwizard) | **GET** /tcx/wizards/sip/trunks/{id} | Get SIP Trunk|
 |[**getGetSipTrunksTcxWizard**](#getgetsiptrunkstcxwizard) | **GET** /tcx/wizards/sip/trunks | Get SIP Trunks|
@@ -654,6 +655,53 @@ No authorization required
 
 [[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)
 
+# **getGetOrderItems**
+> Array<ItemEntity> getGetOrderItems()
+
+Get all items on the order linked to the wizard licence key
+
+### Example
+
+```typescript
+import {
+    Class3CXInstallationWizardApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXInstallationWizardApi(configuration);
+
+const { status, data } = await apiInstance.getGetOrderItems();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<ItemEntity>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Order Items |  -  |
+|**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)
+
 # **getGetPbxIpAddress**
 > string getGetPbxIpAddress()
 

package/docs/Class3CXInstallationsApi.md

@@ -1,6 +1,6 @@
 # Class3CXInstallationsApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXIntegrationsApi.md

@@ -1,12 +1,13 @@
 # Class3CXIntegrationsApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |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 | |
+|[**getSearchSchools**](#getsearchschools) | **GET** /tcx/integrations/edtechpro/search/schools | |
 |[**patchUpdateEtpOrderReference**](#patchupdateetporderreference) | **PATCH** /tcx/integrations/edtechpro/{clientId}/schools/{schoolId}/orderReference | |
 |[**postOrderEdTechPro**](#postorderedtechpro) | **POST** /tcx/integrations/edtechpro/orders | |
 |[**postUpgradeEdTechPro**](#postupgradeedtechpro) | **POST** /tcx/integrations/edtechpro/upgrades | |
@@ -172,6 +173,57 @@ No authorization required
 
 [[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)
 
+# **getSearchSchools**
+> Array<SearchSchoolModel> getSearchSchools()
+
+Seach EdTechPro Schools
+
+### Example
+
+```typescript
+import {
+    Class3CXIntegrationsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXIntegrationsApi(configuration);
+
+let search: string; //School Name, Dfe code or URN (default to undefined)
+
+const { status, data } = await apiInstance.getSearchSchools(
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **search** | [**string**] | School Name, Dfe code or URN | defaults to undefined|
+
+
+### Return type
+
+**Array<SearchSchoolModel>**
+
+### 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 |  -  |
+
+[[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()
 

package/docs/Class3CXMultiTenantApi.md

@@ -1,6 +1,6 @@
 # Class3CXMultiTenantApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ClientDetailsModel.md

@@ -6,13 +6,13 @@ Client Details
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**clientId** | **string** | Client ID | [optional] [default to undefined]
-**userId** | **number** | User ID | [optional] [default to undefined]
-**email** | **string** | Email Address | [optional] [default to undefined]
-**customerId** | **number** | Customer ID | [optional] [default to undefined]
-**xeroId** | **string** | Xero ID | [optional] [default to undefined]
-**firstName** | **string** | User First Name | [optional] [default to undefined]
-**lastName** | **string** | User Last Name | [optional] [default to undefined]
+**clientId** | **string** | Client ID | [default to undefined]
+**userId** | **number** | User ID | [default to undefined]
+**email** | **string** | Email Address | [default to undefined]
+**customerId** | **number** | Customer ID | [default to undefined]
+**xeroId** | **string** | Xero ID | [default to undefined]
+**firstName** | **string** | User First Name | [default to undefined]
+**lastName** | **string** | User Last Name | [default to undefined]
 
 ## Example
 

package/docs/ClientModel.md

@@ -6,10 +6,10 @@ OAuth client details
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**scopes** | **Array<string>** | OAuth 2.0 Scopes | [optional] [default to undefined]
-**client_id** | **string** | OAuth 2.0 Client ID | [optional] [default to undefined]
-**client_secret** | **string** | OAuth 2.0 Client Secret | [optional] [default to undefined]
-**created** | **string** | Creation Date | [optional] [default to undefined]
+**scopes** | **Array<string>** | OAuth 2.0 Scopes | [default to undefined]
+**client_id** | **string** | OAuth 2.0 Client ID | [default to undefined]
+**client_secret** | **string** | OAuth 2.0 Client Secret | [default to undefined]
+**created** | **string** | Creation Date | [default to undefined]
 
 ## Example