yellowgrid-api-ts 3.2.244 → 3.2.246-dev.0

package/docs/PromotionsApi.md

@@ -0,0 +1,241 @@
+# PromotionsApi
+
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getGetPromo**](#getgetpromo) | **GET** /marketing/promos/{id} | |
+|[**getGetPromos**](#getgetpromos) | **GET** /marketing/promos | |
+|[**postGetPromos**](#postgetpromos) | **POST** /marketing/promos | |
+|[**putGetPromo**](#putgetpromo) | **PUT** /marketing/promos/{id} | |
+
+# **getGetPromo**
+> PromoModel getGetPromo()
+
+Get a promotion
+
+### Example
+
+```typescript
+import {
+    PromotionsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new PromotionsApi(configuration);
+
+let id: number; //Promo ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetPromo(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Promo ID | defaults to undefined|
+
+
+### Return type
+
+**PromoModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Promotion |  -  |
+|**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)
+
+# **getGetPromos**
+> PromoSummariesModel getGetPromos()
+
+Get Promos
+
+### Example
+
+```typescript
+import {
+    PromotionsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new PromotionsApi(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 expired: boolean; //Expired (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetPromos(
+    pageSize,
+    page,
+    search,
+    expired
+);
+```
+
+### 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|
+| **expired** | [**boolean**] | Expired | (optional) defaults to undefined|
+
+
+### Return type
+
+**PromoSummariesModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Promo 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)
+
+# **postGetPromos**
+> PromoModel postGetPromos()
+
+Create a promotion
+
+### Example
+
+```typescript
+import {
+    PromotionsApi,
+    Configuration,
+    PromoModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new PromotionsApi(configuration);
+
+let promoModel: PromoModel; //Promotion (optional)
+
+const { status, data } = await apiInstance.postGetPromos(
+    promoModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promoModel** | **PromoModel**| Promotion | |
+
+
+### Return type
+
+**PromoModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Promotion |  -  |
+|**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)
+
+# **putGetPromo**
+> PromoModel putGetPromo()
+
+Update a promotion
+
+### Example
+
+```typescript
+import {
+    PromotionsApi,
+    Configuration,
+    PromoModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new PromotionsApi(configuration);
+
+let id: number; //Promo ID (default to undefined)
+let promoModel: PromoModel; //Promotion (optional)
+
+const { status, data } = await apiInstance.putGetPromo(
+    id,
+    promoModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **promoModel** | **PromoModel**| Promotion | |
+| **id** | [**number**] | Promo ID | defaults to undefined|
+
+
+### Return type
+
+**PromoModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Promotion |  -  |
+|**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/ProspectDTO.md

@@ -8,8 +8,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **companyName** | **string** | Company Name | [optional] [default to undefined]
 **telephone** | **string** | Telephone | [optional] [default to undefined]
-**lastOrderDate** | **string** | Last Order Date | [optional] [default to undefined]
-**callbackDate** | **string** | Call Back Date | [optional] [default to undefined]
+**lastOrderDate** | **string** | Date Time | [optional] [default to undefined]
+**callbackDate** | **string** | Date Time | [optional] [default to undefined]
 **xeroId** | **string** | Xero ID | [optional] [default to undefined]
 **removed** | **boolean** | Removed From Prospects | [optional] [default to undefined]
 **status** | **string** | Status | [optional] [default to undefined]

package/docs/ProspectsApi.md

@@ -1,6 +1,6 @@
 # ProspectsApi
 
-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/ProvisioningApi.md

@@ -1,6 +1,6 @@
 # ProvisioningApi
 
-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/PutAddCallTariffToCallTariffPlanRequest.md

@@ -0,0 +1,30 @@
+# PutAddCallTariffToCallTariffPlanRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tariffRateMarkup** | **string** |  | [optional] [default to undefined]
+**tariffRateDay** | **number** |  | [optional] [default to undefined]
+**tariffRateEvening** | **number** |  | [optional] [default to undefined]
+**tariffRateWeekend** | **number** |  | [optional] [default to undefined]
+**tariffRateMinimum** | **number** |  | [optional] [default to undefined]
+**tariffRateSetup** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutAddCallTariffToCallTariffPlanRequest } from 'yellowgrid-api-ts';
+
+const instance: PutAddCallTariffToCallTariffPlanRequest = {
+    tariffRateMarkup,
+    tariffRateDay,
+    tariffRateEvening,
+    tariffRateWeekend,
+    tariffRateMinimum,
+    tariffRateSetup,
+};
+```
+
+[[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/PutAddServiceToServicePlanRequest.md

@@ -0,0 +1,26 @@
+# PutAddServiceToServicePlanRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customerRate_Markup** | **string** |  | [optional] [default to undefined]
+**customerRate_Amount** | **number** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**hideOnInvoice** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutAddServiceToServicePlanRequest } from 'yellowgrid-api-ts';
+
+const instance: PutAddServiceToServicePlanRequest = {
+    customerRate_Markup,
+    customerRate_Amount,
+    description,
+    hideOnInvoice,
+};
+```
+
+[[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/PutConnectionSearchRequest.md

@@ -0,0 +1,20 @@
+# PutConnectionSearchRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customerId** | **number** | Customer ID | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutConnectionSearchRequest } from 'yellowgrid-api-ts';
+
+const instance: PutConnectionSearchRequest = {
+    customerId,
+};
+```
+
+[[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/PutGetBaseServicesRequest.md

@@ -0,0 +1,28 @@
+# PutGetBaseServicesRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property** | **string** |  | [optional] [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+**serviceCodeAdmin** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**dataType** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutGetBaseServicesRequest } from 'yellowgrid-api-ts';
+
+const instance: PutGetBaseServicesRequest = {
+    property,
+    value,
+    serviceCodeAdmin,
+    description,
+    dataType,
+};
+```
+
+[[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/PutGetCallTariffPlanRequest.md

@@ -0,0 +1,28 @@
+# PutGetCallTariffPlanRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**unknownDestinationsRateType** | **string** |  | [optional] [default to undefined]
+**unknownDestinationsRateAmount** | **number** |  | [optional] [default to undefined]
+**ngcsAccessChargePerMin** | **number** |  | [optional] [default to undefined]
+**ngcsAccessChargePerCall** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutGetCallTariffPlanRequest } from 'yellowgrid-api-ts';
+
+const instance: PutGetCallTariffPlanRequest = {
+    name,
+    unknownDestinationsRateType,
+    unknownDestinationsRateAmount,
+    ngcsAccessChargePerMin,
+    ngcsAccessChargePerCall,
+};
+```
+
+[[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/PutGetPriceGroupsRequest.md

@@ -0,0 +1,28 @@
+# PutGetPriceGroupsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property** | **string** |  | [optional] [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+**unknownDestinationsRateAmount** | **number** |  | [optional] [default to undefined]
+**ngcsAccessChargePerMin** | **number** |  | [optional] [default to undefined]
+**ngcsAccessChargePerCall** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PutGetPriceGroupsRequest } from 'yellowgrid-api-ts';
+
+const instance: PutGetPriceGroupsRequest = {
+    property,
+    value,
+    unknownDestinationsRateAmount,
+    ngcsAccessChargePerMin,
+    ngcsAccessChargePerCall,
+};
+```
+
+[[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/RecordingsBackupInfoDTO.md

@@ -6,8 +6,8 @@ Recordings Backup Info
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) | Azure Backup Storage | [optional] [default to undefined]
-**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) | 3CX Remote Storage | [optional] [default to undefined]
+**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) |  | [optional] [default to undefined]
+**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) |  | [optional] [default to undefined]
 
 ## Example
 

package/docs/RecurringCharge.md

@@ -0,0 +1,48 @@
+# RecurringCharge
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**customerId** | **number** |  | [optional] [default to undefined]
+**customer** | [**Customer**](Customer.md) |  | [default to undefined]
+**phoneNumber** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**channelPartnerBuy** | **number** |  | [optional] [default to undefined]
+**customerCharge** | **number** |  | [optional] [default to undefined]
+**frequency** | **number** |  | [optional] [default to undefined]
+**startDate** | **string** |  | [default to undefined]
+**endDate** | **string** |  | [optional] [default to undefined]
+**quantity** | **number** |  | [optional] [default to undefined]
+**accountCode** | **string** |  | [optional] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+**isActive** | **boolean** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { RecurringCharge } from 'yellowgrid-api-ts';
+
+const instance: RecurringCharge = {
+    createdDate,
+    id,
+    customerId,
+    customer,
+    phoneNumber,
+    description,
+    channelPartnerBuy,
+    customerCharge,
+    frequency,
+    startDate,
+    endDate,
+    quantity,
+    accountCode,
+    filePeriod,
+    isActive,
+};
+```
+
+[[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/ReportRequestDTO.md

@@ -7,8 +7,8 @@ Report Request
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **report** | **string** | Report | [optional] [default to undefined]
-**start** | **string** | Start | [optional] [default to undefined]
-**end** | **string** | End | [optional] [default to undefined]
+**start** | **string** | Date Time | [optional] [default to undefined]
+**end** | **string** | Date Time | [optional] [default to undefined]
 **month** | **number** | Month | [optional] [default to undefined]
 **year** | **number** | Year | [optional] [default to undefined]
 **sku** | **string** | SKU | [optional] [default to undefined]

package/docs/ReportsApi.md

@@ -1,6 +1,6 @@
 # ReportsApi
 
-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/SIPTrunksApi.md

@@ -1,6 +1,6 @@
 # SIPTrunksApi
 
-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/SMSApi.md

@@ -1,6 +1,6 @@
 # SMSApi
 
-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/Sdr.md

@@ -0,0 +1,66 @@
+# Sdr
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**customerIdentifier** | **string** |  | [default to undefined]
+**fromDate** | **string** |  | [default to undefined]
+**fromTime** | **string** |  | [optional] [default to undefined]
+**toDate** | **string** |  | [optional] [default to undefined]
+**toTime** | **string** |  | [optional] [default to undefined]
+**refund** | **string** |  | [optional] [default to undefined]
+**quantity** | **number** |  | [optional] [default to undefined]
+**frequency** | **number** |  | [optional] [default to undefined]
+**unitCost** | **number** |  | [optional] [default to undefined]
+**totalCost** | **number** |  | [optional] [default to undefined]
+**chargeTypeClass** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [default to undefined]
+**serviceID** | **string** |  | [optional] [default to undefined]
+**accountRef** | **string** |  | [optional] [default to undefined]
+**carrier** | **string** |  | [optional] [default to undefined]
+**recordID** | **string** |  | [optional] [default to undefined]
+**currency** | **string** |  | [optional] [default to undefined]
+**discountReference** | **string** |  | [optional] [default to undefined]
+**effectiveDate** | **string** |  | [optional] [default to undefined]
+**partMonthCost** | **number** |  | [optional] [default to undefined]
+**filename** | **string** |  | [default to undefined]
+**contentReference** | **string** |  | [default to undefined]
+**filePeriod** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Sdr } from 'yellowgrid-api-ts';
+
+const instance: Sdr = {
+    id,
+    customerIdentifier,
+    fromDate,
+    fromTime,
+    toDate,
+    toTime,
+    refund,
+    quantity,
+    frequency,
+    unitCost,
+    totalCost,
+    chargeTypeClass,
+    description,
+    serviceID,
+    accountRef,
+    carrier,
+    recordID,
+    currency,
+    discountReference,
+    effectiveDate,
+    partMonthCost,
+    filename,
+    contentReference,
+    filePeriod,
+};
+```
+
+[[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/SdrReferenceType.md

@@ -0,0 +1,24 @@
+# SdrReferenceType
+
+
+## Enum
+
+* `SipTrunk` (value: `'SIP_TRUNK'`)
+
+* `Broadband` (value: `'BROADBAND'`)
+
+* `Ethernet` (value: `'ETHERNET'`)
+
+* `Mobile` (value: `'MOBILE'`)
+
+* `Wlr` (value: `'WLR'`)
+
+* `Hzn` (value: `'HZN'`)
+
+* `Nts` (value: `'NTS'`)
+
+* `Hosting` (value: `'HOSTING'`)
+
+* `Crm` (value: `'CRM'`)
+
+[[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/Service.md

@@ -0,0 +1,42 @@
+# Service
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**servicePlanId** | **number** |  | [optional] [default to undefined]
+**servicePlan** | [**ServicePlan**](ServicePlan.md) |  | [optional] [default to undefined]
+**baseServiceId** | **number** |  | [optional] [default to undefined]
+**baseService** | [**BaseService**](BaseService.md) |  | [optional] [default to undefined]
+**customerRate** | [**CustomerRate**](CustomerRate.md) |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**hideOnInvoice** | **boolean** |  | [optional] [default to undefined]
+**bureauRate** | **string** |  | [optional] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+**common** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Service } from 'yellowgrid-api-ts';
+
+const instance: Service = {
+    createdDate,
+    id,
+    servicePlanId,
+    servicePlan,
+    baseServiceId,
+    baseService,
+    customerRate,
+    description,
+    hideOnInvoice,
+    bureauRate,
+    filePeriod,
+    common,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)