@epilot/sdk 2.6.0 → 2.7.1

package/definitions/email-settings.json

@@ -516,13 +516,23 @@
       }
     },
     "/v2/outlook/connect": {
-      "get": {
+      "post": {
         "operationId": "connectOutlook",
         "summary": "connectOutlook",
-        "description": "Returns Microsoft authorization URL for Outlook OAuth.",
+        "description": "Returns the Microsoft authorization URL for Outlook OAuth.\n\nThe request body selects which features to request scopes for. Feature\nflags are additive; Microsoft OAuth scopes are cumulative. Calling this\nendpoint again with a superset of features (e.g. `mail` already connected,\nand `calendar` added) triggers Microsoft's incremental-consent flow —\nthe user only sees a consent prompt for the new scopes.\n",
         "tags": [
           "O365 Outlook Connection"
         ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ConnectOutlookRequest"
+              }
+            }
+          }
+        },
         "responses": {
           "200": {
             "description": "Authorization URL",
@@ -530,6 +540,9 @@
               "application/json": {
                 "schema": {
                   "type": "object",
+                  "required": [
+                    "authorization_url"
+                  ],
                   "properties": {
                     "authorization_url": {
                       "type": "string"
@@ -539,6 +552,9 @@
               }
             }
           },
+          "400": {
+            "$ref": "#/components/responses/OutlookErrorResponse"
+          },
           "403": {
             "$ref": "#/components/responses/OutlookErrorResponse"
           }
@@ -1655,7 +1671,7 @@
       "post": {
         "operationId": "verifyNameServers",
         "summary": "verifyNameServers",
-        "description": "Verifies that the domain's name server (NS) records are correctly configured.\n\nThis check ensures that DNS resolution is properly set up for the domain\nbefore proceeding with full domain verification.\n\nRun this verification after configuring NS records in your DNS provider.\n",
+        "description": "Verifies that the domain's name server (NS) records are correctly configured.\n\nThis check ensures that DNS resolution is properly set up for the domain\nbefore proceeding with full domain verification.\n\nRun this verification after configuring NS records in your DNS provider.\n\n**Deprecated**: Use `/domain/dns-records:verify` for new integrations.\n",
         "tags": [
           "Domains"
         ],
@@ -1693,6 +1709,48 @@
         }
       }
     },
+    "/v1/email-settings/domain/dns-records:verify": {
+      "post": {
+        "operationId": "verifyDnsRecords",
+        "summary": "verifyDnsRecords",
+        "description": "Verifies that the domain's DNS records (MX, TXT, CNAME) are correctly configured\nin the customer's DNS provider.\n\nThis check performs DNS lookups to confirm each required record is present\nbefore proceeding with full domain identity verification.\n\nRun this verification after configuring all DNS records in your DNS provider.\n",
+        "tags": [
+          "Domains"
+        ],
+        "requestBody": {
+          "description": "The domain to verify DNS records for",
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/Domain"
+              },
+              "example": {
+                "domain": "mail.yourcompany.com"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "DNS record verification result. Check the response to see if all records\nare verified or if additional DNS configuration is needed.\n",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SettingsResponse"
+                }
+              }
+            }
+          },
+          "403": {
+            "$ref": "#/components/responses/Forbidden"
+          },
+          "404": {
+            "$ref": "#/components/responses/NotFound"
+          }
+        }
+      }
+    },
     "/v1/email-settings/domain:verify": {
       "post": {
         "operationId": "verifyDomain",
@@ -2007,6 +2065,22 @@
       }
     },
     "schemas": {
+      "ConnectOutlookRequest": {
+        "type": "object",
+        "description": "Feature flags selecting which Microsoft Graph scopes to request.\nAt least one flag must be true. Passing a superset of previously\ngranted features triggers incremental consent for the delta only.\n",
+        "additionalProperties": false,
+        "minProperties": 1,
+        "properties": {
+          "mail": {
+            "type": "boolean",
+            "description": "Request 'mail' specific scopes."
+          },
+          "calendar": {
+            "type": "boolean",
+            "description": "Request 'calendar' specific scopes."
+          }
+        }
+      },
       "MailboxSyncStatus": {
         "type": "object",
         "required": [
@@ -2597,7 +2671,15 @@
               "reconnect",
               "none"
             ],
-            "description": "Action for UI to take (all call GET /outlook/connect):\n- connect: No connection, initiate OAuth\n- authorize: Admin consent done, complete OAuth\n- reconnect: Re-authenticate expired session\n- none: Fully connected, no action needed\n"
+            "description": "Action for UI to take (all call POST /outlook/connect):\n- connect: No connection, initiate OAuth\n- authorize: Admin consent done, complete OAuth\n- reconnect: Re-authenticate expired session or approve updated permissions\n- none: Fully connected, no action needed\n"
+          },
+          "action_reason": {
+            "type": "string",
+            "enum": [
+              "expired",
+              "permission_update"
+            ],
+            "description": "Discriminates the cause when `action` is `reconnect`:\n- expired: Stored tokens are no longer valid; user must re-authenticate\n- permission_update: Token is valid, but the granted scopes do not cover the\n  scopes required by the configured Outlook integrations (currently `mail`).\n  The user must reconnect to grant the additional permissions; Microsoft's\n  incremental-consent flow will only prompt for the delta.\n"
           },
           "connected_by_display_name": {
             "type": "string",

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],["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]]],["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"}

package/definitions/event-catalog.json

@@ -261,6 +261,118 @@
         }
       }
     },
