yellowgrid-api-ts 3.2.361 → 3.2.362

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -393,10 +393,13 @@ docs/TcxSbcEntity.md
393
393
  docs/TcxSbcModel.md
394
394
  docs/TcxSbcResponseDTO.md
395
395
  docs/TcxServicePrincipalEntity.md
396
+ docs/TcxServicePrincipalModel.md
396
397
  docs/TcxSetupEntity.md
397
398
  docs/TcxSetupsModel.md
398
399
  docs/TcxSipTrunksEntity.md
399
400
  docs/TcxSummaryDTO.md
401
+ docs/TcxTccAlertsEntity.md
402
+ docs/TcxTccMonitoringEntity.md
400
403
  docs/TcxTemplateXmlEnum.md
401
404
  docs/TcxUsersEntity.md
402
405
  docs/TcxWizardConfigModel.md
package/README.md CHANGED
@@ -181,6 +181,7 @@ Class | Method | HTTP request | Description
181
181
  *CRMApi* | [**getSearchByPhone**](docs/CRMApi.md#getsearchbyphone) | **GET** /crm/contact/search |
182
182
  *CRMApi* | [**postCreateCrmNote**](docs/CRMApi.md#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note |
183
183
  *CRMApi* | [**postJournalCall**](docs/CRMApi.md#postjournalcall) | **POST** /crm/contact/{id}/journal |
184
+ *Class3CXApi* | [**getAddAlert**](docs/Class3CXApi.md#getaddalert) | **GET** /tcx/cc/instance/{id}/alerts |
184
185
  *Class3CXApi* | [**getGetCCDevices**](docs/Class3CXApi.md#getgetccdevices) | **GET** /tcx/cc/devices |
185
186
  *Class3CXApi* | [**getGetCallHistory**](docs/Class3CXApi.md#getgetcallhistory) | **GET** /tcx/cc/instance/{id}/calls |
186
187
  *Class3CXApi* | [**getGetLicenceDetails**](docs/Class3CXApi.md#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details
@@ -189,6 +190,7 @@ Class | Method | HTTP request | Description
189
190
  *Class3CXApi* | [**getGetTcxExpiringKeys**](docs/Class3CXApi.md#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys
190
191
  *Class3CXApi* | [**getGetTcxExpiringKeysCsv**](docs/Class3CXApi.md#getgettcxexpiringkeyscsv) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys
191
192
  *Class3CXApi* | [**getGetTcxPartners**](docs/Class3CXApi.md#getgettcxpartners) | **GET** /tcx/admin/partners | Get 3CX Partners
193
+ *Class3CXApi* | [**postAddAlert**](docs/Class3CXApi.md#postaddalert) | **POST** /tcx/cc/instance/{id}/alerts |
192
194
  *Class3CXApi* | [**postAddCallLog**](docs/Class3CXApi.md#postaddcalllog) | **POST** /tcx/cc/call/log |
193
195
  *Class3CXApi* | [**postAuthenticateInstanceWebsocket**](docs/Class3CXApi.md#postauthenticateinstancewebsocket) | **POST** /tcx/cc/instance/auth/{id} |
194
196
  *Class3CXApi* | [**postGetBulkLicenceDetails**](docs/Class3CXApi.md#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details
@@ -820,10 +822,13 @@ Class | Method | HTTP request | Description
820
822
  - [TcxSbcModel](docs/TcxSbcModel.md)
821
823
  - [TcxSbcResponseDTO](docs/TcxSbcResponseDTO.md)
822
824
  - [TcxServicePrincipalEntity](docs/TcxServicePrincipalEntity.md)
825
+ - [TcxServicePrincipalModel](docs/TcxServicePrincipalModel.md)
823
826
  - [TcxSetupEntity](docs/TcxSetupEntity.md)
824
827
  - [TcxSetupsModel](docs/TcxSetupsModel.md)
825
828
  - [TcxSipTrunksEntity](docs/TcxSipTrunksEntity.md)
826
829
  - [TcxSummaryDTO](docs/TcxSummaryDTO.md)
830
+ - [TcxTccAlertsEntity](docs/TcxTccAlertsEntity.md)
831
+ - [TcxTccMonitoringEntity](docs/TcxTccMonitoringEntity.md)
827
832
  - [TcxTemplateXmlEnum](docs/TcxTemplateXmlEnum.md)
828
833
  - [TcxUsersEntity](docs/TcxUsersEntity.md)
829
834
  - [TcxWizardConfigModel](docs/TcxWizardConfigModel.md)
package/api.ts CHANGED
@@ -1352,6 +1352,8 @@ export const AuditLogEntityTypeEnum = {
1352
1352
  Pops3cxUsers: 'pops_3cx_users',
1353
1353
  _3cxServicePrincipals: '3cx_service_principals',
1354
1354
  _3cxCallLog: '3cx_call_log',
1355
+ _3cxTccMonitoring: '3cx_tcc_monitoring',
1356
+ _3cxTccAlerts: '3cx_tcc_alerts',
1355
1357
  PopsUsers: 'pops_users',
1356
1358
  PopsVideoRequests: 'pops_video_requests',
1357
1359
  Webhook: 'webhook',
@@ -10929,6 +10931,39 @@ export interface TcxServicePrincipalEntity {
10929
10931
  */
10930
10932
  'appSecret': string;
10931
10933
  }
10934
+ /**
10935
+ * 3CX Service Principal
10936
+ */
10937
+ export interface TcxServicePrincipalModel {
10938
+ /**
10939
+ * id
10940
+ */
10941
+ 'id': string;
10942
+ /**
10943
+ * customerId
10944
+ */
10945
+ 'customerId': number;
10946
+ /**
10947
+ * pbxBase
10948
+ */
10949
+ 'pbxBase': string;
10950
+ /**
10951
+ * appId
10952
+ */
10953
+ 'appId': string;
10954
+ /**
10955
+ * appSecret
10956
+ */
10957
+ 'appSecret': string;
10958
+ /**
10959
+ * Monitoring
10960
+ */
10961
+ 'monitoring'?: Array<TcxTccMonitoringEntity>;
10962
+ /**
10963
+ * Alerts
10964
+ */
10965
+ 'alerts'?: Array<TcxTccAlertsEntity>;
10966
+ }
10932
10967
  /**
10933
10968
  * 3CX Wizard Setup Config
10934
10969
  */
@@ -11152,6 +11187,60 @@ export interface TcxSummaryDTO {
11152
11187
  */
11153
11188
  'licenceKey': string;
11154
11189
  }
11190
+ /**
11191
+ * TcxTccAlertsEntity
11192
+ */
11193
+ export interface TcxTccAlertsEntity {
11194
+ /**
11195
+ * instanceId
11196
+ */
11197
+ 'instanceId': string;
11198
+ /**
11199
+ * monitoring_id
11200
+ */
11201
+ 'monitoringId': number;
11202
+ /**
11203
+ * timestamp
11204
+ */
11205
+ 'timestamp': string;
11206
+ /**
11207
+ * alertSent
11208
+ */
11209
+ 'alertSent': number;
11210
+ }
11211
+ /**
11212
+ * TcxTccMonitoringEntity
11213
+ */
11214
+ export interface TcxTccMonitoringEntity {
11215
+ /**
11216
+ * id
11217
+ */
11218
+ 'id': number;
11219
+ /**
11220
+ * instanceId
11221
+ */
11222
+ 'instanceId': string;
11223
+ /**
11224
+ * maxCalls
11225
+ */
11226
+ 'maxCalls': number;
11227
+ /**
11228
+ * trunk
11229
+ */
11230
+ 'trunk': string;
11231
+ /**
11232
+ * type
11233
+ */
11234
+ 'type': string;
11235
+ /**
11236
+ * emails
11237
+ */
11238
+ 'emails': string;
11239
+ /**
11240
+ * sms
11241
+ */
11242
+ 'sms': string;
11243
+ }
11155
11244
  /**
11156
11245
  * 3CX Template
11157
11246
  */
@@ -20774,6 +20863,58 @@ export type GetGetCrmActivitiesTypeEnum = typeof GetGetCrmActivitiesTypeEnum[key
20774
20863
  */
20775
20864
  export const Class3CXApiAxiosParamCreator = function (configuration?: Configuration) {
20776
20865
  return {
20866
+ /**
20867
+ * Get 3CX call control alerts
20868
+ * @param {string} id Instance ID
20869
+ * @param {string} [start] Start Date
20870
+ * @param {string} [end] End Date
20871
+ * @param {number} [monitoringId] Monitoring ID
20872
+ * @param {*} [options] Override http request option.
20873
+ * @throws {RequiredError}
20874
+ */
20875
+ getAddAlert: async (id: string, start?: string, end?: string, monitoringId?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
20876
+ // verify required parameter 'id' is not null or undefined
20877
+ assertParamExists('getAddAlert', 'id', id)
20878
+ const localVarPath = `/tcx/cc/instance/{id}/alerts`
20879
+ .replace('{id}', encodeURIComponent(String(id)));
20880
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
20881
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
20882
+ let baseOptions;
20883
+ if (configuration) {
20884
+ baseOptions = configuration.baseOptions;
20885
+ }
20886
+
20887
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
20888
+ const localVarHeaderParameter = {} as any;
20889
+ const localVarQueryParameter = {} as any;
20890
+
20891
+ if (start !== undefined) {
20892
+ localVarQueryParameter['start'] = (start as any instanceof Date) ?
20893
+ (start as any).toISOString().substring(0,10) :
20894
+ start;
20895
+ }
20896
+
20897
+ if (end !== undefined) {
20898
+ localVarQueryParameter['end'] = (end as any instanceof Date) ?
20899
+ (end as any).toISOString().substring(0,10) :
20900
+ end;
20901
+ }
20902
+
20903
+ if (monitoringId !== undefined) {
20904
+ localVarQueryParameter['monitoring_id'] = monitoringId;
20905
+ }
20906
+
20907
+ localVarHeaderParameter['Accept'] = 'application/json';
20908
+
20909
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
20910
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
20911
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
20912
+
20913
+ return {
20914
+ url: toPathString(localVarUrlObj),
20915
+ options: localVarRequestOptions,
20916
+ };
20917
+ },
20777
20918
  /**
20778
20919
  * Get a list of 3CX call control devices
20779
20920
  * @param {*} [options] Override http request option.
@@ -21037,6 +21178,45 @@ export const Class3CXApiAxiosParamCreator = function (configuration?: Configurat
21037
21178
 
21038
21179
  localVarHeaderParameter['Accept'] = 'application/json';
21039
21180
 
21181
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
21182
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
21183
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
21184
+
21185
+ return {
21186
+ url: toPathString(localVarUrlObj),
21187
+ options: localVarRequestOptions,
21188
+ };
21189
+ },
21190
+ /**
21191
+ * Add to 3CX call control alert
21192
+ * @param {string} id Instance ID
21193
+ * @param {number} monitoringId Monitoring ID
21194
+ * @param {*} [options] Override http request option.
21195
+ * @throws {RequiredError}
21196
+ */
21197
+ postAddAlert: async (id: string, monitoringId: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
21198
+ // verify required parameter 'id' is not null or undefined
21199
+ assertParamExists('postAddAlert', 'id', id)
21200
+ // verify required parameter 'monitoringId' is not null or undefined
21201
+ assertParamExists('postAddAlert', 'monitoringId', monitoringId)
21202
+ const localVarPath = `/tcx/cc/instance/{id}/alerts`
21203
+ .replace('{id}', encodeURIComponent(String(id)));
21204
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
21205
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
21206
+ let baseOptions;
21207
+ if (configuration) {
21208
+ baseOptions = configuration.baseOptions;
21209
+ }
21210
+
21211
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
21212
+ const localVarHeaderParameter = {} as any;
21213
+ const localVarQueryParameter = {} as any;
21214
+
21215
+ if (monitoringId !== undefined) {
21216
+ localVarQueryParameter['monitoring_id'] = monitoringId;
21217
+ }
21218
+
21219
+
21040
21220
  setSearchParams(localVarUrlObj, localVarQueryParameter);
21041
21221
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
21042
21222
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -21152,6 +21332,21 @@ export const Class3CXApiAxiosParamCreator = function (configuration?: Configurat
21152
21332
  export const Class3CXApiFp = function(configuration?: Configuration) {
21153
21333
  const localVarAxiosParamCreator = Class3CXApiAxiosParamCreator(configuration)
21154
21334
  return {
21335
+ /**
21336
+ * Get 3CX call control alerts
21337
+ * @param {string} id Instance ID
21338
+ * @param {string} [start] Start Date
21339
+ * @param {string} [end] End Date
21340
+ * @param {number} [monitoringId] Monitoring ID
21341
+ * @param {*} [options] Override http request option.
21342
+ * @throws {RequiredError}
21343
+ */
21344
+ async getAddAlert(id: string, start?: string, end?: string, monitoringId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TcxTccAlertsEntity>>> {
21345
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAddAlert(id, start, end, monitoringId, options);
21346
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21347
+ const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getAddAlert']?.[localVarOperationServerIndex]?.url;
21348
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21349
+ },
21155
21350
  /**
21156
21351
  * Get a list of 3CX call control devices
21157
21352
  * @param {*} [options] Override http request option.
@@ -21197,7 +21392,7 @@ export const Class3CXApiFp = function(configuration?: Configuration) {
21197
21392
  * @param {*} [options] Override http request option.
21198
21393
  * @throws {RequiredError}
21199
21394
  */
21200
- async getGetServicePrincipals(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TcxServicePrincipalEntity>>> {
21395
+ async getGetServicePrincipals(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TcxServicePrincipalModel>>> {
21201
21396
  const localVarAxiosArgs = await localVarAxiosParamCreator.getGetServicePrincipals(options);
21202
21397
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21203
21398
  const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetServicePrincipals']?.[localVarOperationServerIndex]?.url;
@@ -21251,6 +21446,19 @@ export const Class3CXApiFp = function(configuration?: Configuration) {
21251
21446
  const localVarOperationServerBasePath = operationServerMap['Class3CXApi.getGetTcxPartners']?.[localVarOperationServerIndex]?.url;
21252
21447
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21253
21448
  },
21449
+ /**
21450
+ * Add to 3CX call control alert
21451
+ * @param {string} id Instance ID
21452
+ * @param {number} monitoringId Monitoring ID
21453
+ * @param {*} [options] Override http request option.
21454
+ * @throws {RequiredError}
21455
+ */
21456
+ async postAddAlert(id: string, monitoringId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
21457
+ const localVarAxiosArgs = await localVarAxiosParamCreator.postAddAlert(id, monitoringId, options);
21458
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21459
+ const localVarOperationServerBasePath = operationServerMap['Class3CXApi.postAddAlert']?.[localVarOperationServerIndex]?.url;
21460
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21461
+ },
21254
21462
  /**
21255
21463
  * Add to 3CX call log
21256
21464
  * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
@@ -21297,6 +21505,18 @@ export const Class3CXApiFp = function(configuration?: Configuration) {
21297
21505
  export const Class3CXApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
21298
21506
  const localVarFp = Class3CXApiFp(configuration)
21299
21507
  return {
21508
+ /**
21509
+ * Get 3CX call control alerts
21510
+ * @param {string} id Instance ID
21511
+ * @param {string} [start] Start Date
21512
+ * @param {string} [end] End Date
21513
+ * @param {number} [monitoringId] Monitoring ID
21514
+ * @param {*} [options] Override http request option.
21515
+ * @throws {RequiredError}
21516
+ */
21517
+ getAddAlert(id: string, start?: string, end?: string, monitoringId?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxTccAlertsEntity>> {
21518
+ return localVarFp.getAddAlert(id, start, end, monitoringId, options).then((request) => request(axios, basePath));
21519
+ },
21300
21520
  /**
21301
21521
  * Get a list of 3CX call control devices
21302
21522
  * @param {*} [options] Override http request option.
@@ -21333,7 +21553,7 @@ export const Class3CXApiFactory = function (configuration?: Configuration, baseP
21333
21553
  * @param {*} [options] Override http request option.
21334
21554
  * @throws {RequiredError}
21335
21555
  */
21336
- getGetServicePrincipals(options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxServicePrincipalEntity>> {
21556
+ getGetServicePrincipals(options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxServicePrincipalModel>> {
21337
21557
  return localVarFp.getGetServicePrincipals(options).then((request) => request(axios, basePath));
21338
21558
  },
21339
21559
  /**
@@ -21372,6 +21592,16 @@ export const Class3CXApiFactory = function (configuration?: Configuration, baseP
21372
21592
  getGetTcxPartners(options?: RawAxiosRequestConfig): AxiosPromise<Array<PartnerDTO>> {
21373
21593
  return localVarFp.getGetTcxPartners(options).then((request) => request(axios, basePath));
21374
21594
  },
21595
+ /**
21596
+ * Add to 3CX call control alert
21597
+ * @param {string} id Instance ID
21598
+ * @param {number} monitoringId Monitoring ID
21599
+ * @param {*} [options] Override http request option.
21600
+ * @throws {RequiredError}
21601
+ */
21602
+ postAddAlert(id: string, monitoringId: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
21603
+ return localVarFp.postAddAlert(id, monitoringId, options).then((request) => request(axios, basePath));
21604
+ },
21375
21605
  /**
21376
21606
  * Add to 3CX call log
21377
21607
  * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
@@ -21407,6 +21637,19 @@ export const Class3CXApiFactory = function (configuration?: Configuration, baseP
21407
21637
  * Class3CXApi - object-oriented interface
21408
21638
  */
21409
21639
  export class Class3CXApi extends BaseAPI {
21640
+ /**
21641
+ * Get 3CX call control alerts
21642
+ * @param {string} id Instance ID
21643
+ * @param {string} [start] Start Date
21644
+ * @param {string} [end] End Date
21645
+ * @param {number} [monitoringId] Monitoring ID
21646
+ * @param {*} [options] Override http request option.
21647
+ * @throws {RequiredError}
21648
+ */
21649
+ public getAddAlert(id: string, start?: string, end?: string, monitoringId?: number, options?: RawAxiosRequestConfig) {
21650
+ return Class3CXApiFp(this.configuration).getAddAlert(id, start, end, monitoringId, options).then((request) => request(this.axios, this.basePath));
21651
+ }
21652
+
21410
21653
  /**
21411
21654
  * Get a list of 3CX call control devices
21412
21655
  * @param {*} [options] Override http request option.
@@ -21490,6 +21733,17 @@ export class Class3CXApi extends BaseAPI {
21490
21733
  return Class3CXApiFp(this.configuration).getGetTcxPartners(options).then((request) => request(this.axios, this.basePath));
21491
21734
  }
21492
21735
 
21736
+ /**
21737
+ * Add to 3CX call control alert
21738
+ * @param {string} id Instance ID
21739
+ * @param {number} monitoringId Monitoring ID
21740
+ * @param {*} [options] Override http request option.
21741
+ * @throws {RequiredError}
21742
+ */
21743
+ public postAddAlert(id: string, monitoringId: number, options?: RawAxiosRequestConfig) {
21744
+ return Class3CXApiFp(this.configuration).postAddAlert(id, monitoringId, options).then((request) => request(this.axios, this.basePath));
21745
+ }
21746
+
21493
21747
  /**
21494
21748
  * Add to 3CX call log
21495
21749
  * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
package/dist/api.d.ts CHANGED
@@ -1320,6 +1320,8 @@ export declare const AuditLogEntityTypeEnum: {
1320
1320
  readonly Pops3cxUsers: "pops_3cx_users";
1321
1321
  readonly _3cxServicePrincipals: "3cx_service_principals";
1322
1322
  readonly _3cxCallLog: "3cx_call_log";
1323
+ readonly _3cxTccMonitoring: "3cx_tcc_monitoring";
1324
+ readonly _3cxTccAlerts: "3cx_tcc_alerts";
1323
1325
  readonly PopsUsers: "pops_users";
1324
1326
  readonly PopsVideoRequests: "pops_video_requests";
1325
1327
  readonly Webhook: "webhook";
@@ -10731,6 +10733,39 @@ export interface TcxServicePrincipalEntity {
10731
10733
  */
10732
10734
  'appSecret': string;
10733
10735
  }
10736
+ /**
10737
+ * 3CX Service Principal
10738
+ */
10739
+ export interface TcxServicePrincipalModel {
10740
+ /**
10741
+ * id
10742
+ */
10743
+ 'id': string;
10744
+ /**
10745
+ * customerId
10746
+ */
10747
+ 'customerId': number;
10748
+ /**
10749
+ * pbxBase
10750
+ */
10751
+ 'pbxBase': string;
10752
+ /**
10753
+ * appId
10754
+ */
10755
+ 'appId': string;
10756
+ /**
10757
+ * appSecret
10758
+ */
10759
+ 'appSecret': string;
10760
+ /**
10761
+ * Monitoring
10762
+ */
10763
+ 'monitoring'?: Array<TcxTccMonitoringEntity>;
10764
+ /**
10765
+ * Alerts
10766
+ */
10767
+ 'alerts'?: Array<TcxTccAlertsEntity>;
10768
+ }
10734
10769
  /**
10735
10770
  * 3CX Wizard Setup Config
10736
10771
  */
@@ -10950,6 +10985,60 @@ export interface TcxSummaryDTO {
10950
10985
  */
10951
10986
  'licenceKey': string;
10952
10987
  }
10988
+ /**
10989
+ * TcxTccAlertsEntity
10990
+ */
10991
+ export interface TcxTccAlertsEntity {
10992
+ /**
10993
+ * instanceId
10994
+ */
10995
+ 'instanceId': string;
10996
+ /**
10997
+ * monitoring_id
10998
+ */
10999
+ 'monitoringId': number;
11000
+ /**
11001
+ * timestamp
11002
+ */
11003
+ 'timestamp': string;
11004
+ /**
11005
+ * alertSent
11006
+ */
11007
+ 'alertSent': number;
11008
+ }
11009
+ /**
11010
+ * TcxTccMonitoringEntity
11011
+ */
11012
+ export interface TcxTccMonitoringEntity {
11013
+ /**
11014
+ * id
11015
+ */
11016
+ 'id': number;
11017
+ /**
11018
+ * instanceId
11019
+ */
11020
+ 'instanceId': string;
11021
+ /**
11022
+ * maxCalls
11023
+ */
11024
+ 'maxCalls': number;
11025
+ /**
11026
+ * trunk
11027
+ */
11028
+ 'trunk': string;
11029
+ /**
11030
+ * type
11031
+ */
11032
+ 'type': string;
11033
+ /**
11034
+ * emails
11035
+ */
11036
+ 'emails': string;
11037
+ /**
11038
+ * sms
11039
+ */
11040
+ 'sms': string;
11041
+ }
10953
11042
  /**
10954
11043
  * 3CX Template
10955
11044
  */
@@ -15548,6 +15637,16 @@ export type GetGetCrmActivitiesTypeEnum = typeof GetGetCrmActivitiesTypeEnum[key
15548
15637
  * Class3CXApi - axios parameter creator
15549
15638
  */
15550
15639
  export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuration) => {
15640
+ /**
15641
+ * Get 3CX call control alerts
15642
+ * @param {string} id Instance ID
15643
+ * @param {string} [start] Start Date
15644
+ * @param {string} [end] End Date
15645
+ * @param {number} [monitoringId] Monitoring ID
15646
+ * @param {*} [options] Override http request option.
15647
+ * @throws {RequiredError}
15648
+ */
15649
+ getAddAlert: (id: string, start?: string, end?: string, monitoringId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15551
15650
  /**
15552
15651
  * Get a list of 3CX call control devices
15553
15652
  * @param {*} [options] Override http request option.
@@ -15607,6 +15706,14 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
15607
15706
  * @throws {RequiredError}
15608
15707
  */
15609
15708
  getGetTcxPartners: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15709
+ /**
15710
+ * Add to 3CX call control alert
15711
+ * @param {string} id Instance ID
15712
+ * @param {number} monitoringId Monitoring ID
15713
+ * @param {*} [options] Override http request option.
15714
+ * @throws {RequiredError}
15715
+ */
15716
+ postAddAlert: (id: string, monitoringId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
15610
15717
  /**
15611
15718
  * Add to 3CX call log
15612
15719
  * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
@@ -15634,6 +15741,16 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
15634
15741
  * Class3CXApi - functional programming interface
15635
15742
  */
15636
15743
  export declare const Class3CXApiFp: (configuration?: Configuration) => {
15744
+ /**
15745
+ * Get 3CX call control alerts
15746
+ * @param {string} id Instance ID
15747
+ * @param {string} [start] Start Date
15748
+ * @param {string} [end] End Date
15749
+ * @param {number} [monitoringId] Monitoring ID
15750
+ * @param {*} [options] Override http request option.
15751
+ * @throws {RequiredError}
15752
+ */
15753
+ getAddAlert(id: string, start?: string, end?: string, monitoringId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TcxTccAlertsEntity>>>;
15637
15754
  /**
15638
15755
  * Get a list of 3CX call control devices
15639
15756
  * @param {*} [options] Override http request option.
@@ -15664,7 +15781,7 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
15664
15781
  * @param {*} [options] Override http request option.
15665
15782
  * @throws {RequiredError}
15666
15783
  */
15667
- getGetServicePrincipals(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TcxServicePrincipalEntity>>>;
15784
+ getGetServicePrincipals(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TcxServicePrincipalModel>>>;
15668
15785
  /**
15669
15786
  * Get 3CX Credit Status
15670
15787
  * @summary Get 3CX Credit Status
@@ -15693,6 +15810,14 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
15693
15810
  * @throws {RequiredError}
15694
15811
  */
15695
15812
  getGetTcxPartners(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PartnerDTO>>>;
15813
+ /**
15814
+ * Add to 3CX call control alert
15815
+ * @param {string} id Instance ID
15816
+ * @param {number} monitoringId Monitoring ID
15817
+ * @param {*} [options] Override http request option.
15818
+ * @throws {RequiredError}
15819
+ */
15820
+ postAddAlert(id: string, monitoringId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
15696
15821
  /**
15697
15822
  * Add to 3CX call log
15698
15823
  * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
@@ -15720,6 +15845,16 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
15720
15845
  * Class3CXApi - factory interface
15721
15846
  */
15722
15847
  export declare const Class3CXApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
15848
+ /**
15849
+ * Get 3CX call control alerts
15850
+ * @param {string} id Instance ID
15851
+ * @param {string} [start] Start Date
15852
+ * @param {string} [end] End Date
15853
+ * @param {number} [monitoringId] Monitoring ID
15854
+ * @param {*} [options] Override http request option.
15855
+ * @throws {RequiredError}
15856
+ */
15857
+ getAddAlert(id: string, start?: string, end?: string, monitoringId?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxTccAlertsEntity>>;
15723
15858
  /**
15724
15859
  * Get a list of 3CX call control devices
15725
15860
  * @param {*} [options] Override http request option.
@@ -15750,7 +15885,7 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
15750
15885
  * @param {*} [options] Override http request option.
15751
15886
  * @throws {RequiredError}
15752
15887
  */
15753
- getGetServicePrincipals(options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxServicePrincipalEntity>>;
15888
+ getGetServicePrincipals(options?: RawAxiosRequestConfig): AxiosPromise<Array<TcxServicePrincipalModel>>;
15754
15889
  /**
15755
15890
  * Get 3CX Credit Status
15756
15891
  * @summary Get 3CX Credit Status
@@ -15779,6 +15914,14 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
15779
15914
  * @throws {RequiredError}
15780
15915
  */
15781
15916
  getGetTcxPartners(options?: RawAxiosRequestConfig): AxiosPromise<Array<PartnerDTO>>;
15917
+ /**
15918
+ * Add to 3CX call control alert
15919
+ * @param {string} id Instance ID
15920
+ * @param {number} monitoringId Monitoring ID
15921
+ * @param {*} [options] Override http request option.
15922
+ * @throws {RequiredError}
15923
+ */
15924
+ postAddAlert(id: string, monitoringId: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
15782
15925
  /**
15783
15926
  * Add to 3CX call log
15784
15927
  * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
@@ -15806,6 +15949,16 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
15806
15949
  * Class3CXApi - object-oriented interface
15807
15950
  */
15808
15951
  export declare class Class3CXApi extends BaseAPI {
15952
+ /**
15953
+ * Get 3CX call control alerts
15954
+ * @param {string} id Instance ID
15955
+ * @param {string} [start] Start Date
15956
+ * @param {string} [end] End Date
15957
+ * @param {number} [monitoringId] Monitoring ID
15958
+ * @param {*} [options] Override http request option.
15959
+ * @throws {RequiredError}
15960
+ */
15961
+ getAddAlert(id: string, start?: string, end?: string, monitoringId?: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<TcxTccAlertsEntity[], any, {}, any>>;
15809
15962
  /**
15810
15963
  * Get a list of 3CX call control devices
15811
15964
  * @param {*} [options] Override http request option.
@@ -15836,7 +15989,7 @@ export declare class Class3CXApi extends BaseAPI {
15836
15989
  * @param {*} [options] Override http request option.
15837
15990
  * @throws {RequiredError}
15838
15991
  */
15839
- getGetServicePrincipals(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<TcxServicePrincipalEntity[], any, {}, any>>;
15992
+ getGetServicePrincipals(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<TcxServicePrincipalModel[], any, {}, any>>;
15840
15993
  /**
15841
15994
  * Get 3CX Credit Status
15842
15995
  * @summary Get 3CX Credit Status
@@ -15865,6 +16018,14 @@ export declare class Class3CXApi extends BaseAPI {
15865
16018
  * @throws {RequiredError}
15866
16019
  */
15867
16020
  getGetTcxPartners(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PartnerDTO[], any, {}, any>>;
16021
+ /**
16022
+ * Add to 3CX call control alert
16023
+ * @param {string} id Instance ID
16024
+ * @param {number} monitoringId Monitoring ID
16025
+ * @param {*} [options] Override http request option.
16026
+ * @throws {RequiredError}
16027
+ */
16028
+ postAddAlert(id: string, monitoringId: number, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}, any>>;
15868
16029
  /**
15869
16030
  * Add to 3CX call log
15870
16031
  * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
package/dist/api.js CHANGED
@@ -175,6 +175,8 @@ exports.AuditLogEntityTypeEnum = {
175
175
  Pops3cxUsers: 'pops_3cx_users',
176
176
  _3cxServicePrincipals: '3cx_service_principals',
177
177
  _3cxCallLog: '3cx_call_log',
178
+ _3cxTccMonitoring: '3cx_tcc_monitoring',
179
+ _3cxTccAlerts: '3cx_tcc_alerts',
178
180
  PopsUsers: 'pops_users',
179
181
  PopsVideoRequests: 'pops_video_requests',
180
182
  Webhook: 'webhook',
@@ -9101,6 +9103,51 @@ exports.GetGetCrmActivitiesTypeEnum = {
9101
9103
  */
9102
9104
  const Class3CXApiAxiosParamCreator = function (configuration) {
9103
9105
  return {
9106
+ /**
9107
+ * Get 3CX call control alerts
9108
+ * @param {string} id Instance ID
9109
+ * @param {string} [start] Start Date
9110
+ * @param {string} [end] End Date
9111
+ * @param {number} [monitoringId] Monitoring ID
9112
+ * @param {*} [options] Override http request option.
9113
+ * @throws {RequiredError}
9114
+ */
9115
+ getAddAlert: async (id, start, end, monitoringId, options = {}) => {
9116
+ // verify required parameter 'id' is not null or undefined
9117
+ (0, common_1.assertParamExists)('getAddAlert', 'id', id);
9118
+ const localVarPath = `/tcx/cc/instance/{id}/alerts`
9119
+ .replace('{id}', encodeURIComponent(String(id)));
9120
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
9121
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
9122
+ let baseOptions;
9123
+ if (configuration) {
9124
+ baseOptions = configuration.baseOptions;
9125
+ }
9126
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
9127
+ const localVarHeaderParameter = {};
9128
+ const localVarQueryParameter = {};
9129
+ if (start !== undefined) {
9130
+ localVarQueryParameter['start'] = (start instanceof Date) ?
9131
+ start.toISOString().substring(0, 10) :
9132
+ start;
9133
+ }
9134
+ if (end !== undefined) {
9135
+ localVarQueryParameter['end'] = (end instanceof Date) ?
9136
+ end.toISOString().substring(0, 10) :
9137
+ end;
9138
+ }
9139
+ if (monitoringId !== undefined) {
9140
+ localVarQueryParameter['monitoring_id'] = monitoringId;
9141
+ }
9142
+ localVarHeaderParameter['Accept'] = 'application/json';
9143
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
9144
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9145
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
9146
+ return {
9147
+ url: (0, common_1.toPathString)(localVarUrlObj),
9148
+ options: localVarRequestOptions,
9149
+ };
9150
+ },
9104
9151
  /**
9105
9152
  * Get a list of 3CX call control devices
9106
9153
  * @param {*} [options] Override http request option.
@@ -9336,6 +9383,40 @@ const Class3CXApiAxiosParamCreator = function (configuration) {
9336
9383
  options: localVarRequestOptions,
9337
9384
  };
9338
9385
  },
9386
+ /**
9387
+ * Add to 3CX call control alert
9388
+ * @param {string} id Instance ID
9389
+ * @param {number} monitoringId Monitoring ID
9390
+ * @param {*} [options] Override http request option.
9391
+ * @throws {RequiredError}
9392
+ */
9393
+ postAddAlert: async (id, monitoringId, options = {}) => {
9394
+ // verify required parameter 'id' is not null or undefined
9395
+ (0, common_1.assertParamExists)('postAddAlert', 'id', id);
9396
+ // verify required parameter 'monitoringId' is not null or undefined
9397
+ (0, common_1.assertParamExists)('postAddAlert', 'monitoringId', monitoringId);
9398
+ const localVarPath = `/tcx/cc/instance/{id}/alerts`
9399
+ .replace('{id}', encodeURIComponent(String(id)));
9400
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
9401
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
9402
+ let baseOptions;
9403
+ if (configuration) {
9404
+ baseOptions = configuration.baseOptions;
9405
+ }
9406
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
9407
+ const localVarHeaderParameter = {};
9408
+ const localVarQueryParameter = {};
9409
+ if (monitoringId !== undefined) {
9410
+ localVarQueryParameter['monitoring_id'] = monitoringId;
9411
+ }
9412
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
9413
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9414
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
9415
+ return {
9416
+ url: (0, common_1.toPathString)(localVarUrlObj),
9417
+ options: localVarRequestOptions,
9418
+ };
9419
+ },
9339
9420
  /**
9340
9421
  * Add to 3CX call log
9341
9422
  * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
@@ -9430,6 +9511,21 @@ exports.Class3CXApiAxiosParamCreator = Class3CXApiAxiosParamCreator;
9430
9511
  const Class3CXApiFp = function (configuration) {
9431
9512
  const localVarAxiosParamCreator = (0, exports.Class3CXApiAxiosParamCreator)(configuration);
9432
9513
  return {
9514
+ /**
9515
+ * Get 3CX call control alerts
9516
+ * @param {string} id Instance ID
9517
+ * @param {string} [start] Start Date
9518
+ * @param {string} [end] End Date
9519
+ * @param {number} [monitoringId] Monitoring ID
9520
+ * @param {*} [options] Override http request option.
9521
+ * @throws {RequiredError}
9522
+ */
9523
+ async getAddAlert(id, start, end, monitoringId, options) {
9524
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAddAlert(id, start, end, monitoringId, options);
9525
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9526
+ const localVarOperationServerBasePath = base_1.operationServerMap['Class3CXApi.getAddAlert']?.[localVarOperationServerIndex]?.url;
9527
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9528
+ },
9433
9529
  /**
9434
9530
  * Get a list of 3CX call control devices
9435
9531
  * @param {*} [options] Override http request option.
@@ -9529,6 +9625,19 @@ const Class3CXApiFp = function (configuration) {
9529
9625
  const localVarOperationServerBasePath = base_1.operationServerMap['Class3CXApi.getGetTcxPartners']?.[localVarOperationServerIndex]?.url;
9530
9626
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9531
9627
  },
9628
+ /**
9629
+ * Add to 3CX call control alert
9630
+ * @param {string} id Instance ID
9631
+ * @param {number} monitoringId Monitoring ID
9632
+ * @param {*} [options] Override http request option.
9633
+ * @throws {RequiredError}
9634
+ */
9635
+ async postAddAlert(id, monitoringId, options) {
9636
+ const localVarAxiosArgs = await localVarAxiosParamCreator.postAddAlert(id, monitoringId, options);
9637
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9638
+ const localVarOperationServerBasePath = base_1.operationServerMap['Class3CXApi.postAddAlert']?.[localVarOperationServerIndex]?.url;
9639
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9640
+ },
9532
9641
  /**
9533
9642
  * Add to 3CX call log
9534
9643
  * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
@@ -9575,6 +9684,18 @@ exports.Class3CXApiFp = Class3CXApiFp;
9575
9684
  const Class3CXApiFactory = function (configuration, basePath, axios) {
9576
9685
  const localVarFp = (0, exports.Class3CXApiFp)(configuration);
9577
9686
  return {
9687
+ /**
9688
+ * Get 3CX call control alerts
9689
+ * @param {string} id Instance ID
9690
+ * @param {string} [start] Start Date
9691
+ * @param {string} [end] End Date
9692
+ * @param {number} [monitoringId] Monitoring ID
9693
+ * @param {*} [options] Override http request option.
9694
+ * @throws {RequiredError}
9695
+ */
9696
+ getAddAlert(id, start, end, monitoringId, options) {
9697
+ return localVarFp.getAddAlert(id, start, end, monitoringId, options).then((request) => request(axios, basePath));
9698
+ },
9578
9699
  /**
9579
9700
  * Get a list of 3CX call control devices
9580
9701
  * @param {*} [options] Override http request option.
@@ -9650,6 +9771,16 @@ const Class3CXApiFactory = function (configuration, basePath, axios) {
9650
9771
  getGetTcxPartners(options) {
9651
9772
  return localVarFp.getGetTcxPartners(options).then((request) => request(axios, basePath));
9652
9773
  },
9774
+ /**
9775
+ * Add to 3CX call control alert
9776
+ * @param {string} id Instance ID
9777
+ * @param {number} monitoringId Monitoring ID
9778
+ * @param {*} [options] Override http request option.
9779
+ * @throws {RequiredError}
9780
+ */
9781
+ postAddAlert(id, monitoringId, options) {
9782
+ return localVarFp.postAddAlert(id, monitoringId, options).then((request) => request(axios, basePath));
9783
+ },
9653
9784
  /**
9654
9785
  * Add to 3CX call log
9655
9786
  * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
@@ -9685,6 +9816,18 @@ exports.Class3CXApiFactory = Class3CXApiFactory;
9685
9816
  * Class3CXApi - object-oriented interface
9686
9817
  */
9687
9818
  class Class3CXApi extends base_1.BaseAPI {
9819
+ /**
9820
+ * Get 3CX call control alerts
9821
+ * @param {string} id Instance ID
9822
+ * @param {string} [start] Start Date
9823
+ * @param {string} [end] End Date
9824
+ * @param {number} [monitoringId] Monitoring ID
9825
+ * @param {*} [options] Override http request option.
9826
+ * @throws {RequiredError}
9827
+ */
9828
+ getAddAlert(id, start, end, monitoringId, options) {
9829
+ return (0, exports.Class3CXApiFp)(this.configuration).getAddAlert(id, start, end, monitoringId, options).then((request) => request(this.axios, this.basePath));
9830
+ }
9688
9831
  /**
9689
9832
  * Get a list of 3CX call control devices
9690
9833
  * @param {*} [options] Override http request option.
@@ -9760,6 +9903,16 @@ class Class3CXApi extends base_1.BaseAPI {
9760
9903
  getGetTcxPartners(options) {
9761
9904
  return (0, exports.Class3CXApiFp)(this.configuration).getGetTcxPartners(options).then((request) => request(this.axios, this.basePath));
9762
9905
  }
9906
+ /**
9907
+ * Add to 3CX call control alert
9908
+ * @param {string} id Instance ID
9909
+ * @param {number} monitoringId Monitoring ID
9910
+ * @param {*} [options] Override http request option.
9911
+ * @throws {RequiredError}
9912
+ */
9913
+ postAddAlert(id, monitoringId, options) {
9914
+ return (0, exports.Class3CXApiFp)(this.configuration).postAddAlert(id, monitoringId, options).then((request) => request(this.axios, this.basePath));
9915
+ }
9763
9916
  /**
9764
9917
  * Add to 3CX call log
9765
9918
  * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
@@ -4,6 +4,7 @@ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**getAddAlert**](#getaddalert) | **GET** /tcx/cc/instance/{id}/alerts | |
7
8
  |[**getGetCCDevices**](#getgetccdevices) | **GET** /tcx/cc/devices | |
8
9
  |[**getGetCallHistory**](#getgetcallhistory) | **GET** /tcx/cc/instance/{id}/calls | |
9
10
  |[**getGetLicenceDetails**](#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details|
@@ -12,10 +13,74 @@ All URIs are relative to *https://bitbucket.org*
12
13
  |[**getGetTcxExpiringKeys**](#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys|
13
14
  |[**getGetTcxExpiringKeysCsv**](#getgettcxexpiringkeyscsv) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys|
14
15
  |[**getGetTcxPartners**](#getgettcxpartners) | **GET** /tcx/admin/partners | Get 3CX Partners|
16
+ |[**postAddAlert**](#postaddalert) | **POST** /tcx/cc/instance/{id}/alerts | |
15
17
  |[**postAddCallLog**](#postaddcalllog) | **POST** /tcx/cc/call/log | |
16
18
  |[**postAuthenticateInstanceWebsocket**](#postauthenticateinstancewebsocket) | **POST** /tcx/cc/instance/auth/{id} | |
17
19
  |[**postGetBulkLicenceDetails**](#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details|
18
20
 
21
+ # **getAddAlert**
22
+ > Array<TcxTccAlertsEntity> getAddAlert()
23
+
24
+ Get 3CX call control alerts
25
+
26
+ ### Example
27
+
28
+ ```typescript
29
+ import {
30
+ Class3CXApi,
31
+ Configuration
32
+ } from 'yellowgrid-api-ts';
33
+
34
+ const configuration = new Configuration();
35
+ const apiInstance = new Class3CXApi(configuration);
36
+
37
+ let id: string; //Instance ID (default to undefined)
38
+ let start: string; //Start Date (optional) (default to undefined)
39
+ let end: string; //End Date (optional) (default to undefined)
40
+ let monitoringId: number; //Monitoring ID (optional) (default to undefined)
41
+
42
+ const { status, data } = await apiInstance.getAddAlert(
43
+ id,
44
+ start,
45
+ end,
46
+ monitoringId
47
+ );
48
+ ```
49
+
50
+ ### Parameters
51
+
52
+ |Name | Type | Description | Notes|
53
+ |------------- | ------------- | ------------- | -------------|
54
+ | **id** | [**string**] | Instance ID | defaults to undefined|
55
+ | **start** | [**string**] | Start Date | (optional) defaults to undefined|
56
+ | **end** | [**string**] | End Date | (optional) defaults to undefined|
57
+ | **monitoringId** | [**number**] | Monitoring ID | (optional) defaults to undefined|
58
+
59
+
60
+ ### Return type
61
+
62
+ **Array<TcxTccAlertsEntity>**
63
+
64
+ ### Authorization
65
+
66
+ No authorization required
67
+
68
+ ### HTTP request headers
69
+
70
+ - **Content-Type**: Not defined
71
+ - **Accept**: application/json
72
+
73
+
74
+ ### HTTP response details
75
+ | Status code | Description | Response headers |
76
+ |-------------|-------------|------------------|
77
+ |**200** | Alerts | - |
78
+ |**400** | Bad Request | - |
79
+ |**401** | Unauthorised | - |
80
+ |**403** | Access Denied | - |
81
+
82
+ [[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)
83
+
19
84
  # **getGetCCDevices**
20
85
  > Array<DeviceModel> getGetCCDevices()
21
86
 
@@ -184,7 +249,7 @@ No authorization required
184
249
  [[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)
185
250
 
186
251
  # **getGetServicePrincipals**
187
- > Array<TcxServicePrincipalEntity> getGetServicePrincipals()
252
+ > Array<TcxServicePrincipalModel> getGetServicePrincipals()
188
253
 
189
254
  Get 3CX service principals
190
255
 
@@ -208,7 +273,7 @@ This endpoint does not have any parameters.
208
273
 
209
274
  ### Return type
210
275
 
211
- **Array<TcxServicePrincipalEntity>**
276
+ **Array<TcxServicePrincipalModel>**
212
277
 
213
278
  ### Authorization
214
279
 
@@ -418,6 +483,63 @@ No authorization required
418
483
 
419
484
  [[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)
420
485
 
486
+ # **postAddAlert**
487
+ > postAddAlert()
488
+
489
+ Add to 3CX call control alert
490
+
491
+ ### Example
492
+
493
+ ```typescript
494
+ import {
495
+ Class3CXApi,
496
+ Configuration
497
+ } from 'yellowgrid-api-ts';
498
+
499
+ const configuration = new Configuration();
500
+ const apiInstance = new Class3CXApi(configuration);
501
+
502
+ let id: string; //Instance ID (default to undefined)
503
+ let monitoringId: number; //Monitoring ID (default to undefined)
504
+
505
+ const { status, data } = await apiInstance.postAddAlert(
506
+ id,
507
+ monitoringId
508
+ );
509
+ ```
510
+
511
+ ### Parameters
512
+
513
+ |Name | Type | Description | Notes|
514
+ |------------- | ------------- | ------------- | -------------|
515
+ | **id** | [**string**] | Instance ID | defaults to undefined|
516
+ | **monitoringId** | [**number**] | Monitoring ID | defaults to undefined|
517
+
518
+
519
+ ### Return type
520
+
521
+ void (empty response body)
522
+
523
+ ### Authorization
524
+
525
+ No authorization required
526
+
527
+ ### HTTP request headers
528
+
529
+ - **Content-Type**: Not defined
530
+ - **Accept**: Not defined
531
+
532
+
533
+ ### HTTP response details
534
+ | Status code | Description | Response headers |
535
+ |-------------|-------------|------------------|
536
+ |**204** | No Response | - |
537
+ |**400** | Bad Request | - |
538
+ |**401** | Unauthorised | - |
539
+ |**403** | Access Denied | - |
540
+
541
+ [[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)
542
+
421
543
  # **postAddCallLog**
422
544
  > postAddCallLog()
423
545
 
@@ -0,0 +1,33 @@
1
+ # TcxServicePrincipalModel
2
+
3
+ 3CX Service Principal
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **string** | id | [default to undefined]
10
+ **customerId** | **number** | customerId | [default to undefined]
11
+ **pbxBase** | **string** | pbxBase | [default to undefined]
12
+ **appId** | **string** | appId | [default to undefined]
13
+ **appSecret** | **string** | appSecret | [default to undefined]
14
+ **monitoring** | [**Array&lt;TcxTccMonitoringEntity&gt;**](TcxTccMonitoringEntity.md) | Monitoring | [optional] [default to undefined]
15
+ **alerts** | [**Array&lt;TcxTccAlertsEntity&gt;**](TcxTccAlertsEntity.md) | Alerts | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { TcxServicePrincipalModel } from 'yellowgrid-api-ts';
21
+
22
+ const instance: TcxServicePrincipalModel = {
23
+ id,
24
+ customerId,
25
+ pbxBase,
26
+ appId,
27
+ appSecret,
28
+ monitoring,
29
+ alerts,
30
+ };
31
+ ```
32
+
33
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,27 @@
1
+ # TcxTccAlertsEntity
2
+
3
+ TcxTccAlertsEntity
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **instanceId** | **string** | instanceId | [default to undefined]
10
+ **monitoringId** | **number** | monitoring_id | [default to undefined]
11
+ **timestamp** | **string** | timestamp | [default to undefined]
12
+ **alertSent** | **number** | alertSent | [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { TcxTccAlertsEntity } from 'yellowgrid-api-ts';
18
+
19
+ const instance: TcxTccAlertsEntity = {
20
+ instanceId,
21
+ monitoringId,
22
+ timestamp,
23
+ alertSent,
24
+ };
25
+ ```
26
+
27
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,33 @@
1
+ # TcxTccMonitoringEntity
2
+
3
+ TcxTccMonitoringEntity
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | id | [default to undefined]
10
+ **instanceId** | **string** | instanceId | [default to undefined]
11
+ **maxCalls** | **number** | maxCalls | [default to undefined]
12
+ **trunk** | **string** | trunk | [default to undefined]
13
+ **type** | **string** | type | [default to undefined]
14
+ **emails** | **string** | emails | [default to undefined]
15
+ **sms** | **string** | sms | [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { TcxTccMonitoringEntity } from 'yellowgrid-api-ts';
21
+
22
+ const instance: TcxTccMonitoringEntity = {
23
+ id,
24
+ instanceId,
25
+ maxCalls,
26
+ trunk,
27
+ type,
28
+ emails,
29
+ sms,
30
+ };
31
+ ```
32
+
33
+ [[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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.361",
3
+ "version": "3.2.362",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {