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

package/base.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/common.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/config.json

@@ -1,3 +1,3 @@
-{
-  "npmName": "yellowgrid-api-ts"
-}
+{
+  "npmName": "yellowgrid-api-ts"
+}

package/configuration.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/dist/api.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
  *
@@ -2359,6 +2359,198 @@ export interface EdTechProSetupModel {
      */
     'installed'?: boolean;
 }
+/**
+ * Service Event DTO
+ * @export
+ * @interface EventDTO
+ */
+export interface EventDTO {
+    /**
+     * Service Event Title
+     * @type {string}
+     * @memberof EventDTO
+     */
+    'title'?: string;
+    /**
+     * Service Event Type
+     * @type {number}
+     * @memberof EventDTO
+     */
+    'type'?: number;
+    /**
+     * Service Impacted
+     * @type {number}
+     * @memberof EventDTO
+     */
+    'service'?: number;
+    /**
+     * Event Status Description
+     * @type {string}
+     * @memberof EventDTO
+     */
+    'statusName'?: string;
+    /**
+     * Event Type Description
+     * @type {string}
+     * @memberof EventDTO
+     */
+    'typeName'?: string;
+    /**
+     * Service Event ID
+     * @type {number}
+     * @memberof EventDTO
+     */
+    'id'?: number;
+    /**
+     * Service Event Status
+     * @type {number}
+     * @memberof EventDTO
+     */
+    'status'?: EventDTOStatusEnum;
+    /**
+     * Service Event Updates
+     * @type {Array<EventUpdateDTO>}
+     * @memberof EventDTO
+     */
+    'updates'?: Array<EventUpdateDTO>;
+}
+export declare const EventDTOStatusEnum: {
+    readonly NUMBER_0: 0;
+    readonly NUMBER_1: 1;
+    readonly NUMBER_2: 2;
+};
+export type EventDTOStatusEnum = typeof EventDTOStatusEnum[keyof typeof EventDTOStatusEnum];
+/**
+ * Service Event Request DTO
+ * @export
+ * @interface EventRequestDTO
+ */
+export interface EventRequestDTO {
+    /**
+     * Service Event Title
+     * @type {string}
+     * @memberof EventRequestDTO
+     */
+    'title'?: string;
+    /**
+     * Service Event Type
+     * @type {number}
+     * @memberof EventRequestDTO
+     */
+    'type'?: number;
+    /**
+     * Service Impacted
+     * @type {number}
+     * @memberof EventRequestDTO
+     */
+    'service'?: number;
+}
+/**
+ * Service Event Subscribption Model
+ * @export
+ * @interface EventSubscriptionModel
+ */
+export interface EventSubscriptionModel {
+    /**
+     * id
+     * @type {string}
+     * @memberof EventSubscriptionModel
+     */
+    'id'?: string;
+    /**
+     * email
+     * @type {string}
+     * @memberof EventSubscriptionModel
+     */
+    'email'?: string;
+}
+/**
+ * Service Event Update DTO
+ * @export
+ * @interface EventUpdateDTO
+ */
+export interface EventUpdateDTO {
+    /**
+     * Service Event Update Message
+     * @type {string}
+     * @memberof EventUpdateDTO
+     */
+    'message'?: string;
+    /**
+     * Service Event Update Type
+     * @type {number}
+     * @memberof EventUpdateDTO
+     */
+    'type'?: number;
+    /**
+     * Service Event Update Type Description
+     * @type {string}
+     * @memberof EventUpdateDTO
+     */
+    'typeName'?: string;
+    /**
+     * Date Time
+     * @type {string}
+     * @memberof EventUpdateDTO
+     */
+    'createdAt'?: string;
+}
+/**
+ * Event Update Entity
+ * @export
+ * @interface EventUpdateEntity
+ */
+export interface EventUpdateEntity {
+    /**
+     * id
+     * @type {number}
+     * @memberof EventUpdateEntity
+     */
+    'id'?: number;
+    /**
+     * eventId
+     * @type {number}
+     * @memberof EventUpdateEntity
+     */
+    'eventId'?: number;
+    /**
+     * message
+     * @type {string}
+     * @memberof EventUpdateEntity
+     */
+    'message'?: string;
+    /**
+     * type
+     * @type {number}
+     * @memberof EventUpdateEntity
+     */
+    'type'?: number;
+    /**
+     * createdAt
+     * @type {string}
+     * @memberof EventUpdateEntity
+     */
+    'createdAt'?: string;
+}
+/**
+ * Service Event Update Request DTO
+ * @export
+ * @interface EventUpdateRequestDTO
+ */
+export interface EventUpdateRequestDTO {
+    /**
+     * Service Event Update Message
+     * @type {string}
+     * @memberof EventUpdateRequestDTO
+     */
+    'message'?: string;
+    /**
+     * Service Event Update Type
+     * @type {number}
+     * @memberof EventUpdateRequestDTO
+     */
+    'type'?: number;
+}
 /**
  * Fraud Management
  * @export
@@ -5261,6 +5453,68 @@ export interface ScopeModel {
      */
     'description'?: string;
 }
