@epilot/sdk 2.8.10 → 2.9.0

package/definitions/integration-toolkit.json

@@ -2,7 +2,7 @@
   "openapi": "3.0.3",
   "info": {
     "title": "Integration Toolkit API",
-    "version": "1.2.0",
+    "version": "1.3.0",
     "description": "API for integrating with external systems in a standardised way."
   },
   "tags": [
@@ -3100,11 +3100,11 @@
             }
           },
           "502": {
-            "description": "Upstream error from the proxied target",
+            "description": "Upstream failure: epilot could not obtain an HTTP response from the proxied target\n(e.g. TLS handshake failure, connection refused/reset, DNS failure or timeout).\nThe body's `code`/`reason` identify the underlying cause, distinguishing a\nremote-side problem from an epilot-side one. When the target *does* answer with\nits own status, that status and body are passed through unchanged via\n`SecureProxyResponse` instead.\n",
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/ErrorResponseBase"
+                  "$ref": "#/components/schemas/SecureProxyUpstreamError"
                 }
               }
             }
@@ -5856,7 +5856,32 @@
             "description": "Response headers from upstream"
           },
           "body": {
-            "description": "Response body from upstream"
+            "description": "Response body from upstream. When `status_code` is 502 and the target never produced an HTTP response (TLS/connection/DNS failure or timeout), this is a `SecureProxyUpstreamError` describing the underlying cause."
+          }
+        }
+      },
+      "SecureProxyUpstreamError": {
+        "type": "object",
+        "description": "Error payload returned when epilot could not obtain an HTTP response from the proxied target. The failure is epilot-generated (HTTP 502) but the cause is usually remote-side; `code`/`reason` make that attributable.",
+        "required": [
+          "message"
+        ],
+        "properties": {
+          "message": {
+            "type": "string",
+            "description": "Short error category.",
+            "enum": [
+              "Upstream network error",
+              "Upstream error"
+            ]
+          },
+          "code": {
+            "type": "string",
+            "description": "Underlying Node.js/axios error code when available (e.g. `UNABLE_TO_VERIFY_LEAF_SIGNATURE`, `ECONNREFUSED`, `ETIMEDOUT`, `ENOTFOUND`)."
+          },
+          "reason": {
+            "type": "string",
+            "description": "Human-readable explanation, present only for well-known codes (TLS/certificate, DNS and connection failures)."
           }
         }
       },
@@ -6908,7 +6933,7 @@
               "block"
             ],
             "default": "dead_letter",
