yellowgrid-api-ts 3.2.183 → 3.2.184-dev.0

package/docs/ProspectDTO.md

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

package/docs/ProspectsApi.md

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

package/docs/ProvisioningApi.md

@@ -1,16 +1,19 @@
 # ProvisioningApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**deleteAddFanvilMac**](#deleteaddfanvilmac) | **DELETE** /provisioning/fanvil/groups/{id}/macs/{mac} | Remove MAC address from DB and FDPS group|
+|[**deleteCheckMacExists**](#deletecheckmacexists) | **DELETE** /admin/provisioning/fanvil/macs/{mac} | |
 |[**deleteDeleteFanvilGroup**](#deletedeletefanvilgroup) | **DELETE** /provisioning/fanvil/groups/{id} | Delete group from DB and FDPS|
+|[**getCheckMacExists**](#getcheckmacexists) | **GET** /admin/provisioning/fanvil/macs/{mac} | |
 |[**getGetFanvilEncryptionKey**](#getgetfanvilencryptionkey) | **GET** /provisioning/fanvil/groups/{id}/macs/{mac}/key | Get group Fanvil encryption key|
 |[**getGetFanvilGroupMacs**](#getgetfanvilgroupmacs) | **GET** /provisioning/fanvil/groups/{id}/macs | Get MAC addresses on group at FDPS|
 |[**getGetGroups**](#getgetgroups) | **GET** /provisioning/groups | Get all provisioning groups or filter by customer ID|
 |[**postAddFanvilGroup**](#postaddfanvilgroup) | **POST** /provisioning/fanvil/groups | Add group to DB and FDPS|
 |[**postAddFanvilMac**](#postaddfanvilmac) | **POST** /provisioning/fanvil/groups/{id}/macs/{mac} | Add MAC address to DB and FDPS group|
+|[**postCreateMac**](#postcreatemac) | **POST** /admin/provisioning/fanvil/macs | |
 
 # **deleteAddFanvilMac**
 > deleteAddFanvilMac()
@@ -69,6 +72,60 @@ 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)
 
+# **deleteCheckMacExists**
+> deleteCheckMacExists()
+
+Delete a MAC address in FDPS
+
+### Example
+
+```typescript
+import {
+    ProvisioningApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProvisioningApi(configuration);
+
+let mac: string; //MAC Address (default to undefined)
+
+const { status, data } = await apiInstance.deleteCheckMacExists(
+    mac
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **mac** | [**string**] | MAC Address | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No 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)
+
 # **deleteDeleteFanvilGroup**
 > deleteDeleteFanvilGroup()
 
@@ -123,6 +180,60 @@ 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)
 
+# **getCheckMacExists**
+> GetCheckMacExists200Response getCheckMacExists()
+
+Check if a MAC address exists in FDPS
+
+### Example
+
+```typescript
+import {
+    ProvisioningApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProvisioningApi(configuration);
+
+let mac: string; //MAC Address (default to undefined)
+
+const { status, data } = await apiInstance.getCheckMacExists(
+    mac
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **mac** | [**string**] | MAC Address | defaults to undefined|
+
+
+### Return type
+
+**GetCheckMacExists200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | MAC Address Found |  -  |
+|**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)
+
 # **getGetFanvilEncryptionKey**
 > string getGetFanvilEncryptionKey()
 
@@ -400,3 +511,58 @@ 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)
 
+# **postCreateMac**
+> MacAddressDTO postCreateMac()
+
+Create a MAC address in FDPS
+
+### Example
+
+```typescript
+import {
+    ProvisioningApi,
+    Configuration,
+    MacAddressDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProvisioningApi(configuration);
+
+let macAddressDTO: MacAddressDTO; //Mac Address (optional)
+
+const { status, data } = await apiInstance.postCreateMac(
+    macAddressDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **macAddressDTO** | **MacAddressDTO**| Mac Address | |
+
+
+### Return type
+
+**MacAddressDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | MAC Address Created |  -  |
+|**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/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/SIPTrunksApi.md

@@ -1,6 +1,6 @@
 # SIPTrunksApi
 
-All URIs are relative to *https://bitbucket.org*
+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://bitbucket.org*
+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://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ShipmentRequestDTO.md

@@ -7,10 +7,10 @@ Shipment Request
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **courier** | **string** | Courier | [optional] [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 | [optional] [default to undefined]
 **service** | **string** | Service | [optional] [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 | [optional] [default to undefined]
 
 ## Example

package/docs/ShippingApi.md

@@ -1,6 +1,6 @@
 # ShippingApi
 
-All URIs are relative to *https://bitbucket.org*
+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://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/SupplierItemModel.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **itemPrice** | **number** | itemPrice | [optional] [default to undefined]
 **itemType** | **number** | itemType | [optional] [default to undefined]
 **supplierSku** | **string** | supplierSku | [optional] [default to undefined]
+**supplier** | [**SupplierModel**](SupplierModel.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -29,6 +30,7 @@ const instance: SupplierItemModel = {
     itemPrice,
     itemType,
     supplierSku,
+    supplier,
 };
 ```
 

package/docs/SupplierItemsResultsDTO.md

@@ -0,0 +1,21 @@
+# SupplierItemsResultsDTO
+
+Supplier Item Results
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<SupplierItemModel>**](SupplierItemModel.md) | Results | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SupplierItemsResultsDTO } from 'yellowgrid-api-ts';
+
+const instance: SupplierItemsResultsDTO = {
+    results,
+};
+```
+
+[[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/SupplierProductModel.md

@@ -0,0 +1,25 @@
+# SupplierProductModel
+
+Supplier Product
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **string** | SKU | [optional] [default to undefined]
+**description** | **string** | Description | [optional] [default to undefined]
+**items** | [**Array<SupplierItemModel>**](SupplierItemModel.md) | Items | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SupplierProductModel } from 'yellowgrid-api-ts';
+
+const instance: SupplierProductModel = {
+    sku,
+    description,
+    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/SupplierProductResultsModel.md

@@ -0,0 +1,27 @@
+# SupplierProductResultsModel
+
+Supplier Product Results
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<SupplierProductModel>**](SupplierProductModel.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 { SupplierProductResultsModel } from 'yellowgrid-api-ts';
+
+const instance: SupplierProductResultsModel = {
+    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/SuppliersApi.md

@@ -0,0 +1,68 @@
+# SuppliersApi
+
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getGetSupplierItems**](#getgetsupplieritems) | **GET** /suppliers/items | Get Supplier Items|
+
+# **getGetSupplierItems**
+> SupplierProductResultsModel getGetSupplierItems()
+
+Get Supplier Items
+
+### Example
+
+```typescript
+import {
+    SuppliersApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SuppliersApi(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)
+
+const { status, data } = await apiInstance.getGetSupplierItems(
+    pageSize,
+    page,
+    search
+);
+```
+
+### 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|
+
+
+### Return type
+
+**SupplierProductResultsModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Supplier Items |  -  |
+|**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/SystemApi.md

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

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

@@ -35,6 +35,8 @@ Name | Type | Description | Notes
 **disk** | **number** | Recordings Disk Size | [optional] [default to undefined]
 **flavour** | **string** | Instance Spec | [optional] [default to undefined]
 **autoFailover** | **boolean** | Auto Failover | [optional] [default to undefined]
+**extensions** | **number** | Extensions in Use | [optional] [default to undefined]
+**maxExtensions** | **number** | Max Allowed Extensions | [optional] [default to undefined]
 
 ## Example
 
@@ -71,6 +73,8 @@ const instance: TcxInstallationModel = {
     disk,
     flavour,
     autoFailover,
+    extensions,
+    maxExtensions,
 };
 ```
 

package/docs/TcxKeySummaryDTO.md

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

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://bitbucket.org*
+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://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/getEnums.php

@@ -1,31 +1,31 @@
-<?php
-
-use App\Contracts\Enums\PublicEnumInterface;
-
-require_once __DIR__."/../../../../vendor/autoload.php";
-
-$dir = __DIR__."/models";
-if (!is_dir($dir)) {
-    mkdir($dir);
-}
-foreach (\App\Enums\Router\PublicEnumEnum::cases() as $publicEnum) {
-    $ref = new ReflectionEnum($publicEnum->value);
-    $cases = [];
-    foreach ($ref->getCases() as $c) {
-        /** @var BackedEnum $enum */
-        $enum = $c->getEnum()->getName();
-        $value = $c->getBackingValue();
-        /** @var PublicEnumInterface $case */
-        $case = $enum::from($value);
-        $cases[$c->getName()] = [
-            "name" => $case->name,
-            "value" => $case->value,
-            "publicValue" => $case->getPublicValue()
-        ];
-    }
-    $enumName = $ref->getShortName();
-    $enumString = json_encode($cases, JSON_PRETTY_PRINT);
-    $content = "export const $enumName = $enumString as const;".
-        "\n\n export type $enumName = typeof $enumName;";
-    file_put_contents("$dir/$enumName.ts", $content);
-}
+<?php
+
+use App\Contracts\Enums\PublicEnumInterface;
+
+require_once __DIR__."/../../../../vendor/autoload.php";
+
+$dir = __DIR__."/models";
+if (!is_dir($dir)) {
+    mkdir($dir);
+}
+foreach (\App\Enums\Router\PublicEnumEnum::cases() as $publicEnum) {
+    $ref = new ReflectionEnum($publicEnum->value);
+    $cases = [];
+    foreach ($ref->getCases() as $c) {
+        /** @var BackedEnum $enum */
+        $enum = $c->getEnum()->getName();
+        $value = $c->getBackingValue();
+        /** @var PublicEnumInterface $case */
+        $case = $enum::from($value);
+        $cases[$c->getName()] = [
+            "name" => $case->name,
+            "value" => $case->value,
+            "publicValue" => $case->getPublicValue()
+        ];
+    }
+    $enumName = $ref->getShortName();
+    $enumString = json_encode($cases, JSON_PRETTY_PRINT);
+    $content = "export const $enumName = $enumString as const;".
+        "\n\n export type $enumName = typeof $enumName;";
+    file_put_contents("$dir/$enumName.ts", $content);
+}