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

package/docs/ServicePlan.md

@@ -0,0 +1,36 @@
+# ServicePlan
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**name** | **string** |  | [default to undefined]
+**services** | [**Array<Service>**](Service.md) |  | [optional] [readonly] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+**planGroup** | **string** |  | [optional] [default to undefined]
+**connectionTypeId** | **number** |  | [optional] [default to undefined]
+**connectionType** | [**ConnectionType**](ConnectionType.md) |  | [optional] [default to undefined]
+**closed** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ServicePlan } from 'yellowgrid-api-ts';
+
+const instance: ServicePlan = {
+    createdDate,
+    id,
+    name,
+    services,
+    filePeriod,
+    planGroup,
+    connectionTypeId,
+    connectionType,
+    closed,
+};
+```
+
+[[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/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/SpecialService.md

@@ -0,0 +1,40 @@
+# SpecialService
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**outboundCliId** | **number** |  | [optional] [default to undefined]
+**outboundCli** | [**OutboundCli**](OutboundCli.md) |  | [default to undefined]
+**baseService** | [**BaseService**](BaseService.md) |  | [default to undefined]
+**customerRate** | [**CustomerRate**](CustomerRate.md) |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**hideOnInvoice** | **boolean** |  | [optional] [default to undefined]
+**startPeriod** | **string** |  | [default to undefined]
+**endPeriod** | **string** |  | [optional] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SpecialService } from 'yellowgrid-api-ts';
+
+const instance: SpecialService = {
+    createdDate,
+    id,
+    outboundCliId,
+    outboundCli,
+    baseService,
+    customerRate,
+    description,
+    hideOnInvoice,
+    startPeriod,
+    endPeriod,
+    filePeriod,
+};
+```
+
+[[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/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/SuppliersApi.md

@@ -1,6 +1,6 @@
 # SuppliersApi
 
-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/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/TariffRate.md

@@ -0,0 +1,30 @@
+# TariffRate
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**markup** | [**CustomerRateType**](CustomerRateType.md) |  | [optional] [default to undefined]
+**day** | **number** |  | [optional] [default to undefined]
+**evening** | **number** |  | [optional] [default to undefined]
+**weekend** | **number** |  | [optional] [default to undefined]
+**minimum** | **number** |  | [optional] [default to undefined]
+**setup** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TariffRate } from 'yellowgrid-api-ts';
+
+const instance: TariffRate = {
+    markup,
+    day,
+    evening,
+    weekend,
+    minimum,
+    setup,
+};
+```
+
+[[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/TcxHostingPricingEntity.md

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

@@ -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/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/UnconnectedSdr.md

@@ -0,0 +1,68 @@
+# UnconnectedSdr
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [default to undefined]
+**sdrId** | **number** |  | [optional] [default to undefined]
+**sdr** | [**Sdr**](Sdr.md) |  | [default to undefined]
+**productCode** | **string** |  | [default to undefined]
+**cli** | **string** |  | [optional] [default to undefined]
+**outboundCliId** | **number** |  | [optional] [default to undefined]
+**outboundCli** | [**OutboundCli**](OutboundCli.md) |  | [optional] [default to undefined]
+**servicePlanId** | **number** |  | [optional] [default to undefined]
+**servicePlan** | [**ServicePlan**](ServicePlan.md) |  | [optional] [default to undefined]
+**serviceId** | **number** |  | [optional] [default to undefined]
+**service** | [**Service**](Service.md) |  | [optional] [default to undefined]
+**specialServiceId** | **number** |  | [optional] [default to undefined]
+**specialService** | [**SpecialService**](SpecialService.md) |  | [optional] [default to undefined]
+**customerCharge** | **number** |  | [optional] [default to undefined]
+**customerRate** | [**CustomerRate**](CustomerRate.md) |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**hideOnInvoice** | **boolean** |  | [optional] [default to undefined]
+**unitCharge** | **number** |  | [optional] [default to undefined]
+**customerId** | **number** |  | [optional] [default to undefined]
+**servicePlanName** | **string** |  | [optional] [default to undefined]
+**serviceCode** | **string** |  | [optional] [default to undefined]
+**sdrDescription** | **string** |  | [optional] [default to undefined]
+**sdrCost** | **number** |  | [optional] [default to undefined]
+**remarks** | **string** |  | [optional] [default to undefined]
+**filePeriod** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UnconnectedSdr } from 'yellowgrid-api-ts';
+
+const instance: UnconnectedSdr = {
+    id,
+    sdrId,
+    sdr,
+    productCode,
+    cli,
+    outboundCliId,
+    outboundCli,
+    servicePlanId,
+    servicePlan,
+    serviceId,
+    service,
+    specialServiceId,
+    specialService,
+    customerCharge,
+    customerRate,
+    description,
+    hideOnInvoice,
+    unitCharge,
+    customerId,
+    servicePlanName,
+    serviceCode,
+    sdrDescription,
+    sdrCost,
+    remarks,
+    filePeriod,
+};
+```
+
+[[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/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);
+}