yellowgrid-api-ts 3.2.38 → 3.2.39-dev.0

package/dist/base.js

@@ -3,7 +3,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/dist/common.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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/dist/common.js

@@ -3,7 +3,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/dist/configuration.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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/dist/configuration.js

@@ -3,7 +3,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/dist/index.d.ts

@@ -1,6 +1,6 @@
 /**
  * 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/dist/index.js

@@ -3,7 +3,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/docs/EventUpdateDTO.md

@@ -8,8 +8,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **message** | **string** | Service Event Update Message | [optional] [default to undefined]
 **type** | **number** | Service Event Update Type | [optional] [default to undefined]
-**typeName** | **string** | Service Event Update Type Description | [optional] [default to undefined]
 **createdAt** | **string** | Date Time | [optional] [default to undefined]
+**typeName** | **string** | Service Event Update Type Description | [optional] [default to undefined]
 
 ## Example
 
@@ -19,8 +19,8 @@ import { EventUpdateDTO } from 'yellowgrid-api-ts';
 const instance: EventUpdateDTO = {
     message,
     type,
-    typeName,
     createdAt,
+    typeName,
 };
 ```
 

package/docs/EventUpdateRequestDTO.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **message** | **string** | Service Event Update Message | [optional] [default to undefined]
 **type** | **number** | Service Event Update Type | [optional] [default to undefined]
+**createdAt** | **string** | Date Time | [optional] [default to undefined]
 
 ## Example
 
@@ -17,6 +18,7 @@ import { EventUpdateRequestDTO } from 'yellowgrid-api-ts';
 const instance: EventUpdateRequestDTO = {
     message,
     type,
+    createdAt,
 };
 ```
 

package/docs/ServicesApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *http://api.yellowgrid.local*
 |[**deleteUnsubscribe**](#deleteunsubscribe) | **DELETE** /services/events/unsubscribe | |
 |[**getGetServiceHealth**](#getgetservicehealth) | **GET** /services/health | |
 |[**patchArchiveEvent**](#patcharchiveevent) | **PATCH** /services/events/{id}/archive | |
+|[**patchUpdateEvent**](#patchupdateevent) | **PATCH** /services/events/{id} | |
 |[**postCreateEvent**](#postcreateevent) | **POST** /services/events | |
 |[**postCreateEventUpdate**](#postcreateeventupdate) | **POST** /services/events/{id}/updates | |
 |[**postSubscribe**](#postsubscribe) | **POST** /services/events/subscribe | |
@@ -126,7 +127,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ServicesApi(configuration);
 
-let id: number; //Group ID (default to undefined)
+let id: number; //Event ID (default to undefined)
 
 const { status, data } = await apiInstance.patchArchiveEvent(
     id
@@ -137,7 +138,7 @@ const { status, data } = await apiInstance.patchArchiveEvent(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **id** | [**number**] | Group ID | defaults to undefined|
+| **id** | [**number**] | Event ID | defaults to undefined|
 
 
 ### Return type
@@ -154,6 +155,63 @@ No authorization required
  - **Accept**: application/json
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Service Event DTO |  -  |
+|**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)
+
+# **patchUpdateEvent**
+> EventDTO patchUpdateEvent()
+
+
+### Example
+
+```typescript
+import {
+    ServicesApi,
+    Configuration,
+    EventRequestDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ServicesApi(configuration);
+
+let id: number; //Event ID (default to undefined)
+let eventRequestDTO: EventRequestDTO; // (optional)
+
+const { status, data } = await apiInstance.patchUpdateEvent(
+    id,
+    eventRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **eventRequestDTO** | **EventRequestDTO**|  | |
+| **id** | [**number**] | Event ID | defaults to undefined|
+
+
+### Return type
+
+**EventDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
@@ -211,7 +269,7 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Service Event DTO |  -  |
+|**201** | Service Event DTO |  -  |
 |**400** | Bad Request |  -  |
 |**401** | Unauthorised |  -  |
 |**403** | Access Denied |  -  |
@@ -234,7 +292,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ServicesApi(configuration);
 
-let id: number; //Group ID (default to undefined)
+let id: number; //Event ID (default to undefined)
 let eventUpdateRequestDTO: EventUpdateRequestDTO; // (optional)
 
 const { status, data } = await apiInstance.postCreateEventUpdate(
@@ -248,7 +306,7 @@ const { status, data } = await apiInstance.postCreateEventUpdate(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **eventUpdateRequestDTO** | **EventUpdateRequestDTO**|  | |
-| **id** | [**number**] | Group ID | defaults to undefined|
+| **id** | [**number**] | Event ID | defaults to undefined|
 
 
 ### Return type