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

package/docs/AdminUserModel.md

@@ -6,7 +6,6 @@ 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]
@@ -14,6 +13,8 @@ Name | Type | Description | Notes
 **email** | **string** | Email | [optional] [default to undefined]
 **primaryHex** | **string** | Primary Colour | [optional] [default to undefined]
 **secondaryHex** | **string** | Secondary Colour | [optional] [default to undefined]
+**scopes** | **Array<string>** | Scopes | [optional] [default to undefined]
+**permissions** | **Array<string>** | Groups | [optional] [default to undefined]
 
 ## Example
 
@@ -21,7 +22,6 @@ Name | Type | Description | Notes
 import { AdminUserModel } from 'yellowgrid-api-ts';
 
 const instance: AdminUserModel = {
-    id,
     firstName,
     lastName,
     avatar,
@@ -29,6 +29,8 @@ const instance: AdminUserModel = {
     email,
     primaryHex,
     secondaryHex,
+    scopes,
+    permissions,
 };
 ```
 

package/docs/CRMApi.md

@@ -1,72 +1,10 @@
 # CRMApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |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()
@@ -115,61 +53,3 @@ 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://localhost*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/Class3CXInstallationWizardApi.md

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

package/docs/Class3CXInstallationsApi.md

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

package/docs/Class3CXIntegrationsApi.md

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

package/docs/Class3CXMultiTenantApi.md

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

package/docs/MyPBXToolsApi.md

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

package/docs/NumberPortModel.md

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

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

package/docs/OAuth20Api.md

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

package/docs/OrdersApi.md

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

package/docs/PricingApi.md

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

package/docs/ProductsApi.md

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

package/docs/ProspectDTO.md

@@ -13,7 +13,6 @@ 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
 
@@ -28,7 +27,6 @@ const instance: ProspectDTO = {
     xeroId,
     removed,
     status,
-    orderCount,
 };
 ```
 

package/docs/ProspectsApi.md

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

package/docs/ProvisioningApi.md

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

package/docs/SIPTrunksApi.md

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

package/docs/SMSApi.md

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

package/docs/ServicesApi.md

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

package/docs/ShippingApi.md

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

package/docs/StockManagementApi.md

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

package/docs/SystemApi.md

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

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)

package/docs/TicketsApi.md

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

package/docs/WebhooksApi.md

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