yellowgrid-api-ts 3.2.230 → 3.2.231-dev.0

package/docs/TableDTO.md

@@ -0,0 +1,25 @@
+# TableDTO
+
+Table
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **string** | Title | [optional] [default to undefined]
+**headers** | [**TableRowDTO**](TableRowDTO.md) |  | [optional] [default to undefined]
+**rows** | [**Array<TableRowDTO>**](TableRowDTO.md) | Rows | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TableDTO } from 'yellowgrid-api-ts';
+
+const instance: TableDTO = {
+    title,
+    headers,
+    rows,
+};
+```
+
+[[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/TableDataDTO.md

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

@@ -0,0 +1,21 @@
+# TableRowDTO
+
+Table Row
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<TableDataDTO>**](TableDataDTO.md) | Table Data | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TableRowDTO } from 'yellowgrid-api-ts';
+
+const instance: TableRowDTO = {
+    data,
+};
+```
+
+[[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/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/TcxInstallationModel.md

@@ -7,6 +7,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **wizardId** | **string** | Wizard ID | [optional] [default to undefined]
+**customerId** | **number** | Customer ID | [optional] [default to undefined]
 **instanceId** | **string** | Instance ID | [optional] [default to undefined]
 **licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
 **endUser** | **string** | End User | [optional] [default to undefined]
@@ -45,6 +46,7 @@ import { TcxInstallationModel } from 'yellowgrid-api-ts';
 
 const instance: TcxInstallationModel = {
     wizardId,
+    customerId,
     instanceId,
     licenceKey,
     endUser,

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);
+}

package/index.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Yellowgrid
- * Welcome to the Yellowgrid API documentation.    This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services.    ## Key Features:   - **Accounts**: View and manage account details, contacts, client credentials, and verification.   - **Provisioning**: Automate setup and configuration of devices and groups.   - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration.   - **Messaging**: Send SMS messages securely via the messaging gateway.   - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup.    ## Authentication:   The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints.          ## Base URL:   `https://bitbucket.org`               For questions or technical support, please contact support@yellowgrid.co.uk.
+ * Welcome to the Yellowgrid API documentation.      This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services.      ## Key Features:    - **Accounts**: View and manage account details, contacts, client credentials, and verification.    - **Provisioning**: Automate setup and configuration of devices and groups.    - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration.    - **Messaging**: Send SMS messages securely via the messaging gateway.    - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup.      ## Authentication:    The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints.            ## Base URL:    `https://api.local.yellowgrid.co.uk`                  For questions or technical support, please contact support@yellowgrid.co.uk.
  *
  * The version of the OpenAPI document: 0
  * 

package/models/ConnectionTypeEnum.ts

@@ -0,0 +1,64 @@
+export const ConnectionTypeEnum = {
+    "SIP_TRUNK": {
+        "name": "SIP_TRUNK",
+        "value": "SIP Trunks",
+        "publicValue": "SIP Trunks"
+    },
+    "BROADBAND": {
+        "name": "BROADBAND",
+        "value": "Broadband",
+        "publicValue": "Broadband"
+    },
+    "ETHERNET": {
+        "name": "ETHERNET",
+        "value": "Ethernet",
+        "publicValue": "Ethernet"
+    },
+    "MOBILE": {
+        "name": "MOBILE",
+        "value": "Mobile",
+        "publicValue": "Mobile"
+    },
+    "WLR": {
+        "name": "WLR",
+        "value": "WLR",
+        "publicValue": "WLR"
+    },
+    "HZN": {
+        "name": "HZN",
+        "value": "Horizon",
+        "publicValue": "Horizon"
+    },
+    "NTS": {
+        "name": "NTS",
+        "value": "NTS",
+        "publicValue": "NTS"
+    },
+    "HOSTING": {
+        "name": "HOSTING",
+        "value": "Hosting",
+        "publicValue": "Hosting"
+    },
+    "CRM": {
+        "name": "CRM",
+        "value": "CRM",
+        "publicValue": "CRM"
+    },
+    "TCX_MULTITENANT": {
+        "name": "TCX_MULTITENANT",
+        "value": "Starter Bundle",
+        "publicValue": "Starter Bundle"
+    },
+    "OTHER": {
+        "name": "OTHER",
+        "value": "Other",
+        "publicValue": "Other"
+    },
+    "RECURRING_CHARGES": {
+        "name": "RECURRING_CHARGES",
+        "value": "Recurring Charges",
+        "publicValue": "Recurring Charges"
+    }
+} as const;
+
+ export type ConnectionTypeEnum = typeof ConnectionTypeEnum;

package/models/GraphTypeEnum.ts

@@ -0,0 +1,14 @@
+export const GraphTypeEnum = {
+    "STACKED": {
+        "name": "STACKED",
+        "value": "stacked-area",
+        "publicValue": "Stacked Area"
+    },
+    "TABLE": {
+        "name": "TABLE",
+        "value": "table",
+        "publicValue": "Table"
+    }
+} as const;
+
+ export type GraphTypeEnum = typeof GraphTypeEnum;

package/models/HostingPriceListEnum.ts

@@ -28,6 +28,11 @@ export const HostingPriceListEnum = {
         "name": "HOSTING_WHOLESALE",
         "value": 6,
         "publicValue": "Hosting Only (Wholesale)"
+    },
+    "HOSTING_ITSP": {
+        "name": "HOSTING_ITSP",
+        "value": 7,
+        "publicValue": "Hosting Only (ITSP)"
     }
 } as const;
 

