yellowgrid-api-ts 3.2.177 → 3.2.178-dev.0

package/docs/Class3CXIntegrationsApi.md

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

package/docs/Class3CXMultiTenantApi.md

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

package/docs/ExpiringKeyDTO.md

@@ -0,0 +1,29 @@
+# ExpiringKeyDTO
+
+3CX Expiring Key
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expiryDate** | **string** | Date Time | [optional] [default to undefined]
+**licenceKey** | **string** | Licence Key | [optional] [default to undefined]
+**edition** | **string** | Edition | [optional] [default to undefined]
+**type** | **string** | Type | [optional] [default to undefined]
+**partner** | [**PartnerDTO**](PartnerDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ExpiringKeyDTO } from 'yellowgrid-api-ts';
+
+const instance: ExpiringKeyDTO = {
+    expiryDate,
+    licenceKey,
+    edition,
+    type,
+    partner,
+};
+```
+
+[[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/GetCheckMacExists200Response.md

@@ -0,0 +1,20 @@
+# GetCheckMacExists200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**found** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GetCheckMacExists200Response } from 'yellowgrid-api-ts';
+
+const instance: GetCheckMacExists200Response = {
+    found,
+};
+```
+
+[[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/MacAddressDTO.md

@@ -0,0 +1,23 @@
+# MacAddressDTO
+
+MAC Address DTO
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**groupId** | **number** | Group ID | [optional] [default to undefined]
+**macAddress** | **string** | MAC Address | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MacAddressDTO } from 'yellowgrid-api-ts';
+
+const instance: MacAddressDTO = {
+    groupId,
+    macAddress,
+};
+```
+
+[[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/MyPBXToolsApi.md

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

package/docs/NumberPortingApi.md

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

package/docs/OAuth20Api.md

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

package/docs/OpayoRedirectDTO.md

@@ -0,0 +1,29 @@
+# OpayoRedirectDTO
+
+Opayo Redirect
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**acsUrl** | **string** | acsUrl | [optional] [default to undefined]
+**paReq** | **string** | paReq | [optional] [default to undefined]
+**transactionId** | **string** | Transaction ID | [optional] [default to undefined]
+**dsTranId** | **string** | dsTranId | [optional] [default to undefined]
+**cReq** | **string** | cReq | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OpayoRedirectDTO } from 'yellowgrid-api-ts';
+
+const instance: OpayoRedirectDTO = {
+    acsUrl,
+    paReq,
+    transactionId,
+    dsTranId,
+    cReq,
+};
+```
+
+[[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/OrdersApi.md

@@ -1,6 +1,6 @@
 # OrdersApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -683,9 +683,11 @@ const configuration = new Configuration();
 const apiInstance = new OrdersApi(configuration);
 
 let id: number; //Order ID (default to undefined)
+let complete: boolean; //Complete Status (default to undefined)
 
 const { status, data } = await apiInstance.patchCompleteOrder(
-    id
+    id,
+    complete
 );
 ```
 
@@ -694,6 +696,7 @@ const { status, data } = await apiInstance.patchCompleteOrder(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **id** | [**number**] | Order ID | defaults to undefined|
+| **complete** | [**boolean**] | Complete Status | defaults to undefined|
 
 
 ### Return type

package/docs/PricingApi.md

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

package/docs/ProductsApi.md

@@ -1,6 +1,6 @@
 # ProductsApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -440,10 +440,12 @@ const apiInstance = new ProductsApi(configuration);
 
 let sku: string; //Product SKU (default to undefined)
 let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
+let orderId: number; //Order ID (optional) (default to undefined)
 
 const { status, data } = await apiInstance.postGetProduct(
     sku,
-    postGetProductForCustomerRequest
+    postGetProductForCustomerRequest,
+    orderId
 );
 ```
 
@@ -453,6 +455,7 @@ const { status, data } = await apiInstance.postGetProduct(
 |------------- | ------------- | ------------- | -------------|
 | **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
 | **sku** | [**string**] | Product SKU | defaults to undefined|
+| **orderId** | [**number**] | Order ID | (optional) defaults to undefined|
 
 
 ### Return type
@@ -499,11 +502,13 @@ const apiInstance = new ProductsApi(configuration);
 let customerId: number; //Customer ID (default to undefined)
 let sku: string; //Product SKU (default to undefined)
 let postGetProductForCustomerRequest: PostGetProductForCustomerRequest; //Product search criteria
+let orderId: number; //Order ID (optional) (default to undefined)
 
 const { status, data } = await apiInstance.postGetProductForCustomer(
     customerId,
     sku,
-    postGetProductForCustomerRequest
+    postGetProductForCustomerRequest,
+    orderId
 );
 ```
 
@@ -514,6 +519,7 @@ const { status, data } = await apiInstance.postGetProductForCustomer(
 | **postGetProductForCustomerRequest** | **PostGetProductForCustomerRequest**| Product search criteria | |
 | **customerId** | [**number**] | Customer ID | defaults to undefined|
 | **sku** | [**string**] | Product SKU | defaults to undefined|
+| **orderId** | [**number**] | Order ID | (optional) defaults to undefined|
 
 
 ### Return type

package/docs/ProspectsApi.md

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

package/docs/ProvisioningApi.md

@@ -1,16 +1,19 @@
 # ProvisioningApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**deleteAddFanvilMac**](#deleteaddfanvilmac) | **DELETE** /provisioning/fanvil/groups/{id}/macs/{mac} | Remove MAC address from DB and FDPS group|
+|[**deleteCheckMacExists**](#deletecheckmacexists) | **DELETE** /admin/provisioning/fanvil/macs/{mac} | |
 |[**deleteDeleteFanvilGroup**](#deletedeletefanvilgroup) | **DELETE** /provisioning/fanvil/groups/{id} | Delete group from DB and FDPS|
+|[**getCheckMacExists**](#getcheckmacexists) | **GET** /admin/provisioning/fanvil/macs/{mac} | |
 |[**getGetFanvilEncryptionKey**](#getgetfanvilencryptionkey) | **GET** /provisioning/fanvil/groups/{id}/macs/{mac}/key | Get group Fanvil encryption key|
 |[**getGetFanvilGroupMacs**](#getgetfanvilgroupmacs) | **GET** /provisioning/fanvil/groups/{id}/macs | Get MAC addresses on group at FDPS|
 |[**getGetGroups**](#getgetgroups) | **GET** /provisioning/groups | Get all provisioning groups or filter by customer ID|
 |[**postAddFanvilGroup**](#postaddfanvilgroup) | **POST** /provisioning/fanvil/groups | Add group to DB and FDPS|
 |[**postAddFanvilMac**](#postaddfanvilmac) | **POST** /provisioning/fanvil/groups/{id}/macs/{mac} | Add MAC address to DB and FDPS group|
+|[**postCreateMac**](#postcreatemac) | **POST** /admin/provisioning/fanvil/macs/ | |
 
 # **deleteAddFanvilMac**
 > deleteAddFanvilMac()
@@ -69,6 +72,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)
 
+# **deleteCheckMacExists**
+> deleteCheckMacExists()
+
+Delete a MAC address in FDPS
+
+### Example
+
+```typescript
+import {
+    ProvisioningApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProvisioningApi(configuration);
+
+let mac: string; //MAC Address (default to undefined)
+
+const { status, data } = await apiInstance.deleteCheckMacExists(
+    mac
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **mac** | [**string**] | MAC Address | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | No Response |  -  |
+|**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)
+
 # **deleteDeleteFanvilGroup**
 > deleteDeleteFanvilGroup()
 
@@ -123,6 +180,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)
 
+# **getCheckMacExists**
+> GetCheckMacExists200Response getCheckMacExists()
+
+Check if a MAC address exists in FDPS
+
+### Example
+
+```typescript
+import {
+    ProvisioningApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProvisioningApi(configuration);
+
+let mac: string; //MAC Address (default to undefined)
+
+const { status, data } = await apiInstance.getCheckMacExists(
+    mac
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **mac** | [**string**] | MAC Address | defaults to undefined|
+
+
+### Return type
+
+**GetCheckMacExists200Response**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | MAC Address Found |  -  |
+|**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)
+
 # **getGetFanvilEncryptionKey**
 > string getGetFanvilEncryptionKey()
 
@@ -400,3 +511,58 @@ 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)
 
+# **postCreateMac**
+> MacAddressDTO postCreateMac()
+
+Create a MAC address in FDPS
+
+### Example
+
+```typescript
+import {
+    ProvisioningApi,
+    Configuration,
+    MacAddressDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ProvisioningApi(configuration);
+
+let macAddressDTO: MacAddressDTO; //Mac Address (optional)
+
+const { status, data } = await apiInstance.postCreateMac(
+    macAddressDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **macAddressDTO** | **MacAddressDTO**| Mac Address | |
+
+
+### Return type
+
+**MacAddressDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | MAC Address Created |  -  |
+|**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)
+

package/docs/SIPTrunksApi.md

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

package/docs/SMSApi.md

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

package/docs/ServicesApi.md

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

package/docs/ShippingApi.md

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

package/docs/StockManagementApi.md

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

package/docs/SystemApi.md

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

package/docs/TicketsApi.md

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

package/docs/WebhooksApi.md

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

package/models/UserGroupEnum.ts

@@ -28,6 +28,11 @@ export const UserGroupEnum = {
         "name": "FINANCE",
         "value": "Finance",
         "publicValue": "Finance"
+    },
+    "TELESALES": {
+        "name": "TELESALES",
+        "value": "Telesales",
+        "publicValue": "Telesales"
     }
 } as const;
 

package/openapitools.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.177",
+  "version": "3.2.178-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.15.2"
+    "axios": "^1.16.0"
   },
   "devDependencies": {
     "@types/node": "12.11.5 - 12.20.42",