-            "description": "What happens when an item exhausts max_delivery_attempts: dead_letter routes the exhausted item to the dead-letter queue; block halts the queue until operator/consumer action. Enforcement lands with the queue consumer (Phase 10) — this field defines the contract."
+            "description": "What happens when an item exhausts max_delivery_attempts: dead_letter routes the exhausted item to the dead-letter queue and advances past it so the stream keeps flowing; block halts the queue at that item until operator/consumer action removes it."
           },
           "max_delivery_attempts": {
             "type": "integer",

package/definitions/journey.json

@@ -117,7 +117,7 @@
           {
             "name": "version",
             "in": "query",
-            "description": "DynamoDB version to fetch. `0` (default) is the live row; positive integers are historical snapshots created on each save. Note: this is distinct from the `revisions` counter on the row body.\n",
+            "description": "DynamoDB version to fetch. `0` (default) is the live row; positive integers are historical snapshots created on each save. Note: this is distinct from the `revisions` counter on the row body.",
             "required": false,
             "schema": {
               "type": "integer",
@@ -722,7 +722,7 @@
           {
             "name": "version",
             "in": "query",
-            "description": "DynamoDB version to fetch. `0` (default) is the live row; positive integers are historical snapshots created on each save. Note: this is distinct from the `revisions` counter on the row body.\n",
+            "description": "DynamoDB version to fetch. `0` (default) is the live row; positive integers are historical snapshots created on each save. Note: this is distinct from the `revisions` counter on the row body.",
             "required": false,
             "schema": {
               "type": "integer",
@@ -1314,13 +1314,6 @@
             "type": "boolean",
             "description": "If true, journey is displayed in read-only mode"
           },
-          "protectedEditable": {
-            "type": "array",
-            "items": {
-              "type": "string"
-            },
-            "description": "Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*/blocks/**)."
-          },
           "settings": {
             "type": "object",
             "properties": {
@@ -1841,13 +1834,6 @@
             "type": "boolean",
             "description": "If true, journey is displayed in read-only mode"
           },
-          "protectedEditable": {
-            "type": "array",
-            "items": {
-              "type": "string"
-            },
-            "description": "Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*/blocks/**)."
-          },
           "settings": {
             "type": "object",
             "properties": {
@@ -1995,9 +1981,6 @@
               "enableDarkMode": {
                 "type": "boolean",
                 "description": "If true, the journey shows an icon to toggle dark mode"
-              },
-              "isActive": {
-                "type": "boolean"
               }
             },
             "additionalProperties": false

package/definitions/targeting.json

@@ -1361,16 +1361,15 @@
               },
               "email": {
                 "type": "object",
-                "description": "Email campaign delivery. An automation flow (legacy) and/or an email\ntemplate can be provided to send the campaign emails. The selection is\npersisted as the campaign's `flow_id`. If `automation_id` is provided it is\nused as-is; otherwise a flow is created from `template_id`. Only sent by the\nconsumer once one has been selected.\n",
+                "description": "Email campaign delivery. The selected automation flow is persisted as the\ncampaign's `flow_id` and is responsible for sending the campaign emails.\nOnly sent by the consumer once an automation has been selected.\n",
                 "properties": {
                   "automation_id": {
                     "$ref": "#/components/schemas/BaseUUID"
-                  },
-                  "template_id": {
-                    "$ref": "#/components/schemas/BaseUUID"
                   }
                 },
-                "minProperties": 1,
+                "required": [
+                  "automation_id"
+                ],
                 "additionalProperties": false
               }
             },

package/definitions/user-runtime.json

@@ -1 +1 @@
-{"s":"https://user.sls.epilot.io","o":[["signUpUser","post","/v2/users/public/signup",[["token","q"]],1],["getMeV2","get","/v2/users/me"],["listUserSettings","get","/v2/users/me/settings"],["getUserSettingsScope","get","/v2/users/me/settings/{scope}",[["scope","p",true]]],["getUserSetting","get","/v2/users/me/settings/{scope}/{key}",[["scope","p",true],["key","p",true]]],["putUserSetting","put","/v2/users/me/settings/{scope}/{key}",[["scope","p",true],["key","p",true]],1],["deleteUserSetting","delete","/v2/users/me/settings/{scope}/{key}",[["scope","p",true],["key","p",true]]],["listUsersV2","get","/v2/users",[["query","q"],["limit","q"],["offset","q"]]],["getUserV2","get","/v2/users/{id}",[["id","p",true]]],["updateUserV2","patch","/v2/users/{id}",[["id","p",true]],1],["deleteUserV2","delete","/v2/users/{id}",[["id","p",true]]],["inviteUser","post","/v2/users/invite",null,1],["resendUserInvitation","post","/v2/users/invite:resendEmail",null,1],["sendUserPasswordReset","post","/v2/users:sendPasswordReset",null,1],["getGroupsForUser","get","/v2/users/{id}/groups",[["id","p",true]]],["getGroups","get","/v1/groups",[["query","q"],["limit","q"],["offset","q"],["hydrate","q"]]],["createGroup","post","/v1/groups",null,1],["getGroup","get","/v1/groups/{id}",[["id","p",true],["hydrate","q"]]],["updateGroup","patch","/v1/groups/{id}",[["id","p",true]],1],["deleteGroup","delete","/v1/groups/{id}",[["id","p",true]]],["advanceUserAssignment","post","/v1/groups/{id}/user:next",[["id","p",true]]],["createNavigation","post","/v2/user/navigations",null,1],["getNavigation","get","/v2/user/navigations/{id}",[["id","p",true]]],["verifyEmailWithToken","post","/v2/users/public/verifyEmail",[["token","q",true]],1],["requestPasswordReset","post","/v2/users/public/requestPasswordReset",null,1],["checkInviteToken","get","/v2/users/public/checkToken",[["token","q",true]]],["activateUser","post","/v2/users/public/activate",[["token","q",true]],1],["rejectInvite","delete","/v2/users/public/reject",[["token","q",true]]],["getUserLoginParametersV2","get","/v2/users/public/username/{username}:getLoginParameters",[["username","p",true]]],["beginPasskeyAuthentication","post","/v2/users/public/passkeys:authenticateBegin",null,1],["beginDiscoverablePasskeyAuthentication","post","/v2/users/public/passkeys:authenticateBeginDiscoverable"],["resolveDiscoverableCredential","post","/v2/users/public/passkeys:resolveCredential",null,1],["beginPasskeyRegistration","post","/v2/users/me/passkeys:registerBegin",null,1],["completePasskeyRegistration","post","/v2/users/me/passkeys:registerComplete",null,1],["listPasskeys","get","/v2/users/me/passkeys"],["deletePasskey","delete","/v2/users/me/passkeys/{credentialId}",[["credentialId","p",true]]],["switchOrganization","post","/v2/users/switchOrganization",null,1],["getMe","get","/v1/users/me"],["listUsers","get","/v1/users",[["org_ids","q",false,"form",false],["query","q"],["limit","q"],["offset","q"]]],["getUser","get","/v1/users/{id}",[["id","p",true]]],["getUserLoginParameters","get","/v1/users/username/{username}:getLoginParameters",[["username","p",true]]]]}
+{"s":"https://user.sls.epilot.io","o":[["signUpUser","post","/v2/users/public/signup",[["token","q"]],1],["getMeV2","get","/v2/users/me"],["listUsersV2","get","/v2/users",[["query","q"],["limit","q"],["offset","q"]]],["getUserV2","get","/v2/users/{id}",[["id","p",true]]],["updateUserV2","patch","/v2/users/{id}",[["id","p",true]],1],["deleteUserV2","delete","/v2/users/{id}",[["id","p",true]]],["inviteUser","post","/v2/users/invite",null,1],["resendUserInvitation","post","/v2/users/invite:resendEmail",null,1],["getGroupsForUser","get","/v2/users/{id}/groups",[["id","p",true]]],["getGroups","get","/v1/groups",[["query","q"],["limit","q"],["offset","q"],["hydrate","q"]]],["createGroup","post","/v1/groups",null,1],["getGroup","get","/v1/groups/{id}",[["id","p",true],["hydrate","q"]]],["updateGroup","patch","/v1/groups/{id}",[["id","p",true]],1],["deleteGroup","delete","/v1/groups/{id}",[["id","p",true]]],["advanceUserAssignment","post","/v1/groups/{id}/user:next",[["id","p",true]]],["createNavigation","post","/v2/user/navigations",null,1],["getNavigation","get","/v2/user/navigations/{id}",[["id","p",true]]],["verifyEmailWithToken","post","/v2/users/public/verifyEmail",[["token","q",true]],1],["checkInviteToken","get","/v2/users/public/checkToken",[["token","q",true]]],["activateUser","post","/v2/users/public/activate",[["token","q",true]],1],["rejectInvite","delete","/v2/users/public/reject",[["token","q",true]]],["getUserLoginParametersV2","get","/v2/users/public/username/{username}:getLoginParameters",[["username","p",true]]],["beginPasskeyAuthentication","post","/v2/users/public/passkeys:authenticateBegin",null,1],["beginDiscoverablePasskeyAuthentication","post","/v2/users/public/passkeys:authenticateBeginDiscoverable"],["resolveDiscoverableCredential","post","/v2/users/public/passkeys:resolveCredential",null,1],["beginPasskeyRegistration","post","/v2/users/me/passkeys:registerBegin",null,1],["completePasskeyRegistration","post","/v2/users/me/passkeys:registerComplete",null,1],["listPasskeys","get","/v2/users/me/passkeys"],["deletePasskey","delete","/v2/users/me/passkeys/{credentialId}",[["credentialId","p",true]]],["switchOrganization","post","/v2/users/switchOrganization",null,1],["getMe","get","/v1/users/me"],["listUsers","get","/v1/users",[["org_ids","q",false,"form",false],["query","q"],["limit","q"],["offset","q"]]],["getUser","get","/v1/users/{id}",[["id","p",true]]],["getUserLoginParameters","get","/v1/users/username/{username}:getLoginParameters",[["username","p",true]]]]}

package/definitions/user.json

@@ -101,189 +101,6 @@
         }
       }
     },
-    "/v2/users/me/settings": {
-      "get": {
-        "operationId": "listUserSettings",
-        "summary": "listUserSettings",
-        "description": "List all setting scopes and keys available for the currently logged in user. Does not return setting values.",
-        "tags": [
-          "User V2"
-        ],
-        "responses": {
-          "200": {
-            "description": "List of user setting scopes and keys",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/UserSettingsListResponse"
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "/v2/users/me/settings/{scope}": {
-      "get": {
-        "operationId": "getUserSettingsScope",
-        "summary": "getUserSettingsScope",
-        "description": "Get all setting values for one scope for the currently logged in user.",
-        "tags": [
-          "User V2"
-        ],
-        "parameters": [
-          {
-            "name": "scope",
-            "in": "path",
-            "required": true,
-            "schema": {
-              "$ref": "#/components/schemas/UserSettingScope"
-            },
-            "description": "User setting scope, for example calendar, navigation, or search"
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "User settings for the requested scope",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/UserSettingsScopeResponse"
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "/v2/users/me/settings/{scope}/{key}": {
-      "get": {
-        "operationId": "getUserSetting",
-        "summary": "getUserSetting",
-        "description": "Get one setting value by scope and key for the currently logged in user.",
-        "tags": [
-          "User V2"
-        ],
-        "parameters": [
-          {
-            "name": "scope",
-            "in": "path",
-            "required": true,
-            "schema": {
-              "$ref": "#/components/schemas/UserSettingScope"
-            },
-            "description": "User setting scope"
-          },
-          {
-            "name": "key",
-            "in": "path",
-            "required": true,
-            "schema": {
-              "$ref": "#/components/schemas/UserSettingKey"
-            },
-            "description": "User setting key"
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "User setting",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/UserSetting"
-                }
-              }
-            }
-          },
-          "404": {
-            "description": "User setting not found"
-          }
-        }
-      },
-      "put": {
-        "operationId": "putUserSetting",
-        "summary": "putUserSetting",
-        "description": "Create or replace one setting value for the currently logged in user.",
-        "tags": [
-          "User V2"
-        ],
-        "parameters": [
-          {
-            "name": "scope",
-            "in": "path",
-            "required": true,
-            "schema": {
-              "$ref": "#/components/schemas/UserSettingScope"
-            },
-            "description": "User setting scope"
-          },
-          {
-            "name": "key",
-            "in": "path",
-            "required": true,
-            "schema": {
-              "$ref": "#/components/schemas/UserSettingKey"
-            },
-            "description": "User setting key"
-          }
-        ],
-        "requestBody": {
-          "required": true,
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/UserSettingValue"
-              }
-            }
-          }
-        },
-        "responses": {
-          "200": {
-            "description": "User setting saved successfully",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/UserSetting"
-                }
-              }
-            }
-          }
-        }
-      },
-      "delete": {
-        "operationId": "deleteUserSetting",
-        "summary": "deleteUserSetting",
-        "description": "Delete one setting value for the currently logged in user.",
-        "tags": [
-          "User V2"
-        ],
-        "parameters": [
-          {
-            "name": "scope",
-            "in": "path",
-            "required": true,
-            "schema": {
-              "$ref": "#/components/schemas/UserSettingScope"
-            },
-            "description": "User setting scope"
-          },
-          {
-            "name": "key",
-            "in": "path",
-            "required": true,
-            "schema": {
-              "$ref": "#/components/schemas/UserSettingKey"
-            },
-            "description": "User setting key"
-          }
-        ],
-        "responses": {
-          "204": {
-            "description": "User setting deleted successfully"
-          }
-        }
-      }
-    },
     "/v2/users": {
       "get": {
         "operationId": "listUsersV2",
@@ -531,63 +348,6 @@
         }
       }
     },
