yellowgrid-api-ts 3.2.247-dev.0 → 3.2.248-dev.0

package/docs/BillingApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**deleteAddRecurringCharge**](#deleteaddrecurringcharge) | **DELETE** /billing/customer/recurringCharges | |
 |[**deleteAddServiceToServicePlan**](#deleteaddservicetoserviceplan) | **DELETE** /billing/admin/servicePlan/service | |
 |[**deleteCloseAccount**](#deletecloseaccount) | **DELETE** /billing/customer/customer | |
+|[**deleteDeleteCallTariffId**](#deletedeletecalltariffid) | **DELETE** /billing/admin/callTariffPlan/callTariff/{id} | |
 |[**deleteGetBaseServices**](#deletegetbaseservices) | **DELETE** /billing/admin/baseServices | |
 |[**deleteGetCallTariffPlan**](#deletegetcalltariffplan) | **DELETE** /billing/admin/callTariffPlan | |
 |[**deleteGetPriceGroups**](#deletegetpricegroups) | **DELETE** /billing/admin/priceGroups | |
@@ -293,6 +294,60 @@ 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)
 
+# **deleteDeleteCallTariffId**
+> boolean deleteDeleteCallTariffId()
+
+Delete Call Tariff By ID
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+let id: number; //Call Tariff ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteDeleteCallTariffId(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Call Tariff ID | defaults to undefined|
+
+
+### Return type
+
+**boolean**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful |  -  |
+|**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)
+
 # **deleteGetBaseServices**
 > boolean deleteGetBaseServices()
 
@@ -946,7 +1001,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new BillingApi(configuration);
 
-let billCustomerId: number; //Customer ID (optional) (default to undefined)
+let billCustomerId: string; //Customer ID (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getGetBillingCustomerDetails(
     billCustomerId
@@ -957,7 +1012,7 @@ const { status, data } = await apiInstance.getGetBillingCustomerDetails(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
+| **billCustomerId** | [**string**] | Customer ID | (optional) defaults to undefined|
 
 
 ### Return type
@@ -1306,7 +1361,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new BillingApi(configuration);
 
-let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Other' | 'Recurring Charges'; //Connection Type (optional) (default to undefined)
+let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Recurring Charges' | 'SMS' | 'CFD' | 'EdTechPro'; //Connection Type (optional) (default to undefined)
 let billCustomerId: number; //Customer ID (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getGetConnections(
@@ -1319,7 +1374,7 @@ const { status, data } = await apiInstance.getGetConnections(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **type** | [**&#39;SIP Trunks&#39; | &#39;Broadband&#39; | &#39;Ethernet&#39; | &#39;Mobile&#39; | &#39;WLR&#39; | &#39;Horizon&#39; | &#39;NTS&#39; | &#39;Hosting&#39; | &#39;CRM&#39; | &#39;Starter Bundle&#39; | &#39;Other&#39; | &#39;Recurring Charges&#39;**]**Array<&#39;SIP Trunks&#39; &#124; &#39;Broadband&#39; &#124; &#39;Ethernet&#39; &#124; &#39;Mobile&#39; &#124; &#39;WLR&#39; &#124; &#39;Horizon&#39; &#124; &#39;NTS&#39; &#124; &#39;Hosting&#39; &#124; &#39;CRM&#39; &#124; &#39;Starter Bundle&#39; &#124; &#39;Other&#39; &#124; &#39;Recurring Charges&#39;>** | Connection Type | (optional) defaults to undefined|
+| **type** | [**&#39;SIP Trunks&#39; | &#39;Broadband&#39; | &#39;Ethernet&#39; | &#39;Mobile&#39; | &#39;WLR&#39; | &#39;Horizon&#39; | &#39;NTS&#39; | &#39;Hosting&#39; | &#39;CRM&#39; | &#39;Starter Bundle&#39; | &#39;Recurring Charges&#39; | &#39;SMS&#39; | &#39;CFD&#39; | &#39;EdTechPro&#39;**]**Array<&#39;SIP Trunks&#39; &#124; &#39;Broadband&#39; &#124; &#39;Ethernet&#39; &#124; &#39;Mobile&#39; &#124; &#39;WLR&#39; &#124; &#39;Horizon&#39; &#124; &#39;NTS&#39; &#124; &#39;Hosting&#39; &#124; &#39;CRM&#39; &#124; &#39;Starter Bundle&#39; &#124; &#39;Recurring Charges&#39; &#124; &#39;SMS&#39; &#124; &#39;CFD&#39; &#124; &#39;EdTechPro&#39;>** | Connection Type | (optional) defaults to undefined|
 | **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
 
 
@@ -1665,7 +1720,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new BillingApi(configuration);
 
-let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Other' | 'Recurring Charges'; //Connection Type (optional) (default to undefined)
+let type: 'SIP Trunks' | 'Broadband' | 'Ethernet' | 'Mobile' | 'WLR' | 'Horizon' | 'NTS' | 'Hosting' | 'CRM' | 'Starter Bundle' | 'Recurring Charges' | 'SMS' | 'CFD' | 'EdTechPro'; //Connection Type (optional) (default to undefined)
 
 const { status, data } = await apiInstance.getGetServicesPlanDetails(
     type
@@ -1676,7 +1731,7 @@ const { status, data } = await apiInstance.getGetServicesPlanDetails(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **type** | [**&#39;SIP Trunks&#39; | &#39;Broadband&#39; | &#39;Ethernet&#39; | &#39;Mobile&#39; | &#39;WLR&#39; | &#39;Horizon&#39; | &#39;NTS&#39; | &#39;Hosting&#39; | &#39;CRM&#39; | &#39;Starter Bundle&#39; | &#39;Other&#39; | &#39;Recurring Charges&#39;**]**Array<&#39;SIP Trunks&#39; &#124; &#39;Broadband&#39; &#124; &#39;Ethernet&#39; &#124; &#39;Mobile&#39; &#124; &#39;WLR&#39; &#124; &#39;Horizon&#39; &#124; &#39;NTS&#39; &#124; &#39;Hosting&#39; &#124; &#39;CRM&#39; &#124; &#39;Starter Bundle&#39; &#124; &#39;Other&#39; &#124; &#39;Recurring Charges&#39;>** | Connection Type | (optional) defaults to undefined|
+| **type** | [**&#39;SIP Trunks&#39; | &#39;Broadband&#39; | &#39;Ethernet&#39; | &#39;Mobile&#39; | &#39;WLR&#39; | &#39;Horizon&#39; | &#39;NTS&#39; | &#39;Hosting&#39; | &#39;CRM&#39; | &#39;Starter Bundle&#39; | &#39;Recurring Charges&#39; | &#39;SMS&#39; | &#39;CFD&#39; | &#39;EdTechPro&#39;**]**Array<&#39;SIP Trunks&#39; &#124; &#39;Broadband&#39; &#124; &#39;Ethernet&#39; &#124; &#39;Mobile&#39; &#124; &#39;WLR&#39; &#124; &#39;Horizon&#39; &#124; &#39;NTS&#39; &#124; &#39;Hosting&#39; &#124; &#39;CRM&#39; &#124; &#39;Starter Bundle&#39; &#124; &#39;Recurring Charges&#39; &#124; &#39;SMS&#39; &#124; &#39;CFD&#39; &#124; &#39;EdTechPro&#39;>** | Connection Type | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/BrandedVideoSummaryDTO.md

@@ -0,0 +1,45 @@
+# BrandedVideoSummaryDTO
+
+Branded Video Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
+**company** | **string** | Company | [optional] [default to undefined]
+**type** | **string** | Type | [optional] [default to undefined]
+**video** | **string** | Video | [optional] [default to undefined]
+**email** | **string** | Email | [optional] [default to undefined]
+**website** | **string** | Website | [optional] [default to undefined]
+**telephone** | **string** | Telephone | [optional] [default to undefined]
+**invoiceNumber** | **string** | Invoice Number | [optional] [default to undefined]
+**requestDate** | **string** | Date Time | [optional] [default to undefined]
+**dueDate** | **string** | Date Time | [optional] [default to undefined]
+**oneDriveId** | **string** | OneDrive ID | [optional] [default to undefined]
+**status** | **string** | Status | [optional] [default to undefined]
+**notes** | **string** | Notes | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BrandedVideoSummaryDTO } from 'yellowgrid-api-ts';
+
+const instance: BrandedVideoSummaryDTO = {
+    id,
+    company,
+    type,
+    video,
+    email,
+    website,
+    telephone,
+    invoiceNumber,
+    requestDate,
+    dueDate,
+    oneDriveId,
+    status,
+    notes,
+};
+```
+
+[[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/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 | [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 { 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/CallBarringModel.md

@@ -6,11 +6,11 @@ Call Barring
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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]
+**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]
 
 ## Example
 

package/docs/ClientDetailsModel.md

@@ -6,13 +6,13 @@ Client Details
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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]
+**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]
 
 ## Example
 

package/docs/ClientModel.md

@@ -6,10 +6,10 @@ OAuth client details
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**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]
+**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]
 
 ## Example