@epilot/sdk 2.4.4-alpha.0 → 2.4.4

package/dist/configuration-hub.d-Cqaq2F-W.d.cts

@@ -0,0 +1,478 @@
+import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
+
+/* Auto-copied from configuration-hub-client */
+
+
+declare namespace Components {
+    namespace Parameters {
+        export type ConfigId = string;
+        export type ConfigType = /**
+         * Configuration resource type identifier.
+         * Matches blueprint-manifest-api V3 naming conventions.
+         *
+         */
+        Schemas.ResourceType;
+        export type CursorParam = string;
+        export type SizeParam = number;
+    }
+    export interface PathParameters {
+        ConfigType?: Parameters.ConfigType;
+        ConfigId?: Parameters.ConfigId;
+    }
+    export interface QueryParameters {
+        CursorParam?: Parameters.CursorParam;
+        SizeParam?: Parameters.SizeParam;
+    }
+    namespace Schemas {
+        /**
+         * Cursor-paginated list of configs referenced by a given config
+         */
+        export interface ConfigDependenciesResponse {
+            /**
+             * Total number of dependencies found (if known)
+             */
+            total?: number;
+            /**
+             * Cursor for fetching the next page. Absent when no more pages.
+             */
+            next_cursor?: string;
+            results: /* Summary metadata for a single configuration item in the tree */ ConfigNode[];
+        }
+        /**
+         * Cursor-paginated list of configs for a specific type
+         */
+        export interface ConfigListResponse {
+            type: /**
+             * Configuration resource type identifier.
+             * Matches blueprint-manifest-api V3 naming conventions.
+             *
+             */
+            ResourceType;
+            label: string;
+            icon: string;
+            /**
+             * Total number of configs of this type (if known)
+             */
+            total?: number;
+            /**
+             * Cursor for fetching the next page. Absent when no more pages.
+             */
+            next_cursor?: string;
+            results: /* Summary metadata for a single configuration item in the tree */ ConfigNode[];
+        }
+        /**
+         * Summary metadata for a single configuration item in the tree
+         */
+        export interface ConfigNode {
+            type: /**
+             * Configuration resource type identifier.
+             * Matches blueprint-manifest-api V3 naming conventions.
+             *
+             */
+            ResourceType;
+            /**
+             * Unique identifier
+             */
+            id: string;
+            /**
+             * Display name
+             */
+            title: string;
+            /**
+             * Last modified timestamp
+             */
+            updated_at?: string; // date-time
+            /**
+             * User who last modified this config
+             */
+            updated_by?: string;
+            /**
+             * Tags / labels
+             */
+            tags?: string[];
+            /**
+             * Alternative identifiers (short IDs, slugs, variable keys) used in cross-references
+             */
+            aliases?: string[];
+            /**
+             * Business purposes
+             */
+            purposes?: string[];
+            /**
+             * Direct link to open this config in epilot
+             */
+            link?: string; // uri
+            /**
+             * Type-specific metadata (e.g., submission count for journeys)
+             */
+            metadata?: {
+                [name: string]: any;
+            };
+        }
+        /**
+         * Static metadata for a config type folder in the tree.
+         * No downstream API calls — just type + label + icon + source API info.
+         *
+         */
+        export interface ConfigTypeInfo {
+            type: /**
+             * Configuration resource type identifier.
+             * Matches blueprint-manifest-api V3 naming conventions.
+             *
+             */
+            ResourceType;
+            /**
+             * Display label
+             * example:
+             * Journeys
+             */
+            label: string;
+            /**
+             * Frontend icon name
+             * example:
+             * Route
+             */
+            icon: string;
+            /**
+             * Base URL of the epilot API that owns this resource type
+             * example:
+             * https://journey.sls.epilot.io
+             */
+            source_api: string;
+            /**
+             * @epilot/sdk subpath for fetching full config payloads
+             * example:
+             * @epilot/sdk/journey
+             */
+            sdk_client: string;
+        }
+        export interface ErrorResponse {
+            status: number;
+            error: string;
+        }
+        /**
+         * Result of an index rebuild operation
+         */
+        export interface IndexRebuildResponse {
+            status: "ready" | "building" | "failed" | "already_building";
+            last_built_at?: string; // date-time
+            total_items?: number;
+            build_duration_ms?: number;
+            failed_types?: string[];
+        }
+        /**
+         * Current index build state
+         */
+        export interface IndexStatusResponse {
+            status: "missing" | "building" | "ready" | "failed";
+            last_built_at?: string; // date-time
+            total_items?: number;
+            build_duration_ms?: number;
+        }
+        /**
+         * Configuration resource type identifier.
+         * Matches blueprint-manifest-api V3 naming conventions.
+         *
+         */
+        export 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";
+    }
+}
+declare namespace Paths {
+    namespace GetConfigDependencies {
+        namespace Parameters {
+            export type Cursor = string;
+            export type Id = string;
+            export type Size = number;
+            export type Type = /**
+             * Configuration resource type identifier.
+             * Matches blueprint-manifest-api V3 naming conventions.
+             *
+             */
+            Components.Schemas.ResourceType;
+        }
+        export interface PathParameters {
+            type: Parameters.Type;
+            id: Parameters.Id;
+        }
+        export interface QueryParameters {
+            cursor?: Parameters.Cursor;
+            size?: Parameters.Size;
+        }
+        namespace Responses {
+            export type $200 = /* Cursor-paginated list of configs referenced by a given config */ Components.Schemas.ConfigDependenciesResponse;
+            export type $404 = Components.Schemas.ErrorResponse;
+        }
+    }
+    namespace GetConfigUsedBy {
+        namespace Parameters {
+            export type Id = string;
+            export type Type = /**
+             * Configuration resource type identifier.
+             * Matches blueprint-manifest-api V3 naming conventions.
+             *
+             */
+            Components.Schemas.ResourceType;
+        }
+        export interface PathParameters {
+            type: Parameters.Type;
+            id: Parameters.Id;
+        }
+        namespace Responses {
+            export type $200 = /* Cursor-paginated list of configs referenced by a given config */ Components.Schemas.ConfigDependenciesResponse;
+        }
+    }
+    namespace GetIndex {
+        namespace Responses {
+            export type $200 = /* Current index build state */ Components.Schemas.IndexStatusResponse;
+        }
+    }
+    namespace ListConfigTypes {
+        namespace Responses {
+            export interface $200 {
+                results: /**
+                 * Static metadata for a config type folder in the tree.
+                 * No downstream API calls — just type + label + icon + source API info.
+                 *
+                 */
+                Components.Schemas.ConfigTypeInfo[];
+            }
+        }
+    }
+    namespace ListConfigs {
+        namespace Parameters {
+            export type ActiveOnly = boolean;
+            export type BlueprintIds = string;
+            export type Cursor = string;
+            export type Purposes = string;
+            export type Q = string;
+            export type Size = number;
+            export type Sort = "updated_at" | "usage";
+            export type Type = /**
+             * Configuration resource type identifier.
+             * Matches blueprint-manifest-api V3 naming conventions.
+             *
+             */
+            Components.Schemas.ResourceType;
+            export type UpdatedAfter = string; // date-time
+            export type UpdatedBefore = string; // date-time
+        }
+        export interface PathParameters {
+            type: Parameters.Type;
+        }
+        export interface QueryParameters {
+            cursor?: Parameters.Cursor;
+            size?: Parameters.Size;
+            q?: Parameters.Q;
+            updated_after?: Parameters.UpdatedAfter /* date-time */;
+            updated_before?: Parameters.UpdatedBefore /* date-time */;
+            purposes?: Parameters.Purposes;
+            blueprint_ids?: Parameters.BlueprintIds;
+            sort?: Parameters.Sort;
+            active_only?: Parameters.ActiveOnly;
+        }
+        namespace Responses {
+            export type $200 = /* Cursor-paginated list of configs for a specific type */ Components.Schemas.ConfigListResponse;
+            export type $400 = Components.Schemas.ErrorResponse;
+        }
+    }
+    namespace RebuildIndex {
+        namespace Responses {
+            export type $200 = /* Result of an index rebuild operation */ Components.Schemas.IndexRebuildResponse;
+        }
+    }
+}
+
+
+interface OperationMethods {
+  /**
+   * listConfigTypes - listConfigTypes
+   * 
+   * Returns the static list of available configuration types with display metadata.
+   * This is a cheap call — no fan-out to downstream APIs. Returns all known types
+   * with labels and icons. The frontend should then call `listConfigs` separately
+   * for each type it wants to load.
+   * 
+   */
+  'listConfigTypes'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ListConfigTypes.Responses.$200>
+  /**
+   * listConfigs - listConfigs
+   * 
+   * List configs of a given type with pagination. Returns summary metadata only
+   * (not full payloads). The frontend calls this per type folder when expanding.
+   * 
+   * Supports offset-based pagination via `from` and `size` parameters.
+   * 
+   */
+  'listConfigs'(
+    parameters?: Parameters<Paths.ListConfigs.QueryParameters & Paths.ListConfigs.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ListConfigs.Responses.$200>
+  /**
+   * getConfigDependencies - getConfigDependencies
+   * 
+   * Get configs that are referenced by the given config.
+   * Used to render children when expanding a config node in the tree.
+   * 
+   * Resolves dependencies by fetching the config payload server-side and scanning
+   * for references (UUIDs, source IDs, slug-based references).
+   * 
+   */
+  'getConfigDependencies'(
+    parameters?: Parameters<Paths.GetConfigDependencies.QueryParameters & Paths.GetConfigDependencies.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetConfigDependencies.Responses.$200>
+  /**
+   * getConfigUsedBy - getConfigUsedBy
+   * 
+   * Get configs that reference the given config (reverse dependencies).
+   * Scans the indexed config items for references to this config's ID or aliases.
+   * 
+   */
+  'getConfigUsedBy'(
+    parameters?: Parameters<Paths.GetConfigUsedBy.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetConfigUsedBy.Responses.$200>
+  /**
+   * getIndex - 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.
+   * 
+   */
+  'getIndex'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetIndex.Responses.$200>
+  /**
+   * rebuildIndex - rebuildIndex
+   * 
+   * Rebuild the configuration index for the caller's organization.
+   * Fire-and-forget: invokes the async worker and returns immediately.
+   * A new rebuild will cancel any in-flight build (see `build_token`).
+   * 
+   */
+  'rebuildIndex'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.RebuildIndex.Responses.$200>
+}
+
+interface PathsDictionary {
+  ['/v1/configs/types']: {
+    /**
+     * listConfigTypes - listConfigTypes
+     * 
+     * Returns the static list of available configuration types with display metadata.
+     * This is a cheap call — no fan-out to downstream APIs. Returns all known types
+     * with labels and icons. The frontend should then call `listConfigs` separately
+     * for each type it wants to load.
+     * 
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ListConfigTypes.Responses.$200>
+  }
+  ['/v1/configs/{type}']: {
+    /**
+     * listConfigs - listConfigs
+     * 
+     * List configs of a given type with pagination. Returns summary metadata only
+     * (not full payloads). The frontend calls this per type folder when expanding.
+     * 
+     * Supports offset-based pagination via `from` and `size` parameters.
+     * 
+     */
+    'get'(
+      parameters?: Parameters<Paths.ListConfigs.QueryParameters & Paths.ListConfigs.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ListConfigs.Responses.$200>
+  }
+  ['/v1/configs/{type}/{id}/dependencies']: {
+    /**
+     * getConfigDependencies - getConfigDependencies
+     * 
+     * Get configs that are referenced by the given config.
+     * Used to render children when expanding a config node in the tree.
+     * 
+     * Resolves dependencies by fetching the config payload server-side and scanning
+     * for references (UUIDs, source IDs, slug-based references).
+     * 
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetConfigDependencies.QueryParameters & Paths.GetConfigDependencies.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetConfigDependencies.Responses.$200>
+  }
+  ['/v1/configs/{type}/{id}/used_by']: {
+    /**
+     * getConfigUsedBy - 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'(
+      parameters?: Parameters<Paths.GetConfigUsedBy.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetConfigUsedBy.Responses.$200>
+  }
+  ['/v1/configs/index']: {
+    /**
+     * getIndex - 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'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetIndex.Responses.$200>
+  }
+  ['/v1/configs/index:rebuild']: {
+    /**
+     * rebuildIndex - rebuildIndex
+     * 
+     * Rebuild the configuration index for the caller's organization.
+     * Fire-and-forget: invokes the async worker and returns immediately.
+     * A new rebuild will cancel any in-flight build (see `build_token`).
+     * 
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.RebuildIndex.Responses.$200>
+  }
+}
+
+type Client = OpenAPIClient<OperationMethods, PathsDictionary>
+
+
+type ConfigDependenciesResponse = Components.Schemas.ConfigDependenciesResponse;
+type ConfigListResponse = Components.Schemas.ConfigListResponse;
+type ConfigNode = Components.Schemas.ConfigNode;
+type ConfigTypeInfo = Components.Schemas.ConfigTypeInfo;
+type ErrorResponse = Components.Schemas.ErrorResponse;
+type IndexRebuildResponse = Components.Schemas.IndexRebuildResponse;
+type IndexStatusResponse = Components.Schemas.IndexStatusResponse;
+type ResourceType = Components.Schemas.ResourceType;
+
+export { type Client as C, type ErrorResponse as E, type IndexRebuildResponse as I, type OperationMethods as O, Paths as P, type ResourceType as R, Components as a, type PathsDictionary as b, type ConfigDependenciesResponse as c, type ConfigListResponse as d, type ConfigNode as e, type ConfigTypeInfo as f, type IndexStatusResponse as g };