package/models/ReasonEnum.ts

@@ -0,0 +1,24 @@
+export const ReasonEnum = {
+    "DOA": {
+        "name": "DOA",
+        "value": 1,
+        "publicValue": "Dead On Arrival"
+    },
+    "FAULTY": {
+        "name": "FAULTY",
+        "value": 2,
+        "publicValue": "Faulty"
+    },
+    "WORKING_GOOD_CONDITION": {
+        "name": "WORKING_GOOD_CONDITION",
+        "value": 3,
+        "publicValue": "Working (Good Condition)"
+    },
+    "WORKING_BAD_CONDITION": {
+        "name": "WORKING_BAD_CONDITION",
+        "value": 4,
+        "publicValue": "Working (Bad Condition)"
+    }
+} as const;
+
+ export type ReasonEnum = typeof ReasonEnum;

package/models/ReportEnum.ts

@@ -0,0 +1,69 @@
+export const ReportEnum = {
+    "STOCK": {
+        "name": "STOCK",
+        "value": 1,
+        "publicValue": "Stock"
+    },
+    "POS": {
+        "name": "POS",
+        "value": 2,
+        "publicValue": "POS"
+    },
+    "CUSTOMER_SPEND": {
+        "name": "CUSTOMER_SPEND",
+        "value": 3,
+        "publicValue": "Customer Spend"
+    },
+    "MONTHLY_SALES": {
+        "name": "MONTHLY_SALES",
+        "value": 4,
+        "publicValue": "Monthly Sales"
+    },
+    "CUSTOMER_ANNUAL_COMPARISON": {
+        "name": "CUSTOMER_ANNUAL_COMPARISON",
+        "value": 5,
+        "publicValue": "Customer Annual Comparison"
+    },
+    "LOW_STOCK": {
+        "name": "LOW_STOCK",
+        "value": 6,
+        "publicValue": "Low Stock"
+    },
+    "LEAGUE_TABLE": {
+        "name": "LEAGUE_TABLE",
+        "value": 7,
+        "publicValue": "League Table"
+    },
+    "REVENUE": {
+        "name": "REVENUE",
+        "value": 8,
+        "publicValue": "Revenue"
+    },
+    "EXPENDITURE": {
+        "name": "EXPENDITURE",
+        "value": 9,
+        "publicValue": "Expenditure"
+    },
+    "TECH_SUPPORT_CUSTOMERS": {
+        "name": "TECH_SUPPORT_CUSTOMERS",
+        "value": 10,
+        "publicValue": "Tech Support Customers"
+    },
+    "BILLING_BUNDLE_CALLS": {
+        "name": "BILLING_BUNDLE_CALLS",
+        "value": 11,
+        "publicValue": "Billing - Bundle Calls With Cost"
+    },
+    "BILLING_UNCONNECTED_CALLS": {
+        "name": "BILLING_UNCONNECTED_CALLS",
+        "value": 12,
+        "publicValue": "Billing - Unconnected Calls"
+    },
+    "BILLING_UNCONNECTED_SERVICES": {
+        "name": "BILLING_UNCONNECTED_SERVICES",
+        "value": 13,
+        "publicValue": "Billing - Unconnected Services"
+    }
+} as const;
+
+ export type ReportEnum = typeof ReportEnum;

