yellowgrid-api-ts 3.0.80-dev.0 → 3.0.81

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:    `http://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:   `http://api.yellowgrid.local`               For questions or technical support, please contact support@yellowgrid.co.uk.
  *
  * The version of the OpenAPI document: 0
  * 

package/package.json

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

package/docs/AbstractOrderRequestDTO.md

@@ -1,33 +0,0 @@
-# AbstractOrderRequestDTO
-
-Order Request
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**orderReference** | **string** | Order Reference | [optional] [default to undefined]
-**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]
-**partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
-**quote** | **boolean** | Quote | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AbstractOrderRequestDTO } from 'yellowgrid-api-ts';
-
-const instance: AbstractOrderRequestDTO = {
-    orderReference,
-    items,
-    shippingService,
-    provisioningUrl,
-    shippingAddress,
-    partShip,
-    quote,
-};
-```
-
-[[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/AccountDetailedSummaryDTO.md

@@ -1,35 +0,0 @@
-# AccountDetailedSummaryDTO
-
-Account Details
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | ID | [optional] [default to undefined]
-**xeroId** | **string** | Xero ID | [optional] [default to undefined]
-**company** | **string** | Company | [optional] [default to undefined]
-**creditLimit** | **number** | Credit Limit | [optional] [default to undefined]
-**contacts** | [**Array<AccountContactModel>**](AccountContactModel.md) | Contacts | [optional] [default to undefined]
-**billingAddress** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
-**addresses** | [**Array<AddressModel>**](AddressModel.md) | Addresses | [optional] [default to undefined]
-**provisioningUrls** | [**Array<ProvisioningModel>**](ProvisioningModel.md) | Provisioning URLs | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AccountDetailedSummaryDTO } from 'yellowgrid-api-ts';
-
-const instance: AccountDetailedSummaryDTO = {
-    id,
-    xeroId,
-    company,
-    creditLimit,
-    contacts,
-    billingAddress,
-    addresses,
-    provisioningUrls,
-};
-```
-
-[[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/AdminItemRequestDTO.md

@@ -1,37 +0,0 @@
-# AdminItemRequestDTO
-
-Admin Order Item Request
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**sku** | **string** | SKU | [optional] [default to undefined]
-**quantity** | **number** | Quantity | [optional] [default to undefined]
-**id** | **number** | ID | [optional] [default to undefined]
-**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
-**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
-**processDate** | **string** | Date Time | [optional] [default to undefined]
-**sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCS | [optional] [default to undefined]
-**title** | **string** | Title | [optional] [default to undefined]
-**itemPrice** | **number** | Price (£) | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AdminItemRequestDTO } from 'yellowgrid-api-ts';
-
-const instance: AdminItemRequestDTO = {
-    sku,
-    quantity,
-    id,
-    licenceKey,
-    hosting,
-    processDate,
-    sbcs,
-    title,
-    itemPrice,
-};
-```
-
-[[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/AdminOrderRequestDTO.md

@@ -1,41 +0,0 @@
-# AdminOrderRequestDTO
-
-Admin Order Request
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**orderReference** | **string** | Order Reference | [optional] [default to undefined]
-**items** | [**Array<AdminItemRequestDTO>**](AdminItemRequestDTO.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]
-**partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
-**quote** | **boolean** | Quote | [optional] [default to undefined]
-**customerId** | **number** | Customer ID | [optional] [default to undefined]
-**ignoreOnHold** | **boolean** | Ignore Customer On Hold | [optional] [default to false]
-**ignoreCreditLimit** | **boolean** | Ignore Customer Credit Limit | [optional] [default to false]
-**includeNfrPromos** | **boolean** | Include NFR Promos | [optional] [default to false]
-
-## Example
-
-```typescript
-import { AdminOrderRequestDTO } from 'yellowgrid-api-ts';
-
-const instance: AdminOrderRequestDTO = {
-    orderReference,
-    items,
-    shippingService,
-    provisioningUrl,
-    shippingAddress,
-    partShip,
-    quote,
-    customerId,
-    ignoreOnHold,
-    ignoreCreditLimit,
-    includeNfrPromos,
-};
-```
-
-[[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/AdminUserModel.md

@@ -1,31 +0,0 @@
-# AdminUserModel
-
-Admin User
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**firstName** | **string** | First Name | [optional] [default to undefined]
-**lastName** | **string** | Last Name | [optional] [default to undefined]
-**avatar** | **string** | Avatar | [optional] [default to undefined]
-**role** | **number** | Role | [optional] [default to undefined]
-**navigation** | [**Array<NavigationItemModel>**](NavigationItemModel.md) | Navigation | [optional] [default to undefined]
-**email** | **string** | Email | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { AdminUserModel } from 'yellowgrid-api-ts';
-
-const instance: AdminUserModel = {
-    firstName,
-    lastName,
-    avatar,
-    role,
-    navigation,
-    email,
-};
-```
-
-[[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/BasicItemDTO.md

@@ -1,23 +0,0 @@
-# BasicItemDTO
-
-Basic Order Item
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**sku** | **string** | SKU | [optional] [default to undefined]
-**quantity** | **number** | Quantity | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { BasicItemDTO } from 'yellowgrid-api-ts';
-
-const instance: BasicItemDTO = {
-    sku,
-    quantity,
-};
-```
-
-[[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/BasicProductDTO.md

@@ -1,23 +0,0 @@
-# BasicProductDTO
-
-Basic Product
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**sku** | **string** | SKU | [optional] [default to undefined]
-**title** | **string** | Title | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { BasicProductDTO } from 'yellowgrid-api-ts';
-
-const instance: BasicProductDTO = {
-    sku,
-    title,
-};
-```
-
-[[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/CourierPriceEntity.md

@@ -1,39 +0,0 @@
-# CourierPriceEntity
-
-CourierPricesEntity
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**courier** | **string** | courier | [optional] [default to undefined]
-**destinationIso** | **string** | destinationIso | [optional] [default to undefined]
-**serviceDescription** | **string** | serviceDescription | [optional] [default to undefined]
-**flatRate** | **number** | flatRate | [optional] [default to undefined]
-**initialBox** | **number** | initialBox | [optional] [default to undefined]
-**initialKg** | **number** | initialKg | [optional] [default to undefined]
-**perBox** | **number** | perBox | [optional] [default to undefined]
-**perKg** | **number** | perKg | [optional] [default to undefined]
-**maxKg** | **number** | maxKg | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CourierPriceEntity } from 'yellowgrid-api-ts';
-
-const instance: CourierPriceEntity = {
-    id,
-    courier,
-    destinationIso,
-    serviceDescription,
-    flatRate,
-    initialBox,
-    initialKg,
-    perBox,
-    perKg,
-    maxKg,
-};
-```
-
-[[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/CustomerItemRequestDTO.md

@@ -1,33 +0,0 @@
-# CustomerItemRequestDTO
-
-Order Item Request
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**sku** | **string** | SKU | [optional] [default to undefined]
-**quantity** | **number** | Quantity | [optional] [default to undefined]
-**id** | **number** | ID | [optional] [default to undefined]
-**licenceKey** | **string** | 3CX Licence Key | [optional] [default to undefined]
-**hosting** | **boolean** | 3CX Hosting | [optional] [default to undefined]
-**processDate** | **string** | Date Time | [optional] [default to undefined]
-**sbcs** | [**Array<TcxSbcDTO>**](TcxSbcDTO.md) | SBCS | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CustomerItemRequestDTO } from 'yellowgrid-api-ts';
-
-const instance: CustomerItemRequestDTO = {
-    sku,
-    quantity,
-    id,
-    licenceKey,
-    hosting,
-    processDate,
-    sbcs,
-};
-```
-
-[[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

@@ -1,33 +0,0 @@
-# CustomerOrderRequestDTO
-
-Order Request
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**orderReference** | **string** | Order Reference | [optional] [default to undefined]
-**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]
-**partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
-**quote** | **boolean** | Quote | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { CustomerOrderRequestDTO } from 'yellowgrid-api-ts';
-
-const instance: CustomerOrderRequestDTO = {
-    orderReference,
-    items,
-    shippingService,
-    provisioningUrl,
-    shippingAddress,
-    partShip,
-    quote,
-};
-```
-
-[[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/LinkedOrderEntity.md

@@ -1,23 +0,0 @@
-# LinkedOrderEntity
-
-LinkedOrdersEntity
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**orderId** | **number** | orderId | [optional] [default to undefined]
-**linkedOrderId** | **number** | linkedOrderId | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { LinkedOrderEntity } from 'yellowgrid-api-ts';
-
-const instance: LinkedOrderEntity = {
-    orderId,
-    linkedOrderId,
-};
-```
-
-[[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/NavigationItemModel.md

@@ -1,27 +0,0 @@
-# NavigationItemModel
-
-POPS Navigation Item
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**title** | **string** | Title | [optional] [default to undefined]
-**url** | **string** | URL | [optional] [default to undefined]
-**icon** | **string** | Icon (Font Awesome) | [optional] [default to undefined]
-**items** | [**Array<SubNavigationItemModel>**](SubNavigationItemModel.md) | Sub Navigation | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { NavigationItemModel } from 'yellowgrid-api-ts';
-
-const instance: NavigationItemModel = {
-    title,
-    url,
-    icon,
-    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/ShippingApi.md

@@ -1,63 +0,0 @@
-# ShippingApi
-
-All URIs are relative to *http://api.yellowgrid.local*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**postGetShippingServices**](#postgetshippingservices) | **POST** /shipping/services | Get Shipping Services|
-
-# **postGetShippingServices**
-> ShippingServicesModel postGetShippingServices()
-
-Get Shipping Services
-
-### Example
-
-```typescript
-import {
-    ShippingApi,
-    Configuration,
-    ShippingInformationDTO
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new ShippingApi(configuration);
-
-let shippingInformationDTO: ShippingInformationDTO; //Shipping Information (optional)
-
-const { status, data } = await apiInstance.postGetShippingServices(
-    shippingInformationDTO
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **shippingInformationDTO** | **ShippingInformationDTO**| Shipping Information | |
-
-
-### Return type
-
-**ShippingServicesModel**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Shipping Services |  -  |
-|**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/ShippingConsignmentModel.md

@@ -1,26 +0,0 @@
-# ShippingConsignmentModel
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**service** | [**ShippingServiceModel**](ShippingServiceModel.md) |  | [optional] [default to undefined]
-**id** | **string** | ID/Number | [optional] [default to undefined]
-**trackingNumber** | **string** | Tracking Number | [optional] [default to undefined]
-**parcelIds** | **Array<string>** | Parcels | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShippingConsignmentModel } from 'yellowgrid-api-ts';
-
-const instance: ShippingConsignmentModel = {
-    service,
-    id,
-    trackingNumber,
-    parcelIds,
-};
-```
-
-[[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/ShippingInformationDTO.md

@@ -1,25 +0,0 @@
-# ShippingInformationDTO
-
-Shipping Information
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**items** | [**Array<BasicItemDTO>**](BasicItemDTO.md) | Items | [optional] [default to undefined]
-**postalCode** | **string** | Destination Post Code | [optional] [default to undefined]
-**iso** | **string** | Destination ISO | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShippingInformationDTO } from 'yellowgrid-api-ts';
-
-const instance: ShippingInformationDTO = {
-    items,
-    postalCode,
-    iso,
-};
-```
-
-[[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/ShippingServiceDTO.md

@@ -1,23 +0,0 @@
-# ShippingServiceDTO
-
-Shipping Service
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**courier** | **string** | Courier | [optional] [default to undefined]
-**serviceName** | **string** | Service Name | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShippingServiceDTO } from 'yellowgrid-api-ts';
-
-const instance: ShippingServiceDTO = {
-    courier,
-    serviceName,
-};
-```
-
-[[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/ShippingServiceModel.md

@@ -1,31 +0,0 @@
-# ShippingServiceModel
-
-Shipping Service
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**courier** | **string** | Courier | [optional] [default to undefined]
-**code** | **string** | Code | [optional] [default to undefined]
-**name** | **string** | Name | [optional] [default to undefined]
-**description** | **string** | Description | [optional] [default to undefined]
-**label** | **string** | Label | [optional] [default to undefined]
-**price** | **number** | Price | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ShippingServiceModel } from 'yellowgrid-api-ts';
-
-const instance: ShippingServiceModel = {
-    courier,
-    code,
-    name,
-    description,
-    label,
-    price,
-};
-```
-
-[[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/SubNavigationItemModel.md

@@ -1,25 +0,0 @@
-# SubNavigationItemModel
-
-POPS Sub Navigation Item
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**title** | **string** | Title | [optional] [default to undefined]
-**url** | **string** | URL | [optional] [default to undefined]
-**icon** | **string** | Icon (Font Awesome) | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { SubNavigationItemModel } from 'yellowgrid-api-ts';
-
-const instance: SubNavigationItemModel = {
-    title,
-    url,
-    icon,
-};
-```
-
-[[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/TcxSbcDTO.md

@@ -1,31 +0,0 @@
-# TcxSbcDTO
-
-SBC Data
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ipAddress** | **string** | LAN IP Address | [optional] [default to undefined]
-**defaultGateway** | **string** | LAN Default Gateway | [optional] [default to undefined]
-**netmask** | **string** | LAN Subnet Mask | [optional] [default to undefined]
-**dns** | **string** | DNS | [optional] [default to undefined]
-**tcxUrl** | **string** | 3CX URL | [optional] [default to undefined]
-**tcxKey** | **string** | 3CX SBC Key | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { TcxSbcDTO } from 'yellowgrid-api-ts';
-
-const instance: TcxSbcDTO = {
-    ipAddress,
-    defaultGateway,
-    netmask,
-    dns,
-    tcxUrl,
-    tcxKey,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)