yellowgrid-api-ts 3.2.236 → 3.2.237-dev.0

package/docs/PortalAccountModel.md

@@ -6,29 +6,29 @@ Customer Account
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | ID | [optional] [default to undefined]
-**name** | **string** | Contact Name | [optional] [default to undefined]
-**email** | **string** | Email | [optional] [default to undefined]
-**phone** | **string** | Phone Number | [optional] [default to undefined]
-**company** | **string** | Company Name | [optional] [default to undefined]
-**companyNumber** | **string** | Company Registration Number | [optional] [default to undefined]
-**vatNumber** | **string** | VAT Number | [optional] [default to undefined]
-**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
-**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
-**city** | **string** | City | [optional] [default to undefined]
-**county** | **string** | County | [optional] [default to undefined]
-**iso** | **string** | Country ISO Code | [optional] [default to undefined]
-**postalCode** | **string** | Post Code | [optional] [default to undefined]
-**accountNumber** | **string** | Account Number | [optional] [default to undefined]
-**xeroId** | **string** | Xero Contact ID | [optional] [default to undefined]
-**creditLimit** | **number** | Credit Limit | [optional] [default to undefined]
-**paymentMethod** | **string** | Payment Method | [optional] [default to undefined]
-**servicePaymentMethod** | **string** | Service Payment Method | [optional] [default to undefined]
-**resellerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
-**creationDate** | **string** | Creation Date | [optional] [default to undefined]
-**prizePromo** | **boolean** | Prize Promo Enabled | [optional] [default to undefined]
-**portalAccess** | **boolean** | Portal Access | [optional] [default to undefined]
-**cname** | **string** | Wizard CNAME | [optional] [default to undefined]
+**id** | **number** | ID | [default to undefined]
+**name** | **string** | Contact Name | [default to undefined]
+**email** | **string** | Email | [default to undefined]
+**phone** | **string** | Phone Number | [default to undefined]
+**company** | **string** | Company Name | [default to undefined]
+**companyNumber** | **string** | Company Registration Number | [default to undefined]
+**vatNumber** | **string** | VAT Number | [default to undefined]
+**addressLine1** | **string** | Address Line 1 | [default to undefined]
+**addressLine2** | **string** | Address Line 2 | [default to undefined]
+**city** | **string** | City | [default to undefined]
+**county** | **string** | County | [default to undefined]
+**iso** | **string** | Country ISO Code | [default to undefined]
+**postalCode** | **string** | Post Code | [default to undefined]
+**accountNumber** | **string** | Account Number | [default to undefined]
+**xeroId** | **string** | Xero Contact ID | [default to undefined]
+**creditLimit** | **number** | Credit Limit | [default to undefined]
+**paymentMethod** | **string** | Payment Method | [default to undefined]
+**servicePaymentMethod** | **string** | Service Payment Method | [default to undefined]
+**resellerId** | **string** | 3CX Reseller ID | [default to undefined]
+**creationDate** | **string** | Creation Date | [default to undefined]
+**prizePromo** | **boolean** | Prize Promo Enabled | [default to undefined]
+**portalAccess** | **boolean** | Portal Access | [default to undefined]
+**cname** | **string** | Wizard CNAME | [default to undefined]
 **directDebitMandate** | **boolean** | Active Direct Debit Mandate | [optional] [default to undefined]
 **navigation** | [**Array<NavigationModel>**](NavigationModel.md) | Portal Navigation | [optional] [default to undefined]
 

package/docs/PortalLoginModel.md

@@ -6,13 +6,13 @@ Portal Login
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**email** | **string** | Email Address | [optional] [default to undefined]
-**password** | **string** | Password | [optional] [default to undefined]
-**code** | **string** | MFA Code | [optional] [default to undefined]
-**secret** | **string** | MFA Secret | [optional] [default to undefined]
-**codeChallenge** | **string** | Oauth 2.0 code challenge | [optional] [default to undefined]
-**codeVerifier** | **string** | Oauth 2.0 code verifier | [optional] [default to undefined]
-**redirect_uri** | **string** | Oauth 2.0 code redirect uri | [optional] [default to undefined]
+**email** | **string** | Email Address | [default to undefined]
+**password** | **string** | Password | [default to undefined]
+**code** | **string** | MFA Code | [default to undefined]
+**secret** | **string** | MFA Secret | [default to undefined]
+**codeChallenge** | **string** | Oauth 2.0 code challenge | [default to undefined]
+**codeVerifier** | **string** | Oauth 2.0 code verifier | [default to undefined]
+**redirect_uri** | **string** | Oauth 2.0 code redirect uri | [default to undefined]
 
 ## Example
 

package/docs/PostAddBroadbandRequest.md

