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

package/docs/PostGetSipTrunksBillingRequest.md

@@ -0,0 +1,34 @@
+# PostGetSipTrunksBillingRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parentEndpointId** | **string** |  | [optional] [default to undefined]
+**endpointId** | **string** |  | [optional] [default to undefined]
+**connectionDate** | **string** | Date Time | [optional] [default to undefined]
+**servicePlanName** | **string** |  | [optional] [default to undefined]
+**callTariffPlanName** | **string** |  | [optional] [default to undefined]
+**invoiceDescription** | **string** |  | [optional] [default to undefined]
+**isMtPrimarySipTrunk** | **boolean** |  | [optional] [default to undefined]
+**mtPrimarySipTrunkId** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostGetSipTrunksBillingRequest } from 'yellowgrid-api-ts';
+
+const instance: PostGetSipTrunksBillingRequest = {
+    parentEndpointId,
+    endpointId,
+    connectionDate,
+    servicePlanName,
+    callTariffPlanName,
+    invoiceDescription,
+    isMtPrimarySipTrunk,
+    mtPrimarySipTrunkId,
+};
+```
+
+[[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/PostUpdateConnectionRequest.md

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

@@ -0,0 +1,30 @@
+# PostUpdateRecurringChargeRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reference** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**customerCharge** | **number** |  | [optional] [default to undefined]
+**quantity** | **number** |  | [optional] [default to undefined]
+**endPeriod** | **string** | Date Time | [optional] [default to undefined]
+**accountCode** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostUpdateRecurringChargeRequest } from 'yellowgrid-api-ts';
+
+const instance: PostUpdateRecurringChargeRequest = {
+    reference,
+    description,
+    customerCharge,
+    quantity,
+    endPeriod,
+    accountCode,
+};
+```
+
+[[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/PriceGroup.md

@@ -0,0 +1,30 @@
+# PriceGroup
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**name** | **string** |  | [default to undefined]
+**category** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PriceGroup } from 'yellowgrid-api-ts';
+
+const instance: PriceGroup = {
+    createdDate,
+    id,
+    name,
+    category,
+    description,
+    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/PriceGroupResponse.md

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

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

@@ -0,0 +1,96 @@
+# ProcessedCdr
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**cdrId** | **number** |  | [optional] [default to undefined]
+**cdr** | [**Cdr**](Cdr.md) |  | [optional] [default to undefined]
+**contentReference** | **string** |  | [optional] [default to undefined]
+**callClass** | **string** |  | [optional] [default to undefined]
+**inbound** | **boolean** |  | [optional] [default to undefined]
+**cli** | **string** |  | [optional] [default to undefined]
+**presentationNumber** | **string** |  | [optional] [default to undefined]
+**outboundCliId** | **number** |  | [optional] [default to undefined]
+**outboundCli** | [**OutboundCli**](OutboundCli.md) |  | [optional] [default to undefined]
+**mtPrimaryOutboundCliId** | **number** |  | [optional] [default to undefined]
+**mtPrimaryOutboundCli** | [**OutboundCli**](OutboundCli.md) |  | [optional] [default to undefined]
+**callTariffPlanId** | **number** |  | [optional] [default to undefined]
+**callTariffPlan** | [**CallTariffPlan**](CallTariffPlan.md) |  | [optional] [default to undefined]
+**inboundTariffPlanId** | **number** |  | [optional] [default to undefined]
+**inboundTariffPlan** | [**InboundTariffPlan**](InboundTariffPlan.md) |  | [optional] [default to undefined]
+**callTariffId** | **number** |  | [optional] [default to undefined]
+**callTariff** | [**CallTariff**](CallTariff.md) |  | [optional] [default to undefined]
+**customerChargePreRounded** | **number** |  | [optional] [default to undefined]
+**customerCharge** | **number** |  | [optional] [default to undefined]
+**customerChargePostBundle** | **number** |  | [optional] [default to undefined]
+**bundleName** | **string** |  | [optional] [default to undefined]
+**customerId** | **number** |  | [optional] [default to undefined]
+**tariffPlanName** | **string** |  | [optional] [default to undefined]
+**chargecode** | **string** |  | [optional] [default to undefined]
+**priceGroupName** | **string** |  | [optional] [default to undefined]
+**unknownDestRate** | [**CustomerRate**](CustomerRate.md) |  | [optional] [default to undefined]
+**ngcsAcsChgPerMin** | **number** |  | [optional] [default to undefined]
+**ngcsAcsChgPerCall** | **number** |  | [optional] [default to undefined]
+**customerNGCSAcssChg** | **number** |  | [optional] [default to undefined]
+**customerRate** | [**CustomerRate**](CustomerRate.md) |  | [optional] [default to undefined]
+**salesprice** | **number** |  | [optional] [default to undefined]
+**callDateTime** | **string** |  | [optional] [default to undefined]
+**duration** | **number** |  | [optional] [default to undefined]
+**ngcsServiceCharge** | **number** |  | [optional] [default to undefined]
+**cdrDescription** | **string** |  | [optional] [default to undefined]
+**calledNumber** | **string** |  | [optional] [default to undefined]
+**remarks** | **string** |  | [optional] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProcessedCdr } from 'yellowgrid-api-ts';
+
+const instance: ProcessedCdr = {
+    id,
+    cdrId,
+    cdr,
+    contentReference,
+    callClass,
+    inbound,
+    cli,
+    presentationNumber,
+    outboundCliId,
+    outboundCli,
+    mtPrimaryOutboundCliId,
+    mtPrimaryOutboundCli,
+    callTariffPlanId,
+    callTariffPlan,
+    inboundTariffPlanId,
+    inboundTariffPlan,
+    callTariffId,
+    callTariff,
+    customerChargePreRounded,
+    customerCharge,
+    customerChargePostBundle,
+    bundleName,
+    customerId,
+    tariffPlanName,
+    chargecode,
+    priceGroupName,
+    unknownDestRate,
+    ngcsAcsChgPerMin,
+    ngcsAcsChgPerCall,
+    customerNGCSAcssChg,
+    customerRate,
+    salesprice,
+    callDateTime,
+    duration,
+    ngcsServiceCharge,
+    cdrDescription,
+    calledNumber,
+    remarks,
+    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/ProductDetailedSummaryDTO.md

@@ -13,9 +13,9 @@ Name | Type | Description | Notes
 **price** | **number** | Price | [optional] [default to undefined]
 **cartonSize** | **number** | Carton Size | [optional] [default to undefined]
 **rrp** | **number** | RRP Price | [optional] [default to undefined]
-**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) | 3CX Licence Details | [optional] [default to undefined]
+**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) |  | [optional] [default to undefined]
 **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
