yellowgrid-api-ts 3.2.360 → 3.2.362

package/dist/api.d.ts

@@ -1320,6 +1320,8 @@ export declare const AuditLogEntityTypeEnum: {
     readonly Pops3cxUsers: "pops_3cx_users";
     readonly _3cxServicePrincipals: "3cx_service_principals";
     readonly _3cxCallLog: "3cx_call_log";
+    readonly _3cxTccMonitoring: "3cx_tcc_monitoring";
+    readonly _3cxTccAlerts: "3cx_tcc_alerts";
     readonly PopsUsers: "pops_users";
     readonly PopsVideoRequests: "pops_video_requests";
     readonly Webhook: "webhook";
@@ -10731,6 +10733,39 @@ export interface TcxServicePrincipalEntity {
      */
     'appSecret': string;
 }
+/**
+ * 3CX Service Principal
+ */
+export interface TcxServicePrincipalModel {
+    /**
+     * id
+     */
+    'id': string;
+    /**
+     * customerId
+     */
+    'customerId': number;
+    /**
+     * pbxBase
+     */
+    'pbxBase': string;
+    /**
+     * appId
+     */
+    'appId': string;
+    /**
+     * appSecret
+     */
+    'appSecret': string;
+    /**
+     * Monitoring
+     */
+    'monitoring'?: Array<TcxTccMonitoringEntity>;
+    /**
+     * Alerts
+     */
+    'alerts'?: Array<TcxTccAlertsEntity>;
+}
 /**
  * 3CX Wizard Setup Config
  */
@@ -10950,6 +10985,60 @@ export interface TcxSummaryDTO {
      */
     'licenceKey': string;
 }
+/**
+ * TcxTccAlertsEntity
+ */
+export interface TcxTccAlertsEntity {
+    /**
+     * instanceId
+     */
+    'instanceId': string;
+    /**
+     * monitoring_id
+     */
+    'monitoringId': number;
+    /**
+     * timestamp
+     */
+    'timestamp': string;
+    /**
+     * alertSent
+     */
+    'alertSent': number;
+}
+/**
+ * TcxTccMonitoringEntity
+ */
+export interface TcxTccMonitoringEntity {
+    /**
+     * id
+     */
+    'id': number;
+    /**
+     * instanceId
+     */
+    'instanceId': string;
+    /**
+     * maxCalls
+     */
+    'maxCalls': number;
+    /**
+     * trunk
+     */
+    'trunk': string;
+    /**
+     * type
+     */
+    'type': string;
+    /**
+     * emails
+     */
+    'emails': string;
+    /**
+     * sms
+     */
+    'sms': string;
+}
 /**
  * 3CX Template
  */
@@ -15548,6 +15637,16 @@ export type GetGetCrmActivitiesTypeEnum = typeof GetGetCrmActivitiesTypeEnum[key
  * Class3CXApi - axios parameter creator
  */
 export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Get 3CX call control alerts
+     * @param {string} id Instance ID
+     * @param {string} [start] Start Date
+     * @param {string} [end] End Date
+     * @param {number} [monitoringId] Monitoring ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAddAlert: (id: string, start?: string, end?: string, monitoringId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get a list of 3CX call control devices
      * @param {*} [options] Override http request option.
@@ -15557,13 +15656,14 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
     /**
      * Get 3CX call history
      * @param {string} id Instance ID
-     * @param {string} trunk Trunk
      * @param {string} [start] Start Date
      * @param {string} [end] End Date
+     * @param {string} [trunk] Trunk
+     * @param {GetGetCallHistoryTypeEnum} [type] Type
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getGetCallHistory: (id: string, trunk: string, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getGetCallHistory: (id: string, start?: string, end?: string, trunk?: string, type?: GetGetCallHistoryTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get 3CX Licence Details
      * @summary Get 3CX Licence Details
@@ -15606,6 +15706,14 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getGetTcxPartners: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Add to 3CX call control alert
+     * @param {string} id Instance ID
+     * @param {number} monitoringId Monitoring ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postAddAlert: (id: string, monitoringId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Add to 3CX call log
      * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
@@ -15633,6 +15741,16 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
  * Class3CXApi - functional programming interface
  */
 export declare const Class3CXApiFp: (configuration?: Configuration) => {
+    /**
+     * Get 3CX call control alerts
+     * @param {string} id Instance ID
+     * @param {string} [start] Start Date
+     * @param {string} [end] End Date
+     * @param {number} [monitoringId] Monitoring ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAddAlert(id: string, start?: string, end?: string, monitoringId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TcxTccAlertsEntity>>>;
     /**
      * Get a list of 3CX call control devices
      * @param {*} [options] Override http request option.
@@ -15642,13 +15760,14 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
     /**
      * Get 3CX call history
      * @param {string} id Instance ID
-     * @param {string} trunk Trunk
      * @param {string} [start] Start Date
      * @param {string} [end] End Date
+     * @param {string} [trunk] Trunk
+     * @param {GetGetCallHistoryTypeEnum} [type] Type
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getGetCallHistory(id: string, trunk: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxCallLogCollectionModel>>;
+    getGetCallHistory(id: string, start?: string, end?: string, trunk?: string, type?: GetGetCallHistoryTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxCallLogCollectionModel>>;
     /**
      * Get 3CX Licence Details
      * @summary Get 3CX Licence Details
@@ -15662,7 +15781,7 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getGetServicePrincipals(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TcxServicePrincipalEntity>>>;
+    getGetServicePrincipals(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TcxServicePrincipalModel>>>;
     /**
      * Get 3CX Credit Status
      * @summary Get 3CX Credit Status
@@ -15691,6 +15810,14 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetTcxPartners(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PartnerDTO>>>;
+    /**
+     * Add to 3CX call control alert
+     * @param {string} id Instance ID
+     * @param {number} monitoringId Monitoring ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postAddAlert(id: string, monitoringId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Add to 3CX call log
      * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
@@ -15718,6 +15845,16 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
  * Class3CXApi - factory interface
  */
 export declare const Class3CXApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Get 3CX call control alerts
+     * @param {string} id Instance ID
+     * @param {string} [start] Start Date
+     * @param {string} [end] End Date
+     * @param {number} [monitoringId] Monitoring ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAddAlert(id: string, start?: string, end?: string, monitoringId?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxTccAlertsEntity>>;
     /**
      * Get a list of 3CX call control devices
      * @param {*} [options] Override http request option.
@@ -15727,13 +15864,14 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
     /**
      * Get 3CX call history
      * @param {string} id Instance ID
-     * @param {string} trunk Trunk
      * @param {string} [start] Start Date
      * @param {string} [end] End Date
+     * @param {string} [trunk] Trunk
+     * @param {GetGetCallHistoryTypeEnum} [type] Type
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getGetCallHistory(id: string, trunk: string, start?: string, end?: string, options?: RawAxiosRequestConfig): AxiosPromise<TcxCallLogCollectionModel>;
+    getGetCallHistory(id: string, start?: string, end?: string, trunk?: string, type?: GetGetCallHistoryTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<TcxCallLogCollectionModel>;
     /**
      * Get 3CX Licence Details
      * @summary Get 3CX Licence Details
@@ -15747,7 +15885,7 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getGetServicePrincipals(options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxServicePrincipalEntity>>;
+    getGetServicePrincipals(options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxServicePrincipalModel>>;
     /**
      * Get 3CX Credit Status
      * @summary Get 3CX Credit Status
@@ -15776,6 +15914,14 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getGetTcxPartners(options?: RawAxiosRequestConfig): AxiosPromise<Array<PartnerDTO>>;
+    /**
+     * Add to 3CX call control alert
+     * @param {string} id Instance ID
+     * @param {number} monitoringId Monitoring ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postAddAlert(id: string, monitoringId: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Add to 3CX call log
      * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
@@ -15803,6 +15949,16 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
  * Class3CXApi - object-oriented interface
  */
 export declare class Class3CXApi extends BaseAPI {
+    /**
+     * Get 3CX call control alerts
+     * @param {string} id Instance ID
+     * @param {string} [start] Start Date
+     * @param {string} [end] End Date
+     * @param {number} [monitoringId] Monitoring ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAddAlert(id: string, start?: string, end?: string, monitoringId?: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<TcxTccAlertsEntity[], any, {}, any>>;
     /**
      * Get a list of 3CX call control devices
      * @param {*} [options] Override http request option.
@@ -15812,13 +15968,14 @@ export declare class Class3CXApi extends BaseAPI {
     /**
      * Get 3CX call history
      * @param {string} id Instance ID
-     * @param {string} trunk Trunk
      * @param {string} [start] Start Date
      * @param {string} [end] End Date
+     * @param {string} [trunk] Trunk
+     * @param {GetGetCallHistoryTypeEnum} [type] Type
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getGetCallHistory(id: string, trunk: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<TcxCallLogCollectionModel, any, {}, any>>;
+    getGetCallHistory(id: string, start?: string, end?: string, trunk?: string, type?: GetGetCallHistoryTypeEnum, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<TcxCallLogCollectionModel, any, {}, any>>;
     /**
      * Get 3CX Licence Details
      * @summary Get 3CX Licence Details
@@ -15832,7 +15989,7 @@ export declare class Class3CXApi extends BaseAPI {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getGetServicePrincipals(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<TcxServicePrincipalEntity[], any, {}, any>>;
+    getGetServicePrincipals(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<TcxServicePrincipalModel[], any, {}, any>>;
     /**
      * Get 3CX Credit Status
      * @summary Get 3CX Credit Status
@@ -15861,6 +16018,14 @@ export declare class Class3CXApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getGetTcxPartners(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PartnerDTO[], any, {}, any>>;
+    /**
+     * Add to 3CX call control alert
+     * @param {string} id Instance ID
+     * @param {number} monitoringId Monitoring ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postAddAlert(id: string, monitoringId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}, any>>;
     /**
      * Add to 3CX call log
      * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
@@ -15884,6 +16049,14 @@ export declare class Class3CXApi extends BaseAPI {
      */
     postGetBulkLicenceDetails(requestBody?: Array<string>, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<TcxBulkLicenceDetailsModel, any, {}, any>>;
 }
+export declare const GetGetCallHistoryTypeEnum: {
+    readonly Dialing: "dialing";
+    readonly Ended: "ended";
+    readonly Call: "call";
+    readonly Ringing: "ringing";
+    readonly Connected: "connected";
+};
+export type GetGetCallHistoryTypeEnum = typeof GetGetCallHistoryTypeEnum[keyof typeof GetGetCallHistoryTypeEnum];
 /**
  * Class3CXInstallationWizardApi - axios parameter creator
  */