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

package/docs/SbcDTO.md

@@ -0,0 +1,35 @@
+# SbcDTO
+
+Legacy Portal SBC
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**noConfig** | **boolean** | No Config | [optional] [default to undefined]
+**dhcp** | **boolean** | DHCP | [optional] [default to undefined]
+**url** | **boolean** | 3CX URL | [optional] [default to undefined]
+**authKey** | **boolean** | 3CX SBC Auth Key | [optional] [default to undefined]
+**ipAddress** | **boolean** | LAN IP Address | [optional] [default to undefined]
+**subnetMask** | **boolean** | LAN Subnet Mask | [optional] [default to undefined]
+**defaultGateway** | **boolean** | LAN Default Gateway | [optional] [default to undefined]
+**dns** | **boolean** | DNS | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SbcDTO } from 'yellowgrid-api-ts';
+
+const instance: SbcDTO = {
+    noConfig,
+    dhcp,
+    url,
+    authKey,
+    ipAddress,
+    subnetMask,
+    defaultGateway,
+    dns,
+};
+```
+
+[[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://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |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) |  | [optional] [default to undefined]
+**address** | [**AddressModel**](AddressModel.md) | Address | [optional] [default to undefined]
 **scannedLines** | **Array<string>** | Scanned Lines | [optional] [default to undefined]
 **service** | **string** | Service | [optional] [default to undefined]
-**shipDate** | **string** | Date Time | [optional] [default to undefined]
+**shipDate** | **string** | Ship Date | [optional] [default to undefined]
 **items** | [**Array<ShipmentItemDTO>**](ShipmentItemDTO.md) | Items | [optional] [default to undefined]
 
 ## Example

package/docs/ShippingAddressDTO.md

@@ -0,0 +1,35 @@
+# ShippingAddressDTO
+
+Legacy Portal Shipping Address
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shipName** | **string** | Ship Name | [optional] [default to undefined]
+**shipCompany** | **string** | Ship Company | [optional] [default to undefined]
+**shipAddress1** | **string** | Ship Address Line 1 | [optional] [default to undefined]
+**shipAddress2** | **string** | Ship Address Line 2 | [optional] [default to undefined]
+**shipCity** | **string** | Ship City | [optional] [default to undefined]
+**shipRegion** | **string** | Ship Region | [optional] [default to undefined]
+**shipPostCode** | **string** | Ship Post Code | [optional] [default to undefined]
+**shipIso** | **string** | Ship ISO | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ShippingAddressDTO } from 'yellowgrid-api-ts';
+
+const instance: ShippingAddressDTO = {
+    shipName,
+    shipCompany,
+    shipAddress1,
+    shipAddress2,
+    shipCity,
+    shipRegion,
+    shipPostCode,
+    shipIso,
+};
+```
+
+[[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/ShippingApi.md

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

package/docs/TableHistoryEntity.md

@@ -0,0 +1,35 @@
+# TableHistoryEntity
+
+TableAttribsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ownerId** | **string** | ownerId | [optional] [default to undefined]
+**dbTable** | **string** | table | [optional] [default to undefined]
+**orderingField** | **string** | orderingField | [optional] [default to undefined]
+**asc** | **number** | asc | [optional] [default to undefined]
+**perPage** | **number** | perPage | [optional] [default to undefined]
+**currPage** | **number** | currPage | [optional] [default to undefined]
+**filter** | **string** | filter | [optional] [default to undefined]
+**page** | **number** | page | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TableHistoryEntity } from 'yellowgrid-api-ts';
+
+const instance: TableHistoryEntity = {
+    ownerId,
+    dbTable,
+    orderingField,
+    asc,
+    perPage,
+    currPage,
+    filter,
+    page,
+};
+```
+
+[[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** | Date Time | [optional] [default to undefined]
+**expiry** | **string** | Expiry Date | [optional] [default to undefined]
 
 ## Example
 

package/docs/TicketsApi.md

@@ -1,6 +1,6 @@
 # TicketsApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |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://bitbucket.org*
 
 |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://localhost`                  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://bitbucket.org`               For questions or technical support, please contact support@yellowgrid.co.uk.
  *
  * The version of the OpenAPI document: 0
  * 

package/models/HostingPriceListEnum.ts

@@ -2,27 +2,27 @@ export const HostingPriceListEnum = {
     "HOSTING_ONLY": {
         "name": "HOSTING_ONLY",
         "value": 1,
-        "publicValue": "HO - Hosting Only"
+        "publicValue": "Hosting Only"
     },
     "HOSTING_ONLY_BESPOKE": {
         "name": "HOSTING_ONLY_BESPOKE",
         "value": 2,
-        "publicValue": "HOB - Hosted Only Bespoke"
+        "publicValue": "Hosting Only (Bespoke)"
     },
     "HOSTING_AND_SUPPORT": {
         "name": "HOSTING_AND_SUPPORT",
         "value": 3,
-        "publicValue": "HS - Hosted & Support"
+        "publicValue": "Hosting & Support"
     },
     "HOSTING_AND_SUPPORT_BESPOKE": {
         "name": "HOSTING_AND_SUPPORT_BESPOKE",
         "value": 4,
-        "publicValue": "HSB - Hosted & Support Bespoke"
+        "publicValue": "Hosting & Support (Bespoke)"
     },
     "END_USER": {
         "name": "END_USER",
         "value": 5,
-        "publicValue": "YG - Yellowgrid Customer"
+        "publicValue": "End User"
     }
 } as const;
 

package/models/PaymentMethodEnum.ts

@@ -0,0 +1,14 @@
+export const PaymentMethodEnum = {
+    "CARD": {
+        "name": "CARD",
+        "value": "card",
+        "publicValue": "card"
+    },
+    "BACS": {
+        "name": "BACS",
+        "value": "bacs",
+        "publicValue": "bacs"
+    }
+} as const;
+
+ export type PaymentMethodEnum = typeof PaymentMethodEnum;

package/models/UserGroupEnum.ts

@@ -0,0 +1,29 @@
+export const UserGroupEnum = {
+    "ALL": {
+        "name": "ALL",
+        "value": "All",
+        "publicValue": "All"
+    },
+    "STANDARD": {
+        "name": "STANDARD",
+        "value": "Standard",
+        "publicValue": "Standard"
+    },
+    "TECHNICAL": {
+        "name": "TECHNICAL",
+        "value": "Technical",
+        "publicValue": "Technical"
+    },
+    "PRIVILEGED": {
+        "name": "PRIVILEGED",
+        "value": "Privileged",
+        "publicValue": "Privileged"
+    },
+    "DEVELOPMENT": {
+        "name": "DEVELOPMENT",
+        "value": "Development",
+        "publicValue": "Development"
+    }
+} as const;
+
+ export type UserGroupEnum = typeof UserGroupEnum;

package/openapitools.json

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

package/package.json

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

package/dist/models/StatusEnum.d.ts

@@ -1,18 +0,0 @@
-export declare const StatusEnum: {
-    readonly ONGOING: {
-        readonly name: "ONGOING";
-        readonly value: 0;
-        readonly publicValue: "Ongoing";
-    };
-    readonly RESOLVED: {
-        readonly name: "RESOLVED";
-        readonly value: 1;
-        readonly publicValue: "Resolved";
-    };
-    readonly ARCHIVED: {
-        readonly name: "ARCHIVED";
-        readonly value: 2;
-        readonly publicValue: "Archived";
-    };
-};
-export type StatusEnum = typeof StatusEnum;

package/dist/models/StatusEnum.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StatusEnum = void 0;
-exports.StatusEnum = {
-    "ONGOING": {
-        "name": "ONGOING",
-        "value": 0,
-        "publicValue": "Ongoing"
-    },
-    "RESOLVED": {
-        "name": "RESOLVED",
-        "value": 1,
-        "publicValue": "Resolved"
-    },
-    "ARCHIVED": {
-        "name": "ARCHIVED",
-        "value": 2,
-        "publicValue": "Archived"
-    }
-};