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

package/docs/PricingApi.md

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

package/docs/ProductsApi.md

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

package/docs/SIPTrunksApi.md

@@ -1,12 +1,13 @@
 # SIPTrunksApi
 
-All URIs are relative to *https://api.yellowgrid.local*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**deleteGetSipTrunk**](#deletegetsiptrunk) | **DELETE** /sip/trunks/{id} | Delete SIP Trunk|
 |[**getCanDivert**](#getcandivert) | **GET** /sip/trunks/{id}/diverts/allowed | SIP Trunk Diverts Allowed|
 |[**getGetAddress**](#getgetaddress) | **GET** /sip/trunks/{id}/address | Get SIP Trunk Address|
+|[**getGetAdminSipTrunks**](#getgetadminsiptrunks) | **GET** /sip/trunks/admin | |
 |[**getGetAreaCodes**](#getgetareacodes) | **GET** /sip/trunks/area/codes | Get UK National Area Codes|
 |[**getGetCliFlexibility**](#getgetcliflexibility) | **GET** /sip/trunks/{id}/cli/flexibility | Get SIP Trunk CLI Flexibility Status|
 |[**getGetDdis**](#getgetddis) | **GET** /sip/trunks/{id}/ddis | Get SIP Trunk DDIs|
@@ -189,6 +190,60 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **getGetAdminSipTrunks**
+> Array<SipTrunkEntity> getGetAdminSipTrunks()
+
+Get SIP Trunks
+
+### Example
+
+```typescript
+import {
+    SIPTrunksApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SIPTrunksApi(configuration);
+
+let customerId: number; //Customer ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetAdminSipTrunks(
+    customerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **customerId** | [**number**] | Customer ID | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<SipTrunkEntity>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | SIP Trunks |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **getGetAreaCodes**
 > Array<AreaCodeModel> getGetAreaCodes()
 

package/docs/SMSApi.md

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

package/docs/ShippingApi.md

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

package/docs/{TelephonySupportTicketModel.md → SupportTicketModel.md}

@@ -1,4 +1,4 @@
-# TelephonySupportTicketModel
+# SupportTicketModel
 
 Telephony Support Ticket
 
@@ -21,9 +21,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { TelephonySupportTicketModel } from 'yellowgrid-api-ts';
+import { SupportTicketModel } from 'yellowgrid-api-ts';
 
-const instance: TelephonySupportTicketModel = {
+const instance: SupportTicketModel = {
     id,
     status,
     statusId,

package/docs/SystemApi.md

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

package/docs/TicketsApi.md

@@ -1,6 +1,6 @@
 # TicketsApi
 
-All URIs are relative to *https://api.yellowgrid.local*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -71,7 +71,7 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **getGetTicket**
-> TelephonySupportTicketModel getGetTicket()
+> SupportTicketModel getGetTicket()
 
 Retrieve a telephony support ticket
 
@@ -102,7 +102,7 @@ const { status, data } = await apiInstance.getGetTicket(
 
 ### Return type
 
-**TelephonySupportTicketModel**
+**SupportTicketModel**
 
 ### Authorization
 
@@ -125,7 +125,7 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **patchCloseTicket**
-> TelephonySupportTicketModel patchCloseTicket()
+> SupportTicketModel patchCloseTicket()
 
 Close a telephony support ticket
 
@@ -156,7 +156,7 @@ const { status, data } = await apiInstance.patchCloseTicket(
 
 ### Return type
 
-**TelephonySupportTicketModel**
+**SupportTicketModel**
 
 ### Authorization
 
@@ -179,7 +179,7 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **postCreateTicket**
-> TelephonySupportTicketModel postCreateTicket()
+> SupportTicketModel postCreateTicket()
 
 Create a new telephony support ticket
 
@@ -216,7 +216,7 @@ const { status, data } = await apiInstance.postCreateTicket(
 
 ### Return type
 
-**TelephonySupportTicketModel**
+**SupportTicketModel**
 
 ### Authorization
 
@@ -239,7 +239,7 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **postTicketReply**
-> TelephonySupportTicketModel postTicketReply()
+> SupportTicketModel postTicketReply()
 
 Reply to a telephony support ticket
 
@@ -276,7 +276,7 @@ const { status, data } = await apiInstance.postTicketReply(
 
 ### Return type
 
-**TelephonySupportTicketModel**
+**SupportTicketModel**
 
 ### Authorization
 

package/docs/WebhooksApi.md

@@ -1,6 +1,6 @@
 # WebhooksApi
 
-All URIs are relative to *https://api.yellowgrid.local*
+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.yellowgrid.local`                  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/EventStatusEnum.ts

@@ -0,0 +1,19 @@
+export const EventStatusEnum = {
+    "ONGOING": {
+        "name": "ONGOING",
+        "value": 0,
+        "publicValue": "Ongoing"
+    },
+    "RESOLVED": {
+        "name": "RESOLVED",
+        "value": 1,
+        "publicValue": "Resolved"
+    },
+    "ARCHIVED": {
+        "name": "ARCHIVED",
+        "value": 2,
+        "publicValue": "Archived"
+    }
+} as const;
+
+ export type EventStatusEnum = typeof EventStatusEnum;

package/models/PortStatusEnum.ts

@@ -0,0 +1,19 @@
+export const PortStatusEnum = {
+    "DRAFT": {
+        "name": "DRAFT",
+        "value": 0,
+        "publicValue": "Draft"
+    },
+    "OPEN": {
+        "name": "OPEN",
+        "value": 1,
+        "publicValue": "Open"
+    },
+    "CLOSED": {
+        "name": "CLOSED",
+        "value": 2,
+        "publicValue": "Closed"
+    }
+} as const;
+
+ export type PortStatusEnum = typeof PortStatusEnum;

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.20.0"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.63-dev.0",
+  "version": "3.2.63",
   "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.13.5"
   },
   "devDependencies": {
     "@types/node": "12.11.5 - 12.20.42",

package/dist/models/CourierEnum.d.ts

@@ -1,18 +0,0 @@
-export declare const CourierEnum: {
-    readonly DPD: {
-        readonly name: "DPD";
-        readonly value: "DPD";
-        readonly publicValue: "DPD";
-    };
-    readonly CHORLTON: {
-        readonly name: "CHORLTON";
-        readonly value: "Chorlton Pallet";
-        readonly publicValue: "Chorlton Pallet";
-    };
-    readonly BUILT_IN: {
-        readonly name: "BUILT_IN";
-        readonly value: "POPS";
-        readonly publicValue: "POPS";
-    };
-};
-export type CourierEnum = typeof CourierEnum;

package/dist/models/CourierEnum.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CourierEnum = void 0;
-exports.CourierEnum = {
-    "DPD": {
-        "name": "DPD",
-        "value": "DPD",
-        "publicValue": "DPD"
-    },
-    "CHORLTON": {
-        "name": "CHORLTON",
-        "value": "Chorlton Pallet",
-        "publicValue": "Chorlton Pallet"
-    },
-    "BUILT_IN": {
-        "name": "BUILT_IN",
-        "value": "POPS",
-        "publicValue": "POPS"
-    }
-};

package/dist/models/PrinterEnum.d.ts

@@ -1,18 +0,0 @@
-export declare const PrinterEnum: {
-    readonly STORE_ROOM: {
-        readonly name: "STORE_ROOM";
-        readonly value: 1;
-        readonly publicValue: "Store Room";
-    };
-    readonly PI_DESK: {
-        readonly name: "PI_DESK";
-        readonly value: 2;
-        readonly publicValue: "Raspberry Pi Desk";
-    };
-    readonly SPARE: {
-        readonly name: "SPARE";
-        readonly value: 3;
-        readonly publicValue: "Spare";
-    };
-};
-export type PrinterEnum = typeof PrinterEnum;

package/dist/models/PrinterEnum.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PrinterEnum = void 0;
-exports.PrinterEnum = {
-    "STORE_ROOM": {
-        "name": "STORE_ROOM",
-        "value": 1,
-        "publicValue": "Store Room"
-    },
-    "PI_DESK": {
-        "name": "PI_DESK",
-        "value": 2,
-        "publicValue": "Raspberry Pi Desk"
-    },
-    "SPARE": {
-        "name": "SPARE",
-        "value": 3,
-        "publicValue": "Spare"
-    }
-};

package/docs/BatchDTO.md

@@ -1,59 +0,0 @@
-# BatchDTO
-
-Batch DTO
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**orderId** | **number** | orderId | [optional] [default to undefined]
-**supplierId** | **number** | supplierId | [optional] [default to undefined]
-**poNumber** | **string** | poNumber | [optional] [default to undefined]
-**carriage** | **number** | carriage | [optional] [default to undefined]
-**courier** | **string** | courier | [optional] [default to undefined]
-**courierService** | **string** | courierService | [optional] [default to undefined]
-**courierReference** | **string** | courierReference | [optional] [default to undefined]
-**courierUnique** | **string** | courierUnique | [optional] [default to undefined]
-**notes** | **string** | notes | [optional] [default to undefined]
-**ordered** | **number** | ordered | [optional] [default to undefined]
-**carriagePaid** | **number** | carriagePaid | [optional] [default to undefined]
-**carriageRefunded** | **number** | carriageRefunded | [optional] [default to undefined]
-**carriageRefundedDue** | **number** | carriageRefundedDue | [optional] [default to undefined]
-**netdespatchLabel** | **string** | netdespatchLabel | [optional] [default to undefined]
-**courierBoxes** | **number** | courierBoxes | [optional] [default to undefined]
-**mac** | **string** | mac | [optional] [default to undefined]
-**shipments** | [**Array<ShipmentDTO>**](ShipmentDTO.md) | Shipments | [optional] [default to undefined]
-**items** | [**Array<OrderedItemModel>**](OrderedItemModel.md) | Items | [optional] [default to undefined]
-**supplier** | [**SupplierModel**](SupplierModel.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { BatchDTO } from 'yellowgrid-api-ts';
-
-const instance: BatchDTO = {
-    id,
-    orderId,
-    supplierId,
-    poNumber,
-    carriage,
-    courier,
-    courierService,
-    courierReference,
-    courierUnique,
-    notes,
-    ordered,
-    carriagePaid,
-    carriageRefunded,
-    carriageRefundedDue,
-    netdespatchLabel,
-    courierBoxes,
-    mac,
-    shipments,
-    items,
-    supplier,
-};
-```
-
-[[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/CreditNoteDTO.md

@@ -1,21 +0,0 @@
-# CreditNoteDTO
-
-Credit Note
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**items** | [**Array<CreditNoteItemDTO>**](CreditNoteItemDTO.md) | Items | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CreditNoteDTO } from 'yellowgrid-api-ts';
-
-const instance: CreditNoteDTO = {
-    items,
-};
-```
-
-[[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/CreditNoteEntity.md

@@ -1,29 +0,0 @@
-# CreditNoteEntity
-
-CreditNotesEntity
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**orderId** | **number** | orderId | [optional] [default to undefined]
-**transactionId** | **string** | transactionId | [optional] [default to undefined]
-**amount** | **number** | amount | [optional] [default to undefined]
-**timestamp** | **string** | timestamp | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CreditNoteEntity } from 'yellowgrid-api-ts';
-
-const instance: CreditNoteEntity = {
-    id,
-    orderId,
-    transactionId,
-    amount,
-    timestamp,
-};
-```
-
-[[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/CreditNoteItemDTO.md

@@ -1,25 +0,0 @@
-# CreditNoteItemDTO
-
-Credit Note Item
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**itemId** | **number** | Item ID | [optional] [default to undefined]
-**quantity** | **number** | Quantity | [optional] [default to undefined]
-**amount** | **number** | Amount | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CreditNoteItemDTO } from 'yellowgrid-api-ts';
-
-const instance: CreditNoteItemDTO = {
-    itemId,
-    quantity,
-    amount,
-};
-```
-
-[[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/CreditNoteItemEntity.md

@@ -1,29 +0,0 @@
-# CreditNoteItemEntity
-
-CreditNotesItemsEntity
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**creditNoteId** | **number** | creditNoteId | [optional] [default to undefined]
-**orderId** | **number** | orderId | [optional] [default to undefined]
-**itemId** | **number** | itemId | [optional] [default to undefined]
-**amount** | **number** | amount | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CreditNoteItemEntity } from 'yellowgrid-api-ts';
-
-const instance: CreditNoteItemEntity = {
-    id,
-    creditNoteId,
-    orderId,
-    itemId,
-    amount,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)