yellowgrid-api-ts 3.2.170-dev.0 → 3.2.172-dev.0

package/docs/OAuth20Api.md

@@ -9,6 +9,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**postAccessToken**](#postaccesstoken) | **POST** /oauth2/access_token | Validates client credentials and returns access token|
 |[**postAuthorise**](#postauthorise) | **POST** /oauth2/authorise | Get OAuth2.0 Auth Code|
 |[**postGetIdentity**](#postgetidentity) | **POST** /oauth2/me | Get Token Identity|
+|[**postLogout**](#postlogout) | **POST** /oauth2/logout | |
 |[**postPortalLogin**](#postportallogin) | **POST** /oauth2/portal/login | Portal Login|
 
 # **getGetMfaQrCode**
@@ -311,6 +312,53 @@ 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)
 
+# **postLogout**
+> postLogout()
+
+Remove Oauth 2.0 Cookies
+
+### Example
+
+```typescript
+import {
+    OAuth20Api,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new OAuth20Api(configuration);
+
+const { status, data } = await apiInstance.postLogout();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | No Response |  -  |
+|**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)
+
 # **postPortalLogin**
 > AuthCodeResponseModel postPortalLogin()
 

package/docs/PartnerDTO.md

@@ -0,0 +1,39 @@
+# PartnerDTO
+
+3CX Partner Details
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**partnerId** | **string** | 3CX Partner ID | [optional] [default to undefined]
+**companyName** | **string** | 3CX Partner Company Name | [optional] [default to undefined]
+**contactName** | **string** | 3CX Partner Contact Name | [optional] [default to undefined]
+**contactPhone** | **string** | 3CX Partner Contact Phone | [optional] [default to undefined]
+**contactEmail** | **string** | 3CX Partner Contact Email | [optional] [default to undefined]
+**partnerLevel** | **string** | 3CX Partner Level | [optional] [default to undefined]
+**licenceDiscountPercent** | **number** | 3CX Partner Licence Discount Percent | [optional] [default to undefined]
+**hostingDisountPercent** | **number** | 3CX Partner Hosting Discount Percent | [optional] [default to undefined]
+**hostingPriceListId** | **number** | 3CX Hosting Price List ID | [optional] [default to undefined]
+**installationUrl** | **string** | 3CX Installation URL | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PartnerDTO } from 'yellowgrid-api-ts';
+
+const instance: PartnerDTO = {
+    partnerId,
+    companyName,
+    contactName,
+    contactPhone,
+    contactEmail,
+    partnerLevel,
+    licenceDiscountPercent,
+    hostingDisountPercent,
+    hostingPriceListId,
+    installationUrl,
+};
+```
+
+[[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/PatchUpdateAccountCnameRequest.md

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

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

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

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

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

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

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

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

@@ -0,0 +1,20 @@
+# PatchUpdateTcxPartnerIdRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**partnerId** | **string** | Set Account 3CX Partner ID | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchUpdateTcxPartnerIdRequest } from 'yellowgrid-api-ts';
+
+const instance: PatchUpdateTcxPartnerIdRequest = {
+    partnerId,
+};
+```
+
+[[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/PortalAccountModel.md

@@ -27,9 +27,10 @@ Name | Type | Description | Notes
 **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]
 **directDebitMandate** | **boolean** | Active Direct Debit Mandate | [optional] [default to undefined]
 **navigation** | [**Array<NavigationModel>**](NavigationModel.md) | Portal Navigation | [optional] [default to undefined]
-**cname** | **string** | Wizard CNAME | [optional] [default to undefined]
 
 ## Example
 
@@ -58,9 +59,10 @@ const instance: PortalAccountModel = {
     resellerId,
     creationDate,
     prizePromo,
+    portalAccess,
+    cname,
     directDebitMandate,
     navigation,
-    cname,
 };
 ```
 

package/docs/PostSendWelcomeEmailRequest.md

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

@@ -16,6 +16,7 @@ Name | Type | Description | Notes
 **rrp** | **number** | RRP Price | [optional] [default to undefined]
 **licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) |  | [optional] [default to undefined]
 **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
+**discounts** | [**Array<AbstractItemDiscountModel>**](AbstractItemDiscountModel.md) | Applied Discounts | [optional] [default to undefined]
 
 ## Example
 
@@ -33,6 +34,7 @@ const instance: ProductSummaryDTO = {
     rrp,
     licenceDetails,
     hosting,
+    discounts,
 };
 ```
 

package/docs/ProductsApi.md

@@ -422,7 +422,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)
 
 # **postGetProduct**
-> ProductSummaryDTO postGetProduct(postGetProductForCustomerRequest)
+> ProductSummaryDTO postGetProduct()
 
 Get Product
 
@@ -432,18 +432,18 @@ Get Product
 import {
     ProductsApi,
     Configuration,
-    PostGetProductForCustomerRequest
+    ProductSearchDTO
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new ProductsApi(configuration);
 
 let sku: string; //Product SKU (default to undefined)
-let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
+let productSearchDTO: ProductSearchDTO; //Product Search Info (optional)
 
 const { status, data } = await apiInstance.postGetProduct(
     sku,
-    postGetProductForCustomerRequest
+    productSearchDTO
 );
 ```
 
@@ -451,7 +451,7 @@ const { status, data } = await apiInstance.postGetProduct(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
+| **productSearchDTO** | **ProductSearchDTO**| Product Search Info | |
 | **sku** | [**string**] | Product SKU | defaults to undefined|
 
 
@@ -480,7 +480,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)
 
 # **postGetProductForCustomer**
-> ProductSummaryDTO postGetProductForCustomer(postGetProductForCustomerRequest)
+> ProductSummaryDTO postGetProductForCustomer()
 
 Get Product For Customer
 
@@ -490,7 +490,7 @@ Get Product For Customer
 import {
     ProductsApi,
     Configuration,
-    PostGetProductForCustomerRequest
+    ProductSearchDTO
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
@@ -498,12 +498,12 @@ const apiInstance = new ProductsApi(configuration);
 
 let customerId: number; //Customer ID (default to undefined)
 let sku: string; //Product SKU (default to undefined)
-let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
+let productSearchDTO: ProductSearchDTO; //Product Search Info (optional)
 
 const { status, data } = await apiInstance.postGetProductForCustomer(
     customerId,
     sku,
-    postGetProductForCustomerRequest
+    productSearchDTO
 );
 ```
 
@@ -511,7 +511,7 @@ const { status, data } = await apiInstance.postGetProductForCustomer(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
+| **productSearchDTO** | **ProductSearchDTO**| Product Search Info | |
 | **customerId** | [**number**] | Customer ID | defaults to undefined|
 | **sku** | [**string**] | Product SKU | defaults to undefined|
 

package/docs/ProspectDTO.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **xeroId** | **string** | Xero ID | [optional] [default to undefined]
 **removed** | **boolean** | Removed From Prospects | [optional] [default to undefined]
 **status** | **string** | Status | [optional] [default to undefined]
+**orderCount** | **number** | Order Count | [optional] [default to undefined]
 
 ## Example
 
@@ -27,6 +28,7 @@ const instance: ProspectDTO = {
     xeroId,
     removed,
     status,
+    orderCount,
 };
 ```
 

package/docs/RecordingBackupAzureModel.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **name** | **string** | Storage Account Name | [optional] [default to undefined]
 **key** | **string** | Storage Account Key | [optional] [default to undefined]
 **connection_string** | **string** | Storage Account Connection String | [optional] [default to undefined]
+**sasUrl** | **string** | SAS Url | [optional] [default to undefined]
 **recordings_path** | **string** | Recordings Path | [optional] [default to undefined]
 
 ## Example
@@ -20,6 +21,7 @@ const instance: RecordingBackupAzureModel = {
     name,
     key,
     connection_string,
+    sasUrl,
     recordings_path,
 };
 ```

package/docs/TableHistoryEntity.md

@@ -0,0 +1,35 @@
+# TableHistoryEntity
+
+TableAttribsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ownerId** | **string** | ownerId | [optional] [default to undefined]
+**dbTable** | **string** | table | [optional] [default to undefined]
+**orderingField** | **string** | orderingField | [optional] [default to undefined]
+**asc** | **number** | asc | [optional] [default to undefined]
+**perPage** | **number** | perPage | [optional] [default to undefined]
+**currPage** | **number** | currPage | [optional] [default to undefined]
+**filter** | **string** | filter | [optional] [default to undefined]
+**page** | **number** | page | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TableHistoryEntity } from 'yellowgrid-api-ts';
+
+const instance: TableHistoryEntity = {
+    ownerId,
+    dbTable,
+    orderingField,
+    asc,
+    perPage,
+    currPage,
+    filter,
+    page,
+};
+```
+
+[[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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.170-dev.0",
+  "version": "3.2.172-dev.0",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {