@epilot/sdk 2.8.0-rc.0 → 2.8.0

package/definitions/design.json

@@ -344,7 +344,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object"
+                  "$ref": "#/components/schemas/ParseThemeFromDesignResp"
                 }
               }
             }
@@ -1664,6 +1664,10 @@
           },
           "url": {
             "type": "string"
+          },
+          "file_id": {
+            "type": "string",
+            "description": "ID of the source file entity in the epilot file-entity system. Set when the file was picked from the File Manager (rather than uploaded directly to the design-builder bucket). Consumers resolve the live `public_url` via this reference. The org id is derived from the journey's owning org at render time (same convention as journey image blocks), so blueprint cross-org installs work without any extra remapping."
           }
         },
         "required": [
@@ -1706,6 +1710,52 @@
             "$ref": "#/components/schemas/Application"
           }
         }
+      },
+      "ParseThemeFromDesignResp": {
+        "type": "object",
+        "properties": {
+          "theme": {
+            "$ref": "#/components/schemas/Theme"
+          },
+          "design": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              },
+              "last_modified_at": {
+                "type": "string"
+              },
+              "style_name": {
+                "type": "string"
+              },
+              "style": {
+                "type": "object",
+                "properties": {
+                  "logo": {
+                    "$ref": "#/components/schemas/LogoData"
+                  },
+                  "palette": {
+                    "$ref": "#/components/schemas/PaletteData"
+                  },
+                  "typography": {
+                    "$ref": "#/components/schemas/TypographyData"
+                  }
+                }
+              },
+              "custom_theme": {
+                "type": "string"
+              },
+              "use_custom_theme": {
+                "type": "boolean"
+              },
+              "journey_design_tokens": {
+                "type": "object",
+                "description": "Design tokens for journey customization (renamed from design_tokens)"
+              }
+            }
+          }
+        }
       }
     }
   }

package/definitions/event-catalog-runtime.json

@@ -1 +1 @@
-{"s":"https://event-catalog.sls.epilot.io","o":[["listEvents","get","/v1/events"],["getEvent","get","/v1/events/{event_name}",[["event_name","p",true]]],["patchEvent","patch","/v1/events/{event_name}",[["event_name","p",true]],1],["getEventJSONSchema","get","/v1/events/{event_name}/json_schema",[["event_name","p",true]]],["getEventExample","get","/v1/events/{event_name}/example",[["event_name","p",true]]],["searchEventHistory","post","/v1/events/{event_name}:history",[["event_name","p",true]],1],["searchEventHistoryV2","post","/v2/events/{event_name}:history",[["event_name","p",true]],1],["getHistoricalEvent","get","/v2/events/{event_name}/history/{event_id}",[["event_name","p",true],["event_id","p",true]]],["triggerEvent","post","/v1/events/{event_name}:trigger",[["event_name","p",true]],1]],"v":"3.0.0"}
+{"s":"https://event-catalog.sls.epilot.io","o":[["listEvents","get","/v1/events"],["getEvent","get","/v1/events/{event_name}",[["event_name","p",true]]],["patchEvent","patch","/v1/events/{event_name}",[["event_name","p",true]],1],["getEventJSONSchema","get","/v1/events/{event_name}/json_schema",[["event_name","p",true],["Epilot-Event-Version","h"]]],["getEventExample","get","/v1/events/{event_name}/example",[["event_name","p",true],["Epilot-Event-Version","h"]]],["listEventVersions","get","/v1/events/{event_name}/versions",[["event_name","p",true]]],["searchEventHistory","post","/v1/events/{event_name}:history",[["event_name","p",true]],1],["searchEventHistoryV2","post","/v2/events/{event_name}:history",[["event_name","p",true]],1],["getHistoricalEvent","get","/v2/events/{event_name}/history/{event_id}",[["event_name","p",true],["event_id","p",true]]],["triggerEvent","post","/v1/events/{event_name}:trigger",[["event_name","p",true]],1]],"v":"3.0.0"}

package/definitions/event-catalog.json

@@ -131,7 +131,7 @@
       "get": {
         "operationId": "getEventJSONSchema",
         "summary": "getEventJSONSchema",
-        "description": "Retrieve the JSON Schema of a specific business event",
+        "description": "Retrieve the JSON Schema of a specific business event. Pass an optional\n`Epilot-Event-Version` header to retrieve a specific version's schema;\nwhen omitted, the event's latest version is returned.\n",
         "tags": [
           "Event Catalog"
         ],
@@ -144,6 +144,15 @@
             "schema": {
               "type": "string"
             }
+          },
+          {
+            "name": "Epilot-Event-Version",
+            "in": "header",
+            "required": false,
+            "description": "Event payload version (`MAJOR.MINOR`). Defaults to the event's latest version.",
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "responses": {
@@ -156,6 +165,9 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "Event or version not found"
           }
         }
       }
