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

package/dist/models/GroupEnum.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GroupEnum = void 0;
-exports.GroupEnum = {
-    "ACCOUNTS": {
-        "name": "ACCOUNTS",
-        "value": "Accounts",
-        "publicValue": "Accounts"
-    },
-    "ALL": {
-        "name": "ALL",
-        "value": "All",
-        "publicValue": "All"
-    },
-    "BOARD": {
-        "name": "BOARD",
-        "value": "Board",
-        "publicValue": "Board"
-    },
-    "DEVELOPMENT": {
-        "name": "DEVELOPMENT",
-        "value": "Development",
-        "publicValue": "Development"
-    },
-    "SALES_MARKETING": {
-        "name": "SALES_MARKETING",
-        "value": "SalesMarketing",
-        "publicValue": "SalesMarketing"
-    },
-    "TELEPHONY": {
-        "name": "TELEPHONY",
-        "value": "Telephony",
-        "publicValue": "Telephony"
-    },
-    "TELESALES": {
-        "name": "TELESALES",
-        "value": "Telesales",
-        "publicValue": "Telesales"
-    },
-    "TECH": {
-        "name": "TECH",
-        "value": "Tech",
-        "publicValue": "Tech"
-    }
-};

package/docs/NumberPortModel.md

@@ -1,51 +0,0 @@
-# NumberPortModel
-
-Number Port Model
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | Number Port ID | [optional] [default to undefined]
-**customerId** | **number** | Customer ID | [optional] [default to undefined]
-**endUser** | **string** | End User | [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]
-**postCode** | **string** | Post Code | [optional] [default to undefined]
-**trunkId** | **number** | Trunk ID | [optional] [default to undefined]
-**tenantId** | **string** | Tenant ID | [optional] [default to undefined]
-**requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
-**portDate** | **string** | Port Date | [optional] [default to undefined]
-**comment** | **string** | Comment | [optional] [default to undefined]
-**status** | **number** | Status | [optional] [default to undefined]
-**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
-**ranges** | **Array<any>** | Number Port Ranges | [optional] [default to undefined]
-**customerName** | **string** | Customer Company Name | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { NumberPortModel } from 'yellowgrid-api-ts';
-
-const instance: NumberPortModel = {
-    id,
-    customerId,
-    endUser,
-    addressLine1,
-    addressLine2,
-    city,
-    postCode,
-    trunkId,
-    tenantId,
-    requestedPortDate,
-    portDate,
-    comment,
-    status,
-    ticketId,
-    ranges,
-    customerName,
-};
-```
-
-[[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/PostGetProductRequest.md

@@ -1,24 +0,0 @@
-# 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/ProductSearchDTO.md

@@ -1,37 +0,0 @@
-# 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/PromoItemModel.md

@@ -1,35 +0,0 @@
-# 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

@@ -1,45 +0,0 @@
-# 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

@@ -1,27 +0,0 @@
-# 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

@@ -1,29 +0,0 @@
-# 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)

package/docs/PromotionsApi.md

@@ -1,241 +0,0 @@
-# PromotionsApi
-
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getGetPromo**](#getgetpromo) | **GET** /marketing/promos/{id} | |
-|[**getGetPromos**](#getgetpromos) | **GET** /marketing/promos | |
-|[**postGetPromos**](#postgetpromos) | **POST** /marketing/promos | |
-|[**putGetPromo**](#putgetpromo) | **PUT** /marketing/promos/{id} | |
-
-# **getGetPromo**
-> PromoModel getGetPromo()
-
-Get a promotion
-
-### Example
-
-```typescript
-import {
-    PromotionsApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new PromotionsApi(configuration);
-
-let id: number; //Promo ID (default to undefined)
-
-const { status, data } = await apiInstance.getGetPromo(
-    id
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**number**] | Promo ID | defaults to undefined|
-
-
-### Return type
-
-**PromoModel**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Promotion |  -  |
-|**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)
-
-# **getGetPromos**
-> PromoSummariesModel getGetPromos()
-
-Get Promos
-
-### Example
-
-```typescript
-import {
-    PromotionsApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new PromotionsApi(configuration);
-
-let pageSize: number; //Number Of Results (optional) (default to 20)
-let page: number; //Page Number (optional) (default to 1)
-let search: string; //Search (optional) (default to undefined)
-let expired: boolean; //Expired (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getGetPromos(
-    pageSize,
-    page,
-    search,
-    expired
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
-| **page** | [**number**] | Page Number | (optional) defaults to 1|
-| **search** | [**string**] | Search | (optional) defaults to undefined|
-| **expired** | [**boolean**] | Expired | (optional) defaults to undefined|
-
-
-### Return type
-
-**PromoSummariesModel**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Promo Summaries |  -  |
-|**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)
-
-# **postGetPromos**
-> PromoModel postGetPromos()
-
-Create a promotion
-
-### Example
-
-```typescript
-import {
-    PromotionsApi,
-    Configuration,
-    PromoModel
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new PromotionsApi(configuration);
-
-let promoModel: PromoModel; //Promotion (optional)
-
-const { status, data } = await apiInstance.postGetPromos(
-    promoModel
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **promoModel** | **PromoModel**| Promotion | |
-
-
-### Return type
-
-**PromoModel**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Promotion |  -  |
-|**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)
-
-# **putGetPromo**
-> PromoModel putGetPromo()
-
-Update a promotion
-
-### Example
-
-```typescript
-import {
-    PromotionsApi,
-    Configuration,
-    PromoModel
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new PromotionsApi(configuration);
-
-let id: number; //Promo ID (default to undefined)
-let promoModel: PromoModel; //Promotion (optional)
-
-const { status, data } = await apiInstance.putGetPromo(
-    id,
-    promoModel
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **promoModel** | **PromoModel**| Promotion | |
-| **id** | [**number**] | Promo ID | defaults to undefined|
-
-
-### Return type
-
-**PromoModel**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Promotion |  -  |
-|**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)
-

package/docs/TcxHostingPricingEntity.md

@@ -1,35 +0,0 @@
-# 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

@@ -1,45 +0,0 @@
-# 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/TelephonySupportTicketModel.md

@@ -1,41 +0,0 @@
-# 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)