package/models/ResolutionEnum.ts

@@ -0,0 +1,19 @@
+export const ResolutionEnum = {
+    "REPLACEMENT": {
+        "name": "REPLACEMENT",
+        "value": 1,
+        "publicValue": "Replacement"
+    },
+    "CREDIT": {
+        "name": "CREDIT",
+        "value": 2,
+        "publicValue": "Credit"
+    },
+    "ADVANCE_REPLACEMENT": {
+        "name": "ADVANCE_REPLACEMENT",
+        "value": 3,
+        "publicValue": "Advance Replacement"
+    }
+} as const;
+
+ export type ResolutionEnum = typeof ResolutionEnum;

package/models/RmaItemCreditTypeEnum.ts

@@ -0,0 +1,14 @@
+export const RmaItemCreditTypeEnum = {
+    "FULL": {
+        "name": "FULL",
+        "value": 100,
+        "publicValue": "Full"
+    },
+    "RESTOCKING_FEE": {
+        "name": "RESTOCKING_FEE",
+        "value": 85,
+        "publicValue": "Restocking Fee"
+    }
+} as const;
+
+ export type RmaItemCreditTypeEnum = typeof RmaItemCreditTypeEnum;

package/models/RmaItemResolutionEnum.ts

@@ -0,0 +1,29 @@
+export const RmaItemResolutionEnum = {
+    "UNRESOLVED": {
+        "name": "UNRESOLVED",
+        "value": 1,
+        "publicValue": "Unresolved"
+    },
+    "REPLACED": {
+        "name": "REPLACED",
+        "value": 2,
+        "publicValue": "Replaced"
+    },
+    "CREDITED": {
+        "name": "CREDITED",
+        "value": 3,
+        "publicValue": "Credited"
+    },
+    "RETURNED": {
+        "name": "RETURNED",
+        "value": 4,
+        "publicValue": "Returned"
+    },
+    "BINNED": {
+        "name": "BINNED",
+        "value": 5,
+        "publicValue": "Binned"
+    }
+} as const;
+
+ export type RmaItemResolutionEnum = typeof RmaItemResolutionEnum;

package/models/RmaItemStatusEnum.ts

@@ -0,0 +1,19 @@
+export const RmaItemStatusEnum = {
+    "NOT_RECEIVED": {
+        "name": "NOT_RECEIVED",
+        "value": 1,
+        "publicValue": "Not Received"
+    },
+    "IN_PROGRESS": {
+        "name": "IN_PROGRESS",
+        "value": 2,
+        "publicValue": "In Progress"
+    },
+    "RESOLVED": {
+        "name": "RESOLVED",
+        "value": 3,
+        "publicValue": "Resolved"
+    }
+} as const;
+
+ export type RmaItemStatusEnum = typeof RmaItemStatusEnum;

package/models/RmaStatusEnum.ts

@@ -0,0 +1,29 @@
+export const RmaStatusEnum = {
+    "OPEN": {
+        "name": "OPEN",
+        "value": 1,
+        "publicValue": "Open"
+    },
+    "AWAITING_ITEMS": {
+        "name": "AWAITING_ITEMS",
+        "value": 2,
+        "publicValue": "Awaiting Items"
+    },
+    "IN_PROGRESS": {
+        "name": "IN_PROGRESS",
+        "value": 3,
+        "publicValue": "In Progress"
+    },
+    "RESOLVED": {
+        "name": "RESOLVED",
+        "value": 4,
+        "publicValue": "Resolved"
+    },
+    "REJECTED": {
+        "name": "REJECTED",
+        "value": 5,
+        "publicValue": "Rejected"
+    }
+} as const;
+
+ export type RmaStatusEnum = typeof RmaStatusEnum;

package/openapitools.json

@@ -2,6 +2,6 @@
   "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
   "spaces": 2,
   "generator-cli": {
-    "version": "7.23.0"
+    "version": "7.24.0"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.230",
+  "version": "3.2.231-dev.0",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {
@@ -22,7 +22,7 @@
     "prepare": "npm run build"
   },
   "dependencies": {
-    "axios": "^1.16.0"
+    "axios": "1.18.1"
   },
   "devDependencies": {
     "@types/node": "12.11.5 - 12.20.42",