@@ -164,7 +176,7 @@
       "get": {
         "operationId": "getEventExample",
         "summary": "getEventExample",
-        "description": "Generate a sample event payload based on the event's JSON Schema",
+        "description": "Generate a sample event payload based on the event's JSON Schema. Pass an\noptional `Epilot-Event-Version` header to generate the example for a\nspecific version; when omitted, the event's latest version is used.\n",
         "tags": [
           "Event Catalog"
         ],
@@ -177,6 +189,15 @@
             "schema": {
               "type": "string"
             }
+          },
+          {
+            "name": "Epilot-Event-Version",
+            "in": "header",
+            "required": false,
+            "description": "Event payload version (`MAJOR.MINOR`). Defaults to the event's latest version.",
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "responses": {
@@ -190,6 +211,45 @@
                 }
               }
             }
+          },
+          "404": {
+            "description": "Event or version not found"
+          }
+        }
+      }
+    },
+    "/v1/events/{event_name}/versions": {
+      "get": {
+        "operationId": "listEventVersions",
+        "summary": "listEventVersions",
+        "description": "List every known version of an event, along with the `latest`\nand the set of currently `active` versions. See §3.2 of the\nEvent Payload Versioning RFC.\n",
+        "tags": [
+          "Event Catalog"
+        ],
+        "parameters": [
+          {
+            "name": "event_name",
+            "in": "path",
+            "required": true,
+            "description": "Unique human readable name of the event",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Registry summary for the event.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/EventVersionRegistrySummary"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Event not found"
           }
         }
       }
@@ -265,7 +325,7 @@
       "post": {
         "operationId": "searchEventHistoryV2",
         "summary": "searchEventHistoryV2",
-        "description": "Paginated history of events with projected/lightweight payload (v2).\n\nReturns `EventSummary` objects instead of fully hydrated `Event` objects:\nnested entity graphs (objects/arrays-of-objects carrying `_schema`/`_id`)\nare stripped. Use GET /v2/events/{event_name}/history/{event_id} to fetch\nthe full hydrated event for a single result.\n",
+        "description": "Paginated history of events with projected/lightweight payload (v2).\n\nReturns `EventSummary` objects instead of fully hydrated `Event` objects:\nhydrated entity objects (values carrying `_schema`/`_id`) are reduced to\nreference stubs `{_schema, _id, _title}` — the full entity is recoverable\nvia GET /v2/events/{event_name}/history/{event_id} or by hitting\nentity-api directly with the `_id`.\n",
         "tags": [
           "Event Catalog"
         ],
@@ -463,8 +523,8 @@
           },
           "event_version": {
             "type": "string",
-            "description": "Event version (semver)",
-            "example": "1.0.0"
+            "description": "Event payload version (MAJOR.MINOR)",
+            "example": "1.0"
           },
           "event_status": {
             "type": "string",
@@ -704,7 +764,7 @@
             },
             "_event_version": {
               "type": "string",
-              "description": "Event version (semver)"
+              "description": "Event payload version (MAJOR.MINOR)"
             },
             "_event_source": {
               "type": "string",
@@ -841,8 +901,8 @@
           },
           "_event_version": {
             "type": "string",
-            "description": "Event version (semver)",
-            "example": "1.0.0"
+            "description": "Event payload version (MAJOR.MINOR)",
+            "example": "1.0"
           },
           "_event_source": {
             "type": "string",
@@ -876,7 +936,7 @@
           "_event_time": "2024-01-01T12:00:00Z",
           "_event_id": "01FZ4Z5FZ5FZ5FZ5FZ5FZ5FZ5F",
           "_event_name": "MeterReading",
-          "_event_version": "1.0.0",
+          "_event_version": "1.0",
           "_event_source": "api",
           "_trigger_source_type": "api",
           "_trigger_source": "user_123456",
@@ -897,7 +957,7 @@
       },
       "EventSummary": {
         "type": "object",
-        "description": "A lightweight event summary returned by the v2 history endpoint.\n\nIncludes the standard `_*` metadata fields plus a projected subset of the\nevent payload. Hydrated entity objects (values carrying `_schema` or `_id`\nand arrays of such objects) are stripped — fetch via\n`GET /v2/events/{event_name}/history/{event_id}` for full hydration.\n\nProjected scalar payload fields appear as additional top-level properties.\n",
+        "description": "A lightweight event summary returned by the v2 history endpoint.\n\nIncludes the standard `_*` metadata fields plus a projected subset of the\nevent payload. Hydrated entity objects (values carrying `_schema` or `_id`)\n— and arrays of such objects — are reduced to reference stubs\n`{_schema, _id, _title}` so consumers can identify and follow up on each\nentity without paying the cost of the full hydrated graph. Fetch\n`GET /v2/events/{event_name}/history/{event_id}` for the full hydration.\n\nProjected scalar payload fields appear as additional top-level properties.\n",
         "properties": {
           "_org_id": {
             "type": "string",
@@ -918,8 +978,8 @@
           },
           "_event_version": {
             "type": "string",
-            "description": "Event version (semver)",
-            "example": "1.0.0"
+            "description": "Event payload version (MAJOR.MINOR)",
+            "example": "1.0"
           },
           "_event_source": {
             "type": "string",
@@ -1295,6 +1355,102 @@
           "entity_id",
           "version_index"
         ]
+      },
+      "FieldChange": {
+        "type": "object",
+        "description": "A field-level change descriptor. Powers the declarative half of the\nversion DSL.\n",
+        "properties": {
+          "field": {
+            "type": "string",
+            "description": "Name of the field affected by this change.",
+            "example": "reading"
+          },
+          "op": {
+            "type": "string",
+            "enum": [
+              "added",
+              "removed",
+              "type-changed"
+            ],
+            "description": "Kind of change. Renames are NOT a first-class op — represent them\nas a `removed` + `added` pair (semantic intent goes into\n`change_summary` / `change_notes`).\n"
+          },
+          "type_old": {
+            "type": "string",
+            "description": "Type label for the previous shape (for `removed` and `type-changed`)."
+          },
+          "type_new": {
+            "type": "string",
+            "description": "Type label for the new shape (for `added` and `type-changed`)."
+          }
+        },
+        "required": [
+          "field",
+          "op"
+        ]
+      },
+      "VersionMeta": {
+        "type": "object",
+        "description": "One entry of an event's version timeline.",
+        "properties": {
+          "version": {
+            "type": "string",
+            "description": "MAJOR.MINOR version label.",
+            "example": "1.0"
+          },
+          "released_at": {
+            "type": "string",
+            "description": "ISO 8601 release timestamp.",
+            "example": "2025-11-15"
+          },
+          "change_summary": {
+            "type": "string",
+            "description": "Required one-liner describing what changed in this version (≤280 chars)."
+          },
+          "change_notes": {
+            "type": "string",
+            "description": "Optional longer-form prose (markdown)."
+          },
+          "changes": {
+            "type": "array",
+            "description": "Hand-authored list of field-level changes from the previous version. Empty for v1.",
+            "items": {
+              "$ref": "#/components/schemas/FieldChange"
+            }
+          }
+        },
+        "required": [
+          "version",
+          "released_at",
+          "change_summary",
+          "changes"
+        ]
+      },
+      "EventVersionRegistrySummary": {
+        "type": "object",
+        "description": "Summary of an event's version timeline returned by\n`GET /v1/events/{event_name}/versions`.\n",
+        "properties": {
+          "event_name": {
+            "type": "string",
+            "example": "MeterReadingAdded"
+          },
+          "latest": {
+            "type": "string",
+            "description": "The newest registered version.",
+            "example": "1.0"
+          },
+          "versions": {
+            "type": "array",
+            "description": "Full version timeline, ordered oldest → newest.",
+            "items": {
+              "$ref": "#/components/schemas/VersionMeta"
+            }
+          }
+        },
+        "required": [
+          "event_name",
+          "latest",
+          "versions"
+        ]
       }
     }
   },

