@epilot/sdk 2.3.9 → 2.4.0

package/docs/configuration-hub.md

@@ -28,8 +28,8 @@ const { data } = await configurationHubClient.listConfigTypes(...)
 - [`listConfigTypes`](#listconfigtypes)
 - [`listConfigs`](#listconfigs)
 - [`getConfigDependencies`](#getconfigdependencies)
-
-**Index**
+- [`getConfigUsedBy`](#getconfigusedby)
+- [`getIndex`](#getindex)
 - [`rebuildIndex`](#rebuildindex)
 
 **Schemas**
@@ -39,6 +39,7 @@ const { data } = await configurationHubClient.listConfigTypes(...)
 - [`ConfigListResponse`](#configlistresponse)
 - [`ConfigDependenciesResponse`](#configdependenciesresponse)
 - [`IndexRebuildResponse`](#indexrebuildresponse)
+- [`IndexStatusResponse`](#indexstatusresponse)
 - [`ErrorResponse`](#errorresponse)
 
 ### `listConfigTypes`
@@ -90,6 +91,9 @@ const { data } = await client.listConfigs({
   updated_after: 'example',
   updated_before: 'example',
   purposes: 'example',
+  blueprint_ids: 'example',
+  sort: 'example',
+  active_only: true,
 })
 ```
 
@@ -103,7 +107,7 @@ const { data } = await client.listConfigs({
   "icon": "string",
   "total": 0,
   "next_cursor": "string",
-  "items": [
+  "results": [
     {
       "type": "journey",
       "id": "string",
@@ -111,8 +115,10 @@ const { data } = await client.listConfigs({
       "updated_at": "1970-01-01T00:00:00.000Z",
       "updated_by": "string",
       "tags": ["string"],
+      "aliases": ["string"],
       "purposes": ["string"],
-      "link": "https://example.com/path"
+      "link": "https://example.com/path",
+      "metadata": {}
     }
   ]
 }
@@ -153,8 +159,52 @@ const { data } = await client.getConfigDependencies({
       "updated_at": "1970-01-01T00:00:00.000Z",
       "updated_by": "string",
       "tags": ["string"],
+      "aliases": ["string"],
+      "purposes": ["string"],
+      "link": "https://example.com/path",
+      "metadata": {}
+    }
+  ]
+}
+```
+
+</details>
+
+---
+
+### `getConfigUsedBy`
+
+Get configs that reference the given config (reverse dependencies).
+Scans the indexed config items for references to this config's ID or aliases.
+
+`GET /v1/configs/{type}/{id}/used_by`
+
+```ts
+const { data } = await client.getConfigUsedBy({
+  type: 'example',
+  id: '123e4567-e89b-12d3-a456-426614174000',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "total": 0,
+  "next_cursor": "string",
+  "results": [
+    {
+      "type": "journey",
+      "id": "string",
+      "title": "string",
+      "updated_at": "1970-01-01T00:00:00.000Z",
+      "updated_by": "string",
+      "tags": ["string"],
+      "aliases": ["string"],
       "purposes": ["string"],
-      "link": "https://example.com/path"
+      "link": "https://example.com/path",
+      "metadata": {}
     }
   ]
 }
@@ -164,13 +214,41 @@ const { data } = await client.getConfigDependencies({
 
 ---
 
+### `getIndex`
+
+Return the current index build state for the caller's organization.
+Clients poll this to decide whether to show a "building" indicator
+and when to refetch data.
+
+`GET /v1/configs/index`
+
+```ts
+const { data } = await client.getIndex()
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "status": "missing",
+  "last_built_at": "1970-01-01T00:00:00.000Z",
+  "total_items": 0,
+  "build_duration_ms": 0
+}
+```
+
+</details>
+
+---
+
 ### `rebuildIndex`
 
 Rebuild the configuration index for the caller's organization.
-Calls all adapter APIs in parallel and stores results in DynamoDB.
-If a build is already in progress (within 60s), returns immediately.
+Fire-and-forget: invokes the async worker and returns immediately.
+A new rebuild will cancel any in-flight build (see `build_token`).
 
-`POST /v1/index/rebuild`
+`POST /v1/configs/index:rebuild`
 
 ```ts
 const { data } = await client.rebuildIndex()
@@ -202,7 +280,7 @@ Matches blueprint-manifest-api V3 naming conventions.
 
 
 ```ts
-type ResourceType = "journey" | "automation_flow" | "workflow_definition" | "closing_reason" | "flow_template" | "schema" | "emailtemplate" | "product" | "price" | "tax" | "coupon" | "file" | "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"
+type ResourceType = "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`
@@ -213,7 +291,7 @@ No downstream API calls — just type + label + icon + source API info.
 
 ```ts
 type ConfigTypeInfo = {
-  type: "journey" | "automation_flow" | "workflow_definition" | "closing_reason" | "flow_template" | "schema" | "emailtemplate" | "product" | "price" | "tax" | "coupon" | "file" | "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"
+  type: "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"
   label: string
   icon: string
   source_api: string
@@ -227,14 +305,16 @@ Summary metadata for a single configuration item in the tree
 
 ```ts
 type ConfigNode = {
-  type: "journey" | "automation_flow" | "workflow_definition" | "closing_reason" | "flow_template" | "schema" | "emailtemplate" | "product" | "price" | "tax" | "coupon" | "file" | "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"
+  type: "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"
   id: string
   title: string
   updated_at?: string // date-time
   updated_by?: string
   tags?: string[]
+  aliases?: string[]
   purposes?: string[]
   link?: string // uri
+  metadata?: Record<string, unknown>
 }
 ```
 
@@ -244,20 +324,22 @@ Cursor-paginated list of configs for a specific type
 
 ```ts
 type ConfigListResponse = {
-  type: "journey" | "automation_flow" | "workflow_definition" | "closing_reason" | "flow_template" | "schema" | "emailtemplate" | "product" | "price" | "tax" | "coupon" | "file" | "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"
+  type: "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"
   label: string
   icon: string
   total?: number
   next_cursor?: string
-  items: Array<{
-    type: "journey" | "automation_flow" | "workflow_definition" | "closing_reason" | "flow_template" | "schema" | "emailtemplate" | "product" | "price" | "tax" | "coupon" | "file" | "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"
+  results: Array<{
+    type: "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"
     id: string
     title: string
     updated_at?: string // date-time
     updated_by?: string
     tags?: string[]
+    aliases?: string[]
     purposes?: string[]
     link?: string // uri
+    metadata?: Record<string, unknown>
   }>
 }
 ```
@@ -271,14 +353,16 @@ type ConfigDependenciesResponse = {
   total?: number
   next_cursor?: string
   results: Array<{
-    type: "journey" | "automation_flow" | "workflow_definition" | "closing_reason" | "flow_template" | "schema" | "emailtemplate" | "product" | "price" | "tax" | "coupon" | "file" | "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"
+    type: "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"
     id: string
     title: string
     updated_at?: string // date-time
     updated_by?: string
     tags?: string[]
+    aliases?: string[]
     purposes?: string[]
     link?: string // uri
+    metadata?: Record<string, unknown>
   }>
 }
 ```
@@ -297,6 +381,19 @@ type IndexRebuildResponse = {
 }
 ```
 
+### `IndexStatusResponse`
+
+Current index build state
+
+```ts
+type IndexStatusResponse = {
+  status: "missing" | "building" | "ready" | "failed"
+  last_built_at?: string // date-time
+  total_items?: number
+  build_duration_ms?: number
+}
+```
+
 ### `ErrorResponse`
 
 ```ts