+    "/v2/events/{event_name}:history": {
+      "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",
+        "tags": [
+          "Event Catalog"
+        ],
+        "parameters": [
+          {
+            "name": "event_name",
+            "in": "path",
+            "required": true,
+            "description": "Unique human readable name of the event",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SearchOptionsV2"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "List of event summaries in the event history",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "results": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/EventSummary"
+                      }
+                    },
+                    "next_cursor": {
+                      "type": "object",
+                      "description": "Cursor for pagination. Use this to get the next page of results.",
+                      "nullable": true,
+                      "properties": {
+                        "event_time": {
+                          "type": "string",
+                          "description": "Timestamp from the last event in the current page",
+                          "example": "2025-10-31T12:34:56Z"
+                        },
+                        "event_id": {
+                          "type": "string",
+                          "description": "Event ID from the last event in the current page",
+                          "example": "evt_1234567890abcdef"
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v2/events/{event_name}/history/{event_id}": {
+      "get": {
+        "operationId": "getHistoricalEvent",
+        "summary": "getHistoricalEvent",
+        "description": "Fetch a single historical event by id with full hydration",
+        "tags": [
+          "Event Catalog"
+        ],
+        "parameters": [
+          {
+            "name": "event_name",
+            "in": "path",
+            "required": true,
+            "description": "Unique human readable name of the event",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "event_id",
+            "in": "path",
+            "required": true,
+            "description": "Unique event identifier (ULID)",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The fully hydrated historical event",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Event"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Event not found"
+          }
+        }
+      }
+    },
     "/v1/events/{event_name}:trigger": {
       "post": {
         "operationId": "triggerEvent",
@@ -441,7 +553,7 @@
         ]
       },
       "UpdateEventPayload": {
-        "description": "Payload for updating an event configuration.\nAccepts the same fields as EventConfig (all optional for PATCH).\nCurrently only `enabled` and `auto_trigger` fields are processed, other fields are ignored.\n",
+        "description": "Payload for updating an event configuration.\nAccepts the same fields as EventConfig (all optional for PATCH).\nCurrently `enabled` and `auto_trigger` fields are processed.\n",
         "allOf": [
           {
             "$ref": "#/components/schemas/EventConfigBase"
@@ -495,6 +607,22 @@
           "entity_schema"
         ]
       },
+      "AttachmentField": {
+        "type": "object",
+        "description": "A schema field representing file attachments associated with the event.\nPresent in schema_fields for events tagged with \"attachment\".\n",
+        "properties": {
+          "items": {
+            "$ref": "#/components/schemas/EventAttachment"
+          },
+          "required": {
+            "type": "boolean",
+            "description": "Whether this field is required in the event payload"
+          }
+        },
+        "required": [
+          "items"
+        ]
+      },
       "SchemaField": {
         "oneOf": [
           {
@@ -502,6 +630,9 @@
           },
           {
             "$ref": "#/components/schemas/ContextEntity"
+          },
+          {
+            "$ref": "#/components/schemas/AttachmentField"
           }
         ]
       },
@@ -764,6 +895,60 @@
           "contract_id": "880e8400-e29b-41d4-a716-446655440000"
         }
       },
+      "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",
+        "properties": {
+          "_org_id": {
+            "type": "string",
+            "description": "epilot tenant/organization ID"
+          },
+          "_event_time": {
+            "type": "string",
+            "format": "date-time",
+            "description": "ISO 8601 timestamp when event occurred"
+          },
+          "_event_id": {
+            "type": "string",
+            "description": "Unique event identifier (ULID)"
+          },
+          "_event_name": {
+            "type": "string",
+            "description": "Event name from catalog"
+          },
+          "_event_version": {
+            "type": "string",
+            "description": "Event version (semver)",
+            "example": "1.0.0"
+          },
+          "_event_source": {
+            "type": "string",
+            "description": "Source that triggered the event"
+          },
+          "_trigger_source_type": {
+            "type": "string",
+            "description": "The type of system that triggered the event.\nCommon values: api, automation, operation, portal_user\n",
+            "example": "api"
+          },
+          "_trigger_source": {
+            "type": "string",
+            "description": "Identifier of the specific trigger source.\n"
+          },
+          "_ack_id": {
+            "type": "string",
+            "description": "Unique acknowledgment tracking ID for the event.\n"
+          }
+        },
+        "required": [
+          "_org_id",
+          "_event_time",
+          "_event_id",
+          "_event_name",
+          "_event_version",
+          "_event_source"
+        ],
+        "additionalProperties": true
+      },
       "GraphDefinition": {
         "type": "object",
         "description": "Entity graph definition for resolving related entities",
@@ -959,6 +1144,22 @@
           }
         }
       },