-    "/v2/users:sendPasswordReset": {
-      "post": {
-        "operationId": "sendUserPasswordReset",
-        "summary": "sendUserPasswordReset",
-        "description": "Send a password reset email to a user in your organization.\nRequires `user:edit` on the target user.\n",
-        "tags": [
-          "User V2"
-        ],
-        "requestBody": {
-          "required": true,
-          "content": {
-            "application/json": {
-              "schema": {
-                "type": "object",
-                "required": [
-                  "email"
-                ],
-                "properties": {
-                  "email": {
-                    "type": "string",
-                    "description": "Email address of the user to reset",
-                    "example": "test@example.com"
-                  }
-                }
-              }
-            }
-          }
-        },
-        "responses": {
-          "200": {
-            "description": "Password reset triggered",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "required": [
-                    "success"
-                  ],
-                  "properties": {
-                    "success": {
-                      "type": "boolean",
-                      "example": true
-                    }
-                  }
-                }
-              }
-            }
-          },
-          "400": {
-            "description": "Invalid email or user not found"
-          },
-          "403": {
-            "description": "Not permitted to reset this user's password"
-          }
-        }
-      }
-    },
     "/v2/users/{id}/groups": {
       "get": {
         "operationId": "getGroupsForUser",
@@ -949,9 +709,6 @@
         "summary": "verifyEmailWithToken",
         "description": "Update new email using an verification token",
         "security": [],
-        "x-rate-limit": {
-          "limit": 10
-        },
         "tags": [
           "User V2"
         ],
@@ -979,69 +736,8 @@
           "200": {
             "description": "Verified successfully"
           },
-          "400": {
-            "description": "No pending email change for this token"
-          },
           "404": {
             "description": "Token not found"
-          },
-          "409": {
-            "description": "Email address already in use"
-          }
-        }
-      }
-    },
-    "/v2/users/public/requestPasswordReset": {
-      "post": {
-        "operationId": "requestPasswordReset",
-        "summary": "requestPasswordReset",
-        "description": "Request a password reset email for the given email address. Always\nreturns a success response whether or not an account exists with that\nemail.\n",
-        "security": [],
-        "x-rate-limit": {
-          "limit": 10
-        },
-        "tags": [
-          "User V2"
-        ],
-        "requestBody": {
-          "required": true,
-          "content": {
-            "application/json": {
-              "schema": {
-                "type": "object",
-                "required": [
-                  "email"
-                ],
-                "properties": {
-                  "email": {
-                    "type": "string",
-                    "description": "Email address of the account to reset",
-                    "example": "test@example.com"
-                  }
-                }
-              }
-            }
-          }
-        },
-        "responses": {
-          "200": {
-            "description": "Request accepted",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "required": [
-                    "message"
-                  ],
-                  "properties": {
-                    "message": {
-                      "type": "string",
-                      "example": "If an account exists, a password reset email has been sent."
-                    }
-                  }
-                }
-              }
-            }
           }
         }
       }