+/**
+ * Service Health DTO
+ * @export
+ * @interface ServiceHealthDTO
+ */
+export interface ServiceHealthDTO {
+    /**
+     *
+     * @type {Array<ServiceStatusDTO>}
+     * @memberof ServiceHealthDTO
+     */
+    'services'?: Array<ServiceStatusDTO>;
+    /**
+     *
+     * @type {number}
+     * @memberof ServiceHealthDTO
+     */
+    'globalStatus'?: ServiceHealthDTOGlobalStatusEnum;
+}
+export declare const ServiceHealthDTOGlobalStatusEnum: {
+    readonly NUMBER_0: 0;
+    readonly NUMBER_1: 1;
+    readonly NUMBER_2: 2;
+};
+export type ServiceHealthDTOGlobalStatusEnum = typeof ServiceHealthDTOGlobalStatusEnum[keyof typeof ServiceHealthDTOGlobalStatusEnum];
+/**
+ * Service Status DTO
+ * @export
+ * @interface ServiceStatusDTO
+ */
+export interface ServiceStatusDTO {
+    /**
+     * Service Status Description
+     * @type {string}
+     * @memberof ServiceStatusDTO
+     */
+    'statusName'?: string;
+    /**
+     * Service Name
+     * @type {string}
+     * @memberof ServiceStatusDTO
+     */
+    'name'?: string;
+    /**
+     * Service Status
+     * @type {number}
+     * @memberof ServiceStatusDTO
+     */
+    'status'?: ServiceStatusDTOStatusEnum;
+    /**
+     * Service Events
+     * @type {Array<EventDTO>}
+     * @memberof ServiceStatusDTO
+     */
+    'events'?: Array<EventDTO>;
+}
+export declare const ServiceStatusDTOStatusEnum: {
+    readonly NUMBER_0: 0;
+    readonly NUMBER_1: 1;
+    readonly NUMBER_2: 2;
+};
+export type ServiceStatusDTOStatusEnum = typeof ServiceStatusDTOStatusEnum[keyof typeof ServiceStatusDTOStatusEnum];
 /**
  * ShipmentAddressEntity
  * @export
@@ -15143,6 +15397,210 @@ export declare class SMSApi extends BaseAPI {
      */
     postSendSms(authorization: string, smsMessageModel?: SmsMessageModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SmsDataModel, any, {}>>;
 }
+/**
+ * ServicesApi - axios parameter creator
+ * @export
+ */
+export declare const ServicesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {string} [id] Unsubscribe Email ID
+     * @param {string} [email] Unsubscribe Email Address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteUnsubscribe: (id?: string, email?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetServiceHealth: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {number} id Group ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchArchiveEvent: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {EventRequestDTO} [eventRequestDTO]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postCreateEvent: (eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {number} id Group ID
+     * @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postCreateEventUpdate: (id: number, eventUpdateRequestDTO?: EventUpdateRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} [email] Subscription Email Address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postSubscribe: (email?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ServicesApi - functional programming interface
+ * @export
+ */
+export declare const ServicesApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {string} [id] Unsubscribe Email ID
+     * @param {string} [email] Unsubscribe Email Address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteUnsubscribe(id?: string, email?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetServiceHealth(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceHealthDTO>>;
+    /**
+     *
+     * @param {number} id Group ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchArchiveEvent(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventDTO>>;
+    /**
+     *
+     * @param {EventRequestDTO} [eventRequestDTO]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postCreateEvent(eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventDTO>>;
+    /**
+     *
+     * @param {number} id Group ID
+     * @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postCreateEventUpdate(id: number, eventUpdateRequestDTO?: EventUpdateRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventDTO>>;
+    /**
+     *
+     * @param {string} [email] Subscription Email Address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postSubscribe(email?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * ServicesApi - factory interface
+ * @export
+ */
+export declare const ServicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @param {string} [id] Unsubscribe Email ID
+     * @param {string} [email] Unsubscribe Email Address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteUnsubscribe(id?: string, email?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetServiceHealth(options?: RawAxiosRequestConfig): AxiosPromise<ServiceHealthDTO>;
+    /**
+     *
+     * @param {number} id Group ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchArchiveEvent(id: number, options?: RawAxiosRequestConfig): AxiosPromise<EventDTO>;
+    /**
+     *
+     * @param {EventRequestDTO} [eventRequestDTO]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postCreateEvent(eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventDTO>;
+    /**
+     *
+     * @param {number} id Group ID
+     * @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postCreateEventUpdate(id: number, eventUpdateRequestDTO?: EventUpdateRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<EventDTO>;
+    /**
+     *
+     * @param {string} [email] Subscription Email Address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postSubscribe(email?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * ServicesApi - object-oriented interface
+ * @export
+ * @class ServicesApi
+ * @extends {BaseAPI}
+ */
+export declare class ServicesApi extends BaseAPI {
+    /**
+     *
+     * @param {string} [id] Unsubscribe Email ID
+     * @param {string} [email] Unsubscribe Email Address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ServicesApi
+     */
+    deleteUnsubscribe(id?: string, email?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ServicesApi
+     */
+    getGetServiceHealth(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceHealthDTO, any, {}>>;
+    /**
+     *
+     * @param {number} id Group ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ServicesApi
+     */
+    patchArchiveEvent(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventDTO, any, {}>>;
+    /**
+     *
+     * @param {EventRequestDTO} [eventRequestDTO]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ServicesApi
+     */
+    postCreateEvent(eventRequestDTO?: EventRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventDTO, any, {}>>;
+    /**
+     *
+     * @param {number} id Group ID
+     * @param {EventUpdateRequestDTO} [eventUpdateRequestDTO]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ServicesApi
+     */
+    postCreateEventUpdate(id: number, eventUpdateRequestDTO?: EventUpdateRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventDTO, any, {}>>;
+    /**
+     *
+     * @param {string} [email] Subscription Email Address
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ServicesApi
+     */
+    postSubscribe(email?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+}
 /**
  * ShippingApi - axios parameter creator
  * @export