+      "SearchOptionsV2": {
+        "description": "Search options for the v2 history endpoint.\n\nExtends `SearchOptions` with an optional `fields` projection. When `fields`\nis omitted, the response includes all `_*` metadata plus all scalar payload\nfields (and primitive arrays / empty objects/arrays) after entity stripping.\nWhen `fields` is provided, glob/exclusion semantics from `FieldsParam` apply\nagainst `payload.*` paths; `_*` metadata is always included. Entity stripping\nruns AFTER selection.\n",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/SearchOptions"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "fields": {
+                "$ref": "#/components/schemas/FieldsParam"
+              }
+            }
+          }
+        ]
+      },
       "FieldsParam": {
         "type": "array",
         "description": "List of entity fields to include or exclude in the response\n\nUse ! to exclude fields, e.g. `!_id` to exclude the `_id` field.\n\nGlobbing and globstart (**) is supported for nested fields.\n",
@@ -1040,6 +1241,60 @@
           "success",
           "event_id"
         ]
+      },
+      "EventAttachment": {
+        "type": "object",
+        "description": "A file attachment associated with an event",
+        "properties": {
+          "entity_id": {
+            "type": "string",
+            "format": "uuid",
+            "description": "Entity ID of the file"
+          },
+          "filename": {
+            "type": "string",
+            "description": "Name of the file"
+          },
+          "mime_type": {
+            "type": "string",
+            "description": "MIME type of the file (e.g., application/pdf)"
+          },
+          "size_bytes": {
+            "type": "integer",
+            "minimum": 0,
+            "description": "File size in bytes"
+          },
+          "s3ref": {
+            "type": "object",
+            "description": "S3 reference for the file content",
+            "properties": {
+              "bucket": {
+                "type": "string",
+                "description": "S3 bucket name"
+              },
+              "key": {
+                "type": "string",
+                "description": "S3 object key"
+              }
+            },
+            "required": [
+              "bucket",
+              "key"
+            ]
+          },
+          "version_index": {
+            "type": "integer",
+            "description": "File version index (always 0 for newly created files)"
+          },
+          "readable_size": {
+            "type": "string",
+            "description": "Human-readable file size (e.g., \"200 KB\")"
+          }
+        },
+        "required": [
+          "entity_id",
+          "version_index"
+        ]
       }
     }
   },

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],["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]]],["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"]}}