yellowgrid-api-ts 3.2.360 → 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.
package/dist/api.js CHANGED
@@ -18,9 +18,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
18
18
  Object.defineProperty(exports, "__esModule", { value: true });
19
19
  exports.ServiceStatusDTOStatusEnum = exports.ServiceHealthDTOGlobalStatusEnum = exports.SeriesDTOTypeEnum = exports.SdrReferenceType = exports.RmaSummaryDTOStatusEnum = exports.RmaRequestDTORequestedResolutionEnum = exports.RmaRequestDTOReasonEnum = exports.RmaItemDTOStatusEnum = exports.RmaDTOStatusEnum = exports.RmaDTOResolutionEnum = exports.RmaDTOReasonEnum = exports.RmaCreditItemRequestDTORefundPercentageEnum = exports.ResponseDTOTypeEnum = exports.ResolutionRequestModelResolutionEnum = exports.RequestDTOActionEnum = exports.ReportRequestDTOGraphTypeEnum = exports.ReportRequestDTOReportEnum = exports.ReasonRequestModelReasonEnum = exports.ProspectDTOStatusEnum = exports.PostGetServicePlansRequestPlanGroupEnum = exports.PatchUpdateTcxHostingPriceListRequestPriceListEnum = exports.PatchUpdatePriceListRequestPriceListEnum = exports.PasswordSenderDTOIntervalTypeEnum = exports.OrderTotalModelCurrencyEnum = exports.OrderRequestModelSchoolTypeEnum = exports.OrderRequestModelLicenceTypeEnum = exports.OrderDetailsDTOPaymentMethodEnum = exports.MultiTenantChangeResponseModelTypeEnum = exports.ItemResolutionRequestModelResolutionEnum = exports.ItemDiscountEntityTypeEnum = exports.HostingRegionDTOCodeEnum = exports.HostingChangeResponseModelTypeEnum = exports.GraphDTOCurrencyEnum = exports.EventDTOStatusEnum = exports.DivertResponseModelStatusEnum = exports.CustomerRateType = exports.BrandedVideoSummaryDTOStatusEnum = exports.BrandedVideoSummaryDTOTypeEnum = exports.AxisDataDTOTypeEnum = exports.AuditLogEntityTypeEnum = exports.AuditLogEntityActionEnum = exports.AdminUserModelPermissionsEnum = exports.AdminUserModelRoleEnum = exports.AdminRmaSummaryDTOStatusEnum = exports.AdminRmaItemDTOResolutionEnum = exports.AdminRmaItemDTOStatusEnum = exports.AdminRmaDTOStatusEnum = exports.AdminRmaDTOResolutionEnum = exports.AdminRmaDTOReasonEnum = exports.AdminOrderRequestDTOPaymentMethodEnum = void 0;
20
20
  exports.Class3CXApiFp = exports.Class3CXApiAxiosParamCreator = exports.GetGetCrmActivitiesTypeEnum = exports.CRMApi = exports.CRMApiFactory = exports.CRMApiFp = exports.CRMApiAxiosParamCreator = exports.GetGetBrandedVideosTypeEnum = exports.BrandedVideosApi = exports.BrandedVideosApiFactory = exports.BrandedVideosApiFp = exports.BrandedVideosApiAxiosParamCreator = exports.GetGetServicesPlanDetailsTypeEnum = exports.GetGetConnectionsTypeEnum = exports.BillingApi = exports.BillingApiFactory = exports.BillingApiFp = exports.BillingApiAxiosParamCreator = exports.PatchSetPrizePromoStateEnum = exports.PatchSetPortalAccessStateEnum = exports.PatchSetOnHoldStateEnum = exports.PatchSetAccountStatusStateEnum = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.UpgradeRequestModelSchoolTypeEnum = exports.UpgradeRequestModelLicenceTypeEnum = exports.TcxWizardModelInstallationStatusEnum = exports.TcxWizardModelInstallTypeEnum = exports.TcxSetupEntityRegionEnum = exports.TcxSetupEntityInstallTypeEnum = exports.TcxMultiTenantModelPackageEnum = exports.TcxCallLogEntityTypeEnum = exports.SupplierProductDTOCategoryEnum = exports.StockReportItemModelCurrencyEnum = exports.StockProductModelCategoryEnum = exports.StockOrderModelPaidEnum = exports.StockOrderModelDeliveryMethodEnum = exports.SmsResponseModelEventTypeEnum = exports.SmsPhoneNumberModelStatusEnum = exports.SmsAccountRequestDTOTypeEnum = exports.SmsAccountRequestDTOProviderEnum = exports.SipTrunkChangeResponseModelTypeEnum = exports.ShippingServiceModelCourierEnum = exports.ShippingServiceDTOCourierEnum = exports.ShippingRequestDTOPrinterEnum = exports.ShippingRequestDTOCourierEnum = exports.ShipmentRequestDTOCourierEnum = exports.ShipmentDTOCourierEnum = void 0;
