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

package/docs/ServicesApi.md

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

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://api.local.yellowgrid.co.uk*
+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://api.local.yellowgrid.co.uk*
+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://api.local.yellowgrid.co.uk`                  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/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/ServiceEnum.ts

@@ -8,6 +8,11 @@ export const ServiceEnum = {
         "name": "SIP_TRUNKS",
         "value": 1,
         "publicValue": "SIP Trunks"
+    },
+    "CUSTOMER_PORTAL": {
+        "name": "CUSTOMER_PORTAL",
+        "value": 2,
+        "publicValue": "Customer Portal"
     }
 } as const;
 

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.14.0"
+    "version": "7.22.0"
   }
 }

package/package.json

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

package/docs/NumberPortModel.md

@@ -1,51 +0,0 @@
-# NumberPortModel
-
-Number Port Model
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | Number Port ID | [optional] [default to undefined]
-**customerId** | **number** | Customer ID | [optional] [default to undefined]
-**endUser** | **string** | End User | [optional] [default to undefined]
-**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
-**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
-**city** | **string** | City | [optional] [default to undefined]
-**postCode** | **string** | Post Code | [optional] [default to undefined]
-**trunkId** | **number** | Trunk ID | [optional] [default to undefined]
-**tenantId** | **string** | Tenant ID | [optional] [default to undefined]
-**requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
-**portDate** | **string** | Port Date | [optional] [default to undefined]
-**comment** | **string** | Comment | [optional] [default to undefined]
-**status** | **number** | Status | [optional] [default to undefined]
-**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
-**ranges** | **Array<any>** | Number Port Ranges | [optional] [default to undefined]
-**customerName** | **string** | Customer Company Name | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { NumberPortModel } from 'yellowgrid-api-ts';
-
-const instance: NumberPortModel = {
-    id,
-    customerId,
-    endUser,
-    addressLine1,
-    addressLine2,
-    city,
-    postCode,
-    trunkId,
-    tenantId,
-    requestedPortDate,
-    portDate,
-    comment,
-    status,
-    ticketId,
-    ranges,
-    customerName,
-};
-```
-
-[[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/PostGetProductRequest.md

@@ -1,24 +0,0 @@
-# PostGetProductRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**quantity** | **number** | Quantity | [optional] [default to undefined]
-**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
-**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { PostGetProductRequest } from 'yellowgrid-api-ts';
-
-const instance: PostGetProductRequest = {
-    quantity,
-    licenceKey,
-    hosting,
-};
-```
-
-[[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

@@ -1,45 +0,0 @@
-# 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/TelephonySupportTicketModel.md

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