yellowgrid-api-ts 3.2.131-dev.0 → 3.2.132-dev.0

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://localhost*
 
 |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://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

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

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.131-dev.0",
+  "version": "3.2.132-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.6.1"
+    "axios": "^1.13.5"
   },
   "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/ProspectDTO.md

@@ -1,33 +0,0 @@
-# ProspectDTO
-
-Prospect
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**companyName** | **string** | Company Name | [optional] [default to undefined]
-**telephone** | **string** | Telephone | [optional] [default to undefined]
-**lastOrderDate** | **string** | Date Time | [optional] [default to undefined]
-**callbackDate** | **string** | Date Time | [optional] [default to undefined]
-**xeroId** | **string** | Xero ID | [optional] [default to undefined]
-**removed** | **boolean** | Removed From Prospects | [optional] [default to undefined]
-**status** | **string** | Status | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ProspectDTO } from 'yellowgrid-api-ts';
-
-const instance: ProspectDTO = {
-    companyName,
-    telephone,
-    lastOrderDate,
-    callbackDate,
-    xeroId,
-    removed,
-    status,
-};
-```
-
-[[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/ProspectEntity.md

@@ -1,41 +0,0 @@
-# ProspectEntity
-
-ProspectEntity
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**status** | **number** | status | [optional] [default to undefined]
-**customerId** | **number** | customerId | [optional] [default to undefined]
-**companyName** | **string** | companyName | [optional] [default to undefined]
-**contactName** | **string** | contactName | [optional] [default to undefined]
-**telephone** | **string** | telephone | [optional] [default to undefined]
-**email** | **string** | email | [optional] [default to undefined]
-**reason** | **string** | reason | [optional] [default to undefined]
-**lastOrderDate** | **string** | lastOrderDate | [optional] [default to undefined]
-**followUpDate** | **string** | followUpDate | [optional] [default to undefined]
-**notes** | **string** | notes | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { ProspectEntity } from 'yellowgrid-api-ts';
-
-const instance: ProspectEntity = {
-    id,
-    status,
-    customerId,
-    companyName,
-    contactName,
-    telephone,
-    email,
-    reason,
-    lastOrderDate,
-    followUpDate,
-    notes,
-};
-```
-
-[[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/ProspectsApi.md

@@ -1,226 +0,0 @@
-# ProspectsApi
-
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**getGetProspect**](#getgetprospect) | **GET** /accounts/prospects/{xero_id} | Get Prospect|
-|[**getGetProspects**](#getgetprospects) | **GET** /accounts/prospects | Get Prospects|
-|[**getRemoveFromProspects**](#getremovefromprospects) | **GET** /accounts/prospects/{xero_id}/remove | Remove From Prospects|
-|[**getSetCallback**](#getsetcallback) | **GET** /accounts/prospects/{xero_id}/callback | Set Call Back Date|
-
-# **getGetProspect**
-> ProspectDTO getGetProspect()
-
-Get Prospect
-
-### Example
-
-```typescript
-import {
-    ProspectsApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(configuration);
-
-let xeroId: string; //Xero ID (default to undefined)
-
-const { status, data } = await apiInstance.getGetProspect(
-    xeroId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **xeroId** | [**string**] | Xero ID | defaults to undefined|
-
-
-### Return type
-
-**ProspectDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Prospect |  -  |
-|**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)
-
-# **getGetProspects**
-> Array<ProspectDTO> getGetProspects()
-
-Get Prospects
-
-### Example
-
-```typescript
-import {
-    ProspectsApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(configuration);
-
-const { status, data } = await apiInstance.getGetProspects();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**Array<ProspectDTO>**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Prospects |  -  |
-|**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)
-
-# **getRemoveFromProspects**
-> ProspectDTO getRemoveFromProspects()
-
-Remove From Prospect
-
-### Example
-
-```typescript
-import {
-    ProspectsApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(configuration);
-
-let xeroId: string; //Xero ID (default to undefined)
-let status: boolean; //Status (default to undefined)
-
-const { status, data } = await apiInstance.getRemoveFromProspects(
-    xeroId,
-    status
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **xeroId** | [**string**] | Xero ID | defaults to undefined|
-| **status** | [**boolean**] | Status | defaults to undefined|
-
-
-### Return type
-
-**ProspectDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Prospect |  -  |
-|**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)
-
-# **getSetCallback**
-> ProspectDTO getSetCallback()
-
-Set Call Back Date
-
-### Example
-
-```typescript
-import {
-    ProspectsApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new ProspectsApi(configuration);
-
-let xeroId: string; //Xero ID (default to undefined)
-let callback: string; //Callback Date (default to undefined)
-
-const { status, data } = await apiInstance.getSetCallback(
-    xeroId,
-    callback
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **xeroId** | [**string**] | Xero ID | defaults to undefined|
-| **callback** | [**string**] | Callback Date | defaults to undefined|
-
-
-### Return type
-
-**ProspectDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Prospect |  -  |
-|**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/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)