package/definitions/file-runtime.json

@@ -1 +1 @@
-{"s":"https://file.sls.epilot.io","o":[["uploadFileV2","post","/v2/files/upload",[["file_entity_id","q"]],1],["saveFileV2","post","/v2/files",[["ActivityIdQueryParam"],["FillActivityQueryParam"],["StrictQueryParam"],["AsyncOperationQueryParam"],["DeleteTempFileQueryParam"],["VersionOnlyQueryParam"]],1],["uploadFile","post","/v1/files/upload",[["file_entity_id","q"]],1],["saveFile","post","/v1/files",[["ActivityIdQueryParam"],["AsyncOperationQueryParam"],["VersionOnlyQueryParam"]],1],["getFile","get","/v2/files/{id}",[["id","p",true],["source_url","q"],["StrictQueryParam"],["AsyncOperationQueryParam"]]],["deleteFile","delete","/v2/files/{id}",[["id","p",true],["purge","q"],["ActivityIdQueryParam"],["StrictQueryParam"]]],["downloadFile","get","/v1/files/{id}/download",[["id","p",true],["version","q"],["attachment","q"]]],["downloadS3File","post","/v1/files:downloadS3",[["s3_key","q",true],["s3_bucket","q",true],["attachment","q"]]],["downloadFiles","post","/v1/files:downloadFiles",null,1],["createZipJob","post","/v1/files:zipJob",null,1],["getZipJob","get","/v1/files:zipJob/{job_id}",[["job_id","p",true]]],["previewFile","get","/v1/files/{id}/preview",[["id","p",true],["version","q"],["w","q"],["h","q"]]],["previewS3File","post","/v1/files:previewS3",[["w","q"],["h","q"]],1],["previewS3FileGet","get","/v1/files:previewS3",[["key","q",true],["bucket","q",true],["w","q"],["h","q"]]],["previewPublicFile","get","/v1/files/public/{id}/preview",[["id","p",true],["version","q"],["w","q"],["h","q"],["org_id","q"]]],["getSession","get","/v1/files/session"],["deleteSession","delete","/v1/files/session"],["generatePublicLink","post","/v1/files/{id}/public/links",[["id","p",true]]],["listPublicLinksForFile","get","/v1/files/{id}/public/links",[["id","p",true]]],["accessPublicLink","get","/v1/files/public/links/{id}/{filename}",[["id","p",true],["filename","p",true],["hash","q"]]],["revokePublicLink","delete","/v1/files/public/links/{id}",[["id","p",true]]],["verifyCustomDownloadUrl","post","/v1/files/download:verify",null,1],["uploadFilePublic","post","/v1/files/public/upload",null,1],["getUserSchemaFileCollections","get","/v1/{slug}/collections",[["slug","p",true]]],["createUserSchemaFileCollection","post","/v1/{slug}/collections",[["slug","p",true]],1],["updateUserSchemaFileCollection","put","/v1/{slug}/collections/{collectionSlug}",[["slug","p",true],["collectionSlug","p",true]],1],["deleteUserSchemaFileCollection","delete","/v1/{slug}/collections/{collectionSlug}",[["slug","p",true],["collectionSlug","p",true]]],["getFilesInCollection","get","/v1/entity/{id}/collections/{collectionSlug}/files",[["EntityIdPathParam"],["collectionSlug","p",true]]],["getGlobalFileCollections","get","/v1/collections/{schemaSlug}",[["schemaSlug","p",true]]]],"v":"3.0.3","cp":{"EntityIdPathParam":["id","p",true],"StrictQueryParam":["strict","q"],"ActivityIdQueryParam":["activity_id","q"],"FillActivityQueryParam":["fill_activity","q"],"AsyncOperationQueryParam":["async","q"],"DeleteTempFileQueryParam":["delete_temp_file","q"],"VersionOnlyQueryParam":["version_only","q"]}}
+{"s":"https://file.sls.epilot.io","o":[["uploadFileV2","post","/v2/files/upload",[["file_entity_id","q"]],1],["saveFileV2","post","/v2/files",[["ActivityIdQueryParam"],["FillActivityQueryParam"],["StrictQueryParam"],["AsyncOperationQueryParam"],["DeleteTempFileQueryParam"],["VersionOnlyQueryParam"]],1],["uploadFile","post","/v1/files/upload",[["file_entity_id","q"]],1],["saveFile","post","/v1/files",[["ActivityIdQueryParam"],["AsyncOperationQueryParam"],["VersionOnlyQueryParam"]],1],["getFile","get","/v2/files/{id}",[["id","p",true],["source_url","q"],["StrictQueryParam"],["AsyncOperationQueryParam"]]],["deleteFile","delete","/v2/files/{id}",[["id","p",true],["purge","q"],["ActivityIdQueryParam"],["StrictQueryParam"]]],["downloadFile","get","/v1/files/{id}/download",[["id","p",true],["version","q"],["attachment","q"]]],["downloadS3File","post","/v1/files:downloadS3",[["s3_key","q",true],["s3_bucket","q",true],["attachment","q"]]],["downloadFiles","post","/v1/files:downloadFiles",null,1],["createZipJob","post","/v1/files:zipJob",null,1],["getZipJob","get","/v1/files:zipJob/{job_id}",[["job_id","p",true]]],["generateFileSummary","post","/v1/files/{id}/summary:generate",[["id","p",true]]],["previewFile","get","/v1/files/{id}/preview",[["id","p",true],["version","q"],["w","q"],["h","q"]]],["previewS3File","post","/v1/files:previewS3",[["w","q"],["h","q"]],1],["previewS3FileGet","get","/v1/files:previewS3",[["key","q",true],["bucket","q",true],["w","q"],["h","q"]]],["previewPublicFile","get","/v1/files/public/{id}/preview",[["id","p",true],["version","q"],["w","q"],["h","q"],["org_id","q"]]],["getSession","get","/v1/files/session"],["deleteSession","delete","/v1/files/session"],["generatePublicLink","post","/v1/files/{id}/public/links",[["id","p",true]]],["listPublicLinksForFile","get","/v1/files/{id}/public/links",[["id","p",true]]],["accessPublicLink","get","/v1/files/public/links/{id}/{filename}",[["id","p",true],["filename","p",true],["hash","q"]]],["revokePublicLink","delete","/v1/files/public/links/{id}",[["id","p",true]]],["verifyCustomDownloadUrl","post","/v1/files/download:verify",null,1],["uploadFilePublic","post","/v1/files/public/upload",null,1],["getUserSchemaFileCollections","get","/v1/{slug}/collections",[["slug","p",true]]],["createUserSchemaFileCollection","post","/v1/{slug}/collections",[["slug","p",true]],1],["updateUserSchemaFileCollection","put","/v1/{slug}/collections/{collectionSlug}",[["slug","p",true],["collectionSlug","p",true]],1],["deleteUserSchemaFileCollection","delete","/v1/{slug}/collections/{collectionSlug}",[["slug","p",true],["collectionSlug","p",true]]],["getFilesInCollection","get","/v1/entity/{id}/collections/{collectionSlug}/files",[["EntityIdPathParam"],["collectionSlug","p",true]]],["getGlobalFileCollections","get","/v1/collections/{schemaSlug}",[["schemaSlug","p",true]]]],"v":"3.0.3","cp":{"EntityIdPathParam":["id","p",true],"StrictQueryParam":["strict","q"],"ActivityIdQueryParam":["activity_id","q"],"FillActivityQueryParam":["fill_activity","q"],"AsyncOperationQueryParam":["async","q"],"DeleteTempFileQueryParam":["delete_temp_file","q"],"VersionOnlyQueryParam":["version_only","q"]}}

