yellowgrid-api-ts 3.2.151-dev.0 → 3.2.153-dev.0

package/docs/CreateCrmNoteBody.md

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

@@ -1,23 +0,0 @@
-# CrmActivitiesResponseDTO
-
-CRM Activities Response
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**dates** | [**Array<CrmDateActivitiesDTO>**](CrmDateActivitiesDTO.md) | Dates | [optional] [default to undefined]
-**agents** | [**Array<AdminUserModel>**](AdminUserModel.md) | Agents | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CrmActivitiesResponseDTO } from 'yellowgrid-api-ts';
-
-const instance: CrmActivitiesResponseDTO = {
-    dates,
-    agents,
-};
-```
-
-[[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/CrmActivityDto.md

@@ -1,33 +0,0 @@
-# CrmActivityDTO
-
-CRM Activity
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**type** | **string** | Activity Type | [optional] [default to undefined]
-**timestamp** | **string** | Date Time | [optional] [default to undefined]
-**title** | **string** | Activity Title | [optional] [default to undefined]
-**description** | **string** | Activity Description | [optional] [default to undefined]
-**url** | **string** | Activity URL | [optional] [default to undefined]
-**user** | **string** | Activity User Name | [optional] [default to undefined]
-**contact** | **string** | Activity Contact Name | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CrmActivityDTO } from 'yellowgrid-api-ts';
-
-const instance: CrmActivityDTO = {
-    type,
-    timestamp,
-    title,
-    description,
-    url,
-    user,
-    contact,
-};
-```
-
-[[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/CrmDateActivitiesDTO.md

@@ -1,23 +0,0 @@
-# CrmDateActivitiesDTO
-
-CRM Date Activities
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**date** | **string** | Date Time | [optional] [default to undefined]
-**activities** | [**Array<CrmActivityDTO>**](CrmActivityDTO.md) | Activities | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CrmDateActivitiesDTO } from 'yellowgrid-api-ts';
-
-const instance: CrmDateActivitiesDTO = {
-    date,
-    activities,
-};
-```
-
-[[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/CrmNoteEntity.md

@@ -1,39 +0,0 @@
-# CrmNoteEntity
-
-CrmNotesEntity
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**customerId** | **string** | customerId | [optional] [default to undefined]
-**userId** | **number** | userId | [optional] [default to undefined]
-**type** | **string** | type | [optional] [default to undefined]
-**note** | **string** | note | [optional] [default to undefined]
-**timestamp** | **string** | timestamp | [optional] [default to undefined]
-**journalTime** | **string** | journalTime | [optional] [default to undefined]
-**duration** | **string** | duration | [optional] [default to undefined]
-**callType** | **string** | callType | [optional] [default to undefined]
-**callId** | **number** | callId | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CrmNoteEntity } from 'yellowgrid-api-ts';
-
-const instance: CrmNoteEntity = {
-    id,
-    customerId,
-    userId,
-    type,
-    note,
-    timestamp,
-    journalTime,
-    duration,
-    callType,
-    callId,
-};
-```
-
-[[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/CrmNoteModel.md

@@ -1,39 +0,0 @@
-# CrmNoteModel
-
-CrmNotesEntity
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**customerId** | **string** | customerId | [optional] [default to undefined]
-**userId** | **number** | userId | [optional] [default to undefined]
-**type** | **string** | type | [optional] [default to undefined]
-**note** | **string** | note | [optional] [default to undefined]
-**timestamp** | **string** | timestamp | [optional] [default to undefined]
-**journalTime** | **string** | journalTime | [optional] [default to undefined]
-**duration** | **string** | duration | [optional] [default to undefined]
-**callType** | **string** | callType | [optional] [default to undefined]
-**callId** | **number** | callId | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CrmNoteModel } from 'yellowgrid-api-ts';
-
-const instance: CrmNoteModel = {
-    id,
-    customerId,
-    userId,
-    type,
-    note,
-    timestamp,
-    journalTime,
-    duration,
-    callType,
-    callId,
-};
-```
-
-[[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/NumberPortAdminNoteBody.md

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

@@ -1,39 +0,0 @@
-# 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]
-**hostingPriceList** | **string** | 3CX Hosting Price List | [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,
-    hostingPriceList,
-    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/PatchSendWelcomeEmailRequest.md

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

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

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

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

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

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

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

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

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

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

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

@@ -1,20 +0,0 @@
-# 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/models/HostingPriceListEnum.ts

@@ -1,29 +0,0 @@
-export const HostingPriceListEnum = {
-    "HOSTING_ONLY": {
-        "name": "HOSTING_ONLY",
-        "value": 1,
-        "publicValue": "HO - Hosting Only"
-    },
-    "HOSTING_ONLY_BESPOKE": {
-        "name": "HOSTING_ONLY_BESPOKE",
-        "value": 2,
-        "publicValue": "HOB - Hosted Only Bespoke"
-    },
-    "HOSTING_AND_SUPPORT": {
-        "name": "HOSTING_AND_SUPPORT",
-        "value": 3,
-        "publicValue": "HS - Hosted & Support"
-    },
-    "HOSTING_AND_SUPPORT_BESPOKE": {
-        "name": "HOSTING_AND_SUPPORT_BESPOKE",
-        "value": 4,
-        "publicValue": "HSB - Hosted & Support Bespoke"
-    },
-    "END_USER": {
-        "name": "END_USER",
-        "value": 5,
-        "publicValue": "YG - Yellowgrid Customer"
-    }
-} as const;
-
- export type HostingPriceListEnum = typeof HostingPriceListEnum;