@epilot/integration-toolkit-client 1.0.0 → 1.0.2
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/README.md +6 -6
- package/dist/definition.js +1 -1
- package/dist/openapi.d.ts +37 -1
- package/dist/openapi.json +60 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,25 +5,25 @@
|
|
|
5
5
|
[](https://bundlephobia.com/package/@epilot/erp-integration-client)
|
|
6
6
|
[](https://github.com/epilot-dev/sdk-js/blob/main/LICENSE)
|
|
7
7
|
|
|
8
|
-
Client library for epilot [
|
|
8
|
+
Client library for epilot [Integration Toolkit API](https://docs.api.epilot.io/integration-toolkit/)
|
|
9
9
|
|
|
10
10
|
Uses [`openapi-client-axios`](https://github.com/openapistack/openapi-client-axios)
|
|
11
11
|
|
|
12
12
|
## Installation
|
|
13
13
|
|
|
14
14
|
```bash
|
|
15
|
-
npm install --save @epilot/
|
|
15
|
+
npm install --save @epilot/integration-toolkit-client
|
|
16
16
|
```
|
|
17
17
|
|
|
18
18
|
## Usage
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
import { getClient } from '@epilot/
|
|
21
|
+
import { getClient } from '@epilot/integration-toolkit-client';
|
|
22
22
|
|
|
23
|
-
const
|
|
24
|
-
const res = await
|
|
23
|
+
const IntegrationToolkitClient = getClient();
|
|
24
|
+
const res = await IntegrationToolkitClient.acknowledgeTracking({ack_id: '123e4567-e89b-12d3-a456-426614174000'});
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
## Documentation
|
|
28
28
|
|
|
29
|
-
https://docs.api.epilot.io/
|
|
29
|
+
https://docs.api.epilot.io/integration-toolkit/
|
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={438(e,t,n){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var o=r(n(466));t.default=o.default},466(e){e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"servers":[{"url":"https://integration-toolkit.sls.epilot.io"}],"paths":{"/v1/erp/tracking/acknowledgement":{"post":{"operationId":"acknowledgeTracking","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/erp/trigger":{"post":{"operationId":"triggerErp","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/erp/updates/events":{"post":{"deprecated":true,"operationId":"processErpUpdatesEvents","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/erp/updates/events":{"post":{"deprecated":true,"operationId":"processErpUpdatesEventsV2","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v3/erp/updates/events":{"post":{"operationId":"processErpUpdatesEventsV3","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/erp/updates/mapping_simulation":{"post":{"operationId":"simulateMappingV2","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/erp/updates/mapping_simulation":{"post":{"operationId":"simulateMapping","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations":{"get":{"operationId":"listIntegrations","responses":{}},"post":{"operationId":"createIntegration","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}":{"get":{"operationId":"getIntegration","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateIntegration","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteIntegration","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}}},"/v1/integrations/{integrationId}/events":{"post":{"operationId":"queryEvents","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/events/replay":{"post":{"operationId":"replayEvents","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/use-cases":{"get":{"operationId":"listUseCases","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}},"post":{"operationId":"createUseCase","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/use-cases/{useCaseId}":{"get":{"operationId":"getUseCase","parameters":[{"name":"integrationId","in":"path","required":true},{"name":"useCaseId","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateUseCase","parameters":[{"name":"integrationId","in":"path","required":true},{"name":"useCaseId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteUseCase","parameters":[{"name":"integrationId","in":"path","required":true},{"name":"useCaseId","in":"path","required":true}],"responses":{}}},"/v1/integrations/{integrationId}/use-cases/{useCaseId}/history":{"get":{"operationId":"listUseCaseHistory","parameters":[{"name":"integrationId","in":"path","required":true},{"name":"useCaseId","in":"path","required":true},{"name":"cursor","in":"query","required":false}],"responses":{}}},"/v2/integrations":{"get":{"operationId":"listIntegrationsV2","responses":{}},"post":{"operationId":"createIntegrationV2","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/integrations/{integrationId}":{"get":{"operationId":"getIntegrationV2","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateIntegrationV2","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteIntegrationV2","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}}},"/v1/integrations/{integrationId}/app-mapping":{"put":{"operationId":"setIntegrationAppMapping","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteIntegrationAppMapping","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/monitoring/inbound-events":{"post":{"operationId":"queryInboundMonitoringEvents","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/monitoring/stats":{"post":{"operationId":"getMonitoringStats","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/monitoring/timeseries":{"post":{"operationId":"getMonitoringTimeSeries","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/outbound-status":{"get":{"operationId":"getOutboundStatus","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}}},"/v1/integrations/{integrationId}/monitoring/access-logs":{"post":{"operationId":"queryAccessLogs","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/monitoring/outbound-events":{"post":{"operationId":"queryOutboundMonitoringEvents","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/integrations/{integrationId}/monitoring/events":{"post":{"operationId":"queryMonitoringEventsV2","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/integrations/{integrationId}/monitoring/stats":{"post":{"operationId":"getMonitoringStatsV2","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/integrations/{integrationId}/monitoring/time-series":{"post":{"operationId":"getMonitoringTimeSeriesV2","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/integrations/{integrationId}/monitoring/events/{eventId}/associated":{"get":{"operationId":"getAssociatedMonitoringEvents","parameters":[{"name":"integrationId","in":"path","required":true},{"name":"eventId","in":"path","required":true}],"responses":{}}},"/v1/integrations/secure-proxies":{"get":{"operationId":"listSecureProxies","responses":{}}},"/v1/secure-proxy":{"post":{"operationId":"secureProxy","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/managed-call/{slug}/execute":{"post":{"operationId":"managedCallExecute","parameters":[{"name":"slug","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/generate-types-preview":{"post":{"operationId":"generateTypesPreview","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}}},"/v1/integrations/{integrationId}/generate-types":{"post":{"operationId":"generateTypes","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/commit-types":{"post":{"operationId":"commitTypes","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"BadRequest":{"content":{"application/json":{}}},"NotFound":{"content":{"application/json":{}}},"Unauthorized":{"content":{"application/json":{}}},"Forbidden":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}},"QueryInboundMonitoringEventsResponse":{"content":{"application/json":{}}},"GetMonitoringStatsResponse":{"content":{"application/json":{}}},"GetMonitoringTimeSeriesResponse":{"content":{"application/json":{}}},"QueryAccessLogsResponse":{"content":{"application/json":{}}},"QueryOutboundMonitoringEventsResponse":{"content":{"application/json":{}}},"ReplayEventsResponse":{"content":{"application/json":{}}},"ERPUpdatesResponse":{"content":{"application/json":{}}},"TriggerWebhookResponse":{"content":{"application/json":{}}},"QueryEventsResponse":{"content":{"application/json":{}}},"QueryMonitoringEventsV2Response":{"content":{"application/json":{}}},"GetMonitoringStatsV2Response":{"content":{"application/json":{}}},"GetMonitoringTimeSeriesV2Response":{"content":{"application/json":{}}},"GetAssociatedMonitoringEventsResponse":{"content":{"application/json":{}}}}}}')}},t={},n=function n(r){var o=t[r];if(void 0!==o)return o.exports;var i=t[r]={exports:{}};return e[r].call(i.exports,i,i.exports,n),i.exports}(438),r=exports;for(var o in n)r[o]=n[o];n.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
|
|
1
|
+
(()=>{"use strict";var e={330(e,t,n){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var o=r(n(466));t.default=o.default},466(e){e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"servers":[{"url":"https://integration-toolkit.sls.epilot.io"}],"paths":{"/v1/erp/tracking/acknowledgement":{"post":{"operationId":"acknowledgeTracking","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/erp/trigger":{"post":{"operationId":"triggerErp","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/erp/updates/events":{"post":{"deprecated":true,"operationId":"processErpUpdatesEvents","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/erp/updates/events":{"post":{"deprecated":true,"operationId":"processErpUpdatesEventsV2","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v3/erp/updates/events":{"post":{"operationId":"processErpUpdatesEventsV3","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/erp/updates/mapping_simulation":{"post":{"operationId":"simulateMappingV2","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/erp/updates/mapping_simulation":{"post":{"operationId":"simulateMapping","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations":{"get":{"operationId":"listIntegrations","responses":{}},"post":{"operationId":"createIntegration","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}":{"get":{"operationId":"getIntegration","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateIntegration","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteIntegration","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}}},"/v1/integrations/{integrationId}/events":{"post":{"operationId":"queryEvents","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/events/replay":{"post":{"operationId":"replayEvents","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/use-cases":{"get":{"operationId":"listUseCases","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}},"post":{"operationId":"createUseCase","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/use-cases/{useCaseId}":{"get":{"operationId":"getUseCase","parameters":[{"name":"integrationId","in":"path","required":true},{"name":"useCaseId","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateUseCase","parameters":[{"name":"integrationId","in":"path","required":true},{"name":"useCaseId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteUseCase","parameters":[{"name":"integrationId","in":"path","required":true},{"name":"useCaseId","in":"path","required":true}],"responses":{}}},"/v1/integrations/{integrationId}/use-cases/{useCaseId}/history":{"get":{"operationId":"listUseCaseHistory","parameters":[{"name":"integrationId","in":"path","required":true},{"name":"useCaseId","in":"path","required":true},{"name":"cursor","in":"query","required":false}],"responses":{}}},"/v2/integrations":{"get":{"operationId":"listIntegrationsV2","responses":{}},"post":{"operationId":"createIntegrationV2","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/integrations/{integrationId}":{"get":{"operationId":"getIntegrationV2","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}},"put":{"operationId":"updateIntegrationV2","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteIntegrationV2","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}}},"/v1/integrations/{integrationId}/app-mapping":{"put":{"operationId":"setIntegrationAppMapping","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteIntegrationAppMapping","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/monitoring/inbound-events":{"post":{"operationId":"queryInboundMonitoringEvents","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/monitoring/stats":{"post":{"operationId":"getMonitoringStats","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/monitoring/timeseries":{"post":{"operationId":"getMonitoringTimeSeries","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/outbound-status":{"get":{"operationId":"getOutboundStatus","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}}},"/v1/integrations/{integrationId}/monitoring/access-logs":{"post":{"operationId":"queryAccessLogs","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/monitoring/outbound-events":{"post":{"operationId":"queryOutboundMonitoringEvents","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/integrations/{integrationId}/monitoring/events":{"post":{"operationId":"queryMonitoringEventsV2","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/integrations/{integrationId}/monitoring/stats":{"post":{"operationId":"getMonitoringStatsV2","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/integrations/{integrationId}/monitoring/time-series":{"post":{"operationId":"getMonitoringTimeSeriesV2","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/integrations/{integrationId}/monitoring/events/{eventId}/associated":{"get":{"operationId":"getAssociatedMonitoringEvents","parameters":[{"name":"integrationId","in":"path","required":true},{"name":"eventId","in":"path","required":true}],"responses":{}}},"/v1/integrations/secure-proxies":{"get":{"operationId":"listSecureProxies","responses":{}}},"/v1/secure-proxy":{"post":{"operationId":"secureProxy","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/managed-call/{slug}/execute":{"post":{"operationId":"managedCallExecute","parameters":[{"name":"slug","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/generate-types-preview":{"post":{"operationId":"generateTypesPreview","parameters":[{"name":"integrationId","in":"path","required":true}],"responses":{}}},"/v1/integrations/{integrationId}/generate-types":{"post":{"operationId":"generateTypes","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/integrations/{integrationId}/commit-types":{"post":{"operationId":"commitTypes","parameters":[{"name":"integrationId","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"BadRequest":{"content":{"application/json":{}}},"NotFound":{"content":{"application/json":{}}},"Unauthorized":{"content":{"application/json":{}}},"Forbidden":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}},"QueryInboundMonitoringEventsResponse":{"content":{"application/json":{}}},"GetMonitoringStatsResponse":{"content":{"application/json":{}}},"GetMonitoringTimeSeriesResponse":{"content":{"application/json":{}}},"QueryAccessLogsResponse":{"content":{"application/json":{}}},"QueryOutboundMonitoringEventsResponse":{"content":{"application/json":{}}},"ReplayEventsResponse":{"content":{"application/json":{}}},"ERPUpdatesResponse":{"content":{"application/json":{}}},"TriggerWebhookResponse":{"content":{"application/json":{}}},"QueryEventsResponse":{"content":{"application/json":{}}},"QueryMonitoringEventsV2Response":{"content":{"application/json":{}}},"GetMonitoringStatsV2Response":{"content":{"application/json":{}}},"GetMonitoringTimeSeriesV2Response":{"content":{"application/json":{}}},"GetAssociatedMonitoringEventsResponse":{"content":{"application/json":{}}}}}}')}},t={},n=function n(r){var o=t[r];if(void 0!==o)return o.exports;var i=t[r]={exports:{}};return e[r].call(i.exports,i,i.exports,n),i.exports}(330),r=exports;for(var o in n)r[o]=n[o];n.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
|
package/dist/openapi.d.ts
CHANGED
|
@@ -1359,6 +1359,10 @@ declare namespace Components {
|
|
|
1359
1359
|
* Filter by use case type
|
|
1360
1360
|
*/
|
|
1361
1361
|
use_case_type?: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy";
|
|
1362
|
+
/**
|
|
1363
|
+
* Field to group the bucket breakdown by
|
|
1364
|
+
*/
|
|
1365
|
+
group_by?: "use_case_type";
|
|
1362
1366
|
}
|
|
1363
1367
|
/**
|
|
1364
1368
|
* Configuration for inbound use cases (ERP to epilot)
|
|
@@ -2854,7 +2858,8 @@ declare namespace Components {
|
|
|
2854
2858
|
}
|
|
2855
2859
|
export interface QueryMonitoringEventsV2Request {
|
|
2856
2860
|
/**
|
|
2857
|
-
* Filter by use case ID (UUID). Empty string matches "General" events.
|
|
2861
|
+
* Filter by use case ID (UUID). Empty string matches "General" events. Special value "__unknown__" matches events whose use_case_id does not belong to any currently configured use case for this integration (excludes "General" events).
|
|
2862
|
+
*
|
|
2858
2863
|
*/
|
|
2859
2864
|
use_case_id?: string;
|
|
2860
2865
|
/**
|
|
@@ -3385,6 +3390,32 @@ declare namespace Components {
|
|
|
3385
3390
|
*/
|
|
3386
3391
|
overwrite?: boolean;
|
|
3387
3392
|
}
|
|
3393
|
+
export interface TimeSeriesBreakdownItemV2 {
|
|
3394
|
+
/**
|
|
3395
|
+
* Use case type for the breakdown item
|
|
3396
|
+
*/
|
|
3397
|
+
use_case_type: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy";
|
|
3398
|
+
/**
|
|
3399
|
+
* Number of successful events in the breakdown item
|
|
3400
|
+
*/
|
|
3401
|
+
success_count: number;
|
|
3402
|
+
/**
|
|
3403
|
+
* Number of error events in the breakdown item
|
|
3404
|
+
*/
|
|
3405
|
+
error_count: number;
|
|
3406
|
+
/**
|
|
3407
|
+
* Number of warning events in the breakdown item
|
|
3408
|
+
*/
|
|
3409
|
+
warning_count: number;
|
|
3410
|
+
/**
|
|
3411
|
+
* Number of skipped events in the breakdown item
|
|
3412
|
+
*/
|
|
3413
|
+
skipped_count: number;
|
|
3414
|
+
/**
|
|
3415
|
+
* Total events in the breakdown item
|
|
3416
|
+
*/
|
|
3417
|
+
total_count: number;
|
|
3418
|
+
}
|
|
3388
3419
|
export interface TimeSeriesBucket {
|
|
3389
3420
|
/**
|
|
3390
3421
|
* The start timestamp of the bucket
|
|
@@ -3435,6 +3466,10 @@ declare namespace Components {
|
|
|
3435
3466
|
* Total events in the bucket
|
|
3436
3467
|
*/
|
|
3437
3468
|
total_count: number;
|
|
3469
|
+
/**
|
|
3470
|
+
* Statistics breakdown by the requested group_by field for this bucket
|
|
3471
|
+
*/
|
|
3472
|
+
breakdown?: TimeSeriesBreakdownItemV2[];
|
|
3438
3473
|
}
|
|
3439
3474
|
export interface TriggerErpActionRequest {
|
|
3440
3475
|
/**
|
|
@@ -5734,6 +5769,7 @@ export type SecureProxyUseCase = Components.Schemas.SecureProxyUseCase;
|
|
|
5734
5769
|
export type SecureProxyUseCaseConfiguration = Components.Schemas.SecureProxyUseCaseConfiguration;
|
|
5735
5770
|
export type SecureProxyUseCaseHistoryEntry = Components.Schemas.SecureProxyUseCaseHistoryEntry;
|
|
5736
5771
|
export type SetIntegrationAppMappingRequest = Components.Schemas.SetIntegrationAppMappingRequest;
|
|
5772
|
+
export type TimeSeriesBreakdownItemV2 = Components.Schemas.TimeSeriesBreakdownItemV2;
|
|
5737
5773
|
export type TimeSeriesBucket = Components.Schemas.TimeSeriesBucket;
|
|
5738
5774
|
export type TimeSeriesBucketV2 = Components.Schemas.TimeSeriesBucketV2;
|
|
5739
5775
|
export type TriggerErpActionRequest = Components.Schemas.TriggerErpActionRequest;
|
package/dist/openapi.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Integration Toolkit API",
|
|
5
|
-
"version": "1.0.
|
|
5
|
+
"version": "1.0.2",
|
|
6
6
|
"description": "API for integrating with external systems in a standardised way."
|
|
7
7
|
},
|
|
8
8
|
"tags": [
|
|
@@ -7163,7 +7163,7 @@
|
|
|
7163
7163
|
"properties": {
|
|
7164
7164
|
"use_case_id": {
|
|
7165
7165
|
"type": "string",
|
|
7166
|
-
"description": "Filter by use case ID (UUID). Empty string matches \"General\" events."
|
|
7166
|
+
"description": "Filter by use case ID (UUID). Empty string matches \"General\" events. Special value \"__unknown__\" matches events whose use_case_id does not belong to any currently configured use case for this integration (excludes \"General\" events).\n"
|
|
7167
7167
|
},
|
|
7168
7168
|
"use_case_type": {
|
|
7169
7169
|
"type": "string",
|
|
@@ -7449,6 +7449,57 @@
|
|
|
7449
7449
|
"secure_proxy"
|
|
7450
7450
|
],
|
|
7451
7451
|
"description": "Filter by use case type"
|
|
7452
|
+
},
|
|
7453
|
+
"group_by": {
|
|
7454
|
+
"type": "string",
|
|
7455
|
+
"enum": [
|
|
7456
|
+
"use_case_type"
|
|
7457
|
+
],
|
|
7458
|
+
"description": "Field to group the bucket breakdown by"
|
|
7459
|
+
}
|
|
7460
|
+
}
|
|
7461
|
+
},
|
|
7462
|
+
"TimeSeriesBreakdownItemV2": {
|
|
7463
|
+
"type": "object",
|
|
7464
|
+
"required": [
|
|
7465
|
+
"use_case_type",
|
|
7466
|
+
"success_count",
|
|
7467
|
+
"error_count",
|
|
7468
|
+
"warning_count",
|
|
7469
|
+
"skipped_count",
|
|
7470
|
+
"total_count"
|
|
7471
|
+
],
|
|
7472
|
+
"properties": {
|
|
7473
|
+
"use_case_type": {
|
|
7474
|
+
"type": "string",
|
|
7475
|
+
"enum": [
|
|
7476
|
+
"inbound",
|
|
7477
|
+
"outbound",
|
|
7478
|
+
"file_proxy",
|
|
7479
|
+
"managed_call",
|
|
7480
|
+
"secure_proxy"
|
|
7481
|
+
],
|
|
7482
|
+
"description": "Use case type for the breakdown item"
|
|
7483
|
+
},
|
|
7484
|
+
"success_count": {
|
|
7485
|
+
"type": "integer",
|
|
7486
|
+
"description": "Number of successful events in the breakdown item"
|
|
7487
|
+
},
|
|
7488
|
+
"error_count": {
|
|
7489
|
+
"type": "integer",
|
|
7490
|
+
"description": "Number of error events in the breakdown item"
|
|
7491
|
+
},
|
|
7492
|
+
"warning_count": {
|
|
7493
|
+
"type": "integer",
|
|
7494
|
+
"description": "Number of warning events in the breakdown item"
|
|
7495
|
+
},
|
|
7496
|
+
"skipped_count": {
|
|
7497
|
+
"type": "integer",
|
|
7498
|
+
"description": "Number of skipped events in the breakdown item"
|
|
7499
|
+
},
|
|
7500
|
+
"total_count": {
|
|
7501
|
+
"type": "integer",
|
|
7502
|
+
"description": "Total events in the breakdown item"
|
|
7452
7503
|
}
|
|
7453
7504
|
}
|
|
7454
7505
|
},
|
|
@@ -7483,6 +7534,13 @@
|
|
|
7483
7534
|
"total_count": {
|
|
7484
7535
|
"type": "integer",
|
|
7485
7536
|
"description": "Total events in the bucket"
|
|
7537
|
+
},
|
|
7538
|
+
"breakdown": {
|
|
7539
|
+
"type": "array",
|
|
7540
|
+
"description": "Statistics breakdown by the requested group_by field for this bucket",
|
|
7541
|
+
"items": {
|
|
7542
|
+
"$ref": "#/components/schemas/TimeSeriesBreakdownItemV2"
|
|
7543
|
+
}
|
|
7486
7544
|
}
|
|
7487
7545
|
}
|
|
7488
7546
|
}
|