package/definitions/file.json

@@ -802,7 +802,7 @@
                       "3fa85f64-5717-4562-b3fc-2c963f66afa6"
                     ],
                     "zip_filename": "Documents.zip",
-                    "notify_email": true
+                    "notify_email": "user@example.com"
                   }
                 }
               }
@@ -875,6 +875,57 @@
         }
       }
     },
+    "/v1/files/{id}/summary:generate": {
+      "post": {
+        "operationId": "generateFileSummary",
+        "summary": "generateFileSummary",
+        "description": "Request AI generation of preview and short summaries for a file entity.",
+        "tags": [
+          "File"
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "description": "The UUID of the file entity",
+            "schema": {
+              "$ref": "#/components/schemas/FileEntityId"
+            }
+          }
+        ],
+        "responses": {
+          "202": {
+            "description": "Summary generation accepted",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/FileSummaryGenerationStatus"
+                }
+              }
+            }
+          },
+          "400": {
+            "$ref": "#/components/responses/BadRequestError"
+          },
+          "401": {
+            "$ref": "#/components/responses/UnauthorizedError"
+          },
+          "403": {
+            "$ref": "#/components/responses/ForbiddenError"
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFoundError"
+          },
+          "409": {
+            "$ref": "#/components/responses/ConflictError"
+          },
+          "500": {
+            "$ref": "#/components/responses/InternalServerError"
+          }
+        }
+      }
+    },
     "/v1/files/{id}/preview": {
       "get": {
         "operationId": "previewFile",
@@ -1167,6 +1218,20 @@
         "responses": {
           "200": {
             "description": "Generated thumbnail image for a public file",
+            "headers": {
+              "ETag": {
+                "description": "Identifier of the previewed file version, for conditional requests",
+                "schema": {
+                  "type": "string"
+                }
+              },
+              "Cache-Control": {
+                "description": "Caching policy for the preview",
+                "schema": {
+                  "type": "string"
+                }
+              }
+            },
             "content": {
               "image/png": {
                 "schema": {
@@ -1182,6 +1247,23 @@
               }
             }
           },
+          "304": {
+            "description": "The preview is unchanged since the version identified by the `If-None-Match`\nrequest header. No body is returned; the cached copy should be reused.\n",
+            "headers": {
+              "ETag": {
+                "description": "Identifier of the current file version's preview",
+                "schema": {
+                  "type": "string"
+                }
+              },
+              "Cache-Control": {
+                "description": "Caching policy for the preview",
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          },
           "403": {
             "description": "File is not public",
             "content": {
@@ -2113,6 +2195,29 @@
           },
           "custom_download_url": {
             "$ref": "#/components/schemas/CustomDownloadUrl"
+          },
+          "preview_summary_de": {
+            "type": "string",
+            "description": "Compact German summary for hover and list preview surfaces.",
+            "readOnly": true
+          },
+          "short_summary_de": {
+            "type": "string",
+            "description": "Short German paragraph summary for file preview surfaces.",
+            "readOnly": true
+          },
+          "preview_summary_en": {
+            "type": "string",
+            "description": "Compact English summary for hover and list preview surfaces.",
+            "readOnly": true
+          },
+          "short_summary_en": {
+            "type": "string",
+            "description": "Short English paragraph summary for file preview surfaces.",
+            "readOnly": true
+          },
+          "summary_status": {
+            "$ref": "#/components/schemas/FileSummaryStatus"
           }
         }
       },
@@ -2133,6 +2238,28 @@
           "unknown"
         ]
       },
+      "FileSummaryStatus": {
+        "type": "string",
+        "description": "Current AI summary generation state for the file.",
+        "enum": [
+          "processing",
+          "completed",
+          "failed",
+          "unsupported"
+        ],
+        "readOnly": true
+      },
+      "FileSummaryGenerationStatus": {
+        "type": "object",
+        "properties": {
+          "status": {
+            "$ref": "#/components/schemas/FileSummaryStatus"
+          }
+        },
+        "required": [
+          "status"
+        ]
+      },
       "CustomDownloadUrl": {
         "description": "Custom external download url used for the file",
         "type": "string",
@@ -2515,9 +2642,10 @@
             "example": "Documents.zip"
           },
           "notify_email": {
-            "type": "boolean",
-            "description": "Send email notification when ZIP is ready",
-            "default": true
+            "type": "string",
+            "format": "email",
+            "description": "Email address to notify when the ZIP is ready. Omit to skip the email notification.",
+            "example": "user@example.com"
           }
         },
         "oneOf": [
@@ -3070,6 +3198,26 @@
           }
         }
       },
