@epilot/integration-toolkit-client 1.0.1 → 1.0.3

package/dist/openapi.d.ts

@@ -1359,6 +1359,10 @@ declare namespace Components {
              * Filter by use case type
              */
             use_case_type?: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy";
+            /**
+             * Field to group the bucket breakdown by
+             */
+            group_by?: "use_case_type" | "use_case";
         }
         /**
          * Configuration for inbound use cases (ERP to epilot)
@@ -3386,6 +3390,36 @@ declare namespace Components {
              */
             overwrite?: boolean;
         }
+        export interface TimeSeriesBreakdownItemV2 {
+            /**
+             * Present when grouping by use_case_type
+             */
+            use_case_type?: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy";
+            /**
+             * Present when grouping by use_case. Unknown historical IDs are collapsed into "__unknown__"
+             */
+            use_case_id?: string;
+            /**
+             * Number of successful events in the breakdown item
+             */
+            success_count: number;
+            /**
+             * Number of error events in the breakdown item
+             */
+            error_count: number;
+            /**
+             * Number of warning events in the breakdown item
+             */
+            warning_count: number;
+            /**
+             * Number of skipped events in the breakdown item
+             */
+            skipped_count: number;
+            /**
+             * Total events in the breakdown item
+             */
+            total_count: number;
+        }
         export interface TimeSeriesBucket {
             /**
              * The start timestamp of the bucket
@@ -3436,6 +3470,10 @@ declare namespace Components {
              * Total events in the bucket
              */
             total_count: number;
+            /**
+             * Statistics breakdown by the requested group_by field for this bucket
+             */
+            breakdown?: TimeSeriesBreakdownItemV2[];
         }
         export interface TriggerErpActionRequest {
             /**
@@ -5735,6 +5773,7 @@ export type SecureProxyUseCase = Components.Schemas.SecureProxyUseCase;
 export type SecureProxyUseCaseConfiguration = Components.Schemas.SecureProxyUseCaseConfiguration;
 export type SecureProxyUseCaseHistoryEntry = Components.Schemas.SecureProxyUseCaseHistoryEntry;
 export type SetIntegrationAppMappingRequest = Components.Schemas.SetIntegrationAppMappingRequest;
+export type TimeSeriesBreakdownItemV2 = Components.Schemas.TimeSeriesBreakdownItemV2;
 export type TimeSeriesBucket = Components.Schemas.TimeSeriesBucket;
 export type TimeSeriesBucketV2 = Components.Schemas.TimeSeriesBucketV2;
 export type TriggerErpActionRequest = Components.Schemas.TriggerErpActionRequest;

package/dist/openapi.json

@@ -2,7 +2,7 @@
   "openapi": "3.0.3",
   "info": {
     "title": "Integration Toolkit API",
-    "version": "1.0.1",
+    "version": "1.0.3",
     "description": "API for integrating with external systems in a standardised way."
   },
   "tags": [
@@ -7449,6 +7449,61 @@
               "secure_proxy"
             ],
             "description": "Filter by use case type"
+          },
+          "group_by": {
+            "type": "string",
+            "enum": [
+              "use_case_type",
+              "use_case"
+            ],
+            "description": "Field to group the bucket breakdown by"
+          }
+        }
+      },
+      "TimeSeriesBreakdownItemV2": {
+        "type": "object",
+        "required": [
+          "success_count",
+          "error_count",
+          "warning_count",
+          "skipped_count",
+          "total_count"
+        ],
+        "properties": {
+          "use_case_type": {
+            "type": "string",
+            "enum": [
+              "inbound",
+              "outbound",
+              "file_proxy",
+              "managed_call",
+              "secure_proxy"
+            ],
+            "description": "Present when grouping by use_case_type"
+          },
+          "use_case_id": {
+            "type": "string",
+            "description": "Present when grouping by use_case. Unknown historical IDs are collapsed into \"__unknown__\""
+          },
+          "success_count": {
+            "type": "integer",
+            "description": "Number of successful events in the breakdown item"
+          },
+          "error_count": {
+            "type": "integer",
+            "description": "Number of error events in the breakdown item"
+          },
+          "warning_count": {
+            "type": "integer",
+            "description": "Number of warning events in the breakdown item"
+          },
+          "skipped_count": {
+            "type": "integer",
+            "description": "Number of skipped events in the breakdown item"
+          },
+          "total_count": {
+            "type": "integer",
+            "description": "Total events in the breakdown item"
           }
         }
       },
@@ -7483,6 +7538,13 @@
           "total_count": {
             "type": "integer",
             "description": "Total events in the bucket"
+          },
+          "breakdown": {
+            "type": "array",
+            "description": "Statistics breakdown by the requested group_by field for this bucket",
+            "items": {
+              "$ref": "#/components/schemas/TimeSeriesBreakdownItemV2"
+            }
           }
         }
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/integration-toolkit-client",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Client library for epilot Integration Toolkit API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",