yellowgrid-api-ts 3.2.230 → 3.2.231-dev.0

package/docs/Bundle.md

@@ -0,0 +1,34 @@
+# Bundle
+
+
+## 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]
+**customers** | [**Array<Customer>**](Customer.md) |  | [optional] [readonly] [default to undefined]
+**bundleCustomers** | [**Array<BundleCustomer>**](BundleCustomer.md) |  | [optional] [readonly] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Bundle } from 'yellowgrid-api-ts';
+
+const instance: Bundle = {
+    createdDate,
+    id,
+    name,
+    category,
+    description,
+    customers,
+    bundleCustomers,
+    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/BundleCustomer.md

@@ -0,0 +1,34 @@
+# BundleCustomer
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**bundleId** | **number** |  | [optional] [default to undefined]
+**bundle** | [**Bundle**](Bundle.md) |  | [default to undefined]
+**customerId** | **number** |  | [optional] [default to undefined]
+**customer** | [**Customer**](Customer.md) |  | [default to undefined]
+**endDate** | **string** |  | [optional] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BundleCustomer } from 'yellowgrid-api-ts';
+
+const instance: BundleCustomer = {
+    createdDate,
+    id,
+    bundleId,
+    bundle,
+    customerId,
+    customer,
+    endDate,
+    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/CRMApi.md

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

@@ -0,0 +1,34 @@
+# CallTariff
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**callTariffPlanId** | **number** |  | [optional] [default to undefined]
+**inboundTariffPlanId** | **number** |  | [optional] [default to undefined]
+**priceGroupId** | **number** |  | [optional] [default to undefined]
+**priceGroup** | [**PriceGroup**](PriceGroup.md) |  | [default to undefined]
+**tariffRate** | [**TariffRate**](TariffRate.md) |  | [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CallTariff } from 'yellowgrid-api-ts';
+
+const instance: CallTariff = {
+    createdDate,
+    id,
+    callTariffPlanId,
+    inboundTariffPlanId,
+    priceGroupId,
+    priceGroup,
+    tariffRate,
+    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/CallTariffPlan.md

@@ -0,0 +1,36 @@
+# CallTariffPlan
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**name** | **string** |  | [default to undefined]
+**unknownDestinationsRate** | [**CustomerRate**](CustomerRate.md) |  | [default to undefined]
+**ngcsAccessChargePerMin** | **number** |  | [optional] [default to undefined]
+**ngcsAccessChargePerCall** | **number** |  | [optional] [default to undefined]
+**callTariffs** | [**Array<CallTariff>**](CallTariff.md) |  | [optional] [readonly] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+**closed** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CallTariffPlan } from 'yellowgrid-api-ts';
+
+const instance: CallTariffPlan = {
+    createdDate,
+    id,
+    name,
+    unknownDestinationsRate,
+    ngcsAccessChargePerMin,
+    ngcsAccessChargePerCall,
+    callTariffs,
+    filePeriod,
+    closed,
+};
+```
+
+[[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/CallTariffResponse.md

@@ -0,0 +1,26 @@
+# CallTariffResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**priceGroupId** | **number** |  | [optional] [default to undefined]
+**priceGroup** | [**PriceGroupResponse**](PriceGroupResponse.md) |  | [optional] [default to undefined]
+**tariffRate** | [**TariffRate**](TariffRate.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CallTariffResponse } from 'yellowgrid-api-ts';
+
+const instance: CallTariffResponse = {
+    id,
+    priceGroupId,
+    priceGroup,
+    tariffRate,
+};
+```
+
+[[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/Cdr.md

@@ -0,0 +1,112 @@
+# Cdr
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**callType** | **string** |  | [default to undefined]
+**callCause** | **string** |  | [optional] [default to undefined]
+**customerIdentifier** | **string** |  | [default to undefined]
+**nonChargedParty** | **string** |  | [default to undefined]
+**callDate** | **string** |  | [default to undefined]
+**callTime** | **string** |  | [default to undefined]
+**duration** | **number** |  | [optional] [default to undefined]
+**bytesTransmitted** | **number** |  | [optional] [default to undefined]
+**bytesReceived** | **number** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**chargecode** | **string** |  | [optional] [default to undefined]
+**timeBand** | **string** |  | [optional] [default to undefined]
+**salesprice** | **number** |  | [optional] [default to undefined]
+**salespricePreBundle** | **number** |  | [optional] [default to undefined]
+**extension** | **string** |  | [optional] [default to undefined]
+**ddi** | **string** |  | [optional] [default to undefined]
+**groupingID** | **string** |  | [optional] [default to undefined]
+**callClass** | **string** |  | [optional] [default to undefined]
+**carrier** | **string** |  | [optional] [default to undefined]
+**recording** | **boolean** |  | [optional] [default to undefined]
+**vat** | **string** |  | [optional] [default to undefined]
+**countryOfOrigin** | **string** |  | [optional] [default to undefined]
+**network** | **string** |  | [optional] [default to undefined]
+**retailTariffCode** | **string** |  | [optional] [default to undefined]
+**remoteNetwork** | **string** |  | [optional] [default to undefined]
+**apn** | **string** |  | [optional] [default to undefined]
+**divertedNumber** | **string** |  | [optional] [default to undefined]
+**ringTime** | **number** |  | [optional] [default to undefined]
+**recordID** | **string** |  | [optional] [default to undefined]
+**currency** | **string** |  | [optional] [default to undefined]
+**presentationNumber** | **string** |  | [optional] [default to undefined]
+**networkAccessReference** | **string** |  | [optional] [default to undefined]
+**ngcsAccessCharge** | **number** |  | [optional] [default to undefined]
+**ngcsServiceCharge** | **number** |  | [optional] [default to undefined]
+**totalBytesTransferred** | **number** |  | [optional] [default to undefined]
+**userID** | **string** |  | [optional] [default to undefined]
+**onwardBillingReference** | **string** |  | [optional] [default to undefined]
+**contractName** | **string** |  | [optional] [default to undefined]
+**bundleName** | **string** |  | [optional] [default to undefined]
+**bundleAllowance** | **number** |  | [optional] [default to undefined]
+**discountReference** | **string** |  | [optional] [default to undefined]
+**routingCode** | **string** |  | [optional] [default to undefined]
+**filename** | **string** |  | [default to undefined]
+**contentReference** | **string** |  | [default to undefined]
+**processedCdr** | [**ProcessedCdr**](ProcessedCdr.md) |  | [optional] [default to undefined]
+**filePeriod** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Cdr } from 'yellowgrid-api-ts';
+
+const instance: Cdr = {
+    id,
+    callType,
+    callCause,
+    customerIdentifier,
+    nonChargedParty,
+    callDate,
+    callTime,
+    duration,
+    bytesTransmitted,
+    bytesReceived,
+    description,
+    chargecode,
+    timeBand,
+    salesprice,
+    salespricePreBundle,
+    extension,
+    ddi,
+    groupingID,
+    callClass,
+    carrier,
+    recording,
+    vat,
+    countryOfOrigin,
+    network,
+    retailTariffCode,
+    remoteNetwork,
+    apn,
+    divertedNumber,
+    ringTime,
+    recordID,
+    currency,
+    presentationNumber,
+    networkAccessReference,
+    ngcsAccessCharge,
+    ngcsServiceCharge,
+    totalBytesTransferred,
+    userID,
+    onwardBillingReference,
+    contractName,
+    bundleName,
+    bundleAllowance,
+    discountReference,
+    routingCode,
+    filename,
+    contentReference,
+    processedCdr,
+    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/Class3CXApi.md

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

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

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

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

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

@@ -0,0 +1,36 @@
+# ConnectionRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customerId** | **number** |  | [default to undefined]
+**reference** | **string** |  | [default to undefined]
+**connectionDate** | **string** |  | [default to undefined]
+**servicePlanId** | **number** |  | [default to undefined]
+**zeroRated** | **boolean** |  | [optional] [default to undefined]
+**callTariffPlanId** | **number** |  | [optional] [default to undefined]
+**inboundTariffPlanId** | **number** |  | [optional] [default to undefined]
+**invoiceDescription** | **string** |  | [optional] [default to undefined]
+**mtSipTrunkRequest** | [**MultiTenantSipTrunkRequest**](MultiTenantSipTrunkRequest.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ConnectionRequest } from 'yellowgrid-api-ts';
+
+const instance: ConnectionRequest = {
+    customerId,
+    reference,
+    connectionDate,
+    servicePlanId,
+    zeroRated,
+    callTariffPlanId,
+    inboundTariffPlanId,
+    invoiceDescription,
+    mtSipTrunkRequest,
+};
+```
+
+[[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/ConnectionType.md

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

@@ -0,0 +1,58 @@
+# ContactDetail
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customerName** | **string** |  | [default to undefined]
+**contactName** | **string** |  | [optional] [default to undefined]
+**address1** | **string** |  | [optional] [default to undefined]
+**address2** | **string** |  | [optional] [default to undefined]
+**address3** | **string** |  | [optional] [default to undefined]
+**address4** | **string** |  | [optional] [default to undefined]
+**postCode** | **string** |  | [optional] [default to undefined]
+**country** | **string** |  | [optional] [default to undefined]
+**phone1** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**siteInfo** | **string** |  | [optional] [default to undefined]
+**siteContactName** | **string** |  | [optional] [default to undefined]
+**siteAddress1** | **string** |  | [optional] [default to undefined]
+**siteAddress2** | **string** |  | [optional] [default to undefined]
+**siteAddress3** | **string** |  | [optional] [default to undefined]
+**siteAddress4** | **string** |  | [optional] [default to undefined]
+**sitePostcode** | **string** |  | [optional] [default to undefined]
+**siteCountry** | **string** |  | [optional] [default to undefined]
+**sitePhone1** | **string** |  | [optional] [default to undefined]
+**siteEmail** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ContactDetail } from 'yellowgrid-api-ts';
+
+const instance: ContactDetail = {
+    customerName,
+    contactName,
+    address1,
+    address2,
+    address3,
+    address4,
+    postCode,
+    country,
+    phone1,
+    email,
+    siteInfo,
+    siteContactName,
+    siteAddress1,
+    siteAddress2,
+    siteAddress3,
+    siteAddress4,
+    sitePostcode,
+    siteCountry,
+    sitePhone1,
+    siteEmail,
+};
+```
+
+[[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/CreditNoteItemEntity.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **orderId** | **number** | orderId | [optional] [default to undefined]
 **itemId** | **number** | itemId | [optional] [default to undefined]
 **amount** | **number** | amount | [optional] [default to undefined]
+**quantity** | **number** | quantity | [optional] [default to undefined]
 
 ## Example
 
@@ -23,6 +24,7 @@ const instance: CreditNoteItemEntity = {
     orderId,
     itemId,
     amount,
+    quantity,
 };
 ```
 

package/docs/CreditNoteItemModel.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **orderId** | **number** | orderId | [optional] [default to undefined]
 **itemId** | **number** | itemId | [optional] [default to undefined]
 **amount** | **number** | amount | [optional] [default to undefined]
+**quantity** | **number** | quantity | [optional] [default to undefined]
 
 ## Example
 
@@ -23,6 +24,7 @@ const instance: CreditNoteItemModel = {
     orderId,
     itemId,
     amount,
+    quantity,
 };
 ```
 

package/docs/Customer.md

@@ -0,0 +1,98 @@
+# Customer
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**customerCode** | **string** |  | [default to undefined]
+**parentCustomerCode** | **string** |  | [optional] [default to undefined]
+**customerName** | **string** |  | [default to undefined]
+**accountId** | **string** |  | [optional] [default to undefined]
+**contactName** | **string** |  | [optional] [default to undefined]
+**address1** | **string** |  | [optional] [default to undefined]
+**address2** | **string** |  | [optional] [default to undefined]
+**address3** | **string** |  | [optional] [default to undefined]
+**address4** | **string** |  | [optional] [default to undefined]
+**postCode** | **string** |  | [optional] [default to undefined]
+**country** | **string** |  | [optional] [default to undefined]
+**phone1** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**ddEnabled** | **boolean** |  | [optional] [default to undefined]
+**acClosedDate** | **string** |  | [optional] [default to undefined]
+**siteInfo** | **string** |  | [optional] [default to undefined]
+**siteContactName** | **string** |  | [optional] [default to undefined]
+**siteAddress1** | **string** |  | [optional] [default to undefined]
+**siteAddress2** | **string** |  | [optional] [default to undefined]
+**siteAddress3** | **string** |  | [optional] [default to undefined]
+**siteAddress4** | **string** |  | [optional] [default to undefined]
+**sitePostcode** | **string** |  | [optional] [default to undefined]
+**siteCountry** | **string** |  | [optional] [default to undefined]
+**sitePhone1** | **string** |  | [optional] [default to undefined]
+**siteEmail** | **string** |  | [optional] [default to undefined]
+**vatCode** | **string** |  | [optional] [default to undefined]
+**outboundClis** | [**Array<OutboundCli>**](OutboundCli.md) |  | [optional] [readonly] [default to undefined]
+**inboundClis** | [**Array<InboundCli>**](InboundCli.md) |  | [optional] [readonly] [default to undefined]
+**bundles** | [**Array<Bundle>**](Bundle.md) |  | [optional] [readonly] [default to undefined]
+**bundleCustomers** | [**Array<BundleCustomer>**](BundleCustomer.md) |  | [optional] [readonly] [default to undefined]
+**ddiBilling** | **boolean** |  | [optional] [default to undefined]
+**lastInvoiceNumber** | **string** |  | [optional] [default to undefined]
+**username** | **string** |  | [optional] [default to undefined]
+**sshKey** | **string** |  | [optional] [default to undefined]
+**directCustomer** | **boolean** |  | [optional] [readonly] [default to undefined]
+**parentCustomer** | **boolean** |  | [optional] [readonly] [default to undefined]
+**childCustomer** | **boolean** |  | [optional] [readonly] [default to undefined]
+**acClosed** | **boolean** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { Customer } from 'yellowgrid-api-ts';
+
+const instance: Customer = {
+    createdDate,
+    id,
+    customerCode,
+    parentCustomerCode,
+    customerName,
+    accountId,
+    contactName,
+    address1,
+    address2,
+    address3,
+    address4,
+    postCode,
+    country,
+    phone1,
+    email,
+    ddEnabled,
+    acClosedDate,
+    siteInfo,
+    siteContactName,
+    siteAddress1,
+    siteAddress2,
+    siteAddress3,
+    siteAddress4,
+    sitePostcode,
+    siteCountry,
+    sitePhone1,
+    siteEmail,
+    vatCode,
+    outboundClis,
+    inboundClis,
+    bundles,
+    bundleCustomers,
+    ddiBilling,
+    lastInvoiceNumber,
+    username,
+    sshKey,
+    directCustomer,
+    parentCustomer,
+    childCustomer,
+    acClosed,
+};
+```
+
+[[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/CustomerCoordinatesDTO.md

@@ -0,0 +1,31 @@
+# CustomerCoordinatesDTO
+
+Customer Coordinates
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | ID | [optional] [default to undefined]
+**company** | **string** | Company | [optional] [default to undefined]
+**resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
+**postCode** | **string** | Post Code | [optional] [default to undefined]
+**latitude** | **string** | Latitude | [optional] [default to undefined]
+**longitude** | **string** | Longitude | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CustomerCoordinatesDTO } from 'yellowgrid-api-ts';
+
+const instance: CustomerCoordinatesDTO = {
+    id,
+    company,
+    resellerId,
+    postCode,
+    latitude,
+    longitude,
+};
+```
+
+[[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/CustomerRate.md

@@ -0,0 +1,22 @@
+# CustomerRate
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**markup** | [**CustomerRateType**](CustomerRateType.md) |  | [optional] [default to undefined]
+**amount** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CustomerRate } from 'yellowgrid-api-ts';
+
+const instance: CustomerRate = {
+    markup,
+    amount,
+};
+```
+
+[[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/CustomerRateType.md

@@ -0,0 +1,12 @@
+# CustomerRateType
+
+
+## Enum
+
+* `Fixed` (value: `'FIXED'`)
+
+* `MarkupPercent` (value: `'MARKUP_PERCENT'`)
+
+* `MarkupFixed` (value: `'MARKUP_FIXED'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)