@@ -1991,13 +1687,6 @@
             "nullable": true,
             "format": "email"
           },
-          "draft_email_expires_at": {
-            "description": "Server-set expiry for the pending email change verification link (ISO 8601). Read-only.",
-            "type": "string",
-            "nullable": true,
-            "format": "date-time",
-            "readOnly": true
-          },
           "department": {
             "type": "string",
             "description": "User's department",
@@ -2021,11 +1710,6 @@
             "type": "boolean",
             "example": false
           },
-          "has_passkeys": {
-            "description": "Whether the user has any registered passkeys",
-            "type": "boolean",
-            "example": false
-          },
           "phone_verified": {
             "description": "User's phone number verification status",
             "type": "boolean",
@@ -2364,13 +2048,6 @@
           },
           "image_uri": {
             "$ref": "#/components/schemas/GroupImageUri"
-          },
-          "abbreviation": {
-            "description": "A short abbreviation for the group, up to 2 characters.",
-            "type": "string",
-            "maxLength": 2,
-            "nullable": true,
-            "example": "FN"
           }
         },
         "required": [
@@ -2398,13 +2075,6 @@
           },
           "image_uri": {
             "$ref": "#/components/schemas/GroupImageUri"
-          },
-          "abbreviation": {
-            "description": "A short abbreviation for the group, up to 2 characters.",
-            "type": "string",
-            "maxLength": 2,
-            "nullable": true,
-            "example": "FN"
           }
         }
       },