@@ -0,0 +1,28 @@
+# PostAddBroadbandRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customerId** | **number** |  | [optional] [default to undefined]
+**orderId** | **number** |  | [optional] [default to undefined]
+**connectionDate** | **string** | Date Time | [optional] [default to undefined]
+**servicePlanName** | **string** |  | [optional] [default to undefined]
+**invoiceDescription** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostAddBroadbandRequest } from 'yellowgrid-api-ts';
+
+const instance: PostAddBroadbandRequest = {
+    customerId,
+    orderId,
+    connectionDate,
+    servicePlanName,
+    invoiceDescription,
+};
+```
+
+[[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/PostAddCallTariffToCallTariffPlanRequest.md

@@ -0,0 +1,34 @@
+# PostAddCallTariffToCallTariffPlanRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**planName** | **string** |  | [optional] [default to undefined]
+**priceGroupName** | **string** |  | [optional] [default to undefined]
+**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 { PostAddCallTariffToCallTariffPlanRequest } from 'yellowgrid-api-ts';
+
+const instance: PostAddCallTariffToCallTariffPlanRequest = {
+    planName,
+    priceGroupName,
+    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/PostAddEthernetRequest.md

@@ -0,0 +1,28 @@
+# PostAddEthernetRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customerId** | **number** |  | [optional] [default to undefined]
+**cesRef** | **string** |  | [optional] [default to undefined]
+**connectionDate** | **string** | Date Time | [optional] [default to undefined]
+**servicePlanName** | **string** |  | [optional] [default to undefined]
+**invoiceDescription** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostAddEthernetRequest } from 'yellowgrid-api-ts';
+
+const instance: PostAddEthernetRequest = {
+    customerId,
+    cesRef,
+    connectionDate,
+    servicePlanName,
+    invoiceDescription,
+};
+```
+
+[[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/PostAddRecurringChargeRequest.md

@@ -0,0 +1,30 @@
+# PostAddRecurringChargeRequest
+
+
+## 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 { PostAddRecurringChargeRequest } from 'yellowgrid-api-ts';
+
+const instance: PostAddRecurringChargeRequest = {
+    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/PostAddServiceToServicePlanRequest.md

@@ -0,0 +1,30 @@
+# PostAddServiceToServicePlanRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**serviceCode** | **string** |  | [optional] [default to undefined]
+**planGroup** | **string** |  | [optional] [default to undefined]
+**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 { PostAddServiceToServicePlanRequest } from 'yellowgrid-api-ts';
+
+const instance: PostAddServiceToServicePlanRequest = {
+    serviceCode,
+    planGroup,
+    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/PostAddSipTrunkDDIsRequest.md

@@ -0,0 +1,30 @@
+# PostAddSipTrunkDDIsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**startDDI** | **Array<string>** |  | [optional] [default to undefined]
+**sipTrunkSdrRefId** | **string** |  | [optional] [default to undefined]
+**connectionDate** | **string** | Date Time | [optional] [default to undefined]
+**endDDI** | **Array<string>** |  | [optional] [default to undefined]
+**inboundTariffPlanName** | **Array<string>** |  | [optional] [default to undefined]
+**invoiceDescription** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostAddSipTrunkDDIsRequest } from 'yellowgrid-api-ts';
+
+const instance: PostAddSipTrunkDDIsRequest = {
+    startDDI,
+    sipTrunkSdrRefId,
+    connectionDate,
+    endDDI,
+    inboundTariffPlanName,
+    invoiceDescription,
+};
+```
+
+[[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/PostDisconnectDDIRequest.md

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

@@ -0,0 +1,36 @@
+# PostGenerateReport200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Title | [default to undefined]
+**xAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | X Axis | [default to undefined]
+**yAxis** | [**Array<AxisDataDTO>**](AxisDataDTO.md) | Y Axis | [default to undefined]
+**legend** | **Array<string>** | Legend | [default to undefined]
+**series** | [**Array<SeriesDTO>**](SeriesDTO.md) | Series | [default to undefined]
+**currency** | **string** | Currency | [optional] [default to undefined]
+**locale** | **string** | Locale | [default to undefined]
+**headers** | [**TableRowDTO**](TableRowDTO.md) |  | [default to undefined]
+**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [default to undefined]
+
+## Example
+
+```typescript
+import { PostGenerateReport200Response } from 'yellowgrid-api-ts';
+
+const instance: PostGenerateReport200Response = {
+    title,
+    xAxis,
+    yAxis,
+    legend,
+    series,
+    currency,
+    locale,
+    headers,
+    rows,
+};
+```
+
+[[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/PostGetBaseServicesRequest.md

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

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

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

@@ -6,9 +6,9 @@ Price & Stock List
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**title** | **string** | Title | [optional] [default to undefined]
+**title** | **string** | Title | [default to undefined]
 **sku** | **string** | SKU | [optional] [default to undefined]
-**price** | **number** | Price | [optional] [default to undefined]
+**price** | **number** | Price | [default to undefined]
 **rrp** | **number** | RRP | [optional] [default to undefined]
 **stock** | **number** | Stock | [optional] [default to undefined]
 

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/PrinterEntity.md

@@ -6,11 +6,11 @@ PrintersEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**brand** | **string** | brand | [optional] [default to undefined]
-**model** | **string** | model | [optional] [default to undefined]
-**sn** | **string** | sn | [optional] [default to undefined]
-**location** | **string** | location | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**brand** | **string** | brand | [default to undefined]
+**model** | **string** | model | [default to undefined]
+**sn** | **string** | sn | [default to undefined]
+**location** | **string** | location | [default to undefined]
 
 ## Example
 

package/docs/PrizesEntity.md

@@ -6,12 +6,12 @@ PrizesEntity
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**year** | **number** | year | [optional] [default to undefined]
-**sku** | **string** | sku | [optional] [default to undefined]
-**title** | **string** | title | [optional] [default to undefined]
-**target** | **number** | target | [optional] [default to undefined]
-**image** | **string** | image | [optional] [default to undefined]
+**id** | **number** | id | [default to undefined]
+**year** | **number** | year | [default to undefined]
+**sku** | **string** | sku | [default to undefined]
+**title** | **string** | title | [default to undefined]
+**target** | **number** | target | [default to undefined]
+**image** | **string** | image | [default to undefined]
 
 ## Example