yellowgrid-api-ts 3.2.144-dev.0 → 3.2.145-dev.0

package/docs/AddressDTO.md

@@ -0,0 +1,31 @@
+# AddressDTO
+
+Address
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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]
+**region** | **string** | Region | [optional] [default to undefined]
+**postalCode** | **string** | Postal Code | [optional] [default to undefined]
+**iso** | **string** | Country | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AddressDTO } from 'yellowgrid-api-ts';
+
+const instance: AddressDTO = {
+    addressLine1,
+    addressLine2,
+    city,
+    region,
+    postalCode,
+    iso,
+};
+```
+
+[[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/AdminUserModel.md

@@ -6,6 +6,7 @@ Admin User
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
 **firstName** | **string** | First Name | [optional] [default to undefined]
 **lastName** | **string** | Last Name | [optional] [default to undefined]
 **avatar** | **string** | Avatar | [optional] [default to undefined]
@@ -20,6 +21,7 @@ Name | Type | Description | Notes
 import { AdminUserModel } from 'yellowgrid-api-ts';
 
 const instance: AdminUserModel = {
+    id,
     firstName,
     lastName,
     avatar,

package/docs/CRMApi.md

@@ -1,10 +1,72 @@
 # CRMApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**getGetCrmActivities**](#getgetcrmactivities) | **GET** /admin/crm/{id}/activities | |
 |[**getSearchByPhone**](#getsearchbyphone) | **GET** /crm/contact/search | |
+|[**postCreateCrmNote**](#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note | |
+
+# **getGetCrmActivities**
+> CrmActivitiesResponseDTO getGetCrmActivities()
+
+Get Customer CRM Activities
+
+### Example
+
+```typescript
+import {
+    CRMApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new CRMApi(configuration);
+
+let id: number; //Account ID (default to undefined)
+let type: 'alert' | 'call' | 'note' | 'order' | 'quote' | 'tcx_order'; //Activity Type (optional) (default to undefined)
+let userId: number; //Activity Created By (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetCrmActivities(
+    id,
+    type,
+    userId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Account ID | defaults to undefined|
+| **type** | [**&#39;alert&#39; | &#39;call&#39; | &#39;note&#39; | &#39;order&#39; | &#39;quote&#39; | &#39;tcx_order&#39;**]**Array<&#39;alert&#39; &#124; &#39;call&#39; &#124; &#39;note&#39; &#124; &#39;order&#39; &#124; &#39;quote&#39; &#124; &#39;tcx_order&#39;>** | Activity Type | (optional) defaults to undefined|
+| **userId** | [**number**] | Activity Created By | (optional) defaults to undefined|
+
+
+### Return type
+
+**CrmActivitiesResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | CRM Activities |  -  |
+|**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)
 
 # **getSearchByPhone**
 > CrmContactDTO getSearchByPhone()
@@ -53,3 +115,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)
 
+# **postCreateCrmNote**
+> CrmActivityDTO postCreateCrmNote()
+
+Create CRM Note
+
+### Example
+
+```typescript
+import {
+    CRMApi,
+    Configuration,
+    CreateCrmNoteBody
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new CRMApi(configuration);
+
+let id: number; //Account ID (default to undefined)
+let createCrmNoteBody: CreateCrmNoteBody; //CRM Note Request (optional)
+
+const { status, data } = await apiInstance.postCreateCrmNote(
+    id,
+    createCrmNoteBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createCrmNoteBody** | **CreateCrmNoteBody**| CRM Note Request | |
+| **id** | [**number**] | Account ID | defaults to undefined|
+
+
+### Return type
+
+**CrmActivityDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | CRM Activity |  -  |
+|**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/Class3CXApi.md

@@ -1,6 +1,6 @@
 # Class3CXApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXInstallationWizardApi.md

@@ -1,6 +1,6 @@
 # Class3CXInstallationWizardApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXInstallationsApi.md

@@ -1,6 +1,6 @@
 # Class3CXInstallationsApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXIntegrationsApi.md

@@ -1,6 +1,6 @@
 # Class3CXIntegrationsApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXMultiTenantApi.md

@@ -1,6 +1,6 @@
 # Class3CXMultiTenantApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/CreateCrmNoteBody.md

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

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

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

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

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

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

@@ -1,6 +1,6 @@
 # MyPBXToolsApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/NumberPortAdminNoteBody.md

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

@@ -1,6 +1,6 @@
 # NumberPortingApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -401,7 +401,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)
 
 # **postAddAdminNote**
-> AdminNumberPortDTO postAddAdminNote(postAddAdminNoteRequest)
+> AdminNumberPortDTO postAddAdminNote(numberPortAdminNoteBody)
 
 
 ### Example
@@ -410,18 +410,18 @@ No authorization required
 import {
     NumberPortingApi,
     Configuration,
-    PostAddAdminNoteRequest
+    NumberPortAdminNoteBody
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new NumberPortingApi(configuration);
 
 let id: number; //Number Port ID (default to undefined)
-let postAddAdminNoteRequest: PostAddAdminNoteRequest; //
+let numberPortAdminNoteBody: NumberPortAdminNoteBody; //Number Port Note Request
 
 const { status, data } = await apiInstance.postAddAdminNote(
     id,
-    postAddAdminNoteRequest
+    numberPortAdminNoteBody
 );
 ```
 
@@ -429,7 +429,7 @@ const { status, data } = await apiInstance.postAddAdminNote(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **postAddAdminNoteRequest** | **PostAddAdminNoteRequest**|  | |
+| **numberPortAdminNoteBody** | **NumberPortAdminNoteBody**| Number Port Note Request | |
 | **id** | [**number**] | Number Port ID | defaults to undefined|
 
 

package/docs/OAuth20Api.md

@@ -1,6 +1,6 @@
 # OAuth20Api
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/OrdersApi.md

@@ -1,13 +1,12 @@
 # OrdersApi
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**deleteDeleteBatch**](#deletedeletebatch) | **DELETE** /admin/orders/{id}/batches/{batch_id} | |
 |[**deleteUpdateOrder**](#deleteupdateorder) | **DELETE** /orders/{id} | Delete Orders (Beta)|
 |[**deleteUpdateShipment**](#deleteupdateshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Delete Shipment (Admin)|
-|[**getCreatePortalOrderLegacy**](#getcreateportalorderlegacy) | **GET** /orders/portal/legacy | Create an order via the legacy portal|
 |[**getGetAdminEditableOrder**](#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)|
 |[**getGetAdminOrderDetails**](#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)|
 |[**getGetCommercialInvoice**](#getgetcommercialinvoice) | **GET** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/pdf | Get Commercial Invoice PDF|
@@ -207,61 +206,6 @@ 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)
 
-# **getCreatePortalOrderLegacy**
-> OrderResponseDTO getCreatePortalOrderLegacy()
-
-Create an order via the legacy portal
-
-### Example
-
-```typescript
-import {
-    OrdersApi,
-    Configuration,
-    OrderDTO
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new OrdersApi(configuration);
-
-let orderDTO: OrderDTO; //Legacy Portal Order (optional)
-
-const { status, data } = await apiInstance.getCreatePortalOrderLegacy(
-    orderDTO
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **orderDTO** | **OrderDTO**| Legacy Portal Order | |
-
-
-### Return type
-
-**OrderResponseDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Legacy Portal Order 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)
-
 # **getGetAdminEditableOrder**
 > AdminOrderRequestDTO getGetAdminEditableOrder()
 

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]
+**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

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

@@ -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)