@epilot/erp-integration-client 0.16.0 → 0.17.0

package/dist/openapi.d.ts

@@ -193,6 +193,10 @@ declare namespace Components {
              * Optional description of the integration
              */
             description?: string;
+            /**
+             * List of access token IDs to associate with this integration
+             */
+            access_token_ids?: string[];
         }
         export interface CreateOutboundUseCaseRequest {
             /**
@@ -600,6 +604,10 @@ declare namespace Components {
              * Optional description of the integration
              */
             description?: string;
+            /**
+             * List of access token IDs associated with this integration
+             */
+            access_token_ids?: string[];
             /**
              * ISO-8601 timestamp when the integration was created
              */
@@ -663,6 +671,23 @@ declare namespace Components {
              * Controls whether this entity mapping should be processed. Can be a boolean or a JSONata expression (string) that evaluates to a boolean.
              */
             enabled?: /* Controls whether this entity mapping should be processed. Can be a boolean or a JSONata expression (string) that evaluates to a boolean. */ boolean | string;
+            /**
+             * Operation mode for entity mapping:
+             * - 'upsert': Create or update the entity (default)
+             * - 'delete': Soft delete the entity (marks as deleted)
+             * - 'purge': Hard delete the entity (permanent removal)
+             * - 'upsert-prune-scope-purge': Upsert entities from array, then purge entities in scope that weren't upserted
+             * - 'upsert-prune-scope-delete': Upsert entities from array, then soft delete entities in scope that weren't upserted
+             *
+             */
+            mode?: "upsert" | "delete" | "purge" | "upsert-prune-scope-purge" | "upsert-prune-scope-delete";
+            scope?: /**
+             * Scope configuration for upsert-prune-scope modes.
+             * Defines how to find entities that should be pruned if not in the upsert payload.
+             * The scope is resolved against the original event payload (not individual array items).
+             *
+             */
+            PruneScopeConfig;
             /**
              * Field mapping definitions
              */
@@ -779,6 +804,10 @@ declare namespace Components {
              * Optional description of the integration
              */
             description?: string;
+            /**
+             * List of access token IDs associated with this integration
+             */
+            access_token_ids?: string[];
             /**
              * All use cases belonging to this integration
              */
@@ -1191,13 +1220,49 @@ declare namespace Components {
              */
             conflicts?: OutboundConflict[];
         }
+        /**
+         * Scope configuration for upsert-prune-scope modes.
+         * Defines how to find entities that should be pruned if not in the upsert payload.
+         * The scope is resolved against the original event payload (not individual array items).
+         *
+         */
+        export interface PruneScopeConfig {
+            /**
+             * Scope mode for finding entities to prune:
+             * - 'relations': Find scope by looking at all entities related to a specific entity (both direct and reverse relations)
+             * - 'query': Find scope entities directly via query parameters
+             *
+             */
+            scope_mode: "relations" | "query";
+            /**
+             * For 'relations' mode: The schema of the entity to find (e.g., 'billing_account').
+             * Not used for 'query' mode.
+             *
+             */
+            schema?: string;
+            /**
+             * For 'relations' mode: How to identify the scope entity from the payload.
+             * Not used for 'query' mode.
+             *
+             */
+            unique_ids?: RelationUniqueIdField[];
+            /**
+             * For 'query' mode: Direct query parameters to find scope entities.
+             * Not used for 'relations' or 'reverse-relations' modes.
+             *
+             */
+            query?: RelationUniqueIdField[];
+        }
         export interface QueryAccessLogsRequest {
             /**
-             * Filter by access token ID (e.g., 'api_5ZugdRXasLfWBypHi93Fk')
+             * Filter by a specific access token ID (e.g., 'api_5ZugdRXasLfWBypHi93Fk').
+             * Must be one of the access_token_ids linked to the integration.
+             * If omitted, returns logs for all access tokens linked to the integration.
+             *
              * example:
              * api_5ZugdRXasLfWBypHi93Fk
              */
-            token_id: string;
+            token_id?: string;
             /**
              * Filter by service name (e.g., 'entity', 'metering', 'submission-api')
              * example:
@@ -1741,6 +1806,10 @@ declare namespace Components {
              * Optional description of the integration
              */
             description?: string;
+            /**
+             * List of access token IDs to associate with this integration
+             */
+            access_token_ids?: string[];
         }
         export interface UpdateOutboundUseCaseRequest {
             /**
@@ -1790,6 +1859,10 @@ declare namespace Components {
              * Optional description of the integration
              */
             description?: string;
+            /**
+             * List of access token IDs to associate with this integration
+             */
+            access_token_ids?: string[];
             /**
              * Full list of use cases (declarative). This replaces ALL existing use cases.
              * - Use cases with an `id` field matching an existing use case will be updated
@@ -3197,6 +3270,7 @@ export type OutboundStatusResponse = Components.Schemas.OutboundStatusResponse;
 export type OutboundUseCase = Components.Schemas.OutboundUseCase;
 export type OutboundUseCaseHistoryEntry = Components.Schemas.OutboundUseCaseHistoryEntry;
 export type OutboundUseCaseStatus = Components.Schemas.OutboundUseCaseStatus;
+export type PruneScopeConfig = Components.Schemas.PruneScopeConfig;
 export type QueryAccessLogsRequest = Components.Schemas.QueryAccessLogsRequest;
 export type QueryEventsRequest = Components.Schemas.QueryEventsRequest;
 export type QueryInboundMonitoringEventsRequest = Components.Schemas.QueryInboundMonitoringEventsRequest;

package/dist/openapi.json

@@ -2,7 +2,7 @@
   "openapi": "3.0.3",
   "info": {
     "title": "ERP Integration API",
-    "version": "0.26.0",
+    "version": "0.30.0",
     "description": "API for integrating with ERP systems, handling tracking acknowledgments, triggering ERP processes, and processing ERP updates."
   },
   "tags": [
@@ -2378,6 +2378,13 @@
             "type": "string",
             "description": "Optional description of the integration"
           },
+          "access_token_ids": {
+            "type": "array",
+            "description": "List of access token IDs associated with this integration",
+            "items": {
+              "type": "string"
+            }
+          },
           "created_at": {
             "type": "string",
             "format": "date-time",
@@ -2406,6 +2413,13 @@
             "type": "string",
             "maxLength": 1000,
             "description": "Optional description of the integration"
+          },
+          "access_token_ids": {
+            "type": "array",
+            "description": "List of access token IDs to associate with this integration",
+            "items": {
+              "type": "string"
+            }
           }
         }
       },
@@ -2422,6 +2436,13 @@
             "type": "string",
             "maxLength": 1000,
             "description": "Optional description of the integration"
+          },
+          "access_token_ids": {
+            "type": "array",
+            "description": "List of access token IDs to associate with this integration",
+            "items": {
+              "type": "string"
+            }
           }
         }
       },
@@ -3456,6 +3477,21 @@
             ],
             "description": "Controls whether this entity mapping should be processed. Can be a boolean or a JSONata expression (string) that evaluates to a boolean."
           },
+          "mode": {
+            "type": "string",
+            "enum": [
+              "upsert",
+              "delete",
+              "purge",
+              "upsert-prune-scope-purge",
+              "upsert-prune-scope-delete"
+            ],
+            "default": "upsert",
+            "description": "Operation mode for entity mapping:\n- 'upsert': Create or update the entity (default)\n- 'delete': Soft delete the entity (marks as deleted)\n- 'purge': Hard delete the entity (permanent removal)\n- 'upsert-prune-scope-purge': Upsert entities from array, then purge entities in scope that weren't upserted\n- 'upsert-prune-scope-delete': Upsert entities from array, then soft delete entities in scope that weren't upserted\n"
+          },
+          "scope": {
+            "$ref": "#/components/schemas/PruneScopeConfig"
+          },
           "fields": {
             "type": "array",
             "description": "Field mapping definitions",
@@ -3465,6 +3501,41 @@
           }
         }
       },
+      "PruneScopeConfig": {
+        "type": "object",
+        "description": "Scope configuration for upsert-prune-scope modes.\nDefines how to find entities that should be pruned if not in the upsert payload.\nThe scope is resolved against the original event payload (not individual array items).\n",
+        "required": [
+          "scope_mode"
+        ],
+        "properties": {
+          "scope_mode": {
+            "type": "string",
+            "enum": [
+              "relations",
+              "query"
+            ],
+            "description": "Scope mode for finding entities to prune:\n- 'relations': Find scope by looking at all entities related to a specific entity (both direct and reverse relations)\n- 'query': Find scope entities directly via query parameters\n"
+          },
+          "schema": {
+            "type": "string",
+            "description": "For 'relations' mode: The schema of the entity to find (e.g., 'billing_account').\nNot used for 'query' mode.\n"
+          },
+          "unique_ids": {
+            "type": "array",
+            "description": "For 'relations' mode: How to identify the scope entity from the payload.\nNot used for 'query' mode.\n",
+            "items": {
+              "$ref": "#/components/schemas/RelationUniqueIdField"
+            }
+          },
+          "query": {
+            "type": "array",
+            "description": "For 'query' mode: Direct query parameters to find scope entities.\nNot used for 'relations' or 'reverse-relations' modes.\n",
+            "items": {
+              "$ref": "#/components/schemas/RelationUniqueIdField"
+            }
+          }
+        }
+      },
       "IntegrationMeterReading": {
         "type": "object",
         "required": [
@@ -3769,6 +3840,13 @@
             "type": "string",
             "description": "Optional description of the integration"
           },
+          "access_token_ids": {
+            "type": "array",
+            "description": "List of access token IDs associated with this integration",
+            "items": {
+              "type": "string"
+            }
+          },
           "use_cases": {
             "type": "array",
             "description": "All use cases belonging to this integration",
@@ -3806,6 +3884,13 @@
             "maxLength": 1000,
             "description": "Optional description of the integration"
           },
+          "access_token_ids": {
+            "type": "array",
+            "description": "List of access token IDs to associate with this integration",
+            "items": {
+              "type": "string"
+            }
+          },
           "use_cases": {
             "type": "array",
             "description": "Full list of use cases (declarative). This replaces ALL existing use cases.\n- Use cases with an `id` field matching an existing use case will be updated\n- Use cases without an `id` or with a non-matching `id` will be created\n- Existing use cases not in this list will be deleted\n",
@@ -4077,13 +4162,10 @@
       },
       "QueryAccessLogsRequest": {
         "type": "object",
-        "required": [
-          "token_id"
-        ],
         "properties": {
           "token_id": {
             "type": "string",
-            "description": "Filter by access token ID (e.g., 'api_5ZugdRXasLfWBypHi93Fk')",
+            "description": "Filter by a specific access token ID (e.g., 'api_5ZugdRXasLfWBypHi93Fk').\nMust be one of the access_token_ids linked to the integration.\nIf omitted, returns logs for all access tokens linked to the integration.\n",
             "example": "api_5ZugdRXasLfWBypHi93Fk"
           },
           "service": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/erp-integration-client",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "Client library for ePilot ERP Integration API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -26,7 +26,7 @@
     "test": "jest",
     "typescript": "tsc",
     "bundle-definition": "webpack",
-    "openapi": "node ../../scripts/update-openapi.js /Users/sauerer/epilot/erp-integration-api/lambda/ApiHandlerFunction/openapi.yml",
+    "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/erp-integration.yaml",
     "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
     "build": "tsc && npm run build:patch && npm run bundle-definition",
     "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",