@epilot/sdk 2.2.1 → 2.2.2

package/dist/index.cjs

@@ -81,13 +81,13 @@ var _chunkK2UZPY6Ucjs = require('./chunk-K2UZPY6U.cjs');
 var _chunkANN2QTMYcjs = require('./chunk-ANN2QTMY.cjs');
 
 
-var _chunkTTNPMFXLcjs = require('./chunk-TTNPMFXL.cjs');
+var _chunkXLQ4ZRBFcjs = require('./chunk-XLQ4ZRBF.cjs');
 
 
 var _chunkTXDVGTQDcjs = require('./chunk-TXDVGTQD.cjs');
 
 
-var _chunkIGVVJMX7cjs = require('./chunk-IGVVJMX7.cjs');
+var _chunkODD4JQVScjs = require('./chunk-ODD4JQVS.cjs');
 
 
 var _chunkBLNXQAMXcjs = require('./chunk-BLNXQAMX.cjs');
@@ -143,7 +143,7 @@ var _chunkRXMOHUBPcjs = require('./chunk-RXMOHUBP.cjs');
 
 
 
-var _chunk6TKKEGYUcjs = require('./chunk-6TKKEGYU.cjs');
+var _chunkTG2P4RWZcjs = require('./chunk-TG2P4RWZ.cjs');
 
 
 var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
