@epilot/sdk 2.3.10 → 2.4.0

package/definitions/configuration-hub-runtime.json

@@ -1 +0,0 @@
-{"s":"https://configuration-hub.sls.epilot.io","o":[["listConfigTypes","get","/v1/configs/types"],["listConfigs","get","/v1/configs/{type}",[["ConfigType"],["CursorParam"],["SizeParam"],["q","q"],["updated_after","q"],["updated_before","q"],["purposes","q"],["blueprint_ids","q"],["sort","q"],["active_only","q"]]],["getConfigDependencies","get","/v1/configs/{type}/{id}/dependencies",[["ConfigType"],["ConfigId"],["CursorParam"],["SizeParam"]]],["getConfigUsedBy","get","/v1/configs/{type}/{id}/used_by",[["ConfigType"],["ConfigId"]]],["getIndex","get","/v1/configs/index"],["rebuildIndex","post","/v1/configs/index:rebuild"]],"v":"3.0.3","cp":{"ConfigType":["type","p",true],"ConfigId":["id","p",true],"CursorParam":["cursor","q"],"SizeParam":["size","q"]}}

package/definitions/configuration-hub.json

@@ -1,611 +0,0 @@
-{
-  "openapi": "3.0.3",
-  "info": {
-    "title": "Configuration Hub API",
-    "description": "Lightweight index API for exploring epilot organization configurations.\n\nProvides a unified tree view across all config types. Returns summary metadata only —\nthe frontend calls individual epilot APIs directly (via @epilot/sdk) for full config payloads.\n\n## Source APIs per resource type\n\nEach resource type maps to a specific epilot API. The frontend should use the corresponding\n@epilot/sdk client to fetch full config details (e.g., for the side panel JSON view).\n\n| Resource Type | Source API | SDK Client |\n|---|---|---|\n| `journey` | journey.sls.epilot.io | `@epilot/sdk/journey` |\n| `automation_flow` | automation.sls.epilot.io | `@epilot/sdk/automation` |\n| `workflow_definition` | workflow-definition.sls.epilot.io | `@epilot/sdk/workflow-definition` |\n| `closing_reason` | workflow-definition.sls.epilot.io | `@epilot/sdk/workflow-definition` |\n| `flow_template` | workflow-definition.sls.epilot.io | `@epilot/sdk/workflow-definition` |\n| `schema` | entity.sls.epilot.io | `@epilot/sdk/entity` |\n| `taxonomy` | entity.sls.epilot.io | `@epilot/sdk/entity` |\n| `taxonomy_classification` | entity.sls.epilot.io | `@epilot/sdk/entity` |\n| `emailtemplate` | entity.sls.epilot.io | `@epilot/sdk/entity` |\n| `product` | entity.sls.epilot.io | `@epilot/sdk/entity` |\n| `price` | entity.sls.epilot.io | `@epilot/sdk/entity` |\n| `tax` | entity.sls.epilot.io | `@epilot/sdk/entity` |\n| `coupon` | entity.sls.epilot.io | `@epilot/sdk/entity` |\n| `file` | entity.sls.epilot.io | `@epilot/sdk/entity` |\n| `document_template` | entity.sls.epilot.io | `@epilot/sdk/entity` |\n| `webhook` | webhooks.sls.epilot.io | `@epilot/sdk/webhooks` |\n| `saved_view` | entity.sls.epilot.io | `@epilot/sdk/entity` |\n| `dashboard` | entity.sls.epilot.io | `@epilot/sdk/entity` |\n| `kanban` | kanban.sls.epilot.io | `@epilot/sdk/kanban` |\n| `role` | permissions.sls.epilot.io | `@epilot/sdk/permissions` |\n| `usergroup` | user.sls.epilot.io | `@epilot/sdk/user` |\n| `validation_rule` | entity.sls.epilot.io | `@epilot/sdk/validation-rules` |\n| `integration` | entity.sls.epilot.io | `@epilot/sdk/entity` |\n| `app` | entity.sls.epilot.io | `@epilot/sdk/entity` |\n| `designbuilder` | design-builder-api.sls.epilot.io | `@epilot/sdk/design` |\n| `notification_template` | entity.sls.epilot.io | `@epilot/sdk/entity` |\n| `custom_variable` | entity.sls.epilot.io | `@epilot/sdk/template-variables` |\n| `environment_variable` | environments.sls.epilot.io | `@epilot/sdk/environments` |\n| `entity_mapping` | entity-mapping.sls.epilot.io | `@epilot/sdk/entity-mapping` |\n| `portal_config` | customer-portal.sls.epilot.io | `@epilot/sdk/customer-portal` |\n| `target` | entity.sls.epilot.io | `@epilot/sdk/entity` |\n| `product_recommendation` | entity.sls.epilot.io | `@epilot/sdk/entity` |\n| `access_token` | access-token.sls.epilot.io | `@epilot/sdk/access-token` |\n",
-    "version": "0.2.0"
-  },
-  "servers": [
-    {
-      "url": "https://configuration-hub.sls.epilot.io"
-    },
-    {
-      "url": "https://configuration-hub.dev.sls.epilot.io",
-      "description": "Dev"
-    }
-  ],
-  "security": [
-    {
-      "EpilotAuth": []
-    }
-  ],
-  "tags": [
-    {
-      "name": "Configs",
-      "description": "Configuration tree index"
-    }
-  ],
-  "paths": {
-    "/v1/configs/types": {
-      "get": {
-        "operationId": "listConfigTypes",
-        "summary": "listConfigTypes",
-        "description": "Returns the static list of available configuration types with display metadata.\nThis is a cheap call — no fan-out to downstream APIs. Returns all known types\nwith labels and icons. The frontend should then call `listConfigs` separately\nfor each type it wants to load.\n",
-        "tags": [
-          "Configs"
-        ],
-        "responses": {
-          "200": {
-            "description": "Available config types",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "results": {
-                      "type": "array",
-                      "items": {
-                        "$ref": "#/components/schemas/ConfigTypeInfo"
-                      }
-                    }
-                  },
-                  "required": [
-                    "results"
-                  ]
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "/v1/configs/{type}": {
-      "get": {
-        "operationId": "listConfigs",
-        "summary": "listConfigs",
-        "description": "List configs of a given type with pagination. Returns summary metadata only\n(not full payloads). The frontend calls this per type folder when expanding.\n\nSupports offset-based pagination via `from` and `size` parameters.\n",
-        "tags": [
-          "Configs"
-        ],
-        "parameters": [
-          {
-            "$ref": "#/components/parameters/ConfigType"
-          },
-          {
-            "$ref": "#/components/parameters/CursorParam"
-          },
-          {
-            "$ref": "#/components/parameters/SizeParam"
-          },
-          {
-            "name": "q",
-            "in": "query",
-            "description": "Search query to filter configs by name/title",
-            "schema": {
-              "type": "string"
-            }
-          },
-          {
-            "name": "updated_after",
-            "in": "query",
-            "description": "Filter configs updated after this date (ISO 8601)",
-            "schema": {
-              "type": "string",
-              "format": "date-time"
-            }
-          },
-          {
-            "name": "updated_before",
-            "in": "query",
-            "description": "Filter configs updated before this date (ISO 8601)",
-            "schema": {
-              "type": "string",
-              "format": "date-time"
-            }
-          },
-          {
-            "name": "purposes",
-            "in": "query",
-            "description": "Filter by purpose classification IDs (comma-separated)",
-            "schema": {
-              "type": "string"
-            }
-          },
-          {
-            "name": "blueprint_ids",
-            "in": "query",
-            "description": "Filter by installed-blueprint IDs (comma-separated). Only configs installed by one of the listed blueprints are returned.",
-            "schema": {
-              "type": "string"
-            }
-          },
-          {
-            "name": "sort",
-            "in": "query",
-            "description": "Sort order. `updated_at` (default) sorts by most recently modified.\n`usage` sorts by the type-specific usage metric descending\n(submissions for journeys, executions for automations, entities for schemas, etc.).\n",
-            "schema": {
-              "type": "string",
-              "enum": [
-                "updated_at",
-                "usage"
-              ],
-              "default": "updated_at"
-            }
-          },
-          {
-            "name": "active_only",
-            "in": "query",
-            "description": "If true, filter out configs that are explicitly inactive (active=false).\nConfigs with no `active` field are always included.\n",
-            "schema": {
-              "type": "boolean"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "Paginated config list",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ConfigListResponse"
-                }
-              }
-            }
-          },
-          "400": {
-            "description": "Invalid config type",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ErrorResponse"
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "/v1/configs/{type}/{id}/dependencies": {
-      "get": {
-        "operationId": "getConfigDependencies",
-        "summary": "getConfigDependencies",
-        "description": "Get configs that are referenced by the given config.\nUsed to render children when expanding a config node in the tree.\n\nResolves dependencies by fetching the config payload server-side and scanning\nfor references (UUIDs, source IDs, slug-based references).\n",
-        "tags": [
-          "Configs"
-        ],
-        "parameters": [
-          {
-            "$ref": "#/components/parameters/ConfigType"
-          },
-          {
-            "$ref": "#/components/parameters/ConfigId"
-          },
-          {
-            "$ref": "#/components/parameters/CursorParam"
-          },
-          {
-            "$ref": "#/components/parameters/SizeParam"
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "Paginated list of referenced configs",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ConfigDependenciesResponse"
-                }
-              }
-            }
-          },
-          "404": {
-            "description": "Config not found",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ErrorResponse"
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "/v1/configs/{type}/{id}/used_by": {
-      "get": {
-        "operationId": "getConfigUsedBy",
-        "summary": "getConfigUsedBy",
-        "description": "Get configs that reference the given config (reverse dependencies).\nScans the indexed config items for references to this config's ID or aliases.\n",
-        "tags": [
-          "Configs"
-        ],
-        "parameters": [
-          {
-            "$ref": "#/components/parameters/ConfigType"
-          },
-          {
-            "$ref": "#/components/parameters/ConfigId"
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "List of configs that reference this config",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ConfigDependenciesResponse"
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "/v1/configs/index": {
-      "get": {
-        "operationId": "getIndex",
-        "summary": "getIndex",
-        "description": "Return the current index build state for the caller's organization.\nClients poll this to decide whether to show a \"building\" indicator\nand when to refetch data.\n",
-        "tags": [
-          "Configs"
-        ],
-        "responses": {
-          "200": {
-            "description": "Current index status",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/IndexStatusResponse"
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "/v1/configs/index:rebuild": {
-      "post": {
-        "operationId": "rebuildIndex",
-        "summary": "rebuildIndex",
-        "description": "Rebuild the configuration index for the caller's organization.\nFire-and-forget: invokes the async worker and returns immediately.\nA new rebuild will cancel any in-flight build (see `build_token`).\n",
-        "tags": [
-          "Configs"
-        ],
-        "responses": {
-          "200": {
-            "description": "Index build status",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/IndexRebuildResponse"
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-  },
-  "components": {
-    "securitySchemes": {
-      "EpilotAuth": {
-        "type": "http",
-        "scheme": "bearer",
-        "description": "epilot JWT auth token"
-      }
-    },
-    "parameters": {
-      "ConfigType": {
-        "name": "type",
-        "in": "path",
-        "required": true,
-        "description": "Configuration resource type",
-        "schema": {
-          "$ref": "#/components/schemas/ResourceType"
-        }
-      },
-      "ConfigId": {
-        "name": "id",
-        "in": "path",
-        "required": true,
-        "description": "Configuration resource ID",
-        "schema": {
-          "type": "string"
-        }
-      },
-      "CursorParam": {
-        "name": "cursor",
-        "in": "query",
-        "description": "Opaque cursor for fetching the next page. Omit for the first page.",
-        "schema": {
-          "type": "string"
-        }
-      },
-      "SizeParam": {
-        "name": "size",
-        "in": "query",
-        "description": "Number of items per page",
-        "schema": {
-          "type": "integer",
-          "default": 25,
-          "minimum": 1,
-          "maximum": 100
-        }
-      }
-    },
-    "schemas": {
-      "ResourceType": {
-        "type": "string",
-        "description": "Configuration resource type identifier.\nMatches blueprint-manifest-api V3 naming conventions.\n",
-        "enum": [
-          "journey",
-          "automation_flow",
-          "workflow_definition",
-          "closing_reason",
-          "flow_template",
-          "schema",
-          "emailtemplate",
-          "product",
-          "price",
-          "tax",
-          "coupon",
-          "file",
-          "document_template",
-          "webhook",
-          "saved_view",
-          "dashboard",
-          "kanban",
-          "role",
-          "usergroup",
-          "validation_rule",
-          "integration",
-          "app",
-          "designbuilder",
-          "notification_template",
-          "custom_variable",
-          "environment_variable",
-          "taxonomy",
-          "taxonomy_classification",
-          "entity_mapping",
-          "portal_config",
-          "target",
-          "product_recommendation",
-          "access_token"
-        ]
-      },
-      "ConfigTypeInfo": {
-        "type": "object",
-        "description": "Static metadata for a config type folder in the tree.\nNo downstream API calls — just type + label + icon + source API info.\n",
-        "properties": {
-          "type": {
-            "$ref": "#/components/schemas/ResourceType"
-          },
-          "label": {
-            "type": "string",
-            "description": "Display label",
-            "example": "Journeys"
-          },
-          "icon": {
-            "type": "string",
-            "description": "Frontend icon name",
-            "example": "Route"
-          },
-          "source_api": {
-            "type": "string",
-            "description": "Base URL of the epilot API that owns this resource type",
-            "example": "https://journey.sls.epilot.io"
-          },
-          "sdk_client": {
-            "type": "string",
-            "description": "@epilot/sdk subpath for fetching full config payloads",
-            "example": "@epilot/sdk/journey"
-          }
-        },
-        "required": [
-          "type",
-          "label",
-          "icon",
-          "source_api",
-          "sdk_client"
-        ]
-      },
-      "ConfigNode": {
-        "type": "object",
-        "description": "Summary metadata for a single configuration item in the tree",
-        "properties": {
-          "type": {
-            "$ref": "#/components/schemas/ResourceType"
-          },
-          "id": {
-            "type": "string",
-            "description": "Unique identifier"
-          },
-          "title": {
-            "type": "string",
-            "description": "Display name"
-          },
-          "updated_at": {
-            "type": "string",
-            "format": "date-time",
-            "description": "Last modified timestamp"
-          },
-          "updated_by": {
-            "type": "string",
-            "description": "User who last modified this config"
-          },
-          "tags": {
-            "type": "array",
-            "items": {
-              "type": "string"
-            },
-            "description": "Tags / labels"
-          },
-          "aliases": {
-            "type": "array",
-            "items": {
-              "type": "string"
-            },
-            "description": "Alternative identifiers (short IDs, slugs, variable keys) used in cross-references"
-          },
-          "purposes": {
-            "type": "array",
-            "items": {
-              "type": "string"
-            },
-            "description": "Business purposes"
-          },
-          "link": {
-            "type": "string",
-            "format": "uri",
-            "description": "Direct link to open this config in epilot"
-          },
-          "metadata": {
-            "type": "object",
-            "description": "Type-specific metadata (e.g., submission count for journeys)",
-            "additionalProperties": true
-          }
-        },
-        "required": [
-          "type",
-          "id",
-          "title"
-        ]
-      },
-      "ConfigListResponse": {
-        "type": "object",
-        "description": "Cursor-paginated list of configs for a specific type",
-        "properties": {
-          "type": {
-            "$ref": "#/components/schemas/ResourceType"
-          },
-          "label": {
-            "type": "string"
-          },
-          "icon": {
-            "type": "string"
-          },
-          "total": {
-            "type": "integer",
-            "description": "Total number of configs of this type (if known)"
-          },
-          "next_cursor": {
-            "type": "string",
-            "description": "Cursor for fetching the next page. Absent when no more pages."
-          },
-          "results": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/ConfigNode"
-            }
-          }
-        },
-        "required": [
-          "type",
-          "label",
-          "icon",
-          "results"
-        ]
-      },
-      "ConfigDependenciesResponse": {
-        "type": "object",
-        "description": "Cursor-paginated list of configs referenced by a given config",
-        "properties": {
-          "total": {
-            "type": "integer",
-            "description": "Total number of dependencies found (if known)"
-          },
-          "next_cursor": {
-            "type": "string",
-            "description": "Cursor for fetching the next page. Absent when no more pages."
-          },
-          "results": {
-            "type": "array",
-            "items": {
-              "$ref": "#/components/schemas/ConfigNode"
-            }
-          }
-        },
-        "required": [
-          "results"
-        ]
-      },
-      "IndexRebuildResponse": {
-        "type": "object",
-        "description": "Result of an index rebuild operation",
-        "properties": {
-          "status": {
-            "type": "string",
-            "enum": [
-              "ready",
-              "building",
-              "failed",
-              "already_building"
-            ]
-          },
-          "last_built_at": {
-            "type": "string",
-            "format": "date-time"
-          },
-          "total_items": {
-            "type": "integer"
-          },
-          "build_duration_ms": {
-            "type": "integer"
-          },
-          "failed_types": {
-            "type": "array",
-            "items": {
-              "type": "string"
-            }
-          }
-        },
-        "required": [
-          "status"
-        ]
-      },
-      "IndexStatusResponse": {
-        "type": "object",
-        "description": "Current index build state",
-        "properties": {
-          "status": {
-            "type": "string",
-            "enum": [
-              "missing",
-              "building",
-              "ready",
-              "failed"
-            ]
-          },
-          "last_built_at": {
-            "type": "string",
-            "format": "date-time"
-          },
-          "total_items": {
-            "type": "integer"
-          },
-          "build_duration_ms": {
-            "type": "integer"
-          }
-        },
-        "required": [
-          "status"
-        ]
-      },
-      "ErrorResponse": {
-        "type": "object",
-        "properties": {
-          "status": {
-            "type": "integer"
-          },
-          "error": {
-            "type": "string"
-          }
-        },
-        "required": [
-          "status",
-          "error"
-        ]
-      }
-    }
-  }
-}

package/definitions/consent-runtime.json

@@ -1 +0,0 @@
-{"s":"https://consent.sls.epilot.io","o":[["publishConsentEvent","post","/v1/consent/publish",null,1],["listConsentEvents","get","/v1/consent/{identifier}",[["identifier","p",true],["topic","q"],["limit","q"],["from","q"]]],["handleOptInWithToken","get","/v1/opt-in/{token}",[["token","p",true],["lang","q"]]]],"v":"3.0.3"}