-**dueDate** | **string** | Due Date | [optional] [default to undefined]
+**dueDate** | **string** | Date Time | [optional] [default to undefined]
 **onOrder** | **number** | On Order | [optional] [default to undefined]
 
 ## Example

package/docs/ProductSearchDTO.md

@@ -0,0 +1,37 @@
+# ProductSearchDTO
+
+Product Search
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **string** | SKU | [optional] [default to undefined]
+**quantity** | **number** | Quantity | [optional] [default to undefined]
+**licenceKey** | **string** | Licence Key | [optional] [default to undefined]
+**hosting** | **boolean** | Hosting | [optional] [default to undefined]
+**tcxSalesCode** | **string** | 3CX Sales Code | [optional] [default to undefined]
+**renewalYears** | **number** | 3CX Renewal Years | [optional] [default to undefined]
+**orderId** | **number** | Order ID | [optional] [default to undefined]
+**items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [optional] [default to undefined]
+**discount** | **number** | Discount | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductSearchDTO } from 'yellowgrid-api-ts';
+
+const instance: ProductSearchDTO = {
+    sku,
+    quantity,
+    licenceKey,
+    hosting,
+    tcxSalesCode,
+    renewalYears,
+    orderId,
+    items,
+    discount,
+};
+```
+
+[[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/ProductSummaryDTO.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **price** | **number** | Price | [optional] [default to undefined]
 **cartonSize** | **number** | Carton Size | [optional] [default to undefined]
 **rrp** | **number** | RRP Price | [optional] [default to undefined]
-**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) | 3CX Licence Details | [optional] [default to undefined]
+**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) |  | [optional] [default to undefined]
 **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
 
 ## Example

package/docs/ProductsApi.md

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

@@ -9,14 +9,14 @@ Name | Type | Description | Notes
 **id** | **number** | id | [optional] [default to undefined]
 **code** | **string** | code | [optional] [default to undefined]
 **description** | **string** | description | [optional] [default to undefined]
-**banner** | **string** | banner | [optional] [default to undefined]
-**start** | **string** | start | [optional] [default to undefined]
-**expiry** | **string** | expiry | [optional] [default to undefined]
+**start** | **string** | Date Time | [optional] [default to undefined]
+**expiry** | **string** | Date Time | [optional] [default to undefined]
 **customerLimit** | **number** | customerLimit | [optional] [default to undefined]
 **globalLimit** | **number** | globalLimit | [optional] [default to undefined]
 **orderRestrictions** | **string** | orderRestrictions | [optional] [default to undefined]
-**includeDistribution** | **number** | includeDistribution | [optional] [default to undefined]
-**distributionOnly** | **number** | distributionOnly | [optional] [default to undefined]
+**includeDistribution** | **boolean** | includeDistribution | [optional] [default to undefined]
+**distributionOnly** | **boolean** | distributionOnly | [optional] [default to undefined]
+**nfr** | **boolean** | nfr | [optional] [default to undefined]
 **note** | **string** | note | [optional] [default to undefined]
 
 ## Example
@@ -28,7 +28,6 @@ const instance: PromoCodesEntity = {
     id,
     code,
     description,
-    banner,
     start,
     expiry,
     customerLimit,
@@ -36,6 +35,7 @@ const instance: PromoCodesEntity = {
     orderRestrictions,
     includeDistribution,
     distributionOnly,
+    nfr,
     note,
 };
 ```

