@epilot/entity-client 2.6.3 → 2.6.5-alpha.1

package/dist/openapi.d.ts

@@ -197,6 +197,10 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
             type?: "relation_address";
             has_primary?: boolean;
         }
@@ -209,7 +213,7 @@ declare namespace Components {
             download_url: string;
             alt_text?: string;
         }
-        export type Attribute = /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Currency input */ CurrencyAttribute | /* Repeatable (add N number of fields) */ RepeatableAttribute | /* Tags */ TagsAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* Custom input */ CustomAttribute | /* Partner Status */ PartnerStatusAttribute;
+        export type Attribute = /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Currency input */ CurrencyAttribute | /* Repeatable (add N number of fields) */ RepeatableAttribute | /* Tags */ TagsAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute;
         export interface BaseAttribute {
             name: string;
             label: string;
@@ -267,6 +271,10 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
         }
         /**
          * example:
@@ -366,12 +374,16 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
             type?: "boolean";
         }
         /**
-         * Consent Management
+         * An attribute that is computed from the entity data
          */
-        export interface ConsentAttribute {
+        export interface ComputedAttribute {
             name: string;
             label: string;
             placeholder?: string;
@@ -428,14 +440,16 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
-            type: "consent";
-            topic: string;
-            identifiers?: string[];
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
+            type?: "computed";
         }
         /**
-         * Country picker
+         * Consent Management
          */
-        export interface CountryAttribute {
+        export interface ConsentAttribute {
             name: string;
             label: string;
             placeholder?: string;
@@ -492,12 +506,18 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
-            type?: "country";
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
+            type: "consent";
+            topic: string;
+            identifiers?: string[];
         }
         /**
-         * Currency input
+         * Country picker
          */
-        export interface CurrencyAttribute {
+        export interface CountryAttribute {
             name: string;
             label: string;
             placeholder?: string;
@@ -554,21 +574,16 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
-            type: "currency";
             /**
-             * An array of currency configurations with a country code (ISO-4217)
+             * Setting to `true` disables editing the attribute on the entity builder UI
              */
-            currency: ({
-                code: string;
-                description: string;
-                symbol: string;
-                flag?: string;
-            })[];
+            entity_builder_disable_edit?: boolean;
+            type?: "country";
         }
         /**
-         * Custom input
+         * Currency input
          */
-        export interface CustomAttribute {
+        export interface CurrencyAttribute {
             name: string;
             label: string;
             placeholder?: string;
@@ -625,7 +640,20 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
-            type?: "custom";
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
+            type: "currency";
+            /**
+             * An array of currency configurations with a country code (ISO-4217)
+             */
+            currency: ({
+                code: string;
+                description: string;
+                symbol: string;
+                flag?: string;
+            })[];
         }
         /**
          * Date or Datetime picker
@@ -687,6 +715,10 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
             type?: "date" | "datetime";
         }
         export interface Entity {
@@ -921,6 +953,7 @@ declare namespace Components {
              * contact
              */
             EntitySlug;
+            version?: number;
             blueprint?: /* Reference to blueprint */ BlueprintEntityId /* uuid */;
             /**
              * This schema should only be active when the feature flag is enabled
@@ -980,18 +1013,18 @@ declare namespace Components {
              * }
              */
             group_settings?: {
-                [name: string]: {
-                    expanded?: boolean;
-                    /**
-                     * Render order of the group
-                     */
-                    order?: number;
-                    info_tooltip_title?: {
-                        key?: string;
-                        default?: string;
-                    };
+                label: string;
+                id: string;
+                expanded?: boolean;
+                /**
+                 * Render order of the group
+                 */
+                order?: number;
+                info_tooltip_title?: {
+                    key?: string;
+                    default?: string;
                 };
-            };
+            }[];
             /**
              * Custom grid definitions for the layout
              */
@@ -1076,6 +1109,7 @@ declare namespace Components {
              * contact
              */
             EntitySlug;
+            version?: number;
             blueprint?: /* Reference to blueprint */ BlueprintEntityId /* uuid */;
             /**
              * This schema should only be active when the feature flag is enabled
@@ -1135,18 +1169,18 @@ declare namespace Components {
              * }
              */
             group_settings?: {
-                [name: string]: {
-                    expanded?: boolean;
-                    /**
-                     * Render order of the group
-                     */
-                    order?: number;
-                    info_tooltip_title?: {
-                        key?: string;
-                        default?: string;
-                    };
+                label: string;
+                id: string;
+                expanded?: boolean;
+                /**
+                 * Render order of the group
+                 */
+                order?: number;
+                info_tooltip_title?: {
+                    key?: string;
+                    default?: string;
                 };
-            };
+            }[];
             /**
              * Custom grid definitions for the layout
              */
@@ -1355,6 +1389,10 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
             type: "image" | "file";
             multiple?: boolean;
             /**
@@ -1583,6 +1621,10 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
             type?: "internal";
         }
         /**
@@ -1645,6 +1687,10 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
             type?: "link";
         }
         /**
@@ -1707,6 +1753,10 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
             type?: "number";
             format?: string;
         }
@@ -1770,6 +1820,10 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
             type?: "ordered_list";
         }
         /**
@@ -1832,6 +1886,10 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
             type?: "partner_status";
         }
         /**
@@ -1909,6 +1967,10 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
             type?: "relation";
             relation_type?: "belongs_to" | "has_many";
             delete_mode?: "cascade";
@@ -2032,6 +2094,10 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
             repeatable?: boolean;
             has_primary?: boolean;
             relation_affinity_mode?: "weak" | "strong";
@@ -2125,6 +2191,10 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
             type?: "select" | "radio";
             options?: (string | {
                 value: string;
@@ -2204,6 +2274,10 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
             type?: "tags";
             options?: string[];
             suggestions?: string[];
@@ -2268,6 +2342,10 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
             type?: "string";
             multiline?: boolean;
         }
@@ -2331,6 +2409,10 @@ declare namespace Components {
             feature_flag?: string;
             value_formatter?: string;
             preview_value_formatter?: string;
+            /**
+             * Setting to `true` disables editing the attribute on the entity builder UI
+             */
+            entity_builder_disable_edit?: boolean;
             type?: "relation_user";
             multiple?: boolean;
         }
@@ -2693,6 +2775,24 @@ declare namespace Paths {
             export type $200 = /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem;
         }
     }
+    namespace GetSchemaVersions {
+        namespace Parameters {
+            export type Slug = /**
+             * URL-friendly identifier for the entity schema
+             * example:
+             * contact
+             */
+            Components.Schemas.EntitySlug;
+        }
+        export interface PathParameters {
+            slug: Parameters.Slug;
+        }
+        namespace Responses {
+            export interface $200 {
+                results?: /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem[];
+            }
+        }
+    }
     namespace ListSchemas {
         namespace Responses {
             export interface $200 {
@@ -2867,6 +2967,16 @@ export interface OperationMethods {
     data?: any,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.ListSchemas.Responses.$200>
+  /**
+   * getSchemaVersions - getSchemaVersions
+   * 
+   * Get all versions of this schema
+   */
+  'getSchemaVersions'(
+    parameters?: Parameters<Paths.GetSchemaVersions.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetSchemaVersions.Responses.$200>
   /**
    * getSchema - getSchema
    */
@@ -2877,6 +2987,8 @@ export interface OperationMethods {
   ): OperationResponse<Paths.GetSchema.Responses.$200>
   /**
    * putSchema - putSchema
+   * 
+   * Create new version of the schema
    */
   'putSchema'(
     parameters?: Parameters<Paths.PutSchema.PathParameters> | null,
@@ -2896,6 +3008,8 @@ export interface OperationMethods {
    * 
    * Search for entities. Supports ordering and pagination. Lucene query syntax supported for complex querying.
    * 
+   * Passing comma-separated `x-epilot-org-id` is supported for cross-org entity search.
+   * 
    * ## Relations
    * 
    * When `hydrate=true`, relation attributes are replaced in-place with nested entity values.
@@ -3210,6 +3324,18 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.ListSchemas.Responses.$200>
   }
+  ['/v1/entity/schemas/{slug}/versions']: {
+    /**
+     * getSchemaVersions - getSchemaVersions
+     * 
+     * Get all versions of this schema
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetSchemaVersions.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetSchemaVersions.Responses.$200>
+  }
   ['/v1/entity/schemas/{slug}']: {
     /**
      * getSchema - getSchema
@@ -3221,6 +3347,8 @@ export interface PathsDictionary {
     ): OperationResponse<Paths.GetSchema.Responses.$200>
     /**
      * putSchema - putSchema
+     * 
+     * Create new version of the schema
      */
     'put'(
       parameters?: Parameters<Paths.PutSchema.PathParameters> | null,
@@ -3242,6 +3370,8 @@ export interface PathsDictionary {
      * 
      * Search for entities. Supports ordering and pagination. Lucene query syntax supported for complex querying.
      * 
+     * Passing comma-separated `x-epilot-org-id` is supported for cross-org entity search.
+     * 
      * ## Relations
      * 
      * When `hydrate=true`, relation attributes are replaced in-place with nested entity values.

package/dist/openapi.json

@@ -57,6 +57,46 @@
                 }
             }
         },
+        "/v1/entity/schemas/{slug}/versions": {
+            "get": {
+                "operationId": "getSchemaVersions",
+                "summary": "getSchemaVersions",
+                "description": "Get all versions of this schema",
+                "tags": [
+                    "Schemas"
+                ],
+                "parameters": [
+                    {
+                        "in": "path",
+                        "name": "slug",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/components/schemas/EntitySlug"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Success",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "properties": {
+                                        "results": {
+                                            "type": "array",
+                                            "items": {
+                                                "$ref": "#/components/schemas/EntitySchemaItem"
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "/v1/entity/schemas/{slug}": {
             "get": {
                 "operationId": "getSchema",
@@ -90,6 +130,7 @@
             "put": {
                 "operationId": "putSchema",
                 "summary": "putSchema",
+                "description": "Create new version of the schema",
                 "tags": [
                     "Schemas"
                 ],
@@ -152,7 +193,7 @@
             "post": {
                 "operationId": "searchEntities",
                 "summary": "searchEntities",
-                "description": "Search for entities. Supports ordering and pagination. Lucene query syntax supported for complex querying.\n\n## Relations\n\nWhen `hydrate=true`, relation attributes are replaced in-place with nested entity values.\n\nExample:\n```json\n{\n  \"_id\": \"123\",\n  \"name\": \"parent\",\n  \"_tags\": [\"parent\"],\n  \"contacts\": {\n    \"$relation\": [\n      { \"entity_id\": \"456\", \"_tags\": [\"primary\"] },\n      { \"entity_id\": \"789\", \"_tags\": [\"secondary\"] },\n    ]\n  }\n}\n```\n\nBecomes:\n```json\n{\n  \"_id\": \"123\",\n  \"name\": \"parent\",\n  \"_tags\": [\"parent\"],\n  \"contacts\": [\n    {\n      \"$relation\": { \"entity_id\": \"456\", \"_tags\": [\"primary\"] },\n      \"_id\": \"456\",\n      \"name\": \"child 1\",\n      \"_tags\": [\"child\"]\n    },\n    {\n      \"$relation\": { \"entity_id\": \"789\", \"_tags\": [\"secondary\"] },\n      \"_id\": \"789\",\n      \"name\": \"child 2\",\n      \"_tags\": [\"child\"]\n    }\n  ]\n}\n```\n",
+                "description": "Search for entities. Supports ordering and pagination. Lucene query syntax supported for complex querying.\n\nPassing comma-separated `x-epilot-org-id` is supported for cross-org entity search.\n\n## Relations\n\nWhen `hydrate=true`, relation attributes are replaced in-place with nested entity values.\n\nExample:\n```json\n{\n  \"_id\": \"123\",\n  \"name\": \"parent\",\n  \"_tags\": [\"parent\"],\n  \"contacts\": {\n    \"$relation\": [\n      { \"entity_id\": \"456\", \"_tags\": [\"primary\"] },\n      { \"entity_id\": \"789\", \"_tags\": [\"secondary\"] },\n    ]\n  }\n}\n```\n\nBecomes:\n```json\n{\n  \"_id\": \"123\",\n  \"name\": \"parent\",\n  \"_tags\": [\"parent\"],\n  \"contacts\": [\n    {\n      \"$relation\": { \"entity_id\": \"456\", \"_tags\": [\"primary\"] },\n      \"_id\": \"456\",\n      \"name\": \"child 1\",\n      \"_tags\": [\"child\"]\n    },\n    {\n      \"$relation\": { \"entity_id\": \"789\", \"_tags\": [\"secondary\"] },\n      \"_id\": \"789\",\n      \"name\": \"child 2\",\n      \"_tags\": [\"child\"]\n    }\n  ]\n}\n```\n",
                 "tags": [
                     "Entities"
                 ],
@@ -1141,6 +1182,10 @@
                     "slug": {
                         "$ref": "#/components/schemas/EntitySlug"
                     },
+                    "version": {
+                        "type": "integer",
+                        "minimum": 1
+                    },
                     "blueprint": {
                         "$ref": "#/components/schemas/BlueprintEntityId"
                     },
@@ -1209,11 +1254,17 @@
                         }
                     },
                     "group_settings": {
-                        "type": "object",
+                        "type": "array",
                         "description": "A dictionary of Group Titles and associated settings if present.",
-                        "additionalProperties": {
+                        "items": {
                             "type": "object",
                             "properties": {
+                                "label": {
+                                    "type": "string"
+                                },
+                                "id": {
+                                    "type": "string"
+                                },
                                 "expanded": {
                                     "type": "boolean"
                                 },
@@ -1233,7 +1284,11 @@
                                         }
                                     }
                                 }
-                            }
+                            },
+                            "required": [
+                                "label",
+                                "id"
+                            ]
                         },
                         "example": {
                             "Order Info": {
@@ -1399,7 +1454,7 @@
                         "$ref": "#/components/schemas/FileAttribute"
                     },
                     {
-                        "$ref": "#/components/schemas/CustomAttribute"
+                        "$ref": "#/components/schemas/ComputedAttribute"
                     },
                     {
                         "$ref": "#/components/schemas/PartnerStatusAttribute"
@@ -1497,6 +1552,11 @@
                     },
                     "preview_value_formatter": {
                         "type": "string"
+                    },
+                    "entity_builder_disable_edit": {
+                        "description": "Setting to `true` disables editing the attribute on the entity builder UI",
+                        "type": "boolean",
+                        "default": false
                     }
                 },
                 "required": [
@@ -2061,19 +2121,19 @@
                     }
                 ]
             },
-            "CustomAttribute": {
+            "ComputedAttribute": {
                 "allOf": [
                     {
                         "$ref": "#/components/schemas/BaseAttribute"
                     },
                     {
                         "type": "object",
-                        "description": "Custom input",
+                        "description": "An attribute that is computed from the entity data",
                         "properties": {
                             "type": {
                                 "type": "string",
                                 "enum": [
-                                    "custom"
+                                    "computed"
                                 ]
                             }
                         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/entity-client",
-  "version": "2.6.3",
+  "version": "2.6.5-alpha.1",
   "description": "JavaScript client library for the epilot Core Entity API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",