21
- exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.PostAuthoriseScopeEnum = exports.PostAccessTokenTokenExchangeTypeEnum = exports.PostAccessTokenScopeEnum = exports.PostAccessTokenGrantTypeEnum = exports.OAuth20Api = exports.OAuth20ApiFactory = exports.OAuth20ApiFp = exports.OAuth20ApiAxiosParamCreator = exports.NumberPortingApi = exports.NumberPortingApiFactory = exports.NumberPortingApiFp = exports.NumberPortingApiAxiosParamCreator = exports.MyPBXToolsApi = exports.MyPBXToolsApiFactory = exports.MyPBXToolsApiFp = exports.MyPBXToolsApiAxiosParamCreator = exports.MiscApi = exports.MiscApiFactory = exports.MiscApiFp = exports.MiscApiAxiosParamCreator = exports.GetGetTenantsStatusEnum = exports.Class3CXMultiTenantApi = exports.Class3CXMultiTenantApiFactory = exports.Class3CXMultiTenantApiFp = exports.Class3CXMultiTenantApiAxiosParamCreator = exports.GetGetPriceSchoolTypeEnum = exports.GetGetPriceLicenceTypeEnum = exports.Class3CXIntegrationsApi = exports.Class3CXIntegrationsApiFactory = exports.Class3CXIntegrationsApiFp = exports.Class3CXIntegrationsApiAxiosParamCreator = exports.PostResizeInstanceSizeEnum = exports.PostFailoverInstanceTypeEnum = exports.GetGetInstallationsInstallTypeEnum = exports.GetGetInstallationsHostingEnum = exports.GetGetInstallationsStatusEnum = exports.Class3CXInstallationsApi = exports.Class3CXInstallationsApiFactory = exports.Class3CXInstallationsApiFp = exports.Class3CXInstallationsApiAxiosParamCreator = exports.PatchMarkEngineerTaskAsCompleteCompleteEnum = exports.Class3CXInstallationWizardApi = exports.Class3CXInstallationWizardApiFactory = exports.Class3CXInstallationWizardApiFp = exports.Class3CXInstallationWizardApiAxiosParamCreator = exports.Class3CXApi = exports.Class3CXApiFactory = void 0;
22
- exports.ServicesApiFactory = exports.ServicesApiFp = exports.ServicesApiAxiosParamCreator = exports.SMSApi = exports.SMSApiFactory = exports.SMSApiFp = exports.SMSApiAxiosParamCreator = exports.SIPTrunksApi = exports.SIPTrunksApiFactory = exports.SIPTrunksApiFp = exports.SIPTrunksApiAxiosParamCreator = exports.ReportsApi = exports.ReportsApiFactory = exports.ReportsApiFp = exports.ReportsApiAxiosParamCreator = exports.RMAApi = exports.RMAApiFactory = exports.RMAApiFp = exports.RMAApiAxiosParamCreator = exports.ProvisioningApi = exports.ProvisioningApiFactory = exports.ProvisioningApiFp = exports.ProvisioningApiAxiosParamCreator = exports.ProspectsApi = exports.ProspectsApiFactory = exports.ProspectsApiFp = exports.ProspectsApiAxiosParamCreator = exports.PromotionsApi = exports.PromotionsApiFactory = exports.PromotionsApiFp = exports.PromotionsApiAxiosParamCreator = exports.GetGetLegacyStockListFormatEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.PostSendPriceListCategoryEnum = exports.PostSendPriceListFormatEnum = exports.PostSendPriceListTypeEnum = exports.GetGetPriceListCategoryEnum = exports.GetGetPriceListFormatEnum = exports.GetGetPriceListTypeEnum = exports.PricingApi = exports.PricingApiFactory = exports.PricingApiFp = exports.PricingApiAxiosParamCreator = exports.PostPrintShippingLabelPrinterEnum = exports.GetGetOrdersFilterEnum = exports.GetGetOrdersStatusEnum = exports.OrdersApi = void 0;
23
- exports.PostAddWebhookWebhookUriEnum = exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TicketsApi = exports.TicketsApiFactory = exports.TicketsApiFp = exports.TicketsApiAxiosParamCreator = exports.SystemApi = exports.SystemApiFactory = exports.SystemApiFp = exports.SystemApiAxiosParamCreator = exports.SuppliersApi = exports.SuppliersApiFactory = exports.SuppliersApiFp = exports.SuppliersApiAxiosParamCreator = exports.StockManagementApi = exports.StockManagementApiFactory = exports.StockManagementApiFp = exports.StockManagementApiAxiosParamCreator = exports.ShippingApi = exports.ShippingApiFactory = exports.ShippingApiFp = exports.ShippingApiAxiosParamCreator = exports.ServicesApi = void 0;
21
+ exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.PostAuthoriseScopeEnum = exports.PostAccessTokenTokenExchangeTypeEnum = exports.PostAccessTokenScopeEnum = exports.PostAccessTokenGrantTypeEnum = exports.OAuth20Api = exports.OAuth20ApiFactory = exports.OAuth20ApiFp = exports.OAuth20ApiAxiosParamCreator = exports.NumberPortingApi = exports.NumberPortingApiFactory = exports.NumberPortingApiFp = exports.NumberPortingApiAxiosParamCreator = exports.MyPBXToolsApi = exports.MyPBXToolsApiFactory = exports.MyPBXToolsApiFp = exports.MyPBXToolsApiAxiosParamCreator = exports.MiscApi = exports.MiscApiFactory = exports.MiscApiFp = exports.MiscApiAxiosParamCreator = exports.GetGetTenantsStatusEnum = exports.Class3CXMultiTenantApi = exports.Class3CXMultiTenantApiFactory = exports.Class3CXMultiTenantApiFp = exports.Class3CXMultiTenantApiAxiosParamCreator = exports.GetGetPriceSchoolTypeEnum = exports.GetGetPriceLicenceTypeEnum = exports.Class3CXIntegrationsApi = exports.Class3CXIntegrationsApiFactory = exports.Class3CXIntegrationsApiFp = exports.Class3CXIntegrationsApiAxiosParamCreator = exports.PostResizeInstanceSizeEnum = exports.PostFailoverInstanceTypeEnum = exports.GetGetInstallationsInstallTypeEnum = exports.GetGetInstallationsHostingEnum = exports.GetGetInstallationsStatusEnum = exports.Class3CXInstallationsApi = exports.Class3CXInstallationsApiFactory = exports.Class3CXInstallationsApiFp = exports.Class3CXInstallationsApiAxiosParamCreator = exports.PatchMarkEngineerTaskAsCompleteCompleteEnum = exports.Class3CXInstallationWizardApi = exports.Class3CXInstallationWizardApiFactory = exports.Class3CXInstallationWizardApiFp = exports.Class3CXInstallationWizardApiAxiosParamCreator = exports.GetGetCallHistoryTypeEnum = exports.Class3CXApi = exports.Class3CXApiFactory = void 0;
22
+ exports.ServicesApiFp = exports.ServicesApiAxiosParamCreator = exports.SMSApi = exports.SMSApiFactory = exports.SMSApiFp = exports.SMSApiAxiosParamCreator = exports.SIPTrunksApi = exports.SIPTrunksApiFactory = exports.SIPTrunksApiFp = exports.SIPTrunksApiAxiosParamCreator = exports.ReportsApi = exports.ReportsApiFactory = exports.ReportsApiFp = exports.ReportsApiAxiosParamCreator = exports.RMAApi = exports.RMAApiFactory = exports.RMAApiFp = exports.RMAApiAxiosParamCreator = exports.ProvisioningApi = exports.ProvisioningApiFactory = exports.ProvisioningApiFp = exports.ProvisioningApiAxiosParamCreator = exports.ProspectsApi = exports.ProspectsApiFactory = exports.ProspectsApiFp = exports.ProspectsApiAxiosParamCreator = exports.PromotionsApi = exports.PromotionsApiFactory = exports.PromotionsApiFp = exports.PromotionsApiAxiosParamCreator = exports.GetGetLegacyStockListFormatEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.PostSendPriceListCategoryEnum = exports.PostSendPriceListFormatEnum = exports.PostSendPriceListTypeEnum = exports.GetGetPriceListCategoryEnum = exports.GetGetPriceListFormatEnum = exports.GetGetPriceListTypeEnum = exports.PricingApi = exports.PricingApiFactory = exports.PricingApiFp = exports.PricingApiAxiosParamCreator = exports.PostPrintShippingLabelPrinterEnum = exports.GetGetOrdersFilterEnum = exports.GetGetOrdersStatusEnum = exports.OrdersApi = exports.OrdersApiFactory = void 0;
23
+ exports.PostAddWebhookWebhookUriEnum = exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TicketsApi = exports.TicketsApiFactory = exports.TicketsApiFp = exports.TicketsApiAxiosParamCreator = exports.SystemApi = exports.SystemApiFactory = exports.SystemApiFp = exports.SystemApiAxiosParamCreator = exports.SuppliersApi = exports.SuppliersApiFactory = exports.SuppliersApiFp = exports.SuppliersApiAxiosParamCreator = exports.StockManagementApi = exports.StockManagementApiFactory = exports.StockManagementApiFp = exports.StockManagementApiAxiosParamCreator = exports.ShippingApi = exports.ShippingApiFactory = exports.ShippingApiFp = exports.ShippingApiAxiosParamCreator = exports.ServicesApi = exports.ServicesApiFactory = void 0;
24
24
  const axios_1 = __importDefault(require("axios"));