package/docs/PromoItemModel.md

@@ -0,0 +1,35 @@
+# PromoItemModel
+
+Promo Item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**promoId** | **number** | promoId | [optional] [default to undefined]
+**price** | **number** | price | [optional] [default to undefined]
+**discount** | **number** | discount | [optional] [default to undefined]
+**sku** | **string** | sku | [optional] [default to undefined]
+**quantity** | **number** | quantity | [optional] [default to undefined]
+**bulkQuantity** | **number** | bulkQuantity | [optional] [default to undefined]
+**bulkAdd** | **number** | bulkAdd | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromoItemModel } from 'yellowgrid-api-ts';
+
+const instance: PromoItemModel = {
+    id,
+    promoId,
+    price,
+    discount,
+    sku,
+    quantity,
+    bulkQuantity,
+    bulkAdd,
+};
+```
+
+[[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/PromoModel.md

@@ -0,0 +1,45 @@
+# PromoModel
+
+Promotion
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**code** | **string** | code | [optional] [default to undefined]
+**description** | **string** | description | [optional] [default to undefined]
+**start** | **string** | Date Time | [optional] [default to undefined]
+**expiry** | **string** | Date Time | [optional] [default to undefined]
+**customerLimit** | **number** | customerLimit | [optional] [default to undefined]
+**globalLimit** | **number** | globalLimit | [optional] [default to undefined]
+**orderRestrictions** | **string** | orderRestrictions | [optional] [default to undefined]
+**includeDistribution** | **boolean** | includeDistribution | [optional] [default to undefined]
+**distributionOnly** | **boolean** | distributionOnly | [optional] [default to undefined]
+**nfr** | **boolean** | nfr | [optional] [default to undefined]
+**note** | **string** | note | [optional] [default to undefined]
+**items** | [**Array<PromoItemModel>**](PromoItemModel.md) | Items | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromoModel } from 'yellowgrid-api-ts';
+
+const instance: PromoModel = {
+    id,
+    code,
+    description,
+    start,
+    expiry,
+    customerLimit,
+    globalLimit,
+    orderRestrictions,
+    includeDistribution,
+    distributionOnly,
+    nfr,
+    note,
+    items,
+};
+```
+
+[[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/PromoSummariesModel.md

@@ -0,0 +1,27 @@
+# PromoSummariesModel
+
+Promotions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<PromoSummaryDTO>**](PromoSummaryDTO.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 { PromoSummariesModel } from 'yellowgrid-api-ts';
+
+const instance: PromoSummariesModel = {
+    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/PromoSummaryDTO.md

@@ -0,0 +1,29 @@
+# PromoSummaryDTO
+
+Promo Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **string** | Description | [optional] [default to undefined]
+**code** | **string** | Promo Code | [optional] [default to undefined]
+**startDate** | **string** | Date Time | [optional] [default to undefined]
+**endDate** | **string** | Date Time | [optional] [default to undefined]
+**orders** | **number** | Orders | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PromoSummaryDTO } from 'yellowgrid-api-ts';
+
+const instance: PromoSummaryDTO = {
+    description,
+    code,
+    startDate,
+    endDate,
+    orders,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)