@@ -2462,13 +2132,6 @@
           },
           "image_uri": {
             "$ref": "#/components/schemas/GroupImageUri"
-          },
-          "abbreviation": {
-            "description": "A short abbreviation for the group, up to 2 characters.",
-            "type": "string",
-            "maxLength": 2,
-            "nullable": true,
-            "example": "FN"
           }
         },
         "required": [
@@ -2714,110 +2377,6 @@
           }
         }
       },
-      "UserSettingScope": {
-        "type": "string",
-        "description": "User setting scope. Values are limited to 64 characters.",
-        "minLength": 1,
-        "maxLength": 64,
-        "example": "calendar"
-      },
-      "UserSettingKey": {
-        "type": "string",
-        "description": "User setting key. Values are limited to 128 characters.",
-        "minLength": 1,
-        "maxLength": 128,
-        "example": "visible_calendars"
-      },
-      "UserSettingValue": {
-        "description": "The JSON value of a user setting. Objects are recommended for extensibility, but any JSON value is accepted up to 64 KiB when serialized as JSON.",
-        "x-maxSerializedBytes": 65536
-      },
-      "UserSetting": {
-        "type": "object",
-        "properties": {
-          "scope": {
-            "$ref": "#/components/schemas/UserSettingScope"
-          },
-          "key": {
-            "$ref": "#/components/schemas/UserSettingKey"
-          },
-          "value": {
-            "$ref": "#/components/schemas/UserSettingValue"
-          },
-          "created_at": {
-            "type": "string",
-            "format": "date-time"
-          },
-          "updated_at": {
-            "type": "string",
-            "format": "date-time"
-          }
-        },
-        "required": [
-          "scope",
-          "key",
-          "value",
-          "created_at",
-          "updated_at"
-        ]
-      },
-      "UserSettingsListResponse": {
-        "type": "object",
-        "properties": {
-          "results": {
-            "type": "array",
-            "items": {
-              "type": "object",
-              "properties": {
-                "scope": {
-                  "$ref": "#/components/schemas/UserSettingScope"
-                },
-                "keys": {
-                  "type": "array",
-                  "items": {
-                    "$ref": "#/components/schemas/UserSettingKey"
-                  },
-                  "example": [
-                    "visible_calendars"
-                  ]
-                }
-              },
-              "required": [
-                "scope",
-                "keys"
-              ]
-            }
-          }
-        },
-        "required": [
-          "results"
-        ]
-      },
-      "UserSettingsScopeResponse": {
-        "type": "object",
-        "properties": {
-          "scope": {
-            "$ref": "#/components/schemas/UserSettingScope"
-          },
-          "settings": {
-            "type": "object",
-            "additionalProperties": {
-              "$ref": "#/components/schemas/UserSettingValue"
-            },
-            "example": {
-              "visible_calendars": {
-                "calendar_ids": [
-                  "holidays"
-                ]
-              }
-            }
-          }
-        },
-        "required": [
-          "scope",
-          "settings"
-        ]
-      },
       "Passkey": {
         "type": "object",
         "properties": {