yellowgrid-api-ts 3.2.263 → 3.2.264-dev.0

package/docs/BillingApi.md

@@ -1,6 +1,6 @@
 # BillingApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -61,6 +61,7 @@ All URIs are relative to *https://bitbucket.org*
 |[**postUpdateRecurringCharge**](#postupdaterecurringcharge) | **POST** /billing/customer/updateRecurringCharges | |
 |[**putAddCallTariffToCallTariffPlan**](#putaddcalltarifftocalltariffplan) | **PUT** /billing/admin/callTariffPlan/callTariff | |
 |[**putAddServiceToServicePlan**](#putaddservicetoserviceplan) | **PUT** /billing/admin/servicePlan/service | |
+|[**putChangeParent**](#putchangeparent) | **PUT** /billing/admin/parent/change | |
 |[**putConnectionSearch**](#putconnectionsearch) | **PUT** /billing/admin/connections | |
 |[**putConvertChildToParent**](#putconvertchildtoparent) | **PUT** /billing/customer/makeParent | |
 |[**putDisableBundles**](#putdisablebundles) | **PUT** /billing/customer/disableBundles | |
@@ -1361,7 +1362,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(
@@ -1374,7 +1375,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|
 
 
@@ -1720,7 +1721,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
@@ -1731,7 +1732,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
@@ -3154,6 +3155,63 @@ 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)
 
+# **putChangeParent**
+> Customer putChangeParent()
+
+Change Parent
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+let parentId: number; //Parent ID (optional) (default to undefined)
+let childId: number; //Child ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.putChangeParent(
+    parentId,
+    childId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **parentId** | [**number**] | Parent ID | (optional) defaults to undefined|
+| **childId** | [**number**] | Child ID | (optional) defaults to undefined|
+
+
+### Return type
+
+**Customer**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Customer |  -  |
+|**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)
+
 # **putConnectionSearch**
 > OutboundCli putConnectionSearch(putConnectionSearchRequest)
 

package/docs/BrandedVideoSummaryDTO.md

@@ -0,0 +1,47 @@
+# BrandedVideoSummaryDTO
+
+Branded Video Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [default to undefined]
+**customerId** | **number** | Customer ID | [default to undefined]
+**company** | **string** | Company | [default to undefined]
+**type** | **string** | Type | [default to undefined]
+**video** | **string** | Video | [default to undefined]
+**email** | **string** | Email | [default to undefined]
+**website** | **string** | Website | [default to undefined]
+**telephone** | **string** | Telephone | [default to undefined]
+**invoiceNumber** | **string** | Invoice Number | [optional] [default to undefined]
+**requestDate** | **string** | Request Date | [optional] [default to undefined]
+**dueDate** | **string** | Due Date | [optional] [default to undefined]
+**oneDriveId** | **string** | OneDrive ID | [optional] [default to undefined]
+**status** | **string** | Status | [default to undefined]
+**notes** | **string** | Notes | [default to undefined]
+
+## Example
+
+```typescript
+import { BrandedVideoSummaryDTO } from 'yellowgrid-api-ts';
+
+const instance: BrandedVideoSummaryDTO = {
+    id,
+    customerId,
+    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 | [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,12 +1,13 @@
 # CRMApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**getGetCrmActivities**](#getgetcrmactivities) | **GET** /admin/crm/{id}/activities | |
 |[**getSearchByPhone**](#getsearchbyphone) | **GET** /crm/contact/search | |
 |[**postCreateCrmNote**](#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note | |
+|[**postJournalCall**](#postjournalcall) | **POST** /crm/contact/{id}/journal | |
 
 # **getGetCrmActivities**
 > CrmActivitiesResponseDTO getGetCrmActivities()
@@ -173,3 +174,61 @@ 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)
 
+# **postJournalCall**
+> CrmActivityDTO postJournalCall()
+
+Journal a phone call
+
+### Example
+
+```typescript
+import {
+    CRMApi,
+    Configuration,
+    CallJournalRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new CRMApi(configuration);
+
+let id: number; //Contact ID (default to undefined)
+let callJournalRequestModel: CallJournalRequestModel; //Journal Call Request (optional)
+
+const { status, data } = await apiInstance.postJournalCall(
+    id,
+    callJournalRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **callJournalRequestModel** | **CallJournalRequestModel**| Journal Call Request | |
+| **id** | [**number**] | Contact ID | defaults to undefined|
+
+
+### Return type
+
+**CrmActivityDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | CRM Contact |  -  |
+|**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)
+