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

package/docs/AccountsApi.md

@@ -1,6 +1,6 @@
 # AccountsApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -22,6 +22,7 @@ All URIs are relative to *https://localhost*
 |[**getGetTcxPartnerDetails**](#getgettcxpartnerdetails) | **GET** /admin/accounts/{id}/tcx/partner | |
 |[**getVerifyEmailAddress**](#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address|
 |[**patchSetAccountStatus**](#patchsetaccountstatus) | **PATCH** /admin/accounts/{id}/status/{state} | |
+|[**patchSetOnHold**](#patchsetonhold) | **PATCH** /admin/accounts/{id}/onHold/{state} | |
 |[**patchSetPortalAccess**](#patchsetportalaccess) | **PATCH** /admin/accounts/{id}/portal/access/{state} | |
 |[**patchSetPrizePromo**](#patchsetprizepromo) | **PATCH** /admin/accounts/{id}/prizes/{state} | |
 |[**patchSetTcxWizardCname**](#patchsettcxwizardcname) | **PATCH** /accounts/me/cname | |
@@ -1001,6 +1002,63 @@ 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)
 
+# **patchSetOnHold**
+> AccountFinanceDTO patchSetOnHold()
+
+Set Account On Hold
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+let id: string; //Xero ID (default to undefined)
+let state: 'enable' | 'disable'; //On Hold State (default to undefined)
+
+const { status, data } = await apiInstance.patchSetOnHold(
+    id,
+    state
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Xero ID | defaults to undefined|
+| **state** | [**&#39;enable&#39; | &#39;disable&#39;**]**Array<&#39;enable&#39; &#124; &#39;disable&#39;>** | On Hold State | defaults to undefined|
+
+
+### Return type
+
+**AccountFinanceDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Accounts Finance Details |  -  |
+|**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)
+
 # **patchSetPortalAccess**
 > patchSetPortalAccess()
 

package/docs/BillingApi.md

@@ -1,10 +1,11 @@
 # BillingApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**getGetAllCustomer**](#getgetallcustomer) | **GET** /billing/admin/customerList | Get Billing Customers|
+|[**putTransferConnection**](#puttransferconnection) | **PUT** /billing/admin/connections | |
 
 # **getGetAllCustomer**
 > { [key: string]: { [key: string]: string; }; } getGetAllCustomer()
@@ -53,3 +54,67 @@ 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)
 
+# **putTransferConnection**
+> object putTransferConnection(putTransferConnectionRequest)
+
+Transfer Billing Connection
+
+### Example
+
+```typescript
+import {
+    BillingApi,
+    Configuration,
+    PutTransferConnectionRequest
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new BillingApi(configuration);
+
+let putTransferConnectionRequest: PutTransferConnectionRequest; //Transfer Request
+let id: number; //Connection ID (optional) (default to undefined)
+let cli: string; //CLI (optional) (default to undefined)
+let skipDDis: boolean; //Skip DDIs (optional) (default to undefined)
+
+const { status, data } = await apiInstance.putTransferConnection(
+    putTransferConnectionRequest,
+    id,
+    cli,
+    skipDDis
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **putTransferConnectionRequest** | **PutTransferConnectionRequest**| Transfer Request | |
+| **id** | [**number**] | Connection ID | (optional) defaults to undefined|
+| **cli** | [**string**] | CLI | (optional) defaults to undefined|
+| **skipDDis** | [**boolean**] | Skip DDIs | (optional) defaults to undefined|
+
+
+### Return type
+
+**object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Billing Connection |  -  |
+|**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/CRMApi.md

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

package/docs/Class3CXApi.md

@@ -1,10 +1,11 @@
 # Class3CXApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**getGetLicenceDetails**](#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details|
+|[**getGetTcxCreditStatus**](#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status|
 |[**getGetTcxExpiringKeys**](#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys|
 |[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
 
@@ -62,6 +63,53 @@ 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)
 
+# **getGetTcxCreditStatus**
+> CreditStatusDTO getGetTcxCreditStatus()
+
+Get 3CX Credit Status
+
+### Example
+
+```typescript
+import {
+    Class3CXApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new Class3CXApi(configuration);
+
+const { status, data } = await apiInstance.getGetTcxCreditStatus();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**CreditStatusDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | 3CX Expiring Key CSV |  -  |
+|**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)
+
 # **getGetTcxExpiringKeys**
 > string getGetTcxExpiringKeys()
 

package/docs/Class3CXInstallationWizardApi.md

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

package/docs/Class3CXInstallationsApi.md

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

package/docs/Class3CXIntegrationsApi.md

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

package/docs/Class3CXMultiTenantApi.md

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

package/docs/CreditStatusDTO.md

@@ -0,0 +1,25 @@
+# CreditStatusDTO
+
+3CX Credit Status
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**CurrencyCode** | **string** | Currency Code | [optional] [default to undefined]
+**CreditLimit** | **number** | Credit Limit | [optional] [default to undefined]
+**Credit** | **number** | Credit | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreditStatusDTO } from 'yellowgrid-api-ts';
+
+const instance: CreditStatusDTO = {
+    CurrencyCode,
+    CreditLimit,
+    Credit,
+};
+```
+
+[[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://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/PartnerDTO.md

@@ -16,6 +16,7 @@ Name | Type | Description | Notes
 **hostingDisountPercent** | **number** | 3CX Partner Hosting Discount Percent | [optional] [default to undefined]
 **hostingPriceListId** | **number** | 3CX Hosting Price List ID | [optional] [default to undefined]
 **installationUrl** | **string** | 3CX Installation URL | [optional] [default to undefined]
+**aligned** | **boolean** | Aligned | [optional] [default to undefined]
 
 ## Example
 
@@ -33,6 +34,7 @@ const instance: PartnerDTO = {
     hostingDisountPercent,
     hostingPriceListId,
     installationUrl,
+    aligned,
 };
 ```
 

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/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/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/PutTransferConnectionRequest.md

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

@@ -13,6 +13,11 @@ export const CourierEnum = {
         "name": "BUILT_IN",
         "value": "POPS",
         "publicValue": "POPS"
+    },
+    "INTERPARCEL": {
+        "name": "INTERPARCEL",
+        "value": "Interparcel",
+        "publicValue": "Interparcel"
     }
 } as const;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.173-dev.0",
+  "version": "3.2.173",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {

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"
-    }
-};