@epilot/sdk 2.2.1 → 2.2.3

package/docs/entity.md

@@ -33,6 +33,8 @@ const { data } = await entityClient.listSchemas(...)
 - [`getJsonSchema`](#getjsonschema)
 - [`getSchemaExample`](#getschemaexample)
 - [`getSchemaVersions`](#getschemaversions)
+- [`freezeSchema`](#freezeschema)
+- [`unfreezeSchema`](#unfreezeschema)
 - [`listAvailableCapabilities`](#listavailablecapabilities)
 - [`listSchemaBlueprints`](#listschemablueprints)
 - [`listTaxonomyClassificationsForSchema`](#listtaxonomyclassificationsforschema)
@@ -263,6 +265,7 @@ Get the latest versions of all schemas
 ```ts
 const { data } = await client.listSchemas({
   unpublished: true,
+  latest: true,
   exclude: ['...'],
   include: ['...'],
 })
@@ -280,6 +283,8 @@ const { data } = await client.listSchemas({
       "updated_at": "string",
       "comment": "string",
       "source": {},
+      "frozen": true,
+      "latest": true,
       "_summary": true,
       "slug": "contact",
       "version": 1,
@@ -325,6 +330,7 @@ Use ?full=true for complete schemas.
 const { data } = await client.listSchemasV2({
   full: true,
   unpublished: true,
+  latest: true,
   exclude: ['...'],
   include: ['...'],
 })
@@ -342,6 +348,8 @@ const { data } = await client.listSchemasV2({
       "updated_at": "string",
       "comment": "string",
       "source": {},
+      "frozen": true,
+      "latest": true,
       "_summary": true,
       "slug": "contact",
       "version": 1,
@@ -377,7 +385,9 @@ const { data } = await client.listSchemasV2({
 
 ### `getSchema`
 
-By default gets the latest version of the Schema and to get the specific version of schema pass the id.
+By default gets the current version of the Schema (frozen version if frozen, otherwise latest).
+Pass ?latest=true to get the latest version when the schema is frozen.
+Pass ?id= to get a specific versi
 
 `GET /v1/entity/schemas/{slug}`
 
@@ -385,6 +395,7 @@ By default gets the latest version of the Schema and to get the specific version
 const { data } = await client.getSchema({
   slug: 'example',
   id: '123e4567-e89b-12d3-a456-426614174000',
+  latest: true,
 })
 ```
 
@@ -401,6 +412,8 @@ const { data } = await client.getSchema({
     "id": "string",
     "type": "string"
   },
+  "frozen": true,
+  "latest": true,
   "_summary": true,
   "slug": "contact",
   "version": 1,
@@ -527,7 +540,8 @@ const { data } = await client.getSchema({
 
 ### `putSchema`
 
-Create or update a schema with a new version
+Create or update a schema with a new version.
+When the schema is frozen, writes update the latest version without affecting the frozen version.
 
 `PUT /v1/entity/schemas/{slug}`
 
@@ -672,6 +686,8 @@ const { data } = await client.putSchema(
     "id": "string",
     "type": "string"
   },
+  "frozen": true,
+  "latest": true,
   "_summary": true,
   "slug": "contact",
   "version": 1,
@@ -990,6 +1006,8 @@ const { data } = await client.getSchemaVersions({
       "updated_at": "string",
       "comment": "string",
       "source": {},
+      "frozen": true,
+      "latest": true,
       "_summary": true,
       "slug": "contact",
       "version": 1,
@@ -1023,6 +1041,8 @@ const { data } = await client.getSchemaVersions({
       "updated_at": "string",
       "comment": "string",
       "source": {},
+      "frozen": true,
+      "latest": true,
       "_summary": true,
       "slug": "contact",
       "version": 1,
@@ -1050,7 +1070,317 @@ const { data } = await client.getSchemaVersions({
     }
   ],
   "versions_more": true,
-  "drafts_more": true
+  "drafts_more": true,
+  "frozen_version": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
+}
+```
+
+</details>
+
+---
+
+### `freezeSchema`
+
+Freeze a schema at its current version, or at a specific version.
+When frozen, getSchema returns the frozen version by default.
+New edits via putSchema update the latest version without affecting the 
+
+`POST /v1/entity/schemas/{slug}/freeze`
+
+```ts
+const { data } = await client.freezeSchema(
+  {
+    slug: 'example',
+  },
+  {
+    version_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+  "created_at": "string",
+  "updated_at": "string",
+  "comment": "string",
+  "source": {
+    "id": "string",
+    "type": "string"
+  },
+  "frozen": true,
+  "latest": true,
+  "_summary": true,
+  "slug": "contact",
+  "version": 1,
+  "blueprint": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+  "feature_flag": "FF_MY_FEATURE_FLAG",
+  "enable_setting": ["360_features"],
+  "name": "Contact",
+  "plural": "Contacts",
+  "description": "Example description",
+  "docs_url": "https://docs.epilot.io/docs/pricing/entities",
+  "category": "customer_relations",
+  "published": false,
+  "draft": false,
+  "icon": "person",
+  "title_template": "{{first_name}} {{last_name}}",
+  "ui_config": {
+    "table_view": {
+      "view_type": "default",
+      "row_actions": ["string"],
+      "bulk_actions": ["string"],
+      "navbar_actions": [],
+      "enable_thumbnails": false
+    },
+    "create_view": {
+      "view_type": "default",
+      "search_params": {}
+    },
+    "edit_view": {
+      "view_type": "default",
+      "search_params": {},
+      "summary_attributes": ["email"]
+    },
+    "single_view": {
+      "view_type": "default",
+      "search_params": {},
+      "summary_attributes": ["email"]
+    },
+    "list_item": {
+      "summary_attributes": [],
+      "quick_actions": [],
+      "ui_config": {}
+    },
+    "sharing": {
+      "show_sharing_button": true
+    }
+  },
+  "capabilities": [
+    {
+      "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
+      "name": "customer_messaging",
+      "title": "Messaging",
+      "attributes": [],
+      "_purpose": ["taxonomy-slug:classification-slug"],
+      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
+      "app_id": "123e4567-e89b-12d3-a456-426614174000",
+      "ui_config": {},
+      "ui_hooks": [],
+      "feature_flag": "FF_MY_FEATURE_FLAG",
+      "settings_flag": [],
+      "schemas": []
+    }
+  ],
+  "group_settings": [
+    {
+      "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
+      "label": "Contact Details",
+      "expanded": true,
+      "order": 1
+    },
+    {
+      "id": "e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e",
+      "label": "Address Details",
+      "expanded": false,
+      "order": 2,
+      "info_tooltip_title": {}
+    }
+  ],
+  "layout_settings": {
+    "grid_gap": "string",
+    "grid_template_columns": "string"
+  },
+  "dialog_config": {},
+  "attributes": [
+    {
+      "name": "email",
+      "type": "email",
+      "label": "Email",
+      "required": true
+    },
+    {
+      "name": "first_name",
+      "type": "string",
+      "label": "First Name"
+    }
+  ],
+  "_purpose": ["string"],
+  "explicit_search_mappings": {
+    "image": {
+      "type": "keyword",
+      "index": false
+    }
+  },
+  "group_headlines": [
+    {
+      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+      "name": "string",
+      "label": "string",
+      "layout": "string",
+      "group": "string",
+      "order": 0,
+      "type": "headline",
+      "enable_divider": false,
+      "divider": "top_divider",
+      "_purpose": ["taxonomy-slug:classification-slug"],
+      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
+    }
+  ]
+}
+```
+
+</details>
+
+---
+
+### `unfreezeSchema`
+
+Unfreeze a schema. Promotes the latest version to the current version for all users.
+
+`POST /v1/entity/schemas/{slug}/unfreeze`
+
+```ts
+const { data } = await client.unfreezeSchema({
+  slug: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+  "created_at": "string",
+  "updated_at": "string",
+  "comment": "string",
+  "source": {
+    "id": "string",
+    "type": "string"
+  },
+  "frozen": true,
+  "latest": true,
+  "_summary": true,
+  "slug": "contact",
+  "version": 1,
+  "blueprint": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+  "feature_flag": "FF_MY_FEATURE_FLAG",
+  "enable_setting": ["360_features"],
+  "name": "Contact",
+  "plural": "Contacts",
+  "description": "Example description",
+  "docs_url": "https://docs.epilot.io/docs/pricing/entities",
+  "category": "customer_relations",
+  "published": false,
+  "draft": false,
+  "icon": "person",
+  "title_template": "{{first_name}} {{last_name}}",
+  "ui_config": {
+    "table_view": {
+      "view_type": "default",
+      "row_actions": ["string"],
+      "bulk_actions": ["string"],
+      "navbar_actions": [],
+      "enable_thumbnails": false
+    },
+    "create_view": {
+      "view_type": "default",
+      "search_params": {}
+    },
+    "edit_view": {
+      "view_type": "default",
+      "search_params": {},
+      "summary_attributes": ["email"]
+    },
+    "single_view": {
+      "view_type": "default",
+      "search_params": {},
+      "summary_attributes": ["email"]
+    },
+    "list_item": {
+      "summary_attributes": [],
+      "quick_actions": [],
+      "ui_config": {}
+    },
+    "sharing": {
+      "show_sharing_button": true
+    }
+  },
+  "capabilities": [
+    {
+      "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
+      "name": "customer_messaging",
+      "title": "Messaging",
+      "attributes": [],
+      "_purpose": ["taxonomy-slug:classification-slug"],
+      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
+      "app_id": "123e4567-e89b-12d3-a456-426614174000",
+      "ui_config": {},
+      "ui_hooks": [],
+      "feature_flag": "FF_MY_FEATURE_FLAG",
+      "settings_flag": [],
+      "schemas": []
+    }
+  ],
+  "group_settings": [
+    {
+      "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
+      "label": "Contact Details",
+      "expanded": true,
+      "order": 1
+    },
+    {
+      "id": "e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e",
+      "label": "Address Details",
+      "expanded": false,
+      "order": 2,
+      "info_tooltip_title": {}
+    }
+  ],
+  "layout_settings": {
+    "grid_gap": "string",
+    "grid_template_columns": "string"
+  },
+  "dialog_config": {},
+  "attributes": [
+    {
+      "name": "email",
+      "type": "email",
+      "label": "Email",
+      "required": true
+    },
+    {
+      "name": "first_name",
+      "type": "string",
+      "label": "First Name"
+    }
+  ],
+  "_purpose": ["string"],
+  "explicit_search_mappings": {
+    "image": {
+      "type": "keyword",
+      "index": false
+    }
+  },
+  "group_headlines": [
+    {
+      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
+      "name": "string",
+      "label": "string",
+      "layout": "string",
+      "group": "string",
+      "order": 0,
+      "type": "headline",
+      "enable_divider": false,
+      "divider": "top_divider",
+      "_purpose": ["taxonomy-slug:classification-slug"],
+      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
+    }
+  ]
 }
 ```
 
@@ -1120,6 +1450,8 @@ const { data } = await client.listSchemaBlueprints()
       "updated_at": "string",
       "comment": "string",
       "source": {},
+      "frozen": true,
+      "latest": true,
       "_summary": true,
       "slug": "contact",
       "version": 1,
@@ -5684,6 +6016,8 @@ type EntitySchemaItem = {
     id?: string
     type?: string
   }
+  frozen?: boolean
+  latest?: boolean
   _summary?: boolean
   slug: string
   version?: number
@@ -5773,8 +6107,6 @@ type EntitySchemaItem = {
       icon?: { ... }
       render_condition?: { ... }
       _purpose?: { ... }
-      _manifest?: { ... }
-      constraints?: { ... }
   // ...
 }
 ```