yellowgrid-api-ts 3.2.255 → 3.2.256-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|
 |------------- | ------------- | -------------|
@@ -8,6 +8,7 @@ All URIs are relative to *https://bitbucket.org*
 |[**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 | |
@@ -16,8 +17,6 @@ All URIs are relative to *https://bitbucket.org*
 |[**getAddServiceToServicePlan**](#getaddservicetoserviceplan) | **GET** /billing/admin/servicePlan/service | |
 |[**getAddSipTrunkDDIs**](#getaddsiptrunkddis) | **GET** /billing/customer/sipTrunkDDIs | |
 |[**getConnectionSearch**](#getconnectionsearch) | **GET** /billing/admin/connections | |
-|[**getDisconnectConnection**](#getdisconnectconnection) | **GET** /billing/customer/disconnectConnection | |
-|[**getDisconnectDDI**](#getdisconnectddi) | **GET** /billing/customer/disconnectDDI | |
 |[**getGetAllCustomer**](#getgetallcustomer) | **GET** /billing/admin/customerList | Get Billing Customers|
 |[**getGetAllMtSipTrunks**](#getgetallmtsiptrunks) | **GET** /billing/customer/list/allMtSipTrunks | |
 |[**getGetAllSipTrunks**](#getgetallsiptrunks) | **GET** /billing/customer/list/allSipTrunks | |
@@ -28,6 +27,7 @@ All URIs are relative to *https://bitbucket.org*
 |[**getGetCallTariffs**](#getgetcalltariffs) | **GET** /billing/admin/callTariffs | |
 |[**getGetCallTariffsDetails**](#getgetcalltariffsdetails) | **GET** /billing/admin/callTariffs/details | |
 |[**getGetChildren**](#getgetchildren) | **GET** /billing/customer/children | |
+|[**getGetConnection**](#getgetconnection) | **GET** /billing/customer/connections/{id} | |
 |[**getGetConnections**](#getgetconnections) | **GET** /billing/customer/connections | |
 |[**getGetCustomer**](#getgetcustomer) | **GET** /billing/admin/customer | |
 |[**getGetInboundTariffs**](#getgetinboundtariffs) | **GET** /billing/admin/inboundTariffs | |
@@ -48,6 +48,8 @@ All URIs are relative to *https://bitbucket.org*
 |[**postAddRecurringCharge**](#postaddrecurringcharge) | **POST** /billing/customer/recurringCharges | |
 |[**postAddServiceToServicePlan**](#postaddservicetoserviceplan) | **POST** /billing/admin/servicePlan/service | |
 |[**postAddSipTrunkDDIs**](#postaddsiptrunkddis) | **POST** /billing/customer/sipTrunkDDIs | |
+|[**postDisconnectConnection**](#postdisconnectconnection) | **POST** /billing/customer/disconnectConnection | |
+|[**postDisconnectDDI**](#postdisconnectddi) | **POST** /billing/customer/disconnectDDI | |
 |[**postGetBaseServices**](#postgetbaseservices) | **POST** /billing/admin/baseServices | |
 |[**postGetCallTariffPlan**](#postgetcalltariffplan) | **POST** /billing/admin/callTariffPlan | |
 |[**postGetConnections**](#postgetconnections) | **POST** /billing/customer/connections | |
@@ -292,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()
 
@@ -727,122 +783,6 @@ 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)
 
-# **getDisconnectConnection**
-> number getDisconnectConnection(getDisconnectDDIRequest)
-
-Disconnect Connection
-
-### Example
-
-```typescript
-import {
-    BillingApi,
-    Configuration,
-    GetDisconnectDDIRequest
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new BillingApi(configuration);
-
-let getDisconnectDDIRequest: GetDisconnectDDIRequest; //
-let billCustomerId: number; //Customer ID (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getDisconnectConnection(
-    getDisconnectDDIRequest,
-    billCustomerId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **getDisconnectDDIRequest** | **GetDisconnectDDIRequest**|  | |
-| **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
-
-
-### Return type
-
-**number**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Connection ID |  -  |
-|**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)
-
-# **getDisconnectDDI**
-> number getDisconnectDDI(getDisconnectDDIRequest)
-
-Disconnect DDI
-
-### Example
-
-```typescript
-import {
-    BillingApi,
-    Configuration,
-    GetDisconnectDDIRequest
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new BillingApi(configuration);
-
-let getDisconnectDDIRequest: GetDisconnectDDIRequest; //
-let billCustomerId: number; //Customer ID (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getDisconnectDDI(
-    getDisconnectDDIRequest,
-    billCustomerId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **getDisconnectDDIRequest** | **GetDisconnectDDIRequest**|  | |
-| **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
-
-
-### Return type
-
-**number**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | DDI ID |  -  |
-|**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)
-
 # **getGetAllCustomer**
 > { [key: string]: { [key: string]: string; }; } getGetAllCustomer()
 
@@ -1061,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
@@ -1072,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
@@ -1348,6 +1288,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)
 
+# **getGetConnection**
+> OutboundCli getGetConnection()
+
+Get Connection
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+let id: number; //Connection ID (default to undefined)
+let billCustomerId: number; //Customer ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetConnection(
+    id,
+    billCustomerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Connection ID | defaults to undefined|
+| **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
+
+
+### Return type
+
+**OutboundCli**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Connection |  -  |
+|**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)
+
 # **getGetConnections**
 > Array<OutboundCli> getGetConnections()
 
@@ -1364,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(
@@ -1377,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|
 
 
@@ -1723,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
@@ -1734,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
@@ -1917,7 +1914,7 @@ 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)
 
 # **getGetUnconnectedServices**
-> Array<ProcessedCdr> getGetUnconnectedServices()
+> Array<UnconnectedSdr> getGetUnconnectedServices()
 
 Get Unconnected Services
 
@@ -1941,7 +1938,7 @@ This endpoint does not have any parameters.
 
 ### Return type
 
-**Array<ProcessedCdr>**
+**Array<UnconnectedSdr>**
 
 ### Authorization
 
@@ -1956,7 +1953,7 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Process CDR |  -  |
+|**200** | Unconnected SDR |  -  |
 |**400** | Bad Request |  -  |
 |**401** | Unauthorised |  -  |
 |**403** | Access Denied |  -  |
@@ -2420,6 +2417,122 @@ 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)
 
+# **postDisconnectConnection**
+> number postDisconnectConnection(postDisconnectDDIRequest)
+
+Disconnect Connection
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration,
+    PostDisconnectDDIRequest
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+let postDisconnectDDIRequest: PostDisconnectDDIRequest; //
+let billCustomerId: number; //Customer ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.postDisconnectConnection(
+    postDisconnectDDIRequest,
+    billCustomerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **postDisconnectDDIRequest** | **PostDisconnectDDIRequest**|  | |
+| **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
+
+
+### Return type
+
+**number**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Connection ID |  -  |
+|**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)
+
+# **postDisconnectDDI**
+> number postDisconnectDDI(postDisconnectDDIRequest)
+
+Disconnect DDI
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration,
+    PostDisconnectDDIRequest
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+let postDisconnectDDIRequest: PostDisconnectDDIRequest; //
+let billCustomerId: number; //Customer ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.postDisconnectDDI(
+    postDisconnectDDIRequest,
+    billCustomerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **postDisconnectDDIRequest** | **PostDisconnectDDIRequest**|  | |
+| **billCustomerId** | [**number**] | Customer ID | (optional) defaults to undefined|
+
+
+### Return type
+
+**number**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | DDI ID |  -  |
+|**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)
+
 # **postGetBaseServices**
 > Service postGetBaseServices(postGetBaseServicesRequest)
 

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)