25
25
  // Some imports not used depending on template conditions
26
26
  // @ts-ignore
@@ -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.
@@ -9129,17 +9176,16 @@ const Class3CXApiAxiosParamCreator = function (configuration) {
9129
9176
  /**
9130
9177
  * Get 3CX call history
9131
9178
  * @param {string} id Instance ID
9132
- * @param {string} trunk Trunk
9133
9179
  * @param {string} [start] Start Date
9134
9180
  * @param {string} [end] End Date
9181
+ * @param {string} [trunk] Trunk
9182
+ * @param {GetGetCallHistoryTypeEnum} [type] Type
9135
9183
  * @param {*} [options] Override http request option.
9136
9184
  * @throws {RequiredError}
9137
9185
  */
9138
- getGetCallHistory: async (id, trunk, start, end, options = {}) => {
9186
+ getGetCallHistory: async (id, start, end, trunk, type, options = {}) => {
9139
9187
  // verify required parameter 'id' is not null or undefined
9140
9188
  (0, common_1.assertParamExists)('getGetCallHistory', 'id', id);
9141
- // verify required parameter 'trunk' is not null or undefined
9142
- (0, common_1.assertParamExists)('getGetCallHistory', 'trunk', trunk);
9143
9189
  const localVarPath = `/tcx/cc/instance/{id}/calls`
9144
9190
  .replace('{id}', encodeURIComponent(String(id)));
9145
9191
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -9164,6 +9210,9 @@ const Class3CXApiAxiosParamCreator = function (configuration) {
9164
9210
  if (trunk !== undefined) {
9165
9211
  localVarQueryParameter['trunk'] = trunk;
9166
9212
  }
9213
+ if (type !== undefined) {
9214
+ localVarQueryParameter['type'] = type;
9215
+ }
9167
9216
  localVarHeaderParameter['Accept'] = 'application/json';
9168
9217
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
9169
9218
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -9334,6 +9383,40 @@ const Class3CXApiAxiosParamCreator = function (configuration) {
9334
9383
  options: localVarRequestOptions,
9335
9384
  };
9336
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
+ },
9337
9420
  /**
9338
9421
  * Add to 3CX call log
9339
9422
  * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
@@ -9428,6 +9511,21 @@ exports.Class3CXApiAxiosParamCreator = Class3CXApiAxiosParamCreator;
9428
9511
  const Class3CXApiFp = function (configuration) {
9429
9512
  const localVarAxiosParamCreator = (0, exports.Class3CXApiAxiosParamCreator)(configuration);
9430
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
+ },
9431
9529
  /**
9432
9530
  * Get a list of 3CX call control devices
9433
9531
  * @param {*} [options] Override http request option.
@@ -9442,14 +9540,15 @@ const Class3CXApiFp = function (configuration) {
9442
9540
  /**
9443
9541
  * Get 3CX call history
9444
9542
  * @param {string} id Instance ID
9445
- * @param {string} trunk Trunk
9446
9543
  * @param {string} [start] Start Date
9447
9544
  * @param {string} [end] End Date
9545
+ * @param {string} [trunk] Trunk
9546
+ * @param {GetGetCallHistoryTypeEnum} [type] Type
9448
9547
  * @param {*} [options] Override http request option.
9449
9548
  * @throws {RequiredError}
9450
9549
  */
9451
- async getGetCallHistory(id, trunk, start, end, options) {
9452
- const localVarAxiosArgs = await localVarAxiosParamCreator.getGetCallHistory(id, trunk, start, end, options);
9550
+ async getGetCallHistory(id, start, end, trunk, type, options) {
9551
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getGetCallHistory(id, start, end, trunk, type, options);
9453
9552
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
9454
9553
  const localVarOperationServerBasePath = base_1.operationServerMap['Class3CXApi.getGetCallHistory']?.[localVarOperationServerIndex]?.url;
9455
9554
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -9526,6 +9625,19 @@ const Class3CXApiFp = function (configuration) {
9526
9625
  const localVarOperationServerBasePath = base_1.operationServerMap['Class3CXApi.getGetTcxPartners']?.[localVarOperationServerIndex]?.url;
9527
9626
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
9528
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
+ },
9529
9641
  /**
9530
9642
  * Add to 3CX call log
9531
9643
  * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
@@ -9572,6 +9684,18 @@ exports.Class3CXApiFp = Class3CXApiFp;
9572
9684
  const Class3CXApiFactory = function (configuration, basePath, axios) {
9573
9685
  const localVarFp = (0, exports.Class3CXApiFp)(configuration);
9574
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
+ },
9575
9699
  /**
9576
9700
  * Get a list of 3CX call control devices
9577
9701
  * @param {*} [options] Override http request option.
@@ -9583,14 +9707,15 @@ const Class3CXApiFactory = function (configuration, basePath, axios) {
9583
9707
  /**
9584
9708
  * Get 3CX call history
9585
9709
  * @param {string} id Instance ID
9586
- * @param {string} trunk Trunk
9587
9710
  * @param {string} [start] Start Date
9588
9711
  * @param {string} [end] End Date
9712
+ * @param {string} [trunk] Trunk
9713
+ * @param {GetGetCallHistoryTypeEnum} [type] Type
9589
9714
  * @param {*} [options] Override http request option.
9590
9715
  * @throws {RequiredError}
9591
9716
  */
9592
- getGetCallHistory(id, trunk, start, end, options) {
9593
- return localVarFp.getGetCallHistory(id, trunk, start, end, options).then((request) => request(axios, basePath));
9717
+ getGetCallHistory(id, start, end, trunk, type, options) {
9718
+ return localVarFp.getGetCallHistory(id, start, end, trunk, type, options).then((request) => request(axios, basePath));
9594
9719
  },
9595
9720
  /**
9596
9721
  * Get 3CX Licence Details
@@ -9646,6 +9771,16 @@ const Class3CXApiFactory = function (configuration, basePath, axios) {
9646
9771
  getGetTcxPartners(options) {
9647
9772
  return localVarFp.getGetTcxPartners(options).then((request) => request(axios, basePath));
9648
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
+ },
9649
9784
  /**
9650
9785
  * Add to 3CX call log
9651
9786
  * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
@@ -9681,6 +9816,18 @@ exports.Class3CXApiFactory = Class3CXApiFactory;
9681
9816
  * Class3CXApi - object-oriented interface
9682
9817
  */
9683
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
+ }
9684
9831
  /**
9685
9832
  * Get a list of 3CX call control devices
9686
9833
  * @param {*} [options] Override http request option.
@@ -9692,14 +9839,15 @@ class Class3CXApi extends base_1.BaseAPI {
9692
9839
  /**
9693
9840
  * Get 3CX call history
9694
9841
  * @param {string} id Instance ID
9695
- * @param {string} trunk Trunk
9696
9842
  * @param {string} [start] Start Date
9697
9843
  * @param {string} [end] End Date
9844
+ * @param {string} [trunk] Trunk
9845
+ * @param {GetGetCallHistoryTypeEnum} [type] Type
9698
9846
  * @param {*} [options] Override http request option.
9699
9847
  * @throws {RequiredError}
9700
9848
  */
9701
- getGetCallHistory(id, trunk, start, end, options) {
9702
- return (0, exports.Class3CXApiFp)(this.configuration).getGetCallHistory(id, trunk, start, end, options).then((request) => request(this.axios, this.basePath));
9849
+ getGetCallHistory(id, start, end, trunk, type, options) {
9850
+ return (0, exports.Class3CXApiFp)(this.configuration).getGetCallHistory(id, start, end, trunk, type, options).then((request) => request(this.axios, this.basePath));
9703
9851
  }
9704
9852
  /**
9705
9853
  * Get 3CX Licence Details
@@ -9755,6 +9903,16 @@ class Class3CXApi extends base_1.BaseAPI {
9755
9903
  getGetTcxPartners(options) {
9756
9904
  return (0, exports.Class3CXApiFp)(this.configuration).getGetTcxPartners(options).then((request) => request(this.axios, this.basePath));
9757
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
+ }
9758
9916
  /**
9759
9917
  * Add to 3CX call log
9760
9918
  * @param {TcxCallLogEntity} [tcxCallLogEntity] Call Log
@@ -9785,6 +9943,13 @@ class Class3CXApi extends base_1.BaseAPI {
9785
9943
  }
9786
9944
  }
9787
9945
  exports.Class3CXApi = Class3CXApi;
9946
+ exports.GetGetCallHistoryTypeEnum = {
9947
+ Dialing: 'dialing',
9948
+ Ended: 'ended',
9949
+ Call: 'call',
9950
+ Ringing: 'ringing',
9951
+ Connected: 'connected',
9952
+ };
9788
9953
  /**
9789
9954
  * Class3CXInstallationWizardApi - axios parameter creator
9790
9955
  */
@@ -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
 
@@ -80,15 +145,17 @@ const configuration = new Configuration();
80
145
  const apiInstance = new Class3CXApi(configuration);
81
146
 
82
147
  let id: string; //Instance ID (default to undefined)
83
- let trunk: string; //Trunk (default to undefined)
84
148
  let start: string; //Start Date (optional) (default to undefined)
85
149
  let end: string; //End Date (optional) (default to undefined)
150
+ let trunk: string; //Trunk (optional) (default to undefined)
151
+ let type: 'dialing' | 'ended' | 'call' | 'ringing' | 'connected'; //Type (optional) (default to undefined)
86
152
 
87
153
  const { status, data } = await apiInstance.getGetCallHistory(
88
154
  id,
89
- trunk,
90
155
  start,
91
- end
156
+ end,
157
+ trunk,
158
+ type
92
159
  );
93
160
  ```
94
161
 
@@ -97,9 +164,10 @@ const { status, data } = await apiInstance.getGetCallHistory(
97
164
  |Name | Type | Description | Notes|
98
165
  |------------- | ------------- | ------------- | -------------|
99
166
  | **id** | [**string**] | Instance ID | defaults to undefined|
100
- | **trunk** | [**string**] | Trunk | defaults to undefined|
101
167
  | **start** | [**string**] | Start Date | (optional) defaults to undefined|
102
168
  | **end** | [**string**] | End Date | (optional) defaults to undefined|
169
+ | **trunk** | [**string**] | Trunk | (optional) defaults to undefined|
170
+ | **type** | [**&#39;dialing&#39; | &#39;ended&#39; | &#39;call&#39; | &#39;ringing&#39; | &#39;connected&#39;**]**Array<&#39;dialing&#39; &#124; &#39;ended&#39; &#124; &#39;call&#39; &#124; &#39;ringing&#39; &#124; &#39;connected&#39;>** | Type | (optional) defaults to undefined|
103
171
 
104
172
 
105
173
  ### Return type
@@ -181,7 +249,7 @@ No authorization required
181
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)
182
250
 
183
251
  # **getGetServicePrincipals**
184
- > Array<TcxServicePrincipalEntity> getGetServicePrincipals()
252
+ > Array<TcxServicePrincipalModel> getGetServicePrincipals()
185
253
 
186
254
  Get 3CX service principals
187
255
 
@@ -205,7 +273,7 @@ This endpoint does not have any parameters.
205
273
 
206
274
  ### Return type
207
275
 
208
- **Array<TcxServicePrincipalEntity>**
276
+ **Array<TcxServicePrincipalModel>**
209
277
 
210
278
  ### Authorization
211
279
 
@@ -415,6 +483,63 @@ No authorization required
415
483
 
416
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)
417
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
+
418
543
  # **postAddCallLog**
419
544
  > postAddCallLog()
420
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.360",
3
+ "version": "3.2.362",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {