yellowgrid-api-ts 3.2.158-dev.0 → 3.2.158

package/docs/{CrmActivityDto.md → CrmActivityDTO.md}

@@ -7,7 +7,7 @@ CRM Activity
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **string** | Activity Type | [optional] [default to undefined]
-**timestamp** | **string** | Date Time | [optional] [default to undefined]
+**timestamp** | **string** | Activity Timestamp | [optional] [default to undefined]
 **title** | **string** | Activity Title | [optional] [default to undefined]
 **description** | **string** | Activity Description | [optional] [default to undefined]
 **url** | **string** | Activity URL | [optional] [default to undefined]

package/docs/CrmDateActivitiesDTO.md

@@ -6,7 +6,7 @@ CRM Date Activities
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**date** | **string** | Date Time | [optional] [default to undefined]
+**date** | **string** | Date | [optional] [default to undefined]
 **activities** | [**Array<CrmActivityDTO>**](CrmActivityDTO.md) | Activities | [optional] [default to undefined]
 
 ## Example

package/docs/CustomerListAccountDTO.md

@@ -0,0 +1,45 @@
+# CustomerListAccountDTO
+
+Customer List Account
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
+**xeroId** | **string** | Xero ID | [optional] [default to undefined]
+**accountNumber** | **string** | Account Number | [optional] [default to undefined]
+**company** | **string** | Company Name | [optional] [default to undefined]
+**domains** | **Array<string>** | Associated Email Domains | [optional] [default to undefined]
+**telephone** | **string** | Telephone | [optional] [default to undefined]
+**vatNumber** | **string** | VAT Number | [optional] [default to undefined]
+**companyNumber** | **string** | Company Number | [optional] [default to undefined]
+**cname** | **string** | Wizard CNAME | [optional] [default to undefined]
+**partnerId** | **string** | 3CX Reseller ID | [optional] [default to undefined]
+**status** | **boolean** | Account Status | [optional] [default to undefined]
+**portalAccess** | **boolean** | Portal Access | [optional] [default to undefined]
+**prizePromo** | **boolean** | Prize Promo | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CustomerListAccountDTO } from 'yellowgrid-api-ts';
+
+const instance: CustomerListAccountDTO = {
+    id,
+    xeroId,
+    accountNumber,
+    company,
+    domains,
+    telephone,
+    vatNumber,
+    companyNumber,
+    cname,
+    partnerId,
+    status,
+    portalAccess,
+    prizePromo,
+};
+```
+
+[[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/CustomerOrderRequestDTO.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.md) | Items | [optional] [default to undefined]
 **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) |  | [optional] [default to undefined]
 **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
-**shippingAddress** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
+**shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
 **partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
 **quote** | **boolean** | Quote | [optional] [default to undefined]
 

package/docs/DetailedOrderRequestDTO.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [optional] [default to undefined]
 **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) |  | [optional] [default to undefined]
 **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
-**shippingAddress** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
+**shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
 **partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
 **quote** | **boolean** | Quote | [optional] [default to undefined]
 

package/docs/MyPBXToolsApi.md

@@ -1,6 +1,6 @@
 # MyPBXToolsApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/NumberPortingApi.md

@@ -1,6 +1,6 @@
 # NumberPortingApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/OAuth20Api.md

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

package/docs/ProductSummaryDTO.md

@@ -10,11 +10,11 @@ Name | Type | Description | Notes
 **title** | **string** | Title | [optional] [default to undefined]
 **quantity** | **number** | Stock Quantity | [optional] [default to undefined]
 **stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
-**dueDate** | **string** | Date Time | [optional] [default to undefined]
+**dueDate** | **string** | Due Date | [optional] [default to undefined]
 **price** | **number** | Price | [optional] [default to undefined]
 **cartonSize** | **number** | Carton Size | [optional] [default to undefined]
 **rrp** | **number** | RRP Price | [optional] [default to undefined]
-**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) |  | [optional] [default to undefined]
+**licenceDetails** | [**TcxLicenceDetailsModel**](TcxLicenceDetailsModel.md) | 3CX Licence Details | [optional] [default to undefined]
 **hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
 
 ## Example

package/docs/ProductsApi.md

@@ -1,6 +1,6 @@
 # ProductsApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

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** | Date Time | [optional] [default to undefined]
-**callbackDate** | **string** | Date Time | [optional] [default to undefined]
+**lastOrderDate** | **string** | Last Order Date | [optional] [default to undefined]
+**callbackDate** | **string** | Call Back Date | [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://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |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://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/RecordingBackupAzureModel.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **name** | **string** | Storage Account Name | [optional] [default to undefined]
 **key** | **string** | Storage Account Key | [optional] [default to undefined]
 **connection_string** | **string** | Storage Account Connection String | [optional] [default to undefined]
+**sasUrl** | **string** | SAS Url | [optional] [default to undefined]
 **recordings_path** | **string** | Recordings Path | [optional] [default to undefined]
 
 ## Example
@@ -20,6 +21,7 @@ const instance: RecordingBackupAzureModel = {
     name,
     key,
     connection_string,
+    sasUrl,
     recordings_path,
 };
 ```

package/docs/RecordingsBackupInfoDTO.md

@@ -6,8 +6,8 @@ Recordings Backup Info
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) |  | [optional] [default to undefined]
-**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) |  | [optional] [default to undefined]
+**backup** | [**RecordingBackupAzureModel**](RecordingBackupAzureModel.md) | Azure Backup Storage | [optional] [default to undefined]
+**storage** | [**TcxRemoteStorageModel**](TcxRemoteStorageModel.md) | 3CX Remote Storage | [optional] [default to undefined]
 
 ## Example
 

package/docs/SIPTrunksApi.md

@@ -1,6 +1,6 @@
 # SIPTrunksApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |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://bitbucket.org*
 
 |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://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/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,34 @@
+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"
+    },
+    "FINANCE": {
+        "name": "FINANCE",
+        "value": "Finance",
+        "publicValue": "Finance"
+    }
+} 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.158-dev.0",
+  "version": "3.2.158",
   "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"
-    }
-};