@@ -210,7 +210,7 @@ var resolveClient = (params) => {
   }
   if (!entry.instance) {
     const definition = entry.loader();
-    entry.instance = _chunk6TKKEGYUcjs.createApiClient.call(void 0, {
+    entry.instance = _chunkTG2P4RWZcjs.createApiClient.call(void 0, {
       definition,
       token: state.token,
       headers: state.globalHeaders,
@@ -243,7 +243,7 @@ var resetAllClients = (registry) => {
 };
 
 // src/apis/_registry.ts
-var expandDef = (mod) => _chunk6TKKEGYUcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
+var expandDef = (mod) => _chunkTG2P4RWZcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
 var registerBuiltinApis = (registry) => {
   registerApi({
     registry,
@@ -338,7 +338,7 @@ var registerBuiltinApis = (registry) => {
   registerApi({
     registry,
     name: "entity",
-    loader: () => expandDef(_chunkTTNPMFXLcjs.require_entity_runtime.call(void 0, ))
+    loader: () => expandDef(_chunkXLQ4ZRBFcjs.require_entity_runtime.call(void 0, ))
   });
   registerApi({
     registry,
@@ -353,7 +353,7 @@ var registerBuiltinApis = (registry) => {
   registerApi({
     registry,
     name: "erpIntegration",
-    loader: () => expandDef(_chunkIGVVJMX7cjs.require_erp_integration_runtime.call(void 0, ))
+    loader: () => expandDef(_chunkODD4JQVScjs.require_erp_integration_runtime.call(void 0, ))
   });
   registerApi({
     registry,
@@ -545,9 +545,9 @@ var createSDK = () => {
       const available = [...registry.keys()].join(", ");
       throw new Error(`Unknown API: "${name}". Available: ${available}`);
     }
-    return _chunk6TKKEGYUcjs.createApiHandle.call(void 0, {
+    return _chunkTG2P4RWZcjs.createApiHandle.call(void 0, {
       resolveClient: () => resolveClient({ registry, name, state }),
-      createClient: () => _chunk6TKKEGYUcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
+      createClient: () => _chunkTG2P4RWZcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
       apiName: name
     });
   };
@@ -595,9 +595,9 @@ var createSDK = () => {
           return interceptorUse;
         }
         case "help":
-          return (apiName) => _chunk6TKKEGYUcjs.help.call(void 0, apiName);
+          return (apiName) => _chunkTG2P4RWZcjs.help.call(void 0, apiName);
         case "openapi":
-          return (apiName) => _chunk6TKKEGYUcjs.openapi.call(void 0, apiName);
+          return (apiName) => _chunkTG2P4RWZcjs.openapi.call(void 0, apiName);
         case "then":
         case "catch":
         case "finally":
@@ -624,4 +624,4 @@ var epilot = createSDK();
 
 
 
-exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunk6TKKEGYUcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunk6TKKEGYUcjs.help; exports.openapi = _chunk6TKKEGYUcjs.openapi;
+exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkTG2P4RWZcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkTG2P4RWZcjs.help; exports.openapi = _chunkTG2P4RWZcjs.openapi;

package/dist/index.d.cts

@@ -9,7 +9,7 @@ import { C as Client$2 } from './address-suggestions.d-_YwTOR-9.cjs';
 import { C as Client$3 } from './ai-agents.d-OkXfr2bz.cjs';
 import { C as Client$4 } from './app.d-u7Dq42kU.cjs';
 import { C as Client$5 } from './audit-logs.d-BRToFqeX.cjs';
-import { C as Client$6 } from './automation.d-KOiZ6ru5.cjs';
+import { C as Client$6 } from './automation.d-D7BzN7Gq.cjs';
 import { C as Client$7 } from './billing.d-Bs8Ku9qE.cjs';
 import { C as Client$8 } from './blueprint-manifest.d-DECw6HdM.cjs';
 import { C as Client$9 } from './consent.d-C2PROHhX.cjs';
@@ -21,10 +21,10 @@ import { C as Client$e } from './design.d-eA-irKEX.cjs';
 import { C as Client$f } from './document.d-DN37pjdx.cjs';
 import { C as Client$g } from './email-settings.d-DUvmLZMN.cjs';
 import { C as Client$h } from './email-template.d-gtQkdaXM.cjs';
-import { C as Client$i } from './entity.d-DtiajmaY.cjs';
+import { C as Client$i } from './entity.d-t9R21446.cjs';
 import { C as Client$j } from './entity-mapping.d-DKSW3sfy.cjs';
 import { C as Client$k } from './environments.d-H3LK_KuH.cjs';
-import { C as Client$l } from './erp-integration.d-DOhxy4P5.cjs';
+import { C as Client$l } from './erp-integration.d-BV3Rv9e6.cjs';
 import { C as Client$m } from './event-catalog.d-ENw6HO-w.cjs';
 import { C as Client$n } from './file.d-DcTJxjp7.cjs';
 import { C as Client$o } from './iban.d-BwdiGbxi.cjs';

package/dist/index.d.ts

@@ -9,7 +9,7 @@ import { C as Client$2 } from './address-suggestions.d-_YwTOR-9.js';
 import { C as Client$3 } from './ai-agents.d-OkXfr2bz.js';
 import { C as Client$4 } from './app.d-u7Dq42kU.js';
 import { C as Client$5 } from './audit-logs.d-BRToFqeX.js';
-import { C as Client$6 } from './automation.d-KOiZ6ru5.js';
+import { C as Client$6 } from './automation.d-D7BzN7Gq.js';
 import { C as Client$7 } from './billing.d-Bs8Ku9qE.js';
 import { C as Client$8 } from './blueprint-manifest.d-DECw6HdM.js';
 import { C as Client$9 } from './consent.d-C2PROHhX.js';
@@ -21,10 +21,10 @@ import { C as Client$e } from './design.d-eA-irKEX.js';
 import { C as Client$f } from './document.d-DN37pjdx.js';
 import { C as Client$g } from './email-settings.d-DUvmLZMN.js';
 import { C as Client$h } from './email-template.d-gtQkdaXM.js';
-import { C as Client$i } from './entity.d-DtiajmaY.js';
+import { C as Client$i } from './entity.d-t9R21446.js';
 import { C as Client$j } from './entity-mapping.d-DKSW3sfy.js';
 import { C as Client$k } from './environments.d-H3LK_KuH.js';
-import { C as Client$l } from './erp-integration.d-DOhxy4P5.js';
+import { C as Client$l } from './erp-integration.d-BV3Rv9e6.js';
 import { C as Client$m } from './event-catalog.d-ENw6HO-w.js';
 import { C as Client$n } from './file.d-DcTJxjp7.js';
 import { C as Client$o } from './iban.d-BwdiGbxi.js';

package/dist/index.js

@@ -81,13 +81,13 @@ import {
 } from "./chunk-SBSIGQDU.js";
 import {
   require_entity_runtime
-} from "./chunk-24T6CJTG.js";
+} from "./chunk-RKSUIRD2.js";
 import {
   require_environments_runtime
 } from "./chunk-6OYECNL2.js";
 import {
   require_erp_integration_runtime
-} from "./chunk-TPA4HEAO.js";
+} from "./chunk-LHVRAAFH.js";
 import {
   require_event_catalog_runtime
 } from "./chunk-TME4YJNP.js";
@@ -143,7 +143,7 @@ import {
   expand,
   help,
   openapi
-} from "./chunk-G33CBNJD.js";
+} from "./chunk-K7HKCNT2.js";
 import {
   __require
 } from "./chunk-YPSWSI3M.js";

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?: { ... }
   // ...
 }
 ```