+      "ConflictError": {
+        "description": "The request conflicts with the current resource state",
+        "content": {
+          "application/json": {
+            "schema": {
+              "allOf": [
+                {
+                  "$ref": "#/components/schemas/ErrorObject"
+                },
+                {
+                  "example": {
+                    "status": 409,
+                    "error": "Extracted file content is still being prepared"
+                  }
+                }
+              ]
+            }
+          }
+        }
+      },
       "InternalServerError": {
         "description": "An unexpected error occurred on the server",
         "content": {

package/definitions/integration-toolkit-runtime.json

@@ -1 +1 @@
-{"s":"https://integration-toolkit.sls.epilot.io","o":[["acknowledgeTracking","post","/v1/erp/tracking/acknowledgement",null,1],["triggerErp","post","/v1/erp/trigger",null,1],["processErpUpdatesEvents","post","/v1/erp/updates/events",null,1],["processErpUpdatesEventsV2","post","/v2/erp/updates/events",null,1],["processErpUpdatesEventsV3","post","/v3/erp/updates/events",null,1],["simulateMappingV2","post","/v2/erp/updates/mapping_simulation",null,1],["simulateMapping","post","/v1/erp/updates/mapping_simulation",null,1],["listIntegrations","get","/v1/integrations"],["createIntegration","post","/v1/integrations",null,1],["getIntegration","get","/v1/integrations/{integrationId}",[["integrationId","p",true]]],["updateIntegration","put","/v1/integrations/{integrationId}",[["integrationId","p",true]],1],["deleteIntegration","delete","/v1/integrations/{integrationId}",[["integrationId","p",true]]],["queryEvents","post","/v1/integrations/{integrationId}/events",[["integrationId","p",true]],1],["replayEvents","post","/v1/integrations/{integrationId}/events/replay",[["integrationId","p",true]],1],["listUseCases","get","/v1/integrations/{integrationId}/use-cases",[["integrationId","p",true]]],["createUseCase","post","/v1/integrations/{integrationId}/use-cases",[["integrationId","p",true]],1],["getUseCase","get","/v1/integrations/{integrationId}/use-cases/{useCaseId}",[["integrationId","p",true],["useCaseId","p",true]]],["updateUseCase","put","/v1/integrations/{integrationId}/use-cases/{useCaseId}",[["integrationId","p",true],["useCaseId","p",true]],1],["deleteUseCase","delete","/v1/integrations/{integrationId}/use-cases/{useCaseId}",[["integrationId","p",true],["useCaseId","p",true]]],["listUseCaseHistory","get","/v1/integrations/{integrationId}/use-cases/{useCaseId}/history",[["integrationId","p",true],["useCaseId","p",true],["cursor","q"]]],["listIntegrationsV2","get","/v2/integrations"],["createIntegrationV2","post","/v2/integrations",null,1],["getIntegrationV2","get","/v2/integrations/{integrationId}",[["integrationId","p",true]]],["updateIntegrationV2","put","/v2/integrations/{integrationId}",[["integrationId","p",true]],1],["deleteIntegrationV2","delete","/v2/integrations/{integrationId}",[["integrationId","p",true]]],["getSecureProxyWhitelist","get","/v2/integrations/{integrationId}/use-cases/{useCaseId}/secure-proxy-whitelist",[["integrationId","p",true],["useCaseId","p",true]]],["updateSecureProxyWhitelist","put","/v2/integrations/{integrationId}/use-cases/{useCaseId}/secure-proxy-whitelist",[["integrationId","p",true],["useCaseId","p",true]],1],["listSecureProxyWhitelistHistory","get","/v2/integrations/{integrationId}/use-cases/{useCaseId}/secure-proxy-whitelist/history",[["integrationId","p",true],["useCaseId","p",true],["limit","q"]]],["setIntegrationAppMapping","put","/v1/integrations/{integrationId}/app-mapping",[["integrationId","p",true]],1],["deleteIntegrationAppMapping","delete","/v1/integrations/{integrationId}/app-mapping",[["integrationId","p",true]],1],["queryInboundMonitoringEvents","post","/v1/integrations/{integrationId}/monitoring/inbound-events",[["integrationId","p",true]],1],["getMonitoringStats","post","/v1/integrations/{integrationId}/monitoring/stats",[["integrationId","p",true]],1],["getMonitoringTimeSeries","post","/v1/integrations/{integrationId}/monitoring/timeseries",[["integrationId","p",true]],1],["getOutboundStatus","get","/v1/integrations/{integrationId}/outbound-status",[["integrationId","p",true]]],["queryAccessLogs","post","/v1/integrations/{integrationId}/monitoring/access-logs",[["integrationId","p",true]],1],["queryOutboundMonitoringEvents","post","/v1/integrations/{integrationId}/monitoring/outbound-events",[["integrationId","p",true]],1],["queryMonitoringEventsV2","post","/v2/integrations/{integrationId}/monitoring/events",[["integrationId","p",true]],1],["getMonitoringStatsV2","post","/v2/integrations/{integrationId}/monitoring/stats",[["integrationId","p",true]],1],["getMonitoringTimeSeriesV2","post","/v2/integrations/{integrationId}/monitoring/time-series",[["integrationId","p",true]],1],["getAssociatedMonitoringEvents","get","/v2/integrations/{integrationId}/monitoring/events/{eventId}/associated",[["integrationId","p",true],["eventId","p",true]]],["listSecureProxies","get","/v1/integrations/secure-proxies"],["secureProxy","post","/v1/secure-proxy",null,1],["managedCallExecute","post","/v1/managed-call/{slug}/execute",[["slug","p",true]],1],["generateTypesPreview","post","/v1/integrations/{integrationId}/generate-types-preview",[["integrationId","p",true]]],["generateTypes","post","/v1/integrations/{integrationId}/generate-types",[["integrationId","p",true]],1],["commitTypes","post","/v1/integrations/{integrationId}/commit-types",[["integrationId","p",true]],1]],"v":"3.0.3"}
+{"s":"https://integration-toolkit.sls.epilot.io","o":[["acknowledgeTracking","post","/v1/erp/tracking/acknowledgement",null,1],["triggerErp","post","/v1/erp/trigger",null,1],["processErpUpdatesEvents","post","/v1/erp/updates/events",null,1],["processErpUpdatesEventsV2","post","/v2/erp/updates/events",null,1],["processErpUpdatesEventsV3","post","/v3/erp/updates/events",null,1],["simulateMappingV2","post","/v2/erp/updates/mapping_simulation",null,1],["simulateMapping","post","/v1/erp/updates/mapping_simulation",null,1],["listIntegrations","get","/v1/integrations"],["createIntegration","post","/v1/integrations",null,1],["getIntegration","get","/v1/integrations/{integrationId}",[["integrationId","p",true]]],["updateIntegration","put","/v1/integrations/{integrationId}",[["integrationId","p",true]],1],["deleteIntegration","delete","/v1/integrations/{integrationId}",[["integrationId","p",true]]],["queryEvents","post","/v1/integrations/{integrationId}/events",[["integrationId","p",true]],1],["replayEvents","post","/v1/integrations/{integrationId}/events/replay",[["integrationId","p",true]],1],["listUseCases","get","/v1/integrations/{integrationId}/use-cases",[["integrationId","p",true]]],["createUseCase","post","/v1/integrations/{integrationId}/use-cases",[["integrationId","p",true]],1],["getUseCase","get","/v1/integrations/{integrationId}/use-cases/{useCaseId}",[["integrationId","p",true],["useCaseId","p",true]]],["updateUseCase","put","/v1/integrations/{integrationId}/use-cases/{useCaseId}",[["integrationId","p",true],["useCaseId","p",true]],1],["deleteUseCase","delete","/v1/integrations/{integrationId}/use-cases/{useCaseId}",[["integrationId","p",true],["useCaseId","p",true]]],["listUseCaseHistory","get","/v1/integrations/{integrationId}/use-cases/{useCaseId}/history",[["integrationId","p",true],["useCaseId","p",true],["cursor","q"]]],["listIntegrationsV2","get","/v2/integrations"],["createIntegrationV2","post","/v2/integrations",null,1],["getIntegrationV2","get","/v2/integrations/{integrationId}",[["integrationId","p",true]]],["updateIntegrationV2","put","/v2/integrations/{integrationId}",[["integrationId","p",true]],1],["deleteIntegrationV2","delete","/v2/integrations/{integrationId}",[["integrationId","p",true]]],["getSecureProxyWhitelist","get","/v2/integrations/{integrationId}/use-cases/{useCaseId}/secure-proxy-whitelist",[["integrationId","p",true],["useCaseId","p",true]]],["updateSecureProxyWhitelist","put","/v2/integrations/{integrationId}/use-cases/{useCaseId}/secure-proxy-whitelist",[["integrationId","p",true],["useCaseId","p",true]],1],["listSecureProxyWhitelistHistory","get","/v2/integrations/{integrationId}/use-cases/{useCaseId}/secure-proxy-whitelist/history",[["integrationId","p",true],["useCaseId","p",true],["limit","q"]]],["setIntegrationAppMapping","put","/v1/integrations/{integrationId}/app-mapping",[["integrationId","p",true]],1],["deleteIntegrationAppMapping","delete","/v1/integrations/{integrationId}/app-mapping",[["integrationId","p",true]],1],["queryInboundMonitoringEvents","post","/v1/integrations/{integrationId}/monitoring/inbound-events",[["integrationId","p",true]],1],["getMonitoringStats","post","/v1/integrations/{integrationId}/monitoring/stats",[["integrationId","p",true]],1],["getMonitoringTimeSeries","post","/v1/integrations/{integrationId}/monitoring/timeseries",[["integrationId","p",true]],1],["getOutboundStatus","get","/v1/integrations/{integrationId}/outbound-status",[["integrationId","p",true]]],["pollOutboundMessages","post","/v1/integrations/{integrationId}/outbound/messages/poll",[["integrationId","p",true]],1],["ackOutboundMessages","post","/v1/integrations/{integrationId}/outbound/messages/ack",[["integrationId","p",true]],1],["listOutboundDlqMessages","get","/v1/integrations/{integrationId}/outbound/messages/dlq",[["integrationId","p",true],["limit","q"],["next_token","q"]]],["redriveOutboundDlqMessages","post","/v1/integrations/{integrationId}/outbound/messages/dlq/redrive",[["integrationId","p",true]],1],["unblockOutboundStream","post","/v1/integrations/{integrationId}/outbound/messages/unblock",[["integrationId","p",true]],1],["queryAccessLogs","post","/v1/integrations/{integrationId}/monitoring/access-logs",[["integrationId","p",true]],1],["queryOutboundMonitoringEvents","post","/v1/integrations/{integrationId}/monitoring/outbound-events",[["integrationId","p",true]],1],["queryMonitoringEventsV2","post","/v2/integrations/{integrationId}/monitoring/events",[["integrationId","p",true]],1],["getMonitoringStatsV2","post","/v2/integrations/{integrationId}/monitoring/stats",[["integrationId","p",true]],1],["getMonitoringTimeSeriesV2","post","/v2/integrations/{integrationId}/monitoring/time-series",[["integrationId","p",true]],1],["getAssociatedMonitoringEvents","get","/v2/integrations/{integrationId}/monitoring/events/{eventId}/associated",[["integrationId","p",true],["eventId","p",true]]],["listSecureProxies","get","/v1/integrations/secure-proxies"],["secureProxy","post","/v1/secure-proxy",null,1],["managedCallExecute","post","/v1/managed-call/{slug}/execute",[["slug","p",true]],1],["generateTypesPreview","post","/v1/integrations/{integrationId}/generate-types-preview",[["integrationId","p",true]]],["generateTypes","post","/v1/integrations/{integrationId}/generate-types",[["integrationId","p",true]],1],["commitTypes","post","/v1/integrations/{integrationId}/commit-types",[["integrationId","p",true]],1]],"v":"3.0.3"}