yellowgrid-api-ts 3.2.257-dev.0 → 3.2.258-dev.0

package/docs/PostGetProductRequest.md

@@ -0,0 +1,24 @@
+# PostGetProductRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | **number** | Quantity | [optional] [default to undefined]
+**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
+**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostGetProductRequest } from 'yellowgrid-api-ts';
+
+const instance: PostGetProductRequest = {
+    quantity,
+    licenceKey,
+    hosting,
+};
+```
+
+[[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/ProductPriceModel.md

@@ -0,0 +1,23 @@
+# ProductPriceModel
+
+Product Price
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**priceList** | [**CustomerPriceListEnum**](CustomerPriceListEnum.md) |  | [default to undefined]
+**price** | **number** | Price (£) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProductPriceModel } from 'yellowgrid-api-ts';
+
+const instance: ProductPriceModel = {
+    priceList,
+    price,
+};
+```
+
+[[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

@@ -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/PromoCodesEntity.md

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
 **id** | **number** | id | [optional] [default to undefined]
 **code** | **string** | code | [default to undefined]
 **description** | **string** | description | [default to undefined]
-**startDate** | **string** | start | [optional] [default to undefined]
-**endDate** | **string** | expiry | [optional] [default to undefined]
+**startDate** | **string** | Date Time | [optional] [default to undefined]
+**endDate** | **string** | Date Time | [optional] [default to undefined]
 **customerLimit** | **number** | customerLimit | [default to undefined]
 **globalLimit** | **number** | globalLimit | [default to undefined]
 **orderRestrictions** | **Array<string>** | orderRestrictions | [default to undefined]

package/docs/PromoModel.md

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
 **id** | **number** | id | [optional] [default to undefined]
 **code** | **string** | code | [default to undefined]
 **description** | **string** | description | [default to undefined]
-**startDate** | **string** | start | [optional] [default to undefined]
-**endDate** | **string** | expiry | [optional] [default to undefined]
+**startDate** | **string** | Date Time | [optional] [default to undefined]
+**endDate** | **string** | Date Time | [optional] [default to undefined]
 **customerLimit** | **number** | customerLimit | [default to undefined]
 **globalLimit** | **number** | globalLimit | [default to undefined]
 **orderRestrictions** | **Array<string>** | orderRestrictions | [default to undefined]

package/docs/PromoSummaryDTO.md

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
 **id** | **number** | ID | [optional] [default to undefined]
 **description** | **string** | Description | [default to undefined]
 **code** | **string** | Promo Code | [default to undefined]
-**startDate** | **string** | Start Date | [optional] [default to undefined]
-**endDate** | **string** | End Date | [optional] [default to undefined]
+**startDate** | **string** | Date Time | [optional] [default to undefined]
+**endDate** | **string** | Date Time | [optional] [default to undefined]
 **orders** | **number** | Orders | [default to undefined]
 
 ## Example

package/docs/ProspectDTO.md

@@ -8,8 +8,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **companyName** | **string** | Company Name | [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 | [default to undefined]
 **removed** | **boolean** | Removed From Prospects | [default to undefined]
 **status** | **string** | Status | [default to undefined]

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

@@ -7,8 +7,8 @@ Report Request
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **report** | **string** | Report | [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/ShipmentRequestDTO.md

@@ -7,10 +7,10 @@ Shipment Request
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **courier** | **string** | Courier | [default to undefined]
-**address** | [**AddressModel**](AddressModel.md) | Address | [optional] [default to undefined]
+**address** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
 **scannedLines** | **Array<string>** | Scanned Lines | [default to undefined]
 **service** | **string** | Service | [default to undefined]
-**shipDate** | **string** | Ship Date | [optional] [default to undefined]
+**shipDate** | **string** | Date Time | [optional] [default to undefined]
 **items** | [**Array<ShipmentItemDTO>**](ShipmentItemDTO.md) | Items | [default to undefined]
 
 ## Example

package/docs/StockProductModel.md

@@ -8,19 +8,19 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **number** | id | [default to undefined]
 **manufacturerId** | **number** | manId | [default to undefined]
-**sku** | **string** | sku | [default to undefined]
-**title** | **string** | title | [default to undefined]
+**sku** | **string** | SKU | [default to undefined]
+**title** | **string** | Title | [default to undefined]
 **price** | **number** | price | [default to undefined]
 **carton** | **number** | carton | [default to undefined]
 **manufacturer** | [**StockOrderSupplierModel**](StockOrderSupplierModel.md) |  | [optional] [default to undefined]
 **attributeSet** | [**AttributeSetEnum**](AttributeSetEnum.md) |  | [optional] [default to undefined]
-**stock** | **number** | Current Quantity | [optional] [default to undefined]
 **weight** | **number** | Weight (KG) | [optional] [default to undefined]
 **ean** | **string** | EAN | [optional] [default to undefined]
 **serialPrefix** | **string** | Serial Prefix | [optional] [default to undefined]
 **tcxLabel** | **string** | 3CX Phone Label | [optional] [default to undefined]
 **tcxTemplate** | [**TcxTemplateXmlEnum**](TcxTemplateXmlEnum.md) |  | [optional] [default to undefined]
-**salesPrices** | [**Array<StockProductPriceModel>**](StockProductPriceModel.md) | Prices | [optional] [default to undefined]
+**salesPrices** | [**Array<ProductPriceModel>**](ProductPriceModel.md) | Prices | [optional] [default to undefined]
+**stock** | **number** | Current Quantity | [optional] [default to undefined]
 
 ## Example
 
@@ -36,13 +36,13 @@ const instance: StockProductModel = {
     carton,
     manufacturer,
     attributeSet,
-    stock,
     weight,
     ean,
     serialPrefix,
     tcxLabel,
     tcxTemplate,
     salesPrices,
+    stock,
 };
 ```
 

package/docs/StockProductPriceModel.md

@@ -6,7 +6,7 @@ Stock Product Price
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**priceList** | [**CustomerPriceListEnum**](CustomerPriceListEnum.md) |  | [default to undefined]
+**priceList** | [**CustomerPriceListEnum**](CustomerPriceListEnum.md) |  | [optional] [default to undefined]
 **price** | **number** | Price (£) | [optional] [default to undefined]
 
 ## Example

package/docs/SupplierProductDTO.md

@@ -0,0 +1,41 @@
+# SupplierProductDTO
+
+Supplier Product
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Title | [default to undefined]
+**sku** | **string** | SKU | [default to undefined]
+**attributeSet** | [**AttributeSetEnum**](AttributeSetEnum.md) |  | [optional] [default to undefined]
+**weight** | **number** | Weight (KG) | [optional] [default to undefined]
+**ean** | **string** | EAN | [optional] [default to undefined]
+**serialPrefix** | **string** | Serial Prefix | [optional] [default to undefined]
+**tcxLabel** | **string** | 3CX Phone Label | [optional] [default to undefined]
+**tcxTemplate** | [**TcxTemplateXmlEnum**](TcxTemplateXmlEnum.md) |  | [optional] [default to undefined]
+**salesPrices** | [**Array<ProductPriceModel>**](ProductPriceModel.md) | Prices | [default to undefined]
+**supplierId** | **number** | Supplier ID | [default to undefined]
+**price** | **number** | Supplier Price | [default to undefined]
+
+## Example
+
+```typescript
+import { SupplierProductDTO } from 'yellowgrid-api-ts';
+
+const instance: SupplierProductDTO = {
+    title,
+    sku,
+    attributeSet,
+    weight,
+    ean,
+    serialPrefix,
+    tcxLabel,
+    tcxTemplate,
+    salesPrices,
+    supplierId,
+    price,
+};
+```
+
+[[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/SuppliersApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**getGetSupplierItem**](#getgetsupplieritem) | **GET** /suppliers/items/{id} | Get Supplier Item|
 |[**getGetSupplierItems**](#getgetsupplieritems) | **GET** /suppliers/items | Get Supplier Items|
 |[**getGetSuppliers**](#getgetsuppliers) | **GET** /suppliers | Get Suppliers|
+|[**postGetSupplierItems**](#postgetsupplieritems) | **POST** /suppliers/items | |
 |[**putGetSupplierItem**](#putgetsupplieritem) | **PUT** /suppliers/items/{id} | Update Supplier Product|
 
 # **getGetSupplierItem**
@@ -170,6 +171,61 @@ 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)
 
+# **postGetSupplierItems**
+> SupplierProductDTO postGetSupplierItems()
+
+Create Supplier Product
+
+### Example
+
+```typescript
+import {
+    SuppliersApi,
+    Configuration,
+    SupplierProductDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SuppliersApi(configuration);
+
+let supplierProductDTO: SupplierProductDTO; //Supplier Product (optional)
+
+const { status, data } = await apiInstance.postGetSupplierItems(
+    supplierProductDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **supplierProductDTO** | **SupplierProductDTO**| Supplier Product | |
+
+
+### Return type
+
+**SupplierProductDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Supplier Product |  -  |
+|**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)
+
 # **putGetSupplierItem**
 > SupplierProductModel putGetSupplierItem()
 

package/docs/TcxHostingPricingEntity.md

@@ -0,0 +1,35 @@
+# TcxHostingPricingEntity
+
+HostingPricingEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**title** | **string** | title | [optional] [default to undefined]
+**perSc** | **number** | perSc | [optional] [default to undefined]
+**perMultiTenantSc** | **number** | perMultiTenantSc | [optional] [default to undefined]
+**flatRate** | **number** | flatRate | [optional] [default to undefined]
+**maxFlatRateSc** | **number** | maxFlatRateSc | [optional] [default to undefined]
+**highScThreshold** | **number** | highScThreshold | [optional] [default to undefined]
+**highScDiscount** | **number** | highScDiscount | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TcxHostingPricingEntity } from 'yellowgrid-api-ts';
+
+const instance: TcxHostingPricingEntity = {
+    id,
+    title,
+    perSc,
+    perMultiTenantSc,
+    flatRate,
+    maxFlatRateSc,
+    highScThreshold,
+    highScDiscount,
+};
+```
+
+[[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/TcxInstallationDetailsModel.md

@@ -0,0 +1,45 @@
+# TcxInstallationDetailsModel
+
+3CX Installation Details
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ipAddress** | **string** | PBX IP Address | [optional] [default to undefined]
+**instanceId** | **string** | Instance ID | [optional] [default to undefined]
+**project** | **string** | Project ID | [optional] [default to undefined]
+**privateKey** | [**GenericFileModel**](GenericFileModel.md) |  | [optional] [default to undefined]
+**rootPassword** | **string** | Root Password | [optional] [default to undefined]
+**ownerExtension** | [**TcxUsersEntity**](TcxUsersEntity.md) |  | [optional] [default to undefined]
+**adminEmail** | **string** | Admin Email | [optional] [default to undefined]
+**url** | **string** | Console URL | [optional] [default to undefined]
+**adminUsername** | **string** | Admin Username | [optional] [default to undefined]
+**adminPassword** | **string** | Admin Password | [optional] [default to undefined]
+**ftpHost** | **string** | Config Backup FTP Host | [optional] [default to undefined]
+**ftpUsername** | **string** | Config Backup FTP Username | [optional] [default to undefined]
+**ftpPassword** | **string** | Config Backup FTP Password | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TcxInstallationDetailsModel } from 'yellowgrid-api-ts';
+
+const instance: TcxInstallationDetailsModel = {
+    ipAddress,
+    instanceId,
+    project,
+    privateKey,
+    rootPassword,
+    ownerExtension,
+    adminEmail,
+    url,
+    adminUsername,
+    adminPassword,
+    ftpHost,
+    ftpUsername,
+    ftpPassword,
+};
+```
+
+[[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/TcxKeySummaryDTO.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **endUser** | **string** | End User | [optional] [default to undefined]
 **sc** | **number** | Simultaneous Calls | [default to undefined]
 **edition** | **string** | Edition | [default to undefined]
-**expiry** | **string** | Expiry Date | [optional] [default to undefined]
+**expiry** | **string** | Date Time | [optional] [default to undefined]
 
 ## Example
 

package/docs/TcxWizardModel.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **sbcs** | [**Array<TcxSbcModel>**](TcxSbcModel.md) |  | [optional] [default to undefined]
 **sipTrunk** | [**TcxSipTrunksEntity**](TcxSipTrunksEntity.md) |  | [optional] [default to undefined]
 **installationStatus** | **string** |  | [optional] [default to undefined]
+**engineering** | [**TcxEngineeringDTO**](TcxEngineeringDTO.md) |  | [optional] [default to undefined]
 **setup** | [**TcxSetupEntity**](TcxSetupEntity.md) |  | [optional] [default to undefined]
 **endUserView** | **boolean** | End User Wizard View | [optional] [default to undefined]
 
@@ -39,6 +40,7 @@ const instance: TcxWizardModel = {
     sbcs,
     sipTrunk,
     installationStatus,
+    engineering,
     setup,
     endUserView,
 };

package/docs/TelephonySupportTicketModel.md

@@ -0,0 +1,41 @@
+# TelephonySupportTicketModel
+
+Telephony Support Ticket
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Ticket ID | [optional] [default to undefined]
+**status** | **string** | Ticket status | [optional] [default to undefined]
+**statusId** | **number** | Ticket status ID | [optional] [default to undefined]
+**subject** | **string** | Ticket subject | [optional] [default to undefined]
+**supportEmail** | **string** | Support email address | [optional] [default to undefined]
+**toEmails** | **Array<string>** | Recipient emails | [optional] [default to undefined]
+**description** | **string** | Ticket description (HTML) | [optional] [default to undefined]
+**descriptionText** | **string** | Ticket description (plain text) | [optional] [default to undefined]
+**createdAt** | **string** | Creation timestamp | [optional] [default to undefined]
+**attachments** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [optional] [default to undefined]
+**conversations** | [**Array<ConversationModel>**](ConversationModel.md) | Conversations | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TelephonySupportTicketModel } from 'yellowgrid-api-ts';
+
+const instance: TelephonySupportTicketModel = {
+    id,
+    status,
+    statusId,
+    subject,
+    supportEmail,
+    toEmails,
+    description,
+    descriptionText,
+    createdAt,
+    attachments,
+    conversations,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)