From a387f0b27dc3b808f502795c8f8fbe1163810e7f Mon Sep 17 00:00:00 2001 From: Richard Griffiths Date: Wed, 5 Aug 2026 17:20:37 +0200 Subject: [PATCH 1/2] feat: add adjust installment capability configuration --- clients/entity-client/src/openapi.d.ts | 12 +++++ clients/entity-client/src/openapi.json | 21 +++++++++ packages/epilot-sdk-v2/docs/entity.md | 47 ++++++++++++++++++++ packages/epilot-sdk-v2/src/docs/entity.json | 2 +- packages/epilot-sdk-v2/src/types/entity.d.ts | 12 +++++ 5 files changed, 93 insertions(+), 1 deletion(-) diff --git a/clients/entity-client/src/openapi.d.ts b/clients/entity-client/src/openapi.d.ts index 5c9af18c..cd882d4b 100644 --- a/clients/entity-client/src/openapi.d.ts +++ b/clients/entity-client/src/openapi.d.ts @@ -834,6 +834,15 @@ declare namespace Components { */ DefaultAddressFields; } + /** + * Configuration for adjusting a contract installment through a Journey. + */ + export interface AdjustInstallmentCapabilityConfig { + /** + * ID of the Flow Journey to open when adjusting the installment. + */ + journey_id: 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 | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Address attribute */ AddressAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Tags */ TagsAttribute | /* Message emil address */ MessageEmailAddressAttribute | /* Numeric input */ NumberAttribute | /* Dynamic data table with configurable columns. Data is stored as an array of objects where each object represents a row. */ TableAttribute | /* 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. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute | /* Shared Partner Organisations */ PartnerOrganisationAttribute | /* Portal access configuration */ PortalAccessAttribute | /* Phone number */ PhoneAttribute | /* Email address */ EmailAttribute | /* Payment method */ PaymentAttribute | /* Price component */ PriceComponentAttribute; /** * a readonly computed ID for the attribute including schema slug and the attribute ID @@ -3312,6 +3321,7 @@ declare namespace Components { * 123e4567-e89b-12d3-a456-426614174000 */ app_id?: string; + adjust_installment?: /* Configuration for adjusting a contract installment through a Journey. */ AdjustInstallmentCapabilityConfig; ui_config?: { /** * Whether the capability is filterable @@ -3457,6 +3467,7 @@ declare namespace Components { * 123e4567-e89b-12d3-a456-426614174000 */ app_id?: string; + adjust_installment?: /* Configuration for adjusting a contract installment through a Journey. */ AdjustInstallmentCapabilityConfig; ui_config?: { /** * Whether the capability is filterable @@ -19436,6 +19447,7 @@ export type ActivityItem = Components.Schemas.ActivityItem; export type ActivityType = Components.Schemas.ActivityType; export type AddressAttribute = Components.Schemas.AddressAttribute; export type AddressRelationAttribute = Components.Schemas.AddressRelationAttribute; +export type AdjustInstallmentCapabilityConfig = Components.Schemas.AdjustInstallmentCapabilityConfig; export type Attribute = Components.Schemas.Attribute; export type AttributeWithCompositeID = Components.Schemas.AttributeWithCompositeID; export type AutomationAttribute = Components.Schemas.AutomationAttribute; diff --git a/clients/entity-client/src/openapi.json b/clients/entity-client/src/openapi.json index 238eb696..52b2246e 100644 --- a/clients/entity-client/src/openapi.json +++ b/clients/entity-client/src/openapi.json @@ -7405,6 +7405,24 @@ "pattern": "^[a-zA-Z0-9_-]+$", "example": "contact" }, + "AdjustInstallmentCapabilityConfig": { + "description": "Configuration for adjusting a contract installment through a Journey.", + "type": "object", + "additionalProperties": false, + "example": { + "journey_id": "adjust-installment-flow" + }, + "required": [ + "journey_id" + ], + "properties": { + "journey_id": { + "type": "string", + "minLength": 1, + "description": "ID of the Flow Journey to open when adjusting the installment." + } + } + }, "EntityCapability": { "description": "Capabilities the Entity has. Turn features on/off for entities.", "type": "object", @@ -7451,6 +7469,9 @@ "description": "ID of the app if the capability is provided by an app", "example": "123e4567-e89b-12d3-a456-426614174000" }, + "adjust_installment": { + "$ref": "#/components/schemas/AdjustInstallmentCapabilityConfig" + }, "ui_config": { "type": "object", "properties": { diff --git a/packages/epilot-sdk-v2/docs/entity.md b/packages/epilot-sdk-v2/docs/entity.md index dc32e817..867a83e2 100644 --- a/packages/epilot-sdk-v2/docs/entity.md +++ b/packages/epilot-sdk-v2/docs/entity.md @@ -190,6 +190,7 @@ const { data } = await entityClient.listSchemas(...) - [`LocationConditionDefinition`](#locationconditiondefinition) - [`ConditionDefinition`](#conditiondefinition) - [`EntitySlug`](#entityslug) +- [`AdjustInstallmentCapabilityConfig`](#adjustinstallmentcapabilityconfig) - [`EntityCapability`](#entitycapability) - [`EntityCapabilityWithCompositeID`](#entitycapabilitywithcompositeid) - [`EntityViewDisabled`](#entityviewdisabled) @@ -497,6 +498,9 @@ const { data } = await client.getSchema({ "_purpose": ["taxonomy-slug:classification-slug"], "_manifest": ["123e4567-e89b-12d3-a456-426614174000"], "app_id": "123e4567-e89b-12d3-a456-426614174000", + "adjust_installment": { + "journey_id": "adjust-installment-flow" + }, "ui_config": {}, "ui_hooks": [], "feature_flag": "FF_MY_FEATURE_FLAG", @@ -649,6 +653,9 @@ const { data } = await client.putSchema( _purpose: ['taxonomy-slug:classification-slug'], _manifest: ['123e4567-e89b-12d3-a456-426614174000'], app_id: '123e4567-e89b-12d3-a456-426614174000', + adjust_installment: { + journey_id: 'adjust-installment-flow' + }, ui_config: { /* ... */ }, ui_hooks: [ /* ... */ ], feature_flag: 'FF_MY_FEATURE_FLAG', @@ -801,6 +808,9 @@ const { data } = await client.putSchema( "_purpose": ["taxonomy-slug:classification-slug"], "_manifest": ["123e4567-e89b-12d3-a456-426614174000"], "app_id": "123e4567-e89b-12d3-a456-426614174000", + "adjust_installment": { + "journey_id": "adjust-installment-flow" + }, "ui_config": {}, "ui_hooks": [], "feature_flag": "FF_MY_FEATURE_FLAG", @@ -1245,6 +1255,9 @@ const { data } = await client.freezeSchema( "_purpose": ["taxonomy-slug:classification-slug"], "_manifest": ["123e4567-e89b-12d3-a456-426614174000"], "app_id": "123e4567-e89b-12d3-a456-426614174000", + "adjust_installment": { + "journey_id": "adjust-installment-flow" + }, "ui_config": {}, "ui_hooks": [], "feature_flag": "FF_MY_FEATURE_FLAG", @@ -1411,6 +1424,9 @@ const { data } = await client.unfreezeSchema({ "_purpose": ["taxonomy-slug:classification-slug"], "_manifest": ["123e4567-e89b-12d3-a456-426614174000"], "app_id": "123e4567-e89b-12d3-a456-426614174000", + "adjust_installment": { + "journey_id": "adjust-installment-flow" + }, "ui_config": {}, "ui_hooks": [], "feature_flag": "FF_MY_FEATURE_FLAG", @@ -1515,6 +1531,9 @@ const { data } = await client.listAvailableCapabilities({ "_purpose": ["taxonomy-slug:classification-slug"], "_manifest": ["123e4567-e89b-12d3-a456-426614174000"], "app_id": "123e4567-e89b-12d3-a456-426614174000", + "adjust_installment": { + "journey_id": "adjust-installment-flow" + }, "ui_config": {}, "ui_hooks": [], "feature_flag": "FF_MY_FEATURE_FLAG", @@ -5160,6 +5179,9 @@ const { data } = await client.createSchemaCapability( _purpose: ['taxonomy-slug:classification-slug'], _manifest: ['123e4567-e89b-12d3-a456-426614174000'], app_id: '123e4567-e89b-12d3-a456-426614174000', + adjust_installment: { + journey_id: 'adjust-installment-flow' + }, ui_config: { is_filterable: true }, @@ -5289,6 +5311,9 @@ const { data } = await client.createSchemaCapability( "_purpose": ["taxonomy-slug:classification-slug"], "_manifest": ["123e4567-e89b-12d3-a456-426614174000"], "app_id": "123e4567-e89b-12d3-a456-426614174000", + "adjust_installment": { + "journey_id": "adjust-installment-flow" + }, "ui_config": { "is_filterable": true }, @@ -5433,6 +5458,9 @@ const { data } = await client.getSchemaCapability({ "_purpose": ["taxonomy-slug:classification-slug"], "_manifest": ["123e4567-e89b-12d3-a456-426614174000"], "app_id": "123e4567-e89b-12d3-a456-426614174000", + "adjust_installment": { + "journey_id": "adjust-installment-flow" + }, "ui_config": { "is_filterable": true }, @@ -5573,6 +5601,9 @@ const { data } = await client.putSchemaCapability( _purpose: ['taxonomy-slug:classification-slug'], _manifest: ['123e4567-e89b-12d3-a456-426614174000'], app_id: '123e4567-e89b-12d3-a456-426614174000', + adjust_installment: { + journey_id: 'adjust-installment-flow' + }, ui_config: { is_filterable: true }, @@ -5702,6 +5733,9 @@ const { data } = await client.putSchemaCapability( "_purpose": ["taxonomy-slug:classification-slug"], "_manifest": ["123e4567-e89b-12d3-a456-426614174000"], "app_id": "123e4567-e89b-12d3-a456-426614174000", + "adjust_installment": { + "journey_id": "adjust-installment-flow" + }, "ui_config": { "is_filterable": true }, @@ -5846,6 +5880,9 @@ const { data } = await client.deleteSchemaCapability({ "_purpose": ["taxonomy-slug:classification-slug"], "_manifest": ["123e4567-e89b-12d3-a456-426614174000"], "app_id": "123e4567-e89b-12d3-a456-426614174000", + "adjust_installment": { + "journey_id": "adjust-installment-flow" + }, "ui_config": { "is_filterable": true }, @@ -9511,6 +9548,16 @@ URL-friendly identifier for the entity schema type EntitySlug = string ``` +### `AdjustInstallmentCapabilityConfig` + +Configuration for adjusting a contract installment through a Journey. + +```ts +type AdjustInstallmentCapabilityConfig = { + journey_id: string +} +``` + ### `EntityCapability` Capabilities the Entity has. Turn features on/off for entities. diff --git a/packages/epilot-sdk-v2/src/docs/entity.json b/packages/epilot-sdk-v2/src/docs/entity.json index f68178a3..ee76dea9 100644 --- a/packages/epilot-sdk-v2/src/docs/entity.json +++ b/packages/epilot-sdk-v2/src/docs/entity.json @@ -1 +1 @@ -"# Entity API\n\n- **Base URL:** `https://entity.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/entity](https://docs.epilot.io/api/entity)\n\n## Usage\n\n```ts\nimport { epilot } from '@epilot/sdk'\n\nepilot.authorize(() => '')\nconst { data } = await epilot.entity.listSchemas(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from '@epilot/sdk/entity'\n\nconst entityClient = getClient()\nauthorize(entityClient, () => '')\nconst { data } = await entityClient.listSchemas(...)\n```\n\n## Operations\n\n**Schemas**\n- [`listSchemas`](#listschemas)\n- [`listSchemasV2`](#listschemasv2)\n- [`getSchema`](#getschema)\n- [`putSchema`](#putschema)\n- [`deleteSchema`](#deleteschema)\n- [`getJsonSchema`](#getjsonschema)\n- [`getSchemaExample`](#getschemaexample)\n- [`getSchemaVersions`](#getschemaversions)\n- [`freezeSchema`](#freezeschema)\n- [`unfreezeSchema`](#unfreezeschema)\n- [`listAvailableCapabilities`](#listavailablecapabilities)\n- [`listSchemaBlueprints`](#listschemablueprints)\n- [`listTaxonomyClassificationsForSchema`](#listtaxonomyclassificationsforschema)\n- [`createSchemaAttribute`](#createschemaattribute)\n- [`getSchemaAttribute`](#getschemaattribute)\n- [`putSchemaAttribute`](#putschemaattribute)\n- [`deleteSchemaAttribute`](#deleteschemaattribute)\n- [`createSchemaCapability`](#createschemacapability)\n- [`getSchemaCapability`](#getschemacapability)\n- [`putSchemaCapability`](#putschemacapability)\n- [`deleteSchemaCapability`](#deleteschemacapability)\n- [`createSchemaGroup`](#createschemagroup)\n- [`getSchemaGroup`](#getschemagroup)\n- [`putSchemaGroup`](#putschemagroup)\n- [`deleteSchemaGroup`](#deleteschemagroup)\n- [`createSchemaGroupHeadline`](#createschemagroupheadline)\n- [`getSchemaGroupHeadline`](#getschemagroupheadline)\n- [`putSchemaGroupHeadline`](#putschemagroupheadline)\n- [`deleteSchemaGroupHeadline`](#deleteschemagroupheadline)\n\n**Entities**\n- [`searchEntities`](#searchentities)\n- [`listEntities`](#listentities)\n- [`queryEntityGraph`](#queryentitygraph)\n- [`createEntity`](#createentity)\n- [`validateEntity`](#validateentity)\n- [`validateEntityV2`](#validateentityv2)\n- [`upsertEntity`](#upsertentity)\n- [`getEntityV2`](#getentityv2)\n- [`restoreEntity`](#restoreentity)\n- [`reindexEntity`](#reindexentity)\n- [`getEntity`](#getentity)\n- [`updateEntity`](#updateentity)\n- [`patchEntity`](#patchentity)\n- [`deleteEntity`](#deleteentity)\n- [`autocomplete`](#autocomplete)\n- [`wipeAllEntities`](#wipeallentities)\n- [`applyChangeset`](#applychangeset)\n- [`dismissChangeset`](#dismisschangeset)\n- [`listChangesets`](#listchangesets)\n\n**Activity**\n- [`createActivity`](#createactivity)\n- [`getActivity`](#getactivity)\n- [`attachActivity`](#attachactivity)\n- [`getEntityActivityFeed`](#getentityactivityfeed)\n\n**Relations**\n- [`getRelations`](#getrelations)\n- [`addRelations`](#addrelations)\n- [`removeRelations`](#removerelations)\n- [`getRelationsV2`](#getrelationsv2)\n- [`getRelationsV3`](#getrelationsv3)\n- [`getRelatedEntitiesCount`](#getrelatedentitiescount)\n- [`updateRelation`](#updaterelation)\n- [`deleteRelation`](#deleterelation)\n\n**Import-Export**\n- [`exportEntities`](#exportentities)\n- [`importEntities`](#importentities)\n- [`abortEntityImport`](#abortentityimport)\n\n**Saved Views**\n- [`listSavedViews`](#listsavedviews)\n- [`createSavedView`](#createsavedview)\n- [`getSavedView`](#getsavedview)\n- [`updateSavedView`](#updatesavedview)\n- [`patchSavedView`](#patchsavedview)\n- [`deleteSavedView`](#deletesavedview)\n- [`listFavoriteViewsForUser`](#listfavoriteviewsforuser)\n\n**Taxonomy**\n- [`listTaxonomies`](#listtaxonomies)\n- [`createTaxonomy`](#createtaxonomy)\n- [`getTaxonomy`](#gettaxonomy)\n- [`updateTaxonomy`](#updatetaxonomy)\n- [`deleteTaxonomy`](#deletetaxonomy)\n- [`updateClassificationsForTaxonomy`](#updateclassificationsfortaxonomy)\n- [`createTaxonomyClassification`](#createtaxonomyclassification)\n- [`getTaxonomyClassification`](#gettaxonomyclassification)\n- [`updateTaxonomyClassification`](#updatetaxonomyclassification)\n- [`deleteTaxonomyClassification`](#deletetaxonomyclassification)\n- [`taxonomyAutocomplete`](#taxonomyautocomplete)\n- [`taxonomiesClassificationsSearch`](#taxonomiesclassificationssearch)\n- [`getTaxonomyBulkActionJobs`](#gettaxonomybulkactionjobs)\n- [`getTaxonomyBulkActionJobById`](#gettaxonomybulkactionjobbyid)\n- [`cancelBulkAction`](#cancelbulkaction)\n- [`bulkMoveClassifications`](#bulkmoveclassifications)\n- [`bulkMergeClassifications`](#bulkmergeclassifications)\n- [`bulkDeleteClassifications`](#bulkdeleteclassifications)\n\n**Schemas**\n- [`ExportJobId`](#exportjobid)\n- [`Language`](#language)\n- [`IsTemplate`](#istemplate)\n- [`SchemaId`](#schemaid)\n- [`EntitySchema`](#entityschema)\n- [`EntitySchemaItem`](#entityschemaitem)\n- [`GenerateEntityTableAIFiltersRequest`](#generateentitytableaifiltersrequest)\n- [`GenerateEntityTableAIFiltersResponse`](#generateentitytableaifiltersresponse)\n- [`EntityTableFilterSearch`](#entitytablefiltersearch)\n- [`EntityTableFilterOption`](#entitytablefilteroption)\n- [`EntitySchemaGroup`](#entityschemagroup)\n- [`EntitySchemaGroupWithCompositeID`](#entityschemagroupwithcompositeid)\n- [`Attribute`](#attribute)\n- [`AttributeWithCompositeID`](#attributewithcompositeid)\n- [`BaseAttribute`](#baseattribute)\n- [`TextAttribute`](#textattribute)\n- [`LinkAttribute`](#linkattribute)\n- [`InternalAttribute`](#internalattribute)\n- [`BooleanAttribute`](#booleanattribute)\n- [`DateAttribute`](#dateattribute)\n- [`CountryAttribute`](#countryattribute)\n- [`SelectAttribute`](#selectattribute)\n- [`MultiSelectAttribute`](#multiselectattribute)\n- [`StatusAttribute`](#statusattribute)\n- [`SequenceAttribute`](#sequenceattribute)\n- [`FileAttribute`](#fileattribute)\n- [`CurrencyAttribute`](#currencyattribute)\n- [`SummaryField`](#summaryfield)\n- [`EntityAction`](#entityaction)\n- [`RelationAttribute`](#relationattribute)\n- [`UserRelationAttribute`](#userrelationattribute)\n- [`PartnerOrganisationAttribute`](#partnerorganisationattribute)\n- [`PortalAccessAttribute`](#portalaccessattribute)\n- [`DefaultAddressFields`](#defaultaddressfields)\n- [`AddressAttribute`](#addressattribute)\n- [`AddressRelationAttribute`](#addressrelationattribute)\n- [`PaymentMethodRelationAttribute`](#paymentmethodrelationattribute)\n- [`InvitationEmailAttribute`](#invitationemailattribute)\n- [`AutomationAttribute`](#automationattribute)\n- [`InternalUserAttribute`](#internaluserattribute)\n- [`PurposeAttribute`](#purposeattribute)\n- [`RepeatableAttribute`](#repeatableattribute)\n- [`TagsAttribute`](#tagsattribute)\n- [`MessageEmailAddressAttribute`](#messageemailaddressattribute)\n- [`NumberAttribute`](#numberattribute)\n- [`TableAttribute`](#tableattribute)\n- [`ConsentAttribute`](#consentattribute)\n- [`OrderedListAttribute`](#orderedlistattribute)\n- [`EmailAttribute`](#emailattribute)\n- [`PhoneAttribute`](#phoneattribute)\n- [`PaymentAttribute`](#paymentattribute)\n- [`PriceComponentAttribute`](#pricecomponentattribute)\n- [`ComputedAttribute`](#computedattribute)\n- [`PartnerStatusAttribute`](#partnerstatusattribute)\n- [`SummaryAttribute`](#summaryattribute)\n- [`GroupHeadline`](#groupheadline)\n- [`GroupHeadlineWithCompositeID`](#groupheadlinewithcompositeid)\n- [`BaseConditionDefinition`](#baseconditiondefinition)\n- [`ScalarConditionDefinition`](#scalarconditiondefinition)\n- [`SelectConditionDefinition`](#selectconditiondefinition)\n- [`LocationConditionDefinition`](#locationconditiondefinition)\n- [`ConditionDefinition`](#conditiondefinition)\n- [`EntitySlug`](#entityslug)\n- [`EntityCapability`](#entitycapability)\n- [`EntityCapabilityWithCompositeID`](#entitycapabilitywithcompositeid)\n- [`EntityViewDisabled`](#entityviewdisabled)\n- [`EntityDefaultTable`](#entitydefaulttable)\n- [`EntityDefaultCreate`](#entitydefaultcreate)\n- [`EntityDefaultEdit`](#entitydefaultedit)\n- [`RedirectEntityView`](#redirectentityview)\n- [`EntityId`](#entityid)\n- [`BaseEntity`](#baseentity)\n- [`Entity`](#entity)\n- [`NullableEntity`](#nullableentity)\n- [`EntityOwner`](#entityowner)\n- [`EntityAcl`](#entityacl)\n- [`HydratedEntity`](#hydratedentity)\n- [`EntityItem`](#entityitem)\n- [`EntityValidationError`](#entityvalidationerror)\n- [`EntityValidationResultSuccess`](#entityvalidationresultsuccess)\n- [`EntityValidationResultError`](#entityvalidationresulterror)\n- [`EntityValidationResult`](#entityvalidationresult)\n- [`EntityValidationV2Error`](#entityvalidationv2error)\n- [`EntityValidationV2ResultSuccess`](#entityvalidationv2resultsuccess)\n- [`EntityValidationV2ResultError`](#entityvalidationv2resulterror)\n- [`EntityValidationV2Result`](#entityvalidationv2result)\n- [`HydratedEntityItem`](#hydratedentityitem)\n- [`GetRelationsResp`](#getrelationsresp)\n- [`GetRelationsRespWithPagination`](#getrelationsrespwithpagination)\n- [`GetRelatedEntitiesCount`](#getrelatedentitiescount)\n- [`RelationEntity`](#relationentity)\n- [`RelationItem`](#relationitem)\n- [`EntitySearchIncludeDeletedParam`](#entitysearchincludedeletedparam)\n- [`EntitySearchParams`](#entitysearchparams)\n- [`EntityListParams`](#entitylistparams)\n- [`SearchFilter`](#searchfilter)\n- [`SearchFilterValue`](#searchfiltervalue)\n- [`EntitySearchOptions`](#entitysearchoptions)\n- [`FieldsParam`](#fieldsparam)\n- [`EntityImportParams`](#entityimportparams)\n- [`GraphQueryRequest`](#graphqueryrequest)\n- [`GraphSeed`](#graphseed)\n- [`GraphDefinition`](#graphdefinition)\n- [`GraphNode`](#graphnode)\n- [`GraphEdge`](#graphedge)\n- [`GraphQueryResponse`](#graphqueryresponse)\n- [`EntitySearchResults`](#entitysearchresults)\n- [`SearchMappings`](#searchmappings)\n- [`ActivityId`](#activityid)\n- [`ActivityCallerContext`](#activitycallercontext)\n- [`ActivityType`](#activitytype)\n- [`Activity`](#activity)\n- [`EntityOperation`](#entityoperation)\n- [`EntityOperationSourceContext`](#entityoperationsourcecontext)\n- [`BaseActivityItem`](#baseactivityitem)\n- [`ActivityItem`](#activityitem)\n- [`BlueprintEntityId`](#blueprintentityid)\n- [`ListSavedViewsResults`](#listsavedviewsresults)\n- [`SavedViewId`](#savedviewid)\n- [`SavedViewItem`](#savedviewitem)\n- [`SavedViewPartial`](#savedviewpartial)\n- [`SavedView`](#savedview)\n- [`Taxonomy`](#taxonomy)\n- [`TaxonomyLocationId`](#taxonomylocationid)\n- [`TaxonomySearchIncludeArchivedParam`](#taxonomysearchincludearchivedparam)\n- [`TaxonomyClassification`](#taxonomyclassification)\n- [`ClassificationId`](#classificationid)\n- [`ClassificationIdOrPattern`](#classificationidorpattern)\n- [`ClassificationSlug`](#classificationslug)\n- [`TaxonomySlug`](#taxonomyslug)\n- [`ClassificationsUpdate`](#classificationsupdate)\n- [`TaxonomyBulkJobTriggerResponse`](#taxonomybulkjobtriggerresponse)\n- [`TaxonomyBulkJobStatus`](#taxonomybulkjobstatus)\n- [`TaxonomyBulkJobActionType`](#taxonomybulkjobactiontype)\n- [`TaxonomyBulkJob`](#taxonomybulkjob)\n- [`ESClusterAssignment`](#esclusterassignment)\n- [`SettingFlag`](#settingflag)\n- [`ErrorObject`](#errorobject)\n- [`ChangesetCreator`](#changesetcreator)\n- [`Changeset`](#changeset)\n- [`ChangesetMap`](#changesetmap)\n- [`MeterReadingChangesetEntry`](#meterreadingchangesetentry)\n- [`EditMode`](#editmode)\n- [`EditModeConfig`](#editmodeconfig)\n- [`FuzzyConfig`](#fuzzyconfig)\n- [`MatchStrategy`](#matchstrategy)\n\n### `listSchemas`\n\nGet the latest versions of all schemas\n\n`GET /v1/entity/schemas`\n\n```ts\nconst { data } = await client.listSchemas({\n unpublished: true,\n latest: true,\n exclude: ['...'],\n include: ['...'],\n})\n```\n\n
\nResponse\n\n```json\n{\n \"results\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"comment\": \"string\",\n \"source\": {},\n \"frozen\": true,\n \"latest\": true,\n \"_summary\": true,\n \"slug\": \"contact\",\n \"version\": 1,\n \"blueprint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"enable_setting\": [\"360_features\"],\n \"name\": \"Contact\",\n \"plural\": \"Contacts\",\n \"description\": \"Example description\",\n \"docs_url\": \"https://docs.epilot.io/docs/pricing/entities\",\n \"category\": \"customer_relations\",\n \"published\": false,\n \"draft\": false,\n \"icon\": \"person\",\n \"title_template\": \"{{first_name}} {{last_name}}\",\n \"ui_config\": {},\n \"capabilities\": [],\n \"group_settings\": [],\n \"layout_settings\": {},\n \"dialog_config\": {},\n \"attributes\": [],\n \"_purpose\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"explicit_search_mappings\": {},\n \"group_headlines\": [],\n \"conditions\": []\n }\n ]\n}\n```\n\n
\n\n---\n\n### `listSchemasV2`\n\nGet the latest versions of all schemas.\nReturns summary schemas by default (only summary attributes, no capabilities).\nUse ?full=true for complete schemas.\n\n`GET /v2/entity/schemas`\n\n```ts\nconst { data } = await client.listSchemasV2({\n full: true,\n unpublished: true,\n latest: true,\n exclude: ['...'],\n include: ['...'],\n})\n```\n\n
\nResponse\n\n```json\n{\n \"results\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"comment\": \"string\",\n \"source\": {},\n \"frozen\": true,\n \"latest\": true,\n \"_summary\": true,\n \"slug\": \"contact\",\n \"version\": 1,\n \"blueprint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"enable_setting\": [\"360_features\"],\n \"name\": \"Contact\",\n \"plural\": \"Contacts\",\n \"description\": \"Example description\",\n \"docs_url\": \"https://docs.epilot.io/docs/pricing/entities\",\n \"category\": \"customer_relations\",\n \"published\": false,\n \"draft\": false,\n \"icon\": \"person\",\n \"title_template\": \"{{first_name}} {{last_name}}\",\n \"ui_config\": {},\n \"capabilities\": [],\n \"group_settings\": [],\n \"layout_settings\": {},\n \"dialog_config\": {},\n \"attributes\": [],\n \"_purpose\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"explicit_search_mappings\": {},\n \"group_headlines\": [],\n \"conditions\": []\n }\n ]\n}\n```\n\n
\n\n---\n\n### `getSchema`\n\nBy default gets the current version of the Schema (frozen version if frozen, otherwise latest).\nPass ?latest=true to get the latest version when the schema is frozen.\nPass ?id= to get a specific versi\n\n`GET /v1/entity/schemas/{slug}`\n\n```ts\nconst { data } = await client.getSchema({\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n latest: true,\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"comment\": \"string\",\n \"source\": {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n \"frozen\": true,\n \"latest\": true,\n \"_summary\": true,\n \"slug\": \"contact\",\n \"version\": 1,\n \"blueprint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"enable_setting\": [\"360_features\"],\n \"name\": \"Contact\",\n \"plural\": \"Contacts\",\n \"description\": \"Example description\",\n \"docs_url\": \"https://docs.epilot.io/docs/pricing/entities\",\n \"category\": \"customer_relations\",\n \"published\": false,\n \"draft\": false,\n \"icon\": \"person\",\n \"title_template\": \"{{first_name}} {{last_name}}\",\n \"ui_config\": {\n \"table_view\": {\n \"view_type\": \"default\",\n \"row_actions\": [\"string\"],\n \"bulk_actions\": [\"string\"],\n \"navbar_actions\": [],\n \"enable_thumbnails\": false\n },\n \"create_view\": {\n \"view_type\": \"default\",\n \"search_params\": {}\n },\n \"edit_view\": {\n \"view_type\": \"default\",\n \"search_params\": {},\n \"summary_attributes\": [\"email\"]\n },\n \"single_view\": {\n \"view_type\": \"default\",\n \"search_params\": {},\n \"summary_attributes\": [\"email\"]\n },\n \"list_item\": {\n \"summary_attributes\": [],\n \"quick_actions\": [],\n \"ui_config\": {}\n },\n \"sharing\": {\n \"show_sharing_button\": true\n },\n \"grid_layout\": {\n \"id\": \"string\",\n \"columns\": 0,\n \"cells\": [0]\n },\n \"widget_order\": [\"string\"]\n },\n \"capabilities\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"customer_messaging\",\n \"title\": \"Messaging\",\n \"attributes\": [],\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"app_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"ui_config\": {},\n \"ui_hooks\": [],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"schemas\": []\n }\n ],\n \"group_settings\": [\n {\n \"id\": \"e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"label\": \"Contact Details\",\n \"expanded\": true,\n \"order\": 1\n },\n {\n \"id\": \"e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e\",\n \"label\": \"Address Details\",\n \"expanded\": false,\n \"order\": 2,\n \"info_tooltip_title\": {}\n }\n ],\n \"layout_settings\": {\n \"grid_gap\": \"string\",\n \"grid_template_columns\": \"string\"\n },\n \"dialog_config\": {},\n \"attributes\": [\n {\n \"name\": \"email\",\n \"type\": \"email\",\n \"label\": \"Email\",\n \"required\": true\n },\n {\n \"name\": \"first_name\",\n \"type\": \"string\",\n \"label\": \"First Name\"\n }\n ],\n \"_purpose\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"explicit_search_mappings\": {\n \"image\": {\n \"type\": \"keyword\",\n \"index\": false\n }\n },\n \"group_headlines\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"layout\": \"string\",\n \"group\": \"string\",\n \"order\": 0,\n \"type\": \"headline\",\n \"enable_divider\": false,\n \"divider\": \"top_divider\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ],\n \"conditions\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"delivery_area\",\n \"label\": \"Delivery Area\",\n \"type\": \"string\"\n }\n ]\n}\n```\n\n
\n\n---\n\n### `putSchema`\n\nCreate or update a schema with a new version.\nWhen the schema is frozen, writes update the latest version without affecting the frozen version.\n\n`PUT /v1/entity/schemas/{slug}`\n\n```ts\nconst { data } = await client.putSchema(\n {\n slug: 'example',\n draft: true,\n },\n {\n slug: 'contact',\n version: 1,\n blueprint: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n feature_flag: 'FF_MY_FEATURE_FLAG',\n enable_setting: ['360_features'],\n name: 'Contact',\n plural: 'Contacts',\n description: 'Example description',\n docs_url: 'https://docs.epilot.io/docs/pricing/entities',\n category: 'customer_relations',\n published: false,\n draft: false,\n icon: 'person',\n title_template: '{{first_name}} {{last_name}}',\n ui_config: {\n table_view: {\n view_type: 'default',\n row_actions: ['string'],\n bulk_actions: ['string'],\n navbar_actions: [ /* ... */ ],\n enable_thumbnails: false\n },\n create_view: {\n view_type: 'default',\n search_params: {}\n },\n edit_view: {\n view_type: 'default',\n search_params: {},\n summary_attributes: ['email']\n },\n single_view: {\n view_type: 'default',\n search_params: {},\n summary_attributes: ['email']\n },\n list_item: {\n summary_attributes: [ /* ... */ ],\n quick_actions: [ /* ... */ ],\n ui_config: { /* ... */ }\n },\n sharing: {\n show_sharing_button: true\n },\n grid_layout: {\n id: 'string',\n columns: 0,\n cells: [0]\n },\n widget_order: ['string']\n },\n capabilities: [\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'customer_messaging',\n title: 'Messaging',\n attributes: [ /* ... */ ],\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n app_id: '123e4567-e89b-12d3-a456-426614174000',\n ui_config: { /* ... */ },\n ui_hooks: [ /* ... */ ],\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [ /* ... */ ],\n schemas: [ /* ... */ ]\n }\n ],\n group_settings: [\n {\n id: 'e18a532b-ae79-4d86-a6a5-e5dbfb579d14',\n label: 'Contact Details',\n expanded: true,\n order: 1\n },\n {\n id: 'e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e',\n label: 'Address Details',\n expanded: false,\n order: 2,\n info_tooltip_title: { /* ... */ }\n }\n ],\n layout_settings: {\n grid_gap: 'string',\n grid_template_columns: 'string'\n },\n dialog_config: {},\n attributes: [\n {\n name: 'email',\n type: 'email',\n label: 'Email',\n required: true\n },\n {\n name: 'first_name',\n type: 'string',\n label: 'First Name'\n },\n /* ... 5 more */\n ],\n _purpose: ['string'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n explicit_search_mappings: {\n image: {\n type: 'keyword',\n index: false\n }\n },\n group_headlines: [\n {\n id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n name: 'string',\n label: 'string',\n layout: 'string',\n group: 'string',\n order: 0,\n type: 'headline',\n enable_divider: false,\n divider: 'top_divider',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n }\n ],\n conditions: [\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'delivery_area',\n label: 'Delivery Area',\n type: 'string'\n }\n ]\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"comment\": \"string\",\n \"source\": {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n \"frozen\": true,\n \"latest\": true,\n \"_summary\": true,\n \"slug\": \"contact\",\n \"version\": 1,\n \"blueprint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"enable_setting\": [\"360_features\"],\n \"name\": \"Contact\",\n \"plural\": \"Contacts\",\n \"description\": \"Example description\",\n \"docs_url\": \"https://docs.epilot.io/docs/pricing/entities\",\n \"category\": \"customer_relations\",\n \"published\": false,\n \"draft\": false,\n \"icon\": \"person\",\n \"title_template\": \"{{first_name}} {{last_name}}\",\n \"ui_config\": {\n \"table_view\": {\n \"view_type\": \"default\",\n \"row_actions\": [\"string\"],\n \"bulk_actions\": [\"string\"],\n \"navbar_actions\": [],\n \"enable_thumbnails\": false\n },\n \"create_view\": {\n \"view_type\": \"default\",\n \"search_params\": {}\n },\n \"edit_view\": {\n \"view_type\": \"default\",\n \"search_params\": {},\n \"summary_attributes\": [\"email\"]\n },\n \"single_view\": {\n \"view_type\": \"default\",\n \"search_params\": {},\n \"summary_attributes\": [\"email\"]\n },\n \"list_item\": {\n \"summary_attributes\": [],\n \"quick_actions\": [],\n \"ui_config\": {}\n },\n \"sharing\": {\n \"show_sharing_button\": true\n },\n \"grid_layout\": {\n \"id\": \"string\",\n \"columns\": 0,\n \"cells\": [0]\n },\n \"widget_order\": [\"string\"]\n },\n \"capabilities\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"customer_messaging\",\n \"title\": \"Messaging\",\n \"attributes\": [],\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"app_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"ui_config\": {},\n \"ui_hooks\": [],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"schemas\": []\n }\n ],\n \"group_settings\": [\n {\n \"id\": \"e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"label\": \"Contact Details\",\n \"expanded\": true,\n \"order\": 1\n },\n {\n \"id\": \"e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e\",\n \"label\": \"Address Details\",\n \"expanded\": false,\n \"order\": 2,\n \"info_tooltip_title\": {}\n }\n ],\n \"layout_settings\": {\n \"grid_gap\": \"string\",\n \"grid_template_columns\": \"string\"\n },\n \"dialog_config\": {},\n \"attributes\": [\n {\n \"name\": \"email\",\n \"type\": \"email\",\n \"label\": \"Email\",\n \"required\": true\n },\n {\n \"name\": \"first_name\",\n \"type\": \"string\",\n \"label\": \"First Name\"\n }\n ],\n \"_purpose\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"explicit_search_mappings\": {\n \"image\": {\n \"type\": \"keyword\",\n \"index\": false\n }\n },\n \"group_headlines\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"layout\": \"string\",\n \"group\": \"string\",\n \"order\": 0,\n \"type\": \"headline\",\n \"enable_divider\": false,\n \"divider\": \"top_divider\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ],\n \"conditions\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"delivery_area\",\n \"label\": \"Delivery Area\",\n \"type\": \"string\"\n }\n ]\n}\n```\n\n
\n\n---\n\n### `deleteSchema`\n\nDelete a schema, or a specific version of a schema\n\n`DELETE /v1/entity/schemas/{slug}`\n\n```ts\nconst { data } = await client.deleteSchema({\n slug: 'example',\n})\n```\n\n---\n\n### `getJsonSchema`\n\nGet formal JSON schema definition draft 2020-12 for the given epilot schema\n\n`GET /v1/entity/schemas/{slug}/json/schema`\n\n```ts\nconst { data } = await client.getJsonSchema({\n slug: 'example',\n dereference: true,\n})\n```\n\n
\nResponse\n\n```json\n{\n \"$schema\": \"http://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"_id\": {\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"example\": \"123e4567-e89b-12d3-a456-426614174000\"\n },\n \"_org\": {\n \"type\": \"string\",\n \"description\": \"Organization Id the entity belongs to\",\n \"readOnly\": true\n },\n \"_owners\": {\n \"type\": \"array\",\n \"readOnly\": true,\n \"items\": {}\n },\n \"_schema\": {\n \"readOnly\": true,\n \"type\": \"string\"\n },\n \"_title\": {\n \"readOnly\": true,\n \"type\": \"string\"\n },\n \"_tags\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {}\n },\n \"_manifest\": {\n \"type\": \"array\",\n \"description\": \"Manifest ID used to create/update the entity\",\n \"items\": {}\n },\n \"_created_at\": {\n \"readOnly\": true,\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"_updated_at\": {\n \"readOnly\": true,\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"_acl\": {\n \"readOnly\": true,\n \"type\": \"object\",\n \"description\": \"Access control list (ACL) for an entity. Defines sharing access to external orgs or users.\",\n \"additionalProperties\": true,\n \"properties\": {}\n },\n \"title\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"enum\": [\"Dr.\", \"Prof.\", \"Prof. Dr.\", null]\n },\n \"salutation\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"enum\": [\"Mr.\", \"Ms. / Mrs.\", \"Company\", \"Contact Person\", \"Company/Contact Person\", \"Spouse\", \"Family\", \"Ownership\", \"Assembly\", \"Other\", null]\n },\n \"first_name\": {\n \"type\": \"string\"\n },\n \"last_name\": {\n \"type\": \"string\"\n },\n \"customer_number\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"birthdate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"account\": {\n \"type\": \"object\",\n \"nullable\": true,\n \"properties\": {},\n \"additionalProperties\": true\n },\n \"address\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"description\": \"Addresses as a list of object, the element with index 0 is treated as the primary one.\\n\",\n \"items\": {}\n },\n \"email\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"description\": \"Email addresses as a list of object, the element with index 0 is treated as the primary one.\\n\",\n \"items\": {}\n },\n \"phone\": {\n \"type\": \"array\",\n \"description\": \"Phone numbers as a list of object, the element with index 0 is treated as the primary one.\\n\",\n \"items\": {}\n }\n },\n \"required\": [\"first_name\", \"last_name\", \"_id\", \"_org\", \"_owners\", \"_schema\", \"_title\", \"_tags\", \"_created_at\", \"_updated_at\", \"_acl\"]\n}\n```\n\n
\n\n---\n\n### `getSchemaExample`\n\nGet a full example entity for the given schema\n\n`GET /v1/entity/schemas/{slug}/json/example`\n\n```ts\nconst { data } = await client.getSchemaExample({\n slug: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{}\n```\n\n
\n\n---\n\n### `getSchemaVersions`\n\nGet all versions of this schema ordered by the latest versions including drafts.\n\n`GET /v1/entity/schemas/{slug}/versions`\n\n```ts\nconst { data } = await client.getSchemaVersions({\n slug: 'example',\n versions_from: 1,\n versions_size: 1,\n drafts_from: 1,\n drafts_size: 1,\n fields: ['...'],\n})\n```\n\n
\nResponse\n\n```json\n{\n \"versions\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"comment\": \"string\",\n \"source\": {},\n \"frozen\": true,\n \"latest\": true,\n \"_summary\": true,\n \"slug\": \"contact\",\n \"version\": 1,\n \"blueprint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"enable_setting\": [\"360_features\"],\n \"name\": \"Contact\",\n \"plural\": \"Contacts\",\n \"description\": \"Example description\",\n \"docs_url\": \"https://docs.epilot.io/docs/pricing/entities\",\n \"category\": \"customer_relations\",\n \"published\": false,\n \"draft\": false,\n \"icon\": \"person\",\n \"title_template\": \"{{first_name}} {{last_name}}\",\n \"ui_config\": {},\n \"capabilities\": [],\n \"group_settings\": [],\n \"layout_settings\": {},\n \"dialog_config\": {},\n \"attributes\": [],\n \"_purpose\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"explicit_search_mappings\": {},\n \"group_headlines\": [],\n \"conditions\": []\n }\n ],\n \"drafts\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"comment\": \"string\",\n \"source\": {},\n \"frozen\": true,\n \"latest\": true,\n \"_summary\": true,\n \"slug\": \"contact\",\n \"version\": 1,\n \"blueprint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"enable_setting\": [\"360_features\"],\n \"name\": \"Contact\",\n \"plural\": \"Contacts\",\n \"description\": \"Example description\",\n \"docs_url\": \"https://docs.epilot.io/docs/pricing/entities\",\n \"category\": \"customer_relations\",\n \"published\": false,\n \"draft\": false,\n \"icon\": \"person\",\n \"title_template\": \"{{first_name}} {{last_name}}\",\n \"ui_config\": {},\n \"capabilities\": [],\n \"group_settings\": [],\n \"layout_settings\": {},\n \"dialog_config\": {},\n \"attributes\": [],\n \"_purpose\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"explicit_search_mappings\": {},\n \"group_headlines\": [],\n \"conditions\": []\n }\n ],\n \"versions_more\": true,\n \"drafts_more\": true,\n \"frozen_version\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}\n```\n\n
\n\n---\n\n### `freezeSchema`\n\nFreeze a schema at its current version, or at a specific version.\nWhen frozen, getSchema returns the frozen version by default.\nNew edits via putSchema update the latest version without affecting the \n\n`POST /v1/entity/schemas/{slug}/freeze`\n\n```ts\nconst { data } = await client.freezeSchema(\n {\n slug: 'example',\n },\n {\n version_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6'\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"comment\": \"string\",\n \"source\": {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n \"frozen\": true,\n \"latest\": true,\n \"_summary\": true,\n \"slug\": \"contact\",\n \"version\": 1,\n \"blueprint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"enable_setting\": [\"360_features\"],\n \"name\": \"Contact\",\n \"plural\": \"Contacts\",\n \"description\": \"Example description\",\n \"docs_url\": \"https://docs.epilot.io/docs/pricing/entities\",\n \"category\": \"customer_relations\",\n \"published\": false,\n \"draft\": false,\n \"icon\": \"person\",\n \"title_template\": \"{{first_name}} {{last_name}}\",\n \"ui_config\": {\n \"table_view\": {\n \"view_type\": \"default\",\n \"row_actions\": [\"string\"],\n \"bulk_actions\": [\"string\"],\n \"navbar_actions\": [],\n \"enable_thumbnails\": false\n },\n \"create_view\": {\n \"view_type\": \"default\",\n \"search_params\": {}\n },\n \"edit_view\": {\n \"view_type\": \"default\",\n \"search_params\": {},\n \"summary_attributes\": [\"email\"]\n },\n \"single_view\": {\n \"view_type\": \"default\",\n \"search_params\": {},\n \"summary_attributes\": [\"email\"]\n },\n \"list_item\": {\n \"summary_attributes\": [],\n \"quick_actions\": [],\n \"ui_config\": {}\n },\n \"sharing\": {\n \"show_sharing_button\": true\n },\n \"grid_layout\": {\n \"id\": \"string\",\n \"columns\": 0,\n \"cells\": [0]\n },\n \"widget_order\": [\"string\"]\n },\n \"capabilities\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"customer_messaging\",\n \"title\": \"Messaging\",\n \"attributes\": [],\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"app_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"ui_config\": {},\n \"ui_hooks\": [],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"schemas\": []\n }\n ],\n \"group_settings\": [\n {\n \"id\": \"e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"label\": \"Contact Details\",\n \"expanded\": true,\n \"order\": 1\n },\n {\n \"id\": \"e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e\",\n \"label\": \"Address Details\",\n \"expanded\": false,\n \"order\": 2,\n \"info_tooltip_title\": {}\n }\n ],\n \"layout_settings\": {\n \"grid_gap\": \"string\",\n \"grid_template_columns\": \"string\"\n },\n \"dialog_config\": {},\n \"attributes\": [\n {\n \"name\": \"email\",\n \"type\": \"email\",\n \"label\": \"Email\",\n \"required\": true\n },\n {\n \"name\": \"first_name\",\n \"type\": \"string\",\n \"label\": \"First Name\"\n }\n ],\n \"_purpose\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"explicit_search_mappings\": {\n \"image\": {\n \"type\": \"keyword\",\n \"index\": false\n }\n },\n \"group_headlines\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"layout\": \"string\",\n \"group\": \"string\",\n \"order\": 0,\n \"type\": \"headline\",\n \"enable_divider\": false,\n \"divider\": \"top_divider\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ],\n \"conditions\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"delivery_area\",\n \"label\": \"Delivery Area\",\n \"type\": \"string\"\n }\n ]\n}\n```\n\n
\n\n---\n\n### `unfreezeSchema`\n\nUnfreeze a schema. Promotes the latest version to the current version for all users.\n\n`POST /v1/entity/schemas/{slug}/unfreeze`\n\n```ts\nconst { data } = await client.unfreezeSchema({\n slug: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"comment\": \"string\",\n \"source\": {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n \"frozen\": true,\n \"latest\": true,\n \"_summary\": true,\n \"slug\": \"contact\",\n \"version\": 1,\n \"blueprint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"enable_setting\": [\"360_features\"],\n \"name\": \"Contact\",\n \"plural\": \"Contacts\",\n \"description\": \"Example description\",\n \"docs_url\": \"https://docs.epilot.io/docs/pricing/entities\",\n \"category\": \"customer_relations\",\n \"published\": false,\n \"draft\": false,\n \"icon\": \"person\",\n \"title_template\": \"{{first_name}} {{last_name}}\",\n \"ui_config\": {\n \"table_view\": {\n \"view_type\": \"default\",\n \"row_actions\": [\"string\"],\n \"bulk_actions\": [\"string\"],\n \"navbar_actions\": [],\n \"enable_thumbnails\": false\n },\n \"create_view\": {\n \"view_type\": \"default\",\n \"search_params\": {}\n },\n \"edit_view\": {\n \"view_type\": \"default\",\n \"search_params\": {},\n \"summary_attributes\": [\"email\"]\n },\n \"single_view\": {\n \"view_type\": \"default\",\n \"search_params\": {},\n \"summary_attributes\": [\"email\"]\n },\n \"list_item\": {\n \"summary_attributes\": [],\n \"quick_actions\": [],\n \"ui_config\": {}\n },\n \"sharing\": {\n \"show_sharing_button\": true\n },\n \"grid_layout\": {\n \"id\": \"string\",\n \"columns\": 0,\n \"cells\": [0]\n },\n \"widget_order\": [\"string\"]\n },\n \"capabilities\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"customer_messaging\",\n \"title\": \"Messaging\",\n \"attributes\": [],\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"app_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"ui_config\": {},\n \"ui_hooks\": [],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"schemas\": []\n }\n ],\n \"group_settings\": [\n {\n \"id\": \"e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"label\": \"Contact Details\",\n \"expanded\": true,\n \"order\": 1\n },\n {\n \"id\": \"e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e\",\n \"label\": \"Address Details\",\n \"expanded\": false,\n \"order\": 2,\n \"info_tooltip_title\": {}\n }\n ],\n \"layout_settings\": {\n \"grid_gap\": \"string\",\n \"grid_template_columns\": \"string\"\n },\n \"dialog_config\": {},\n \"attributes\": [\n {\n \"name\": \"email\",\n \"type\": \"email\",\n \"label\": \"Email\",\n \"required\": true\n },\n {\n \"name\": \"first_name\",\n \"type\": \"string\",\n \"label\": \"First Name\"\n }\n ],\n \"_purpose\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"explicit_search_mappings\": {\n \"image\": {\n \"type\": \"keyword\",\n \"index\": false\n }\n },\n \"group_headlines\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"layout\": \"string\",\n \"group\": \"string\",\n \"order\": 0,\n \"type\": \"headline\",\n \"enable_divider\": false,\n \"divider\": \"top_divider\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ],\n \"conditions\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"delivery_area\",\n \"label\": \"Delivery Area\",\n \"type\": \"string\"\n }\n ]\n}\n```\n\n
\n\n---\n\n### `listAvailableCapabilities`\n\nList available capabilities for schema\n\n`GET /v1/entity/schemas/{slug}/capabilities/available`\n\n```ts\nconst { data } = await client.listAvailableCapabilities({\n slug: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"results\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"customer_messaging\",\n \"title\": \"Messaging\",\n \"attributes\": [],\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"app_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"ui_config\": {},\n \"ui_hooks\": [],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"schemas\": []\n }\n ]\n}\n```\n\n
\n\n---\n\n### `listSchemaBlueprints`\n\nList canonical versions of all available schemas\n\n`GET /v1/entity/schemas/blueprints`\n\n```ts\nconst { data } = await client.listSchemaBlueprints()\n```\n\n
\nResponse\n\n```json\n{\n \"results\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"comment\": \"string\",\n \"source\": {},\n \"frozen\": true,\n \"latest\": true,\n \"_summary\": true,\n \"slug\": \"contact\",\n \"version\": 1,\n \"blueprint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"enable_setting\": [\"360_features\"],\n \"name\": \"Contact\",\n \"plural\": \"Contacts\",\n \"description\": \"Example description\",\n \"docs_url\": \"https://docs.epilot.io/docs/pricing/entities\",\n \"category\": \"customer_relations\",\n \"published\": false,\n \"draft\": false,\n \"icon\": \"person\",\n \"title_template\": \"{{first_name}} {{last_name}}\",\n \"ui_config\": {},\n \"capabilities\": [],\n \"group_settings\": [],\n \"layout_settings\": {},\n \"dialog_config\": {},\n \"attributes\": [],\n \"_purpose\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"explicit_search_mappings\": {},\n \"group_headlines\": [],\n \"conditions\": []\n }\n ]\n}\n```\n\n
\n\n---\n\n### `searchEntities`\n\nSearch for entities. Supports ordering and pagination. [Lucene query syntax](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax) supp\n\n`POST /v1/entity:search`\n\n```ts\nconst { data } = await client.searchEntities(\n null,\n {\n q: '_schema:contact AND status:active',\n include_scores: false,\n sort: 'string',\n from: 0,\n size: 10,\n hydrate: false,\n anonymize: false,\n fields: ['_id', '_title', 'first_name', 'account', '!account.*._files', '**._product'],\n aggs: {\n 'contact-count-per-tag': {\n terms: {\n field: '_tags.keyword'\n }\n }\n },\n include_deleted: 'false',\n highlight: {},\n stable_for: 0,\n stable_query_id: 'string',\n search_after: ['string']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"hits\": 1,\n \"results\": [\n {\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ],\n \"aggregations\": {\n \"contact-count-per-tag\": {\n \"doc_count_error_upper_bound\": 0,\n \"sum_other_doc_count\": 23,\n \"buckets\": [\n {\n \"key\": \"automation\",\n \"doc_count\": 108\n },\n {\n \"key\": \"primary\",\n \"doc_count\": 66\n }\n ]\n }\n },\n \"stable_query_id\": \"string\",\n \"sort_end\": [1747905443332, \"0.000023312468\"]\n}\n```\n\n
\n\n---\n\n### `listEntities`\n\nList entities that meet the specified conditions.\n\n`POST /v1/entity:list`\n\n```ts\nconst { data } = await client.listEntities(\n null,\n {\n query: {\n query_string: {\n query: 'status:active',\n fields: ['_title', '_tags', 'status'],\n default_operator: 'OR',\n lenient: true\n }\n },\n filter: [\n {\n term: {\n _schema: 'contact'\n }\n },\n {\n terms: {\n status: ['active']\n }\n }\n ],\n allow_targeting_all_schemas: false,\n sort: 'string',\n from: 0,\n size: 10,\n hydrate: false,\n anonymize: false,\n fields: ['_id', '_title', 'first_name', 'account', '!account.*._files', '**._product'],\n aggs: {\n 'contact-count-per-tag': {\n terms: {\n field: '_tags.keyword'\n }\n }\n },\n include_deleted: 'false',\n include_scores: false,\n highlight: {},\n stable_for: 0,\n stable_query_id: 'string',\n search_after: ['string']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"hits\": 1,\n \"results\": [\n {\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ],\n \"aggregations\": {\n \"contact-count-per-tag\": {\n \"doc_count_error_upper_bound\": 0,\n \"sum_other_doc_count\": 23,\n \"buckets\": [\n {\n \"key\": \"automation\",\n \"doc_count\": 108\n },\n {\n \"key\": \"primary\",\n \"doc_count\": 66\n }\n ]\n }\n },\n \"stable_query_id\": \"string\",\n \"sort_end\": [1747905443332, \"0.000023312468\"]\n}\n```\n\n
\n\n---\n\n### `queryEntityGraph`\n\nTraverse an entity relationship graph starting from a seed entity.\n\n`POST /v1/entity:graph`\n\n```ts\nconst { data } = await client.queryEntityGraph(\n null,\n {\n seed: {\n entity_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n node_id: 'contact'\n },\n graph: {\n nodes: [\n {\n id: 'portal_user',\n schema: 'portal_user',\n cardinality: 'one'\n },\n {\n id: 'contact',\n schema: 'contact',\n cardinality: 'one'\n },\n /* ... 1 more */\n ],\n edges: [\n {\n from: 'portal_user',\n to: 'contact'\n },\n {\n from: 'contact',\n to: 'billing_accounts'\n }\n ]\n },\n hydrate: false,\n apply_changesets: false\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"nodes\": {\n \"portal_user\": [\"550e8400-e29b-41d4-a716-446655440001\"],\n \"contact\": [\"550e8400-e29b-41d4-a716-446655440002\"],\n \"billing_accounts\": [\"550e8400-e29b-41d4-a716-446655440003\", \"550e8400-e29b-41d4-a716-446655440004\"]\n },\n \"entityNodes\": {\n \"portal_user\": {\n \"_id\": \"550e8400-e29b-41d4-a716-446655440001\",\n \"_schema\": \"portal_user\"\n },\n \"contact\": {\n \"_id\": \"550e8400-e29b-41d4-a716-446655440002\",\n \"_schema\": \"contact\"\n },\n \"billing_accounts\": [\n {\n \"_id\": \"550e8400-e29b-41d4-a716-446655440003\",\n \"_schema\": \"billing_account\"\n },\n {\n \"_id\": \"550e8400-e29b-41d4-a716-446655440004\",\n \"_schema\": \"billing_account\"\n }\n ]\n },\n \"edges\": [\n {\n \"from\": \"portal_user\",\n \"to\": \"contact\"\n },\n {\n \"from\": \"contact\",\n \"to\": \"billing_accounts\"\n }\n ]\n}\n```\n\n
\n\n---\n\n### `createEntity`\n\nCreates a new entity using a key.\n\n`POST /v1/entity/{slug}`\n\n```ts\nconst { data } = await client.createEntity(\n {\n slug: 'example',\n activity_id: 'example',\n fill_activity: true,\n async: true,\n validate: true,\n },\n {\n _id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n _org: '123',\n _owners: [\n {\n org_id: '123',\n user_id: '123'\n }\n ],\n _schema: 'contact',\n _tags: ['example', 'mock'],\n _created_at: '2021-02-09T12:41:43.662Z',\n _updated_at: '2021-02-09T12:41:43.662Z',\n _acl: {\n view: ['org:456', 'org:789'],\n edit: ['org:456'],\n delete: ['org:456']\n },\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `validateEntity`\n\nValidates an entity against the schema.\n\n`POST /v1/entity/{slug}:validate`\n\n```ts\nconst { data } = await client.validateEntity(\n {\n slug: 'example',\n },\n {\n _id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n _org: '123',\n _owners: [\n {\n org_id: '123',\n user_id: '123'\n }\n ],\n _schema: 'contact',\n _tags: ['example', 'mock'],\n _created_at: '2021-02-09T12:41:43.662Z',\n _updated_at: '2021-02-09T12:41:43.662Z',\n _acl: {\n view: ['org:456', 'org:789'],\n edit: ['org:456'],\n delete: ['org:456']\n },\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"status\": \"success\",\n \"errors\": [\n {\n \"code\": \"custom\",\n \"params\": {\n \"type\": \"missing_field\"\n },\n \"path\": [\"first_name\"],\n \"message\": \"Invalid input\"\n }\n ]\n}\n```\n\n
\n\n---\n\n### `validateEntityV2`\n\nValidates an entity against the schema.\n\n`POST /v2/entity/{slug}:validate`\n\n```ts\nconst { data } = await client.validateEntityV2(\n {\n slug: 'example',\n },\n {\n _id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n _org: '123',\n _owners: [\n {\n org_id: '123',\n user_id: '123'\n }\n ],\n _schema: 'contact',\n _tags: ['example', 'mock'],\n _created_at: '2021-02-09T12:41:43.662Z',\n _updated_at: '2021-02-09T12:41:43.662Z',\n _acl: {\n view: ['org:456', 'org:789'],\n edit: ['org:456'],\n delete: ['org:456']\n },\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"status\": \"success\",\n \"errors\": [\n {\n \"keyword\": \"string\",\n \"instance_path\": \"string\",\n \"schema_path\": \"string\",\n \"params\": {},\n \"property_name\": \"string\",\n \"message\": \"string\",\n \"schema\": {},\n \"parent_schema\": {},\n \"data\": {}\n }\n ]\n}\n```\n\n
\n\n---\n\n### `upsertEntity`\n\nCreate or update an entity using `unique_key`\n\n`PATCH /v1/entity/{slug}:upsert`\n\n```ts\nconst { data } = await client.upsertEntity(\n {\n slug: 'example',\n activity_id: 'example',\n fill_activity: true,\n dry_run: true,\n async: true,\n validate: true,\n strict: true,\n },\n {\n unique_key: ['_id'],\n entity: {\n _id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n _org: '123',\n _owners: [\n {\n org_id: '123',\n user_id: '123'\n }\n ],\n _schema: 'contact',\n _tags: ['example', 'mock'],\n _created_at: '2021-02-09T12:41:43.662Z',\n _updated_at: '2021-02-09T12:41:43.662Z',\n _acl: {\n view: ['org:456', 'org:789'],\n edit: ['org:456'],\n delete: ['org:456']\n },\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n }\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `getEntityV2`\n\nGets Entity by id.\n\n`GET /v2/entity/{slug}/{id}`\n\n```ts\nconst { data } = await client.getEntityV2({\n id: '123e4567-e89b-12d3-a456-426614174000',\n slug: 'example',\n hydrate: true,\n anonymize: true,\n fields: ['...'],\n apply_changesets: true,\n})\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `restoreEntity`\n\nRestores an entity by id\n\n`PATCH /v1/entity/{slug}/{id}:restore`\n\n```ts\nconst { data } = await client.restoreEntity(\n {\n id: '123e4567-e89b-12d3-a456-426614174000',\n slug: 'example',\n activity_id: 'example',\n },\n {},\n)\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `reindexEntity`\n\nTriggers a reindex for the Entity for search.\n\n`POST /v1/entity/{slug}/{id}:reindex`\n\n```ts\nconst { data } = await client.reindexEntity(\n {\n id: '123e4567-e89b-12d3-a456-426614174000',\n slug: 'example',\n },\n {},\n)\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `getEntity`\n\nGets Entity and relations by id.\n\n`GET /v1/entity/{slug}/{id}`\n\n```ts\nconst { data } = await client.getEntity({\n id: '123e4567-e89b-12d3-a456-426614174000',\n slug: 'example',\n hydrate: true,\n anonymize: true,\n})\n```\n\n
\nResponse\n\n```json\n{\n \"entity\": {\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n },\n \"relations\": [\n {\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ]\n}\n```\n\n
\n\n---\n\n### `updateEntity`\n\nUpdates an Entity\n\n`PUT /v1/entity/{slug}/{id}`\n\n```ts\nconst { data } = await client.updateEntity(\n {\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n activity_id: 'example',\n fill_activity: true,\n async: true,\n validate: true,\n direct: true,\n },\n {\n _id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n _org: '123',\n _owners: [\n {\n org_id: '123',\n user_id: '123'\n }\n ],\n _schema: 'contact',\n _tags: ['example', 'mock'],\n _created_at: '2021-02-09T12:41:43.662Z',\n _updated_at: '2021-02-09T12:41:43.662Z',\n _acl: {\n view: ['org:456', 'org:789'],\n edit: ['org:456'],\n delete: ['org:456']\n },\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `patchEntity`\n\nPartially updates an entity with the passed in entity data.\n\n`PATCH /v1/entity/{slug}/{id}`\n\n```ts\nconst { data } = await client.patchEntity(\n {\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n activity_id: 'example',\n fill_activity: true,\n dry_run: true,\n async: true,\n validate: true,\n direct: true,\n },\n {\n _id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n _org: '123',\n _owners: [\n {\n org_id: '123',\n user_id: '123'\n }\n ],\n _schema: 'contact',\n _tags: ['example', 'mock'],\n _created_at: '2021-02-09T12:41:43.662Z',\n _updated_at: '2021-02-09T12:41:43.662Z',\n _acl: {\n view: ['org:456', 'org:789'],\n edit: ['org:456'],\n delete: ['org:456']\n },\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `deleteEntity`\n\nDeletes an Entity\n\n`DELETE /v1/entity/{slug}/{id}`\n\n```ts\nconst { data } = await client.deleteEntity({\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n activity_id: 'example',\n purge: true,\n})\n```\n\n---\n\n### `autocomplete`\n\nAutocomplete entity attributes\n\n`GET /v1/entity:autocomplete`\n\n```ts\nconst { data } = await client.autocomplete({\n anonymize: true,\n input: 'example',\n attribute: 'example',\n slug: 'example',\n size: 1,\n})\n```\n\n
\nResponse\n\n```json\n{\n \"hits\": 1,\n \"results\": [\"value\"]\n}\n```\n\n
\n\n---\n\n### `wipeAllEntities`\n\nCreates a request to queue the deletion of all entities in the system. This is a destructive operation and should only be used in sandbox environments.\n\n`POST /v1/entity:wipeAllEntities`\n\n```ts\nconst { data } = await client.wipeAllEntities(\n null,\n {\n schemas: ['contact']\n },\n)\n```\n\n---\n\n### `createActivity`\n\nCreate an activity that can be displayed in activity feeds.\n\n`POST /v1/entity/activity`\n\n```ts\nconst { data } = await client.createActivity(\n {\n entities: ['...'],\n },\n {\n type: 'string',\n title: 'My custom activity',\n message: '{{caller}} did something with {{entity payload.entity.id}}.',\n payload: {\n entity: {\n id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n schema: 'contact'\n }\n },\n pending: false\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"01F130Q52Q6MWSNS8N2AVXV4JN\",\n \"timestamp\": \"1970-01-01T00:00:00.000Z\",\n \"type\": \"string\",\n \"title\": \"My custom activity\",\n \"message\": \"{{caller}} did something with {{entity payload.entity.id}}.\",\n \"payload\": {\n \"entity\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"schema\": \"contact\"\n }\n },\n \"pending\": false,\n \"caller\": {\n \"EpilotAuth\": {\n \"token\": {\n \"sub\": \"476e9b48-42f4-4234-a2b0-4668b34626ce\",\n \"cognito:groups\": [\"Administrator\"],\n \"cognito:preferred_role\": \"arn:aws:iam::912468240823:role/base-administrator-role\",\n \"iss\": \"https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D\",\n \"custom:ivy_org_id\": \"739224\",\n \"cognito:username\": \"n.ahmad@epilot.cloud\",\n \"custom:ivy_user_id\": \"10006129\",\n \"cognito:roles\": [\"arn:aws:iam::912468240823:role/base-administrator-role\"],\n \"aud\": \"6e0jbdnger7nmoktaaflarue1l\",\n \"event_id\": \"cd5f5583-d90c-4db5-8e99-5f5dd29a4d75\",\n \"token_use\": \"id\",\n \"auth_time\": 1614333023,\n \"exp\": 1614336623,\n \"iat\": 1614333023,\n \"email\": \"n.ahmad@epilot.cloud\"\n }\n }\n }\n}\n```\n\n
\n\n---\n\n### `getActivity`\n\nGet activity by id\n\n`GET /v1/entity/activity/{id}`\n\n```ts\nconst { data } = await client.getActivity({\n anonymize: true,\n id: '123e4567-e89b-12d3-a456-426614174000',\n operations_size: 1,\n operations_from: 1,\n})\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"01F130Q52Q6MWSNS8N2AVXV4JN\",\n \"timestamp\": \"1970-01-01T00:00:00.000Z\",\n \"type\": \"string\",\n \"title\": \"My custom activity\",\n \"message\": \"{{caller}} did something with {{entity payload.entity.id}}.\",\n \"payload\": {\n \"entity\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"schema\": \"contact\"\n }\n },\n \"pending\": false,\n \"caller\": {\n \"EpilotAuth\": {\n \"token\": {}\n }\n },\n \"operations_total\": 1,\n \"operations\": [\n {\n \"entity\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"org\": \"123\",\n \"activity_id\": \"01F130Q52Q6MWSNS8N2AVXV4JN\",\n \"activity_type\": \"string\",\n \"operation\": \"createEntity\",\n \"params\": {},\n \"payload\": {},\n \"diff\": {},\n \"source_context\": {},\n \"_workflow_origin\": {},\n \"_automation_chain\": [\"string\"]\n }\n ]\n}\n```\n\n
\n\n---\n\n### `attachActivity`\n\nAttach existing activity to entity activity feeds\n\n`POST /v1/entity/activity/{id}:attach`\n\n```ts\nconst { data } = await client.attachActivity({\n id: '123e4567-e89b-12d3-a456-426614174000',\n entities: ['...'],\n})\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"01F130Q52Q6MWSNS8N2AVXV4JN\",\n \"timestamp\": \"1970-01-01T00:00:00.000Z\",\n \"type\": \"string\",\n \"title\": \"My custom activity\",\n \"message\": \"{{caller}} did something with {{entity payload.entity.id}}.\",\n \"payload\": {\n \"entity\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"schema\": \"contact\"\n }\n },\n \"pending\": false,\n \"caller\": {\n \"EpilotAuth\": {\n \"token\": {\n \"sub\": \"476e9b48-42f4-4234-a2b0-4668b34626ce\",\n \"cognito:groups\": [\"Administrator\"],\n \"cognito:preferred_role\": \"arn:aws:iam::912468240823:role/base-administrator-role\",\n \"iss\": \"https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D\",\n \"custom:ivy_org_id\": \"739224\",\n \"cognito:username\": \"n.ahmad@epilot.cloud\",\n \"custom:ivy_user_id\": \"10006129\",\n \"cognito:roles\": [\"arn:aws:iam::912468240823:role/base-administrator-role\"],\n \"aud\": \"6e0jbdnger7nmoktaaflarue1l\",\n \"event_id\": \"cd5f5583-d90c-4db5-8e99-5f5dd29a4d75\",\n \"token_use\": \"id\",\n \"auth_time\": 1614333023,\n \"exp\": 1614336623,\n \"iat\": 1614333023,\n \"email\": \"n.ahmad@epilot.cloud\"\n }\n }\n }\n}\n```\n\n
\n\n---\n\n### `applyChangeset`\n\nApplies the proposed value from a pending changeset to the entity attribute\nand removes the changeset. Used for human approval of pending changes.\n\n`POST /v1/entity/{slug}/{id}/changesets/{attribute}:apply`\n\n```ts\nconst { data } = await client.applyChangeset({\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n attribute: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `dismissChangeset`\n\nRemoves a pending changeset without applying it. The attribute value remains unchanged.\n\n`POST /v1/entity/{slug}/{id}/changesets/{attribute}:dismiss`\n\n```ts\nconst { data } = await client.dismissChangeset(\n {\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n attribute: 'example',\n },\n {\n reason: 'string'\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `listChangesets`\n\nReturns all pending changesets for an entity.\n\n`GET /v1/entity/{slug}/{id}/changesets`\n\n```ts\nconst { data } = await client.listChangesets({\n anonymize: true,\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n})\n```\n\n
\nResponse\n\n```json\n{}\n```\n\n
\n\n---\n\n### `getEntityActivityFeed`\n\nGet activity feed for an entity\n\n`GET /v1/entity/{slug}/{id}/activity`\n\n```ts\nconst { data } = await client.getEntityActivityFeed({\n anonymize: true,\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n after: 'example',\n before: 'example',\n start_date: 'example',\n end_date: 'example',\n preset_range: 'example',\n from: 1,\n size: 1,\n type: ['...'],\n include_relations: true,\n exclude_activity_groups: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"total\": 1,\n \"results\": [\n {\n \"_id\": \"01F130Q52Q6MWSNS8N2AVXV4JN\",\n \"timestamp\": \"1970-01-01T00:00:00.000Z\",\n \"type\": \"string\",\n \"title\": \"My custom activity\",\n \"message\": \"{{caller}} did something with {{entity payload.entity.id}}.\",\n \"payload\": {},\n \"pending\": false,\n \"caller\": {},\n \"operations_total\": 1,\n \"operations\": []\n }\n ]\n}\n```\n\n
\n\n---\n\n### `getRelations`\n\nReturns 1st level direct relations for an entity.\n\n`GET /v1/entity/{slug}/{id}/relations`\n\n```ts\nconst { data } = await client.getRelations({\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n hydrate: true,\n anonymize: true,\n include_reverse: true,\n from: 1,\n size: 1,\n include_schemas: ['...'],\n exclude_schemas: ['...'],\n})\n```\n\n
\nResponse\n\n```json\n[\n {\n \"entity_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"org_id\": \"string\",\n \"_schema\": \"contact\",\n \"attribute\": \"string\",\n \"_tags\": [\"string\"],\n \"reverse\": true\n },\n {\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n]\n```\n\n
\n\n---\n\n### `addRelations`\n\nRelates one or more entities to parent entity by adding items to a relation attribute\n\n`POST /v1/entity/{slug}/{id}/relations`\n\n```ts\nconst { data } = await client.addRelations(\n {\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n async: true,\n activity_id: 'example',\n },\n [\n {\n entity_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n org_id: 'string',\n _schema: 'contact',\n attribute: 'string',\n _tags: ['string'],\n reverse: true\n }\n ],\n)\n```\n\n
\nResponse\n\n```json\n{\n \"entity_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"org_id\": \"string\",\n \"_schema\": \"contact\",\n \"attribute\": \"string\",\n \"_tags\": [\"string\"],\n \"reverse\": true\n}\n```\n\n
\n\n---\n\n### `removeRelations`\n\nDisassociate one or more entities to parent entity by removing items to a relation attribute\n\n`DELETE /v1/entity/{slug}/{id}/relations`\n\n```ts\nconst { data } = await client.removeRelations(\n {\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n async: true,\n activity_id: 'example',\n },\n [\n {\n entity_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n org_id: 'string',\n _schema: 'contact',\n attribute: 'string',\n _tags: ['string'],\n reverse: true\n }\n ],\n)\n```\n\n---\n\n### `getRelationsV2`\n\nReturns 1st level direct relations for an entity with pagination.\n\n`GET /v2/entity/{slug}/{id}/relations`\n\n```ts\nconst { data } = await client.getRelationsV2({\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n hydrate: true,\n anonymize: true,\n query: 'example',\n include_reverse: true,\n from: 1,\n size: 1,\n fields: ['...'],\n})\n```\n\n
\nResponse\n\n```json\n{\n \"hits\": 1,\n \"relations\": [\n {\n \"entity_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"org_id\": \"string\",\n \"_schema\": \"contact\",\n \"attribute\": \"string\",\n \"_tags\": [\"string\"],\n \"reverse\": true\n },\n {\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ]\n}\n```\n\n
\n\n---\n\n### `getRelationsV3`\n\nReturns 1st level direct relations for an entity with pagination.\n\n`GET /v3/entity/{slug}/{id}/relations`\n\n```ts\nconst { data } = await client.getRelationsV3({\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n hydrate: true,\n anonymize: true,\n include_reverse: true,\n from: 1,\n size: 1,\n include_schemas: ['...'],\n exclude_schemas: ['...'],\n mode: 'example',\n fields: ['...'],\n include_deleted: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"hits\": 1,\n \"relations\": [\n {\n \"entity_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"org_id\": \"string\",\n \"_schema\": \"contact\",\n \"attribute\": \"string\",\n \"_tags\": [\"string\"],\n \"reverse\": true\n },\n {\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ]\n}\n```\n\n
\n\n---\n\n### `getRelatedEntitiesCount`\n\nReturns the amount of unique related entities for an entity - includes direct and reverse relations.\n\n`GET /v2/entity/{slug}/{id}/relations/count`\n\n```ts\nconst { data } = await client.getRelatedEntitiesCount({\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n exclude_schemas: ['...'],\n})\n```\n\n
\nResponse\n\n```json\n{\n \"hits\": 1\n}\n```\n\n
\n\n---\n\n### `updateRelation`\n\nUpdates an existing relation between two entities.\n\n`PUT /v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}`\n\n```ts\nconst { data } = await client.updateRelation(\n {\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n attribute: 'example',\n entity_id: 'example',\n async: true,\n activity_id: 'example',\n },\n {\n _tags: ['string']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"entity_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"org_id\": \"string\",\n \"_schema\": \"contact\",\n \"attribute\": \"string\",\n \"_tags\": [\"string\"],\n \"reverse\": true\n}\n```\n\n
\n\n---\n\n### `deleteRelation`\n\nRemoves relation between two entities\n\n`DELETE /v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}`\n\n```ts\nconst { data } = await client.deleteRelation({\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n attribute: 'example',\n entity_id: 'example',\n async: true,\n activity_id: 'example',\n})\n```\n\n---\n\n### `exportEntities`\n\nExport entity data in a CSV-format. The export will export data as close as possible to what is visible on Entity UI tables.\nThe values exported as in some cases, transformed to human-readable values.\n\n`POST /v1/entity:export`\n\n```ts\nconst { data } = await client.exportEntities(\n {\n job_id: 'example',\n is_template: true,\n language: 'example',\n },\n {\n q: '_schema:contact AND status:active',\n include_scores: false,\n sort: 'string',\n from: 0,\n size: 10,\n hydrate: false,\n anonymize: false,\n fields: ['_id', '_title', 'first_name', 'account', '!account.*._files', '**._product'],\n aggs: {\n 'contact-count-per-tag': {\n terms: {\n field: '_tags.keyword'\n }\n }\n },\n include_deleted: 'false',\n highlight: {},\n stable_for: 0,\n stable_query_id: 'string',\n search_after: ['string']\n },\n)\n```\n\n---\n\n### `importEntities`\n\nImport Entities\n\n`POST /v1/entity:import`\n\n```ts\nconst { data } = await client.importEntities(\n {\n job_id: 'example',\n },\n {\n S3Reference: {\n bucket: 'my-bucket',\n key: 'imports/my-import.json'\n },\n schema: 'contact'\n },\n)\n```\n\n---\n\n### `abortEntityImport`\n\nAbort a running entity import\n\n`POST /v1/entity:abortImport`\n\n```ts\nconst { data } = await client.abortEntityImport({\n job_id: 'example',\n schema: 'example',\n})\n```\n\n---\n\n### `listSavedViews`\n\nGet the Saved Views based on the schema\n\n`GET /v1/entity/views`\n\n```ts\nconst { data } = await client.listSavedViews({\n slug: 'example',\n sort: 'example',\n from: 1,\n size: 1,\n q: 'example',\n fields: ['...'],\n})\n```\n\n
\nResponse\n\n```json\n{\n \"hits\": 1,\n \"results\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"slug\": [\"contact\"],\n \"name\": \"View listing German\",\n \"org\": \"66\",\n \"shared\": true,\n \"isFavoritedBy\": [\"11701\"],\n \"created_by\": {\n \"user_id\": \"10598\",\n \"org_id\": \"739224\"\n },\n \"ui_config\": {\n \"filters\": {\n \"customer_name\": \"suresh test\",\n \"_tags\": \"360\"\n },\n \"table_layout\": {\n \"opportunity\": {\n \"page\": 1,\n \"sort\": \"_created_at:desc\",\n \"pageSize\": 25,\n \"columnSettings\": []\n }\n }\n },\n \"shared_with\": [\"112233\"]\n }\n ]\n}\n```\n\n
\n\n---\n\n### `createSavedView`\n\nCreates a new saved view\n\n`POST /v1/entity/view`\n\n```ts\nconst { data } = await client.createSavedView(\n null,\n {\n slug: ['contact'],\n name: 'View listing German',\n org: '66',\n shared: true,\n isFavoritedBy: ['11701'],\n created_by: {\n user_id: '10598',\n org_id: '739224'\n },\n ui_config: {\n filters: {\n customer_name: 'suresh test',\n _tags: '360'\n },\n table_layout: {\n opportunity: {\n page: 1,\n sort: '_created_at:desc',\n pageSize: 25,\n columnSettings: []\n }\n }\n },\n shared_with: ['112233']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"slug\": [\"contact\"],\n \"name\": \"View listing German\",\n \"org\": \"66\",\n \"shared\": true,\n \"isFavoritedBy\": [\"11701\"],\n \"created_by\": {\n \"user_id\": \"10598\",\n \"org_id\": \"739224\"\n },\n \"ui_config\": {\n \"filters\": {\n \"customer_name\": \"suresh test\",\n \"_tags\": \"360\"\n },\n \"table_layout\": {\n \"opportunity\": {\n \"page\": 1,\n \"sort\": \"_created_at:desc\",\n \"pageSize\": 25,\n \"columnSettings\": []\n }\n }\n },\n \"shared_with\": [\"112233\"]\n}\n```\n\n
\n\n---\n\n### `getSavedView`\n\nGets Saved View configuration by id.\n\n`GET /v1/entity/view/{id}`\n\n```ts\nconst { data } = await client.getSavedView({\n id: '123e4567-e89b-12d3-a456-426614174000',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"slug\": [\"contact\"],\n \"name\": \"View listing German\",\n \"org\": \"66\",\n \"shared\": true,\n \"isFavoritedBy\": [\"11701\"],\n \"created_by\": {\n \"user_id\": \"10598\",\n \"org_id\": \"739224\"\n },\n \"ui_config\": {\n \"filters\": {\n \"customer_name\": \"suresh test\",\n \"_tags\": \"360\"\n },\n \"table_layout\": {\n \"opportunity\": {\n \"page\": 1,\n \"sort\": \"_created_at:desc\",\n \"pageSize\": 25,\n \"columnSettings\": []\n }\n }\n },\n \"shared_with\": [\"112233\"]\n}\n```\n\n
\n\n---\n\n### `updateSavedView`\n\nUpdates a saved view\n\n`PUT /v1/entity/view/{id}`\n\n```ts\nconst { data } = await client.updateSavedView(\n {\n id: '123e4567-e89b-12d3-a456-426614174000',\n },\n {\n id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n created_at: 'string',\n updated_at: 'string',\n slug: ['contact'],\n name: 'View listing German',\n org: '66',\n shared: true,\n isFavoritedBy: ['11701'],\n created_by: {\n user_id: '10598',\n org_id: '739224'\n },\n ui_config: {\n filters: {\n customer_name: 'suresh test',\n _tags: '360'\n },\n table_layout: {\n opportunity: {\n page: 1,\n sort: '_created_at:desc',\n pageSize: 25,\n columnSettings: []\n }\n }\n },\n shared_with: ['112233']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"slug\": [\"contact\"],\n \"name\": \"View listing German\",\n \"org\": \"66\",\n \"shared\": true,\n \"isFavoritedBy\": [\"11701\"],\n \"created_by\": {\n \"user_id\": \"10598\",\n \"org_id\": \"739224\"\n },\n \"ui_config\": {\n \"filters\": {\n \"customer_name\": \"suresh test\",\n \"_tags\": \"360\"\n },\n \"table_layout\": {\n \"opportunity\": {\n \"page\": 1,\n \"sort\": \"_created_at:desc\",\n \"pageSize\": 25,\n \"columnSettings\": []\n }\n }\n },\n \"shared_with\": [\"112233\"]\n}\n```\n\n
\n\n---\n\n### `patchSavedView`\n\nPartially updates a saved view with the provided payload. If an updated_at is passed and the server contains a newer version of the view a `409` error is returned\n\n`PATCH /v1/entity/view/{id}`\n\n```ts\nconst { data } = await client.patchSavedView(\n {\n id: '123e4567-e89b-12d3-a456-426614174000',\n },\n {\n slug: ['contact'],\n name: 'View listing German',\n org: '66',\n shared: true,\n isFavoritedBy: ['11701'],\n created_by: {\n user_id: '10598',\n org_id: '739224'\n },\n ui_config: {\n filters: {\n customer_name: 'suresh test',\n _tags: '360'\n },\n table_layout: {\n opportunity: {\n page: 1,\n sort: '_created_at:desc',\n pageSize: 25,\n columnSettings: []\n }\n }\n },\n shared_with: ['112233']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"slug\": [\"contact\"],\n \"name\": \"View listing German\",\n \"org\": \"66\",\n \"shared\": true,\n \"isFavoritedBy\": [\"11701\"],\n \"created_by\": {\n \"user_id\": \"10598\",\n \"org_id\": \"739224\"\n },\n \"ui_config\": {\n \"filters\": {\n \"customer_name\": \"suresh test\",\n \"_tags\": \"360\"\n },\n \"table_layout\": {\n \"opportunity\": {\n \"page\": 1,\n \"sort\": \"_created_at:desc\",\n \"pageSize\": 25,\n \"columnSettings\": []\n }\n }\n },\n \"shared_with\": [\"112233\"]\n}\n```\n\n
\n\n---\n\n### `deleteSavedView`\n\nDeletes a saved view\n\n`DELETE /v1/entity/view/{id}`\n\n```ts\nconst { data } = await client.deleteSavedView({\n id: '123e4567-e89b-12d3-a456-426614174000',\n})\n```\n\n---\n\n### `listFavoriteViewsForUser`\n\nGet the Favorite Saved Views for user based on the schema\n\n`GET /v1/entity/views/favorites`\n\n```ts\nconst { data } = await client.listFavoriteViewsForUser()\n```\n\n
\nResponse\n\n```json\n{\n \"results\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"slug\": [\"contact\"],\n \"name\": \"View listing German\",\n \"org\": \"66\",\n \"shared\": true,\n \"isFavoritedBy\": [\"11701\"],\n \"created_by\": {\n \"user_id\": \"10598\",\n \"org_id\": \"739224\"\n },\n \"ui_config\": {\n \"filters\": {\n \"customer_name\": \"suresh test\",\n \"_tags\": \"360\"\n },\n \"table_layout\": {\n \"opportunity\": {\n \"page\": 1,\n \"sort\": \"_created_at:desc\",\n \"pageSize\": 25,\n \"columnSettings\": []\n }\n }\n },\n \"shared_with\": [\"112233\"]\n }\n ]\n}\n```\n\n
\n\n---\n\n### `listTaxonomies`\n\nList taxonomies in an organization\n\n`GET /v1/entity/taxonomies`\n\n```ts\nconst { data } = await client.listTaxonomies({\n include_disabled: true,\n type: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"results\": [\n {\n \"slug\": \"purpose\",\n \"name\": \"Purpose\",\n \"plural\": \"Purposes\",\n \"kind\": \"system\",\n \"type\": \"entity\",\n \"icon\": \"purpose\",\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"deleted_at\": \"1970-01-01T00:00:00.000Z\",\n \"created_by\": \"10598\",\n \"enabled\": true,\n \"order\": 10,\n \"enabled_locations\": [\"account\", \"string\"]\n }\n ]\n}\n```\n\n
\n\n---\n\n### `createTaxonomy`\n\nCreate a new taxonomy\n\n`POST /v1/entity/taxonomies`\n\n```ts\nconst { data } = await client.createTaxonomy(\n null,\n {\n slug: 'purpose',\n name: 'Purpose',\n plural: 'Purposes',\n kind: 'system',\n type: 'entity',\n icon: 'purpose',\n color: '#FF5733',\n created_at: '1970-01-01T00:00:00.000Z',\n updated_at: '1970-01-01T00:00:00.000Z',\n deleted_at: '1970-01-01T00:00:00.000Z',\n created_by: '10598',\n enabled: true,\n order: 10,\n enabled_locations: ['account', 'string']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"slug\": \"purpose\",\n \"name\": \"Purpose\",\n \"plural\": \"Purposes\",\n \"kind\": \"system\",\n \"type\": \"entity\",\n \"icon\": \"purpose\",\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"deleted_at\": \"1970-01-01T00:00:00.000Z\",\n \"created_by\": \"10598\",\n \"enabled\": true,\n \"order\": 10,\n \"enabled_locations\": [\"account\", \"string\"]\n}\n```\n\n
\n\n---\n\n### `getTaxonomy`\n\nGet taxonomy by slug\n\n`GET /v1/entity/taxonomies/{taxonomySlug}`\n\n```ts\nconst { data } = await client.getTaxonomy({\n taxonomySlug: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"slug\": \"purpose\",\n \"name\": \"Purpose\",\n \"plural\": \"Purposes\",\n \"kind\": \"system\",\n \"type\": \"entity\",\n \"icon\": \"purpose\",\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"deleted_at\": \"1970-01-01T00:00:00.000Z\",\n \"created_by\": \"10598\",\n \"enabled\": true,\n \"order\": 10,\n \"enabled_locations\": [\"account\", \"string\"]\n}\n```\n\n
\n\n---\n\n### `updateTaxonomy`\n\nUpdate a taxonomy\n\n`PUT /v1/entity/taxonomies/{taxonomySlug}`\n\n```ts\nconst { data } = await client.updateTaxonomy(\n {\n taxonomySlug: 'example',\n },\n {\n slug: 'purpose',\n name: 'Purpose',\n plural: 'Purposes',\n kind: 'system',\n type: 'entity',\n icon: 'purpose',\n color: '#FF5733',\n created_at: '1970-01-01T00:00:00.000Z',\n updated_at: '1970-01-01T00:00:00.000Z',\n deleted_at: '1970-01-01T00:00:00.000Z',\n created_by: '10598',\n enabled: true,\n order: 10,\n enabled_locations: ['account', 'string']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"slug\": \"purpose\",\n \"name\": \"Purpose\",\n \"plural\": \"Purposes\",\n \"kind\": \"system\",\n \"type\": \"entity\",\n \"icon\": \"purpose\",\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"deleted_at\": \"1970-01-01T00:00:00.000Z\",\n \"created_by\": \"10598\",\n \"enabled\": true,\n \"order\": 10,\n \"enabled_locations\": [\"account\", \"string\"]\n}\n```\n\n
\n\n---\n\n### `deleteTaxonomy`\n\nDelete a taxonomy\n\n`DELETE /v1/entity/taxonomies/{taxonomySlug}`\n\n```ts\nconst { data } = await client.deleteTaxonomy({\n taxonomySlug: 'example',\n permanent: true,\n})\n```\n\n---\n\n### `updateClassificationsForTaxonomy`\n\nUpdate the classifications for a taxonomy\n\n`POST /v1/entity/taxonomies/{taxonomySlug}/classifications`\n\n```ts\nconst { data } = await client.updateClassificationsForTaxonomy(\n {\n taxonomySlug: 'example',\n },\n {\n create: [\n {\n id: 'taxonomy-slug:classification-slug',\n slug: 'wallbox-pv',\n name: 'Wallbox PV',\n parents: ['taxonomy-slug:classification-slug'],\n color: '#FF5733',\n created_at: '1970-01-01T00:00:00.000Z',\n updated_at: '1970-01-01T00:00:00.000Z',\n archived: false,\n starred: false,\n enabled_locations: ['account', 'string'],\n enabled_purposes: ['string'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n }\n ],\n update: [\n {\n id: 'taxonomy-slug:classification-slug',\n slug: 'wallbox-pv',\n name: 'Wallbox PV',\n parents: ['taxonomy-slug:classification-slug'],\n color: '#FF5733',\n created_at: '1970-01-01T00:00:00.000Z',\n updated_at: '1970-01-01T00:00:00.000Z',\n archived: false,\n starred: false,\n enabled_locations: ['account', 'string'],\n enabled_purposes: ['string'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n }\n ],\n delete: ['taxonomy-slug:classification-slug', 'taxonomy-slug:classification-slug']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"created\": [\n {\n \"id\": \"taxonomy-slug:classification-slug\",\n \"slug\": \"wallbox-pv\",\n \"name\": \"Wallbox PV\",\n \"parents\": [\"taxonomy-slug:classification-slug\"],\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"archived\": false,\n \"starred\": false,\n \"enabled_locations\": [\"account\", \"string\"],\n \"enabled_purposes\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ],\n \"updated\": [\n {\n \"id\": \"taxonomy-slug:classification-slug\",\n \"slug\": \"wallbox-pv\",\n \"name\": \"Wallbox PV\",\n \"parents\": [\"taxonomy-slug:classification-slug\"],\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"archived\": false,\n \"starred\": false,\n \"enabled_locations\": [\"account\", \"string\"],\n \"enabled_purposes\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ],\n \"deleted\": [\"taxonomy-slug:classification-slug\"]\n}\n```\n\n
\n\n---\n\n### `createTaxonomyClassification`\n\nCreate a new classification for a taxonomy\n\n`POST /v2/entity/taxonomies/classifications`\n\n```ts\nconst { data } = await client.createTaxonomyClassification(\n null,\n {\n id: 'taxonomy-slug:classification-slug',\n slug: 'wallbox-pv',\n name: 'Wallbox PV',\n parents: ['taxonomy-slug:classification-slug'],\n color: '#FF5733',\n created_at: '1970-01-01T00:00:00.000Z',\n updated_at: '1970-01-01T00:00:00.000Z',\n archived: false,\n starred: false,\n enabled_locations: ['account', 'string'],\n enabled_purposes: ['string'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"taxonomy-slug:classification-slug\",\n \"slug\": \"wallbox-pv\",\n \"name\": \"Wallbox PV\",\n \"parents\": [\"taxonomy-slug:classification-slug\"],\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"archived\": false,\n \"starred\": false,\n \"enabled_locations\": [\"account\", \"string\"],\n \"enabled_purposes\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `getTaxonomyClassification`\n\nGet a classification for a taxonomy by slug\n\n`GET /v2/entity/taxonomies/classifications/{classificationSlug}`\n\n```ts\nconst { data } = await client.getTaxonomyClassification({\n classificationSlug: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"taxonomy-slug:classification-slug\",\n \"slug\": \"wallbox-pv\",\n \"name\": \"Wallbox PV\",\n \"parents\": [\"taxonomy-slug:classification-slug\"],\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"archived\": false,\n \"starred\": false,\n \"enabled_locations\": [\"account\", \"string\"],\n \"enabled_purposes\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `updateTaxonomyClassification`\n\nUpdate a classification for a taxonomy\n\n`PUT /v2/entity/taxonomies/classifications/{classificationSlug}`\n\n```ts\nconst { data } = await client.updateTaxonomyClassification(\n {\n classificationSlug: 'example',\n },\n {\n id: 'taxonomy-slug:classification-slug',\n slug: 'wallbox-pv',\n name: 'Wallbox PV',\n parents: ['taxonomy-slug:classification-slug'],\n color: '#FF5733',\n created_at: '1970-01-01T00:00:00.000Z',\n updated_at: '1970-01-01T00:00:00.000Z',\n archived: false,\n starred: false,\n enabled_locations: ['account', 'string'],\n enabled_purposes: ['string'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"taxonomy-slug:classification-slug\",\n \"slug\": \"wallbox-pv\",\n \"name\": \"Wallbox PV\",\n \"parents\": [\"taxonomy-slug:classification-slug\"],\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"archived\": false,\n \"starred\": false,\n \"enabled_locations\": [\"account\", \"string\"],\n \"enabled_purposes\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `deleteTaxonomyClassification`\n\nDelete a classification for a taxonomy\n\n`DELETE /v2/entity/taxonomies/classifications/{classificationSlug}`\n\n```ts\nconst { data } = await client.deleteTaxonomyClassification({\n classificationSlug: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"taxonomy-slug:classification-slug\",\n \"slug\": \"wallbox-pv\",\n \"name\": \"Wallbox PV\",\n \"parents\": [\"taxonomy-slug:classification-slug\"],\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"archived\": false,\n \"starred\": false,\n \"enabled_locations\": [\"account\", \"string\"],\n \"enabled_purposes\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `taxonomyAutocomplete`\n\nTaxonomies autocomplete\n\n`GET /v1/entity/taxonomies/{taxonomySlug}:autocomplete`\n\n```ts\nconst { data } = await client.taxonomyAutocomplete({\n taxonomySlug: 'example',\n query: 'example',\n size: 1,\n})\n```\n\n
\nResponse\n\n```json\n{\n \"results\": [\n {\n \"id\": \"taxonomy-slug:classification-slug\",\n \"slug\": \"wallbox-pv\",\n \"name\": \"Wallbox PV\",\n \"parents\": [\"taxonomy-slug:classification-slug\"],\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"archived\": false,\n \"starred\": false,\n \"enabled_locations\": [\"account\", \"string\"],\n \"enabled_purposes\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ]\n}\n```\n\n
\n\n---\n\n### `taxonomiesClassificationsSearch`\n\nList taxonomy classifications in an organization based on taxonomy slug\n\n`POST /v1/entity/taxonomies/classifications:search`\n\n```ts\nconst { data } = await client.taxonomiesClassificationsSearch(\n {\n taxonomySlug: ['...'],\n query: 'example',\n archived: true,\n include_archived: 'example',\n exclude_types: ['...'],\n },\n {\n classificationIds: [\n 'taxonomy-slug:classification-slug',\n {\n pattern: 'taxonomy-slug:*'\n }\n ]\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"results\": [\n {\n \"id\": \"taxonomy-slug:classification-slug\",\n \"slug\": \"wallbox-pv\",\n \"name\": \"Wallbox PV\",\n \"parents\": [\"taxonomy-slug:classification-slug\"],\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"archived\": false,\n \"starred\": false,\n \"enabled_locations\": [\"account\", \"string\"],\n \"enabled_purposes\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ],\n \"hits\": 10\n}\n```\n\n
\n\n---\n\n### `listTaxonomyClassificationsForSchema`\n\nList taxonomy classifications for a given schema\n\n`GET /v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}`\n\n```ts\nconst { data } = await client.listTaxonomyClassificationsForSchema({\n slug: 'example',\n taxonomySlug: 'example',\n query: 'example',\n size: 1,\n})\n```\n\n
\nResponse\n\n```json\n{\n \"results\": [\n {\n \"id\": \"taxonomy-slug:classification-slug\",\n \"slug\": \"wallbox-pv\",\n \"name\": \"Wallbox PV\",\n \"parents\": [\"taxonomy-slug:classification-slug\"],\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"archived\": false,\n \"starred\": false,\n \"enabled_locations\": [\"account\", \"string\"],\n \"enabled_purposes\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ]\n}\n```\n\n
\n\n---\n\n### `getTaxonomyBulkActionJobs`\n\nGets bulk actions jobs by job status:\n- ```` = all active jobs\n- PENDING = all active jobs\n- FAILED = all failed jobs\n- COMPLETED = all completed jobs\n\n`GET /v1/entity/taxonomies/bulk-jobs`\n\n```ts\nconst { data } = await client.getTaxonomyBulkActionJobs({\n status: ['...'],\n size: 1,\n created_after: 'example',\n sort_pending_first: true,\n scope: 'example',\n})\n```\n\n
\nResponse\n\n```json\n[\n {\n \"job_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"PENDING\",\n \"action_type\": \"MOVE_CLASSIFICATIONS\",\n \"created_by\": \"10598\",\n \"created_at\": \"2024-01-01T00:00:00.000Z\",\n \"updated_at\": \"2024-01-01T00:00:00.000Z\",\n \"org\": \"66\"\n }\n]\n```\n\n
\n\n---\n\n### `getTaxonomyBulkActionJobById`\n\nGets a bulk action job by job id\n\n`GET /v1/entity/taxonomies/bulk-jobs/{job_id}`\n\n```ts\nconst { data } = await client.getTaxonomyBulkActionJobById({\n job_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"job_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"PENDING\",\n \"action_type\": \"MOVE_CLASSIFICATIONS\",\n \"created_by\": \"10598\",\n \"created_at\": \"2024-01-01T00:00:00.000Z\",\n \"updated_at\": \"2024-01-01T00:00:00.000Z\",\n \"org\": \"66\"\n}\n```\n\n
\n\n---\n\n### `cancelBulkAction`\n\nCancels a running bulk action job. The job status will be updated to CANCELLED\nand the job will be stopped.\n\n`POST /v1/entity/taxonomies/bulk-jobs/{job_id}/cancel`\n\n```ts\nconst { data } = await client.cancelBulkAction({\n job_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"job_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"PENDING\",\n \"action_type\": \"MOVE_CLASSIFICATIONS\",\n \"created_by\": \"10598\",\n \"created_at\": \"2024-01-01T00:00:00.000Z\",\n \"updated_at\": \"2024-01-01T00:00:00.000Z\",\n \"org\": \"66\"\n}\n```\n\n
\n\n---\n\n### `bulkMoveClassifications`\n\nMoves classifications from one taxonomy to another, through a bulk async operation which\nalso updates all references from the old classification to the new one under the target taxonomy.\n\n`POST /v1/entity/taxonomies/classifications:move`\n\n```ts\nconst { data } = await client.bulkMoveClassifications(\n null,\n {\n job_id: 'string',\n target_taxonomy: 'purpose',\n classification_ids: ['taxonomy-slug:classification-slug']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"job_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"status\": \"PENDING\"\n}\n```\n\n
\n\n---\n\n### `bulkMergeClassifications`\n\nMerges classifications from one taxonomy into one individual classification, through a bulk async operation which\nalso updates all references from the old Classifications to the new one.\n\n`POST /v1/entity/taxonomies/classifications:merge`\n\n```ts\nconst { data } = await client.bulkMergeClassifications(\n null,\n {\n job_id: 'string',\n target_classification: 'purpose',\n classification_ids: ['taxonomy-slug:classification-slug']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"job_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"status\": \"PENDING\"\n}\n```\n\n
\n\n---\n\n### `bulkDeleteClassifications`\n\nPermanently deletes taxonomy classifications. The classifications are deleted through a bulk\nasync operation which also deletes all references of the deleted classifications from the entities\nreferenc\n\n`POST /v1/entity/taxonomies/classifications:delete`\n\n```ts\nconst { data } = await client.bulkDeleteClassifications(\n null,\n {\n job_id: 'string',\n classification_ids: ['taxonomy-slug:classification-slug']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"job_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"status\": \"PENDING\"\n}\n```\n\n
\n\n---\n\n### `createSchemaAttribute`\n\nCreate a schema attribute\n\n`POST /v1/entity/schemas/attributes`\n\n```ts\nconst { data } = await client.createSchemaAttribute(\n null,\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'string',\n label: 'string',\n placeholder: 'string',\n hidden: false,\n show_in_table: true,\n sortable: true,\n required: false,\n readonly: false,\n deprecated: false,\n variant_overridable: false,\n default_value: {},\n group: 'string',\n order: 0,\n layout: 'full_width',\n hide_label: true,\n icon: 'string',\n render_condition: 'string',\n data_classification: 'public',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n constraints: {\n disablePast: true\n },\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [\n {\n name: 'string',\n enabled: true\n }\n ],\n value_formatter: 'string',\n preview_value_formatter: 'string',\n entity_builder_disable_edit: false,\n protected: true,\n info_helpers: {\n hint_text: 'string',\n hint_text_key: 'string',\n hint_custom_component: 'string',\n hint_tooltip_placement: 'top'\n },\n explicit_searchable: false,\n exclude_from_search: false,\n repeatable: true,\n has_primary: true,\n edit_mode: 'direct',\n edit_mode_config: {\n match_strategy: 'exact',\n fuzzy_config: {\n type: 'suffix',\n suffix_length: 0,\n fields_to_ignore: ['string'],\n regex_flags: 'string',\n country_code: 'string',\n match_on: 'string',\n key: 'string',\n mode: 'subset',\n ordered: true,\n require_tags_match: true,\n pattern: 'string'\n }\n },\n type: 'string',\n multiline: true,\n rich_text: true,\n rows: 3\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {\n \"disablePast\": true\n },\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {\n \"hint_text\": \"string\",\n \"hint_text_key\": \"string\",\n \"hint_custom_component\": \"string\",\n \"hint_tooltip_placement\": \"top\"\n },\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {\n \"match_strategy\": \"exact\",\n \"fuzzy_config\": {\n \"type\": \"suffix\",\n \"suffix_length\": 0,\n \"fields_to_ignore\": [\"string\"],\n \"regex_flags\": \"string\",\n \"country_code\": \"string\",\n \"match_on\": \"string\",\n \"key\": \"string\",\n \"mode\": \"subset\",\n \"ordered\": true,\n \"require_tags_match\": true,\n \"pattern\": \"string\"\n }\n },\n \"type\": \"string\",\n \"multiline\": true,\n \"rich_text\": true,\n \"rows\": 3\n}\n```\n\n
\n\n---\n\n### `getSchemaAttribute`\n\nGet a schema attribute from given attribute ID\n\n`GET /v1/entity/schemas/attributes/{composite_id}`\n\n```ts\nconst { data } = await client.getSchemaAttribute({\n composite_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {\n \"disablePast\": true\n },\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {\n \"hint_text\": \"string\",\n \"hint_text_key\": \"string\",\n \"hint_custom_component\": \"string\",\n \"hint_tooltip_placement\": \"top\"\n },\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {\n \"match_strategy\": \"exact\",\n \"fuzzy_config\": {\n \"type\": \"suffix\",\n \"suffix_length\": 0,\n \"fields_to_ignore\": [\"string\"],\n \"regex_flags\": \"string\",\n \"country_code\": \"string\",\n \"match_on\": \"string\",\n \"key\": \"string\",\n \"mode\": \"subset\",\n \"ordered\": true,\n \"require_tags_match\": true,\n \"pattern\": \"string\"\n }\n },\n \"type\": \"string\",\n \"multiline\": true,\n \"rich_text\": true,\n \"rows\": 3\n}\n```\n\n
\n\n---\n\n### `putSchemaAttribute`\n\nUpdates an attribute in the schema\n\n`PUT /v1/entity/schemas/attributes/{composite_id}`\n\n```ts\nconst { data } = await client.putSchemaAttribute(\n {\n composite_id: 'example',\n },\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'string',\n label: 'string',\n placeholder: 'string',\n hidden: false,\n show_in_table: true,\n sortable: true,\n required: false,\n readonly: false,\n deprecated: false,\n variant_overridable: false,\n default_value: {},\n group: 'string',\n order: 0,\n layout: 'full_width',\n hide_label: true,\n icon: 'string',\n render_condition: 'string',\n data_classification: 'public',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n constraints: {\n disablePast: true\n },\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [\n {\n name: 'string',\n enabled: true\n }\n ],\n value_formatter: 'string',\n preview_value_formatter: 'string',\n entity_builder_disable_edit: false,\n protected: true,\n info_helpers: {\n hint_text: 'string',\n hint_text_key: 'string',\n hint_custom_component: 'string',\n hint_tooltip_placement: 'top'\n },\n explicit_searchable: false,\n exclude_from_search: false,\n repeatable: true,\n has_primary: true,\n edit_mode: 'direct',\n edit_mode_config: {\n match_strategy: 'exact',\n fuzzy_config: {\n type: 'suffix',\n suffix_length: 0,\n fields_to_ignore: ['string'],\n regex_flags: 'string',\n country_code: 'string',\n match_on: 'string',\n key: 'string',\n mode: 'subset',\n ordered: true,\n require_tags_match: true,\n pattern: 'string'\n }\n },\n type: 'string',\n multiline: true,\n rich_text: true,\n rows: 3\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {\n \"disablePast\": true\n },\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {\n \"hint_text\": \"string\",\n \"hint_text_key\": \"string\",\n \"hint_custom_component\": \"string\",\n \"hint_tooltip_placement\": \"top\"\n },\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {\n \"match_strategy\": \"exact\",\n \"fuzzy_config\": {\n \"type\": \"suffix\",\n \"suffix_length\": 0,\n \"fields_to_ignore\": [\"string\"],\n \"regex_flags\": \"string\",\n \"country_code\": \"string\",\n \"match_on\": \"string\",\n \"key\": \"string\",\n \"mode\": \"subset\",\n \"ordered\": true,\n \"require_tags_match\": true,\n \"pattern\": \"string\"\n }\n },\n \"type\": \"string\",\n \"multiline\": true,\n \"rich_text\": true,\n \"rows\": 3\n}\n```\n\n
\n\n---\n\n### `deleteSchemaAttribute`\n\nDeletes an attribute from a schema\n\n`DELETE /v1/entity/schemas/attributes/{composite_id}`\n\n```ts\nconst { data } = await client.deleteSchemaAttribute({\n composite_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {\n \"disablePast\": true\n },\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {\n \"hint_text\": \"string\",\n \"hint_text_key\": \"string\",\n \"hint_custom_component\": \"string\",\n \"hint_tooltip_placement\": \"top\"\n },\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {\n \"match_strategy\": \"exact\",\n \"fuzzy_config\": {\n \"type\": \"suffix\",\n \"suffix_length\": 0,\n \"fields_to_ignore\": [\"string\"],\n \"regex_flags\": \"string\",\n \"country_code\": \"string\",\n \"match_on\": \"string\",\n \"key\": \"string\",\n \"mode\": \"subset\",\n \"ordered\": true,\n \"require_tags_match\": true,\n \"pattern\": \"string\"\n }\n },\n \"type\": \"string\",\n \"multiline\": true,\n \"rich_text\": true,\n \"rows\": 3\n}\n```\n\n
\n\n---\n\n### `createSchemaCapability`\n\nCreate a schema capability\n\n`POST /v1/entity/schemas/capabilities`\n\n```ts\nconst { data } = await client.createSchemaCapability(\n null,\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'customer_messaging',\n title: 'Messaging',\n attributes: [\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'string',\n label: 'string',\n placeholder: 'string',\n hidden: false,\n show_in_table: true,\n sortable: true,\n required: false,\n readonly: false,\n deprecated: false,\n variant_overridable: false,\n default_value: {},\n group: 'string',\n order: 0,\n layout: 'full_width',\n hide_label: true,\n icon: 'string',\n render_condition: 'string',\n data_classification: 'public',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n constraints: { /* ... */ },\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [ /* ... */ ],\n value_formatter: 'string',\n preview_value_formatter: 'string',\n entity_builder_disable_edit: false,\n protected: true,\n info_helpers: { /* ... */ },\n explicit_searchable: false,\n exclude_from_search: false,\n repeatable: true,\n has_primary: true,\n edit_mode: 'direct',\n edit_mode_config: { /* ... */ },\n type: 'string',\n multiline: true,\n rich_text: true,\n rows: 3\n },\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'string',\n label: 'string',\n placeholder: 'string',\n hidden: false,\n show_in_table: true,\n sortable: true,\n required: false,\n readonly: false,\n deprecated: false,\n variant_overridable: false,\n default_value: {},\n group: 'string',\n order: 0,\n layout: 'full_width',\n hide_label: true,\n icon: 'string',\n render_condition: 'string',\n data_classification: 'public',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n constraints: { /* ... */ },\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [ /* ... */ ],\n value_formatter: 'string',\n preview_value_formatter: 'string',\n entity_builder_disable_edit: false,\n protected: true,\n info_helpers: { /* ... */ },\n explicit_searchable: false,\n exclude_from_search: false,\n repeatable: true,\n has_primary: true,\n edit_mode: 'direct',\n edit_mode_config: { /* ... */ },\n type: 'link'\n },\n /* ... 33 more */\n ],\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n app_id: '123e4567-e89b-12d3-a456-426614174000',\n ui_config: {\n is_filterable: true\n },\n ui_hooks: [\n {\n hook: 'EntityDetailsV2:Tab',\n render_condition: '_is_composite_price = \"false\"',\n order: 10,\n title: 'Notes',\n group_expanded: true,\n import: '@epilot360/notes',\n component: 'PricingItems',\n route: 'notes',\n icon: 'email',\n disabled: true,\n header: true,\n requiredPermission: { /* ... */ }\n }\n ],\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [\n {\n name: 'string',\n enabled: true\n }\n ],\n schemas: [\n {\n schema: 'contact'\n }\n ],\n composite_id: 'contact:97644baa-083f-4e49-9188-fcff2ecaad7d',\n schema: 'contact'\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"customer_messaging\",\n \"title\": \"Messaging\",\n \"attributes\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {},\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {},\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {},\n \"type\": \"string\",\n \"multiline\": true,\n \"rich_text\": true,\n \"rows\": 3\n },\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {},\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {},\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {},\n \"type\": \"link\"\n }\n ],\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"app_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"ui_config\": {\n \"is_filterable\": true\n },\n \"ui_hooks\": [\n {\n \"hook\": \"EntityDetailsV2:Tab\",\n \"render_condition\": \"_is_composite_price = \\\"false\\\"\",\n \"order\": 10,\n \"title\": \"Notes\",\n \"group_expanded\": true,\n \"import\": \"@epilot360/notes\",\n \"component\": \"PricingItems\",\n \"route\": \"notes\",\n \"icon\": \"email\",\n \"disabled\": true,\n \"header\": true,\n \"requiredPermission\": {}\n }\n ],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"schemas\": [\n {\n \"schema\": \"contact\"\n }\n ],\n \"composite_id\": \"contact:97644baa-083f-4e49-9188-fcff2ecaad7d\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `getSchemaCapability`\n\nGet a schema capability from given capability ID\n\n`GET /v1/entity/schemas/capabilities/{composite_id}`\n\n```ts\nconst { data } = await client.getSchemaCapability({\n composite_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"customer_messaging\",\n \"title\": \"Messaging\",\n \"attributes\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {},\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {},\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {},\n \"type\": \"string\",\n \"multiline\": true,\n \"rich_text\": true,\n \"rows\": 3\n },\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {},\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {},\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {},\n \"type\": \"link\"\n }\n ],\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"app_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"ui_config\": {\n \"is_filterable\": true\n },\n \"ui_hooks\": [\n {\n \"hook\": \"EntityDetailsV2:Tab\",\n \"render_condition\": \"_is_composite_price = \\\"false\\\"\",\n \"order\": 10,\n \"title\": \"Notes\",\n \"group_expanded\": true,\n \"import\": \"@epilot360/notes\",\n \"component\": \"PricingItems\",\n \"route\": \"notes\",\n \"icon\": \"email\",\n \"disabled\": true,\n \"header\": true,\n \"requiredPermission\": {}\n }\n ],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"schemas\": [\n {\n \"schema\": \"contact\"\n }\n ],\n \"composite_id\": \"contact:97644baa-083f-4e49-9188-fcff2ecaad7d\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `putSchemaCapability`\n\nAdds or updates an capability in the schema\n\n`PUT /v1/entity/schemas/capabilities/{composite_id}`\n\n```ts\nconst { data } = await client.putSchemaCapability(\n {\n composite_id: 'example',\n },\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'customer_messaging',\n title: 'Messaging',\n attributes: [\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'string',\n label: 'string',\n placeholder: 'string',\n hidden: false,\n show_in_table: true,\n sortable: true,\n required: false,\n readonly: false,\n deprecated: false,\n variant_overridable: false,\n default_value: {},\n group: 'string',\n order: 0,\n layout: 'full_width',\n hide_label: true,\n icon: 'string',\n render_condition: 'string',\n data_classification: 'public',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n constraints: { /* ... */ },\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [ /* ... */ ],\n value_formatter: 'string',\n preview_value_formatter: 'string',\n entity_builder_disable_edit: false,\n protected: true,\n info_helpers: { /* ... */ },\n explicit_searchable: false,\n exclude_from_search: false,\n repeatable: true,\n has_primary: true,\n edit_mode: 'direct',\n edit_mode_config: { /* ... */ },\n type: 'string',\n multiline: true,\n rich_text: true,\n rows: 3\n },\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'string',\n label: 'string',\n placeholder: 'string',\n hidden: false,\n show_in_table: true,\n sortable: true,\n required: false,\n readonly: false,\n deprecated: false,\n variant_overridable: false,\n default_value: {},\n group: 'string',\n order: 0,\n layout: 'full_width',\n hide_label: true,\n icon: 'string',\n render_condition: 'string',\n data_classification: 'public',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n constraints: { /* ... */ },\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [ /* ... */ ],\n value_formatter: 'string',\n preview_value_formatter: 'string',\n entity_builder_disable_edit: false,\n protected: true,\n info_helpers: { /* ... */ },\n explicit_searchable: false,\n exclude_from_search: false,\n repeatable: true,\n has_primary: true,\n edit_mode: 'direct',\n edit_mode_config: { /* ... */ },\n type: 'link'\n },\n /* ... 33 more */\n ],\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n app_id: '123e4567-e89b-12d3-a456-426614174000',\n ui_config: {\n is_filterable: true\n },\n ui_hooks: [\n {\n hook: 'EntityDetailsV2:Tab',\n render_condition: '_is_composite_price = \"false\"',\n order: 10,\n title: 'Notes',\n group_expanded: true,\n import: '@epilot360/notes',\n component: 'PricingItems',\n route: 'notes',\n icon: 'email',\n disabled: true,\n header: true,\n requiredPermission: { /* ... */ }\n }\n ],\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [\n {\n name: 'string',\n enabled: true\n }\n ],\n schemas: [\n {\n schema: 'contact'\n }\n ],\n composite_id: 'contact:97644baa-083f-4e49-9188-fcff2ecaad7d',\n schema: 'contact'\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"customer_messaging\",\n \"title\": \"Messaging\",\n \"attributes\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {},\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {},\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {},\n \"type\": \"string\",\n \"multiline\": true,\n \"rich_text\": true,\n \"rows\": 3\n },\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {},\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {},\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {},\n \"type\": \"link\"\n }\n ],\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"app_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"ui_config\": {\n \"is_filterable\": true\n },\n \"ui_hooks\": [\n {\n \"hook\": \"EntityDetailsV2:Tab\",\n \"render_condition\": \"_is_composite_price = \\\"false\\\"\",\n \"order\": 10,\n \"title\": \"Notes\",\n \"group_expanded\": true,\n \"import\": \"@epilot360/notes\",\n \"component\": \"PricingItems\",\n \"route\": \"notes\",\n \"icon\": \"email\",\n \"disabled\": true,\n \"header\": true,\n \"requiredPermission\": {}\n }\n ],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"schemas\": [\n {\n \"schema\": \"contact\"\n }\n ],\n \"composite_id\": \"contact:97644baa-083f-4e49-9188-fcff2ecaad7d\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `deleteSchemaCapability`\n\nDeletes a Capability from a schema\n\n`DELETE /v1/entity/schemas/capabilities/{composite_id}`\n\n```ts\nconst { data } = await client.deleteSchemaCapability({\n composite_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"customer_messaging\",\n \"title\": \"Messaging\",\n \"attributes\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {},\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {},\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {},\n \"type\": \"string\",\n \"multiline\": true,\n \"rich_text\": true,\n \"rows\": 3\n },\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {},\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {},\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {},\n \"type\": \"link\"\n }\n ],\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"app_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"ui_config\": {\n \"is_filterable\": true\n },\n \"ui_hooks\": [\n {\n \"hook\": \"EntityDetailsV2:Tab\",\n \"render_condition\": \"_is_composite_price = \\\"false\\\"\",\n \"order\": 10,\n \"title\": \"Notes\",\n \"group_expanded\": true,\n \"import\": \"@epilot360/notes\",\n \"component\": \"PricingItems\",\n \"route\": \"notes\",\n \"icon\": \"email\",\n \"disabled\": true,\n \"header\": true,\n \"requiredPermission\": {}\n }\n ],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"schemas\": [\n {\n \"schema\": \"contact\"\n }\n ],\n \"composite_id\": \"contact:97644baa-083f-4e49-9188-fcff2ecaad7d\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `createSchemaGroup`\n\nCreate a schema group\n\n`POST /v1/entity/schemas/group`\n\n```ts\nconst { data } = await client.createSchemaGroup(\n null,\n {\n label: 'Contact Details',\n id: 'e18a532b-ae79-4d86-a6a5-e5dbfb579d14',\n order: 0,\n expanded: false,\n render_condition: '_is_composite_price = \"false\"',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [\n {\n name: 'string',\n enabled: true\n }\n ],\n info_tooltip_title: {\n key: 'string',\n default: 'string'\n },\n composite_id: 'contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14',\n schema: 'contact'\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"label\": \"Contact Details\",\n \"id\": \"e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"order\": 0,\n \"expanded\": false,\n \"render_condition\": \"_is_composite_price = \\\"false\\\"\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"info_tooltip_title\": {\n \"key\": \"string\",\n \"default\": \"string\"\n },\n \"composite_id\": \"contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `getSchemaGroup`\n\nGet a schema group from given group composite ID\n\n`GET /v1/entity/schemas/group/{composite_id}`\n\n```ts\nconst { data } = await client.getSchemaGroup({\n composite_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"label\": \"Contact Details\",\n \"id\": \"e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"order\": 0,\n \"expanded\": false,\n \"render_condition\": \"_is_composite_price = \\\"false\\\"\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"info_tooltip_title\": {\n \"key\": \"string\",\n \"default\": \"string\"\n },\n \"composite_id\": \"contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `putSchemaGroup`\n\nAdds or updates an capability in the schema\n\n`PUT /v1/entity/schemas/group/{composite_id}`\n\n```ts\nconst { data } = await client.putSchemaGroup(\n {\n composite_id: 'example',\n },\n {\n label: 'Contact Details',\n id: 'e18a532b-ae79-4d86-a6a5-e5dbfb579d14',\n order: 0,\n expanded: false,\n render_condition: '_is_composite_price = \"false\"',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [\n {\n name: 'string',\n enabled: true\n }\n ],\n info_tooltip_title: {\n key: 'string',\n default: 'string'\n },\n composite_id: 'contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14',\n schema: 'contact'\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"label\": \"Contact Details\",\n \"id\": \"e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"order\": 0,\n \"expanded\": false,\n \"render_condition\": \"_is_composite_price = \\\"false\\\"\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"info_tooltip_title\": {\n \"key\": \"string\",\n \"default\": \"string\"\n },\n \"composite_id\": \"contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `deleteSchemaGroup`\n\nDeletes a Capability from a schema\n\n`DELETE /v1/entity/schemas/group/{composite_id}`\n\n```ts\nconst { data } = await client.deleteSchemaGroup({\n composite_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"label\": \"Contact Details\",\n \"id\": \"e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"order\": 0,\n \"expanded\": false,\n \"render_condition\": \"_is_composite_price = \\\"false\\\"\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"info_tooltip_title\": {\n \"key\": \"string\",\n \"default\": \"string\"\n },\n \"composite_id\": \"contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `createSchemaGroupHeadline`\n\nCreate a headline in a schema group\n\n`POST /v1/entity/schemas/headline`\n\n```ts\nconst { data } = await client.createSchemaGroupHeadline(\n null,\n {\n id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n name: 'string',\n label: 'string',\n layout: 'string',\n group: 'string',\n order: 0,\n type: 'headline',\n enable_divider: false,\n divider: 'top_divider',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n composite_id: 'contact:97644baa-083f-4e49-9188-fcff2ecaad7d',\n schema: 'contact'\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"layout\": \"string\",\n \"group\": \"string\",\n \"order\": 0,\n \"type\": \"headline\",\n \"enable_divider\": false,\n \"divider\": \"top_divider\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"composite_id\": \"contact:97644baa-083f-4e49-9188-fcff2ecaad7d\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `getSchemaGroupHeadline`\n\nGet a group headline from schema from given headline composite ID\n\n`GET /v1/entity/schemas/headline/{composite_id}`\n\n```ts\nconst { data } = await client.getSchemaGroupHeadline({\n composite_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"layout\": \"string\",\n \"group\": \"string\",\n \"order\": 0,\n \"type\": \"headline\",\n \"enable_divider\": false,\n \"divider\": \"top_divider\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"composite_id\": \"contact:97644baa-083f-4e49-9188-fcff2ecaad7d\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `putSchemaGroupHeadline`\n\nAdds or updates a group headline in the schema\n\n`PUT /v1/entity/schemas/headline/{composite_id}`\n\n```ts\nconst { data } = await client.putSchemaGroupHeadline(\n {\n composite_id: 'example',\n },\n {\n id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n name: 'string',\n label: 'string',\n layout: 'string',\n group: 'string',\n order: 0,\n type: 'headline',\n enable_divider: false,\n divider: 'top_divider',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n composite_id: 'contact:97644baa-083f-4e49-9188-fcff2ecaad7d',\n schema: 'contact'\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"layout\": \"string\",\n \"group\": \"string\",\n \"order\": 0,\n \"type\": \"headline\",\n \"enable_divider\": false,\n \"divider\": \"top_divider\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"composite_id\": \"contact:97644baa-083f-4e49-9188-fcff2ecaad7d\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `deleteSchemaGroupHeadline`\n\nDeletes a group headline from a schema\n\n`DELETE /v1/entity/schemas/headline/{composite_id}`\n\n```ts\nconst { data } = await client.deleteSchemaGroupHeadline({\n composite_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"layout\": \"string\",\n \"group\": \"string\",\n \"order\": 0,\n \"type\": \"headline\",\n \"enable_divider\": false,\n \"divider\": \"top_divider\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"composite_id\": \"contact:97644baa-083f-4e49-9188-fcff2ecaad7d\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n## Schemas\n\n### `ExportJobId`\n\nThe unique identifier of the import job.\n\n```ts\ntype ExportJobId = string\n```\n\n### `Language`\n\nExport headers translation Language\n\n```ts\ntype Language = string\n```\n\n### `IsTemplate`\n\nPass 'true' to generate import template\n\n```ts\ntype IsTemplate = boolean\n```\n\n### `SchemaId`\n\nGenerated uuid for schema\n\n```ts\ntype SchemaId = string // uuid\n```\n\n### `EntitySchema`\n\nThe \"type\" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.\n\n```ts\ntype EntitySchema = {\n slug: string\n version?: number\n blueprint?: string // uuid\n feature_flag?: string\n enable_setting?: string[]\n name: string\n plural: string\n description?: string\n docs_url?: string // uri\n category?: string\n published?: boolean\n draft?: boolean\n icon?: string\n title_template?: string\n ui_config?: {\n table_view?: {\n view_type?: { ... }\n row_actions?: { ... }\n bulk_actions?: { ... }\n navbar_actions?: { ... }\n enable_thumbnails?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n create_view?: {\n view_type?: { ... }\n search_params?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n edit_view?: {\n view_type?: { ... }\n search_params?: { ... }\n summary_attributes?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n single_view?: {\n view_type?: { ... }\n search_params?: { ... }\n summary_attributes?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n list_item?: {\n summary_attributes?: { ... }\n quick_actions?: { ... }\n ui_config?: { ... }\n }\n sharing?: {\n show_sharing_button?: { ... }\n }\n grid_layout?: {\n id?: { ... }\n columns?: { ... }\n cells?: { ... }\n }\n widget_order?: string[]\n }\n capabilities: Array<{\n id?: string\n name: string\n title?: string\n attributes?: Array<{\n id?: { ... }\n name: { ... }\n label: { ... }\n placeholder?: { ... }\n hidden?: { ... }\n show_in_table?: { ... }\n sortable?: { ... }\n required?: { ... }\n readonly?: { ... }\n deprecated?: { ... }\n variant_overridable?: { ... }\n default_value?: { ... }\n group?: { ... }\n order?: { ... }\n layout?: { ... }\n hide_label?: { ... }\n icon?: { ... }\n render_condition?: { ... }\n data_classification?: { ... }\n _purpose?: { ... }\n _manifest?: { ... }\n constraints?: { ... }\n feature_flag?: { ... }\n // ...\n}\n```\n\n### `EntitySchemaItem`\n\n```ts\ntype EntitySchemaItem = {\n id?: string // uuid\n created_at?: string\n updated_at?: string\n comment?: string\n source?: {\n id?: string\n type?: string\n }\n frozen?: boolean\n latest?: boolean\n _summary?: boolean\n slug: string\n version?: number\n blueprint?: string // uuid\n feature_flag?: string\n enable_setting?: string[]\n name: string\n plural: string\n description?: string\n docs_url?: string // uri\n category?: string\n published?: boolean\n draft?: boolean\n icon?: string\n title_template?: string\n ui_config?: {\n table_view?: {\n view_type?: { ... }\n row_actions?: { ... }\n bulk_actions?: { ... }\n navbar_actions?: { ... }\n enable_thumbnails?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n create_view?: {\n view_type?: { ... }\n search_params?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n edit_view?: {\n view_type?: { ... }\n search_params?: { ... }\n summary_attributes?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n single_view?: {\n view_type?: { ... }\n search_params?: { ... }\n summary_attributes?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n list_item?: {\n summary_attributes?: { ... }\n quick_actions?: { ... }\n ui_config?: { ... }\n }\n sharing?: {\n show_sharing_button?: { ... }\n }\n grid_layout?: {\n id?: { ... }\n columns?: { ... }\n cells?: { ... }\n }\n widget_order?: string[]\n }\n capabilities: Array<{\n id?: string\n name: string\n title?: string\n attributes?: Array<{\n id?: { ... }\n name: { ... }\n label: { ... }\n placeholder?: { ... }\n hidden?: { ... }\n show_in_table?: { ... }\n sortable?: { ... }\n required?: { ... }\n readonly?: { ... }\n deprecated?: { ... }\n variant_overridable?: { ... }\n default_value?: { ... }\n // ...\n}\n```\n\n### `GenerateEntityTableAIFiltersRequest`\n\n```ts\ntype GenerateEntityTableAIFiltersRequest = {\n prompt: string\n main_entity_slug: string\n filter_options: Array<{\n type?: \"search\" | \"filter\"\n label: string\n label_type?: string\n name?: string\n group?: string\n allowedSchemas?: string[]\n relatedOptions?: Array<{\n type?: { ... }\n label: { ... }\n label_type?: { ... }\n name?: { ... }\n group?: { ... }\n allowedSchemas?: { ... }\n relatedOptions?: { ... }\n }>\n }>\n}\n```\n\n### `GenerateEntityTableAIFiltersResponse`\n\n```ts\ntype GenerateEntityTableAIFiltersResponse = Array<{\n label: string\n type: string\n value: string\n}>\n```\n\n### `EntityTableFilterSearch`\n\n```ts\ntype EntityTableFilterSearch = {\n label: string\n type: string\n value: string\n}\n```\n\n### `EntityTableFilterOption`\n\n```ts\ntype EntityTableFilterOption = {\n type?: \"search\" | \"filter\"\n label: string\n label_type?: string\n name?: string\n group?: string\n allowedSchemas?: string[]\n relatedOptions?: Array<{\n type?: \"search\" | \"filter\"\n label: string\n label_type?: string\n name?: string\n group?: string\n allowedSchemas?: string[]\n relatedOptions?: Array<{\n type?: { ... }\n label: { ... }\n label_type?: { ... }\n name?: { ... }\n group?: { ... }\n allowedSchemas?: { ... }\n relatedOptions?: { ... }\n }>\n }>\n}\n```\n\n### `EntitySchemaGroup`\n\n```ts\ntype EntitySchemaGroup = {\n label: string\n id?: string\n order?: number\n expanded?: boolean\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n info_tooltip_title?: {\n key?: string\n default?: string\n }\n}\n```\n\n### `EntitySchemaGroupWithCompositeID`\n\n```ts\ntype EntitySchemaGroupWithCompositeID = {\n label: string\n id?: string\n order?: number\n expanded?: boolean\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n info_tooltip_title?: {\n key?: string\n default?: string\n }\n composite_id?: string\n schema?: string\n}\n```\n\n### `Attribute`\n\n```ts\ntype Attribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"string\"\n multiline?: boolean\n rich_text?: boolean\n rows?: number | string\n} | {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n // ...\n}\n```\n\n### `AttributeWithCompositeID`\n\n```ts\ntype AttributeWithCompositeID = {\n composite_id?: string\n schema?: string\n}\n```\n\n### `BaseAttribute`\n\n```ts\ntype BaseAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n}\n```\n\n### `TextAttribute`\n\n```ts\ntype TextAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"string\"\n multiline?: boolean\n rich_text?: boolean\n rows?: number | string\n}\n```\n\n### `LinkAttribute`\n\n```ts\ntype LinkAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"link\"\n}\n```\n\n### `InternalAttribute`\n\n```ts\ntype InternalAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"internal\"\n}\n```\n\n### `BooleanAttribute`\n\n```ts\ntype BooleanAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"boolean\"\n display_type?: \"switch\" | \"checkbox\"\n}\n```\n\n### `DateAttribute`\n\n```ts\ntype DateAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"date\" | \"datetime\"\n}\n```\n\n### `CountryAttribute`\n\n```ts\ntype CountryAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"country\"\n}\n```\n\n### `SelectAttribute`\n\n```ts\ntype SelectAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"select\" | \"radio\"\n options?: Array<{\n value: string\n title?: string\n } | string>\n allow_any?: boolean\n}\n```\n\n### `MultiSelectAttribute`\n\n```ts\ntype MultiSelectAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"multiselect\" | \"checkbox\"\n disable_case_sensitive?: boolean\n allow_extra_options?: boolean\n options?: Array\n allow_any?: boolean\n}\n```\n\n### `StatusAttribute`\n\n```ts\ntype StatusAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"status\"\n options?: Array\n}\n```\n\n### `SequenceAttribute`\n\n```ts\ntype SequenceAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"sequence\"\n prefix?: string\n start_number?: number\n}\n```\n\n### `FileAttribute`\n\n```ts\ntype FileAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"image\" | \"file\"\n multiple?: boolean\n allowed_extensions?: string[]\n display_images_landscaped?: boolean\n enable_description?: boolean\n default_access_control?: \"public-read\" | \"private\"\n file_size_bytes?: number\n}\n```\n\n### `CurrencyAttribute`\n\n```ts\ntype CurrencyAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"currency\"\n currency_selector_only?: boolean\n currency: Array<{\n code: string\n description: string\n symbol: string\n flag?: string\n }>\n}\n```\n\n### `SummaryField`\n\nSummary Fields are displayed inside list view as a resume of the relation entity.\n\n```ts\ntype SummaryField = {\n field?: string\n display_as?: string\n}\n```\n\n### `EntityAction`\n\nAn entity action configured from the entity schema\n\n```ts\ntype EntityAction = {\n action: string\n label: string\n icon?: string\n permission?: string\n}\n```\n\n### `RelationAttribute`\n\n```ts\ntype RelationAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"list-view\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"relation\"\n relation_type?: \"has_many\" | \"has_one\"\n reverse_attributes?: Record\n relation_affinity_mode?: \"weak\" | \"strong\"\n enable_relation_picker?: boolean\n details_view_mode_enabled?: boolean\n relation_picker_filter?: {\n q: string\n }\n actions?: Array<{\n action_type?: \"add_existing\" | \"create_new\" | \"create_from_existing\"\n label?: string\n default?: boolean\n feature_flag?: string\n settings_flag?: Array<{\n name?: { ... }\n enabled?: { ... }\n }>\n new_entity_item?: Record\n }>\n drawer_size?: \"small\" | \"medium\" | \"large\"\n summary_fields?: Array\n allowedSchemas?: string[]\n enable_relation_tags?: boolean\n add_button_label?: string\n search_placeholder?: string\n}\n```\n\n### `UserRelationAttribute`\n\n```ts\ntype UserRelationAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"relation_user\"\n multiple?: boolean\n}\n```\n\n### `PartnerOrganisationAttribute`\n\n```ts\ntype PartnerOrganisationAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"partner_organisation\"\n}\n```\n\n### `PortalAccessAttribute`\n\n```ts\ntype PortalAccessAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"portal_access\"\n}\n```\n\n### `DefaultAddressFields`\n\nDefault fields visible on addresses\n\nValid values are:\n - postal_code (default)\n - city (default)\n - street (default)\n - street_number (default)\n - plot_area\n - plot_of_land\n - suburb\n - country\n - postbox\n - additional_info\n - coordinates\n - start_date\n - end_date\n - salutation\n - ti\n\n```ts\ntype DefaultAddressFields = string[]\n```\n\n### `AddressAttribute`\n\n```ts\ntype AddressAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"address\"\n default_address_fields?: string[]\n}\n```\n\n### `AddressRelationAttribute`\n\n```ts\ntype AddressRelationAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"relation_address\"\n default_address_fields?: string[]\n}\n```\n\n### `PaymentMethodRelationAttribute`\n\n```ts\ntype PaymentMethodRelationAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"relation_payment_method\"\n}\n```\n\n### `InvitationEmailAttribute`\n\n```ts\ntype InvitationEmailAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"invitation_email\"\n}\n```\n\n### `AutomationAttribute`\n\n```ts\ntype AutomationAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"automation\"\n}\n```\n\n### `InternalUserAttribute`\n\n```ts\ntype InternalUserAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"internal_user\"\n}\n```\n\n### `PurposeAttribute`\n\n```ts\ntype PurposeAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"purpose\"\n}\n```\n\n### `RepeatableAttribute`\n\n```ts\ntype RepeatableAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n}\n```\n\n### `TagsAttribute`\n\n```ts\ntype TagsAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"tags\"\n options?: string[]\n suggestions?: string[]\n}\n```\n\n### `MessageEmailAddressAttribute`\n\n```ts\ntype MessageEmailAddressAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"message_email_address\"\n address?: string\n send_status?: string\n email_type?: string\n}\n```\n\n### `NumberAttribute`\n\n```ts\ntype NumberAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"number\"\n data_type?: \"number\" | \"string\"\n format?: string\n show_separator?: boolean\n}\n```\n\n### `TableAttribute`\n\n```ts\ntype TableAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"table\"\n columns?: Array<{\n name: string\n label: string\n type?: \"string\" | \"number\" | \"date\" | \"boolean\"\n width?: string\n required?: boolean\n bold?: boolean\n }>\n min_rows?: number\n max_rows?: number\n transposed?: boolean\n column_header?: {\n template?: string\n start?: number\n }\n}\n```\n\n### `ConsentAttribute`\n\n```ts\ntype ConsentAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"consent\"\n topic: string\n identifiers?: string[]\n}\n```\n\n### `OrderedListAttribute`\n\n```ts\ntype OrderedListAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"ordered_list\"\n}\n```\n\n### `EmailAttribute`\n\n```ts\ntype EmailAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"email\"\n}\n```\n\n### `PhoneAttribute`\n\n```ts\ntype PhoneAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"phone\"\n}\n```\n\n### `PaymentAttribute`\n\n```ts\ntype PaymentAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"payment\"\n}\n```\n\n### `PriceComponentAttribute`\n\n```ts\ntype PriceComponentAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"price_component\"\n}\n```\n\n### `ComputedAttribute`\n\n```ts\ntype ComputedAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"computed\"\n computed?: boolean\n amount_field?: string\n currency_field?: string\n}\n```\n\n### `PartnerStatusAttribute`\n\n```ts\ntype PartnerStatusAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"partner_status\"\n}\n```\n\n### `SummaryAttribute`\n\nRepresents an expanded version of an attribute to be displayed in the list item summary.\nThis configuration can be used in the following way:\n```js\n{\n \"label\": \"Price components\"\n \"value\": \"{{item.prices.length}} price components\"\n \"show_as_tag\": true\n \"render_condition\": \"is_composite_price = \"\n\n```ts\ntype SummaryAttribute = {\n label: string\n value: string\n show_as_tag?: boolean\n tag_color?: string\n render_condition?: string\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n display_mode?: \"inline\" | \"block\"\n content_line_cap?: number\n content_wrap?: \"normal\" | \"nowrap\" | \"pre\" | \"pre-wrap\"\n hide_label?: boolean\n highlight_container?: boolean\n}\n```\n\n### `GroupHeadline`\n\n```ts\ntype GroupHeadline = {\n id?: string // uuid\n name: string\n label: string\n layout?: string\n group: string\n order?: number\n type: \"headline\"\n enable_divider?: boolean\n divider?: \"top_divider\" | \"bottom_divider\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n}\n```\n\n### `GroupHeadlineWithCompositeID`\n\n```ts\ntype GroupHeadlineWithCompositeID = {\n id?: string // uuid\n name: string\n label: string\n layout?: string\n group: string\n order?: number\n type: \"headline\"\n enable_divider?: boolean\n divider?: \"top_divider\" | \"bottom_divider\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n composite_id?: string\n schema?: string\n}\n```\n\n### `BaseConditionDefinition`\n\n```ts\ntype BaseConditionDefinition = {\n id: string // uuid\n name: string\n label: string\n}\n```\n\n### `ScalarConditionDefinition`\n\n```ts\ntype ScalarConditionDefinition = {\n id: string // uuid\n name: string\n label: string\n type: \"string\" | \"number\" | \"date\" | \"daterange\" | \"boolean\"\n}\n```\n\n### `SelectConditionDefinition`\n\n```ts\ntype SelectConditionDefinition = {\n id: string // uuid\n name: string\n label: string\n type: \"select\"\n values?: string[]\n}\n```\n\n### `LocationConditionDefinition`\n\n```ts\ntype LocationConditionDefinition = {\n id: string // uuid\n name: string\n label: string\n type: \"location\"\n format?: \"zipcode\" | \"zipcode_town\"\n}\n```\n\n### `ConditionDefinition`\n\nOne dimension that conditional variants of an entity type are keyed by. `type`\ndiscriminates the variants: only a `select` condition carries `values`, and only a\n`location` condition carries `format`.\n\n\n```ts\ntype ConditionDefinition = {\n id: string // uuid\n name: string\n label: string\n type: \"string\" | \"number\" | \"date\" | \"daterange\" | \"boolean\"\n} | {\n id: string // uuid\n name: string\n label: string\n type: \"select\"\n values?: string[]\n} | {\n id: string // uuid\n name: string\n label: string\n type: \"location\"\n format?: \"zipcode\" | \"zipcode_town\"\n}\n```\n\n### `EntitySlug`\n\nURL-friendly identifier for the entity schema\n\n```ts\ntype EntitySlug = string\n```\n\n### `EntityCapability`\n\nCapabilities the Entity has. Turn features on/off for entities.\n\n```ts\ntype EntityCapability = {\n id?: string\n name: string\n title?: string\n attributes?: Array<{\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: { ... }\n enabled?: { ... }\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: { ... }\n hint_text_key?: { ... }\n hint_custom_component?: { ... }\n hint_tooltip_placement?: { ... }\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: { ... }\n fuzzy_config?: { ... }\n }\n type: \"string\"\n multiline?: boolean\n rich_text?: boolean\n rows?: number | string\n } | {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: { ... }\n enabled?: { ... }\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: { ... }\n hint_text_key?: { ... }\n hint_custom_component?: { ... }\n hint_tooltip_placement?: { ... }\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: { ... }\n // ...\n}\n```\n\n### `EntityCapabilityWithCompositeID`\n\n```ts\ntype EntityCapabilityWithCompositeID = {\n id?: string\n name: string\n title?: string\n attributes?: Array<{\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: { ... }\n enabled?: { ... }\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: { ... }\n hint_text_key?: { ... }\n hint_custom_component?: { ... }\n hint_tooltip_placement?: { ... }\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: { ... }\n fuzzy_config?: { ... }\n }\n type: \"string\"\n multiline?: boolean\n rich_text?: boolean\n rows?: number | string\n } | {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: { ... }\n enabled?: { ... }\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: { ... }\n hint_text_key?: { ... }\n hint_custom_component?: { ... }\n hint_tooltip_placement?: { ... }\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: { ... }\n // ...\n}\n```\n\n### `EntityViewDisabled`\n\n```ts\ntype EntityViewDisabled = {\n view_type?: \"disabled\"\n}\n```\n\n### `EntityDefaultTable`\n\n```ts\ntype EntityDefaultTable = {\n view_type?: \"default\"\n row_actions?: Array\n bulk_actions?: Array\n navbar_actions?: Array<{\n type: string\n options?: Array<{\n label: { ... }\n params?: { ... }\n }>\n }>\n enable_thumbnails?: boolean\n}\n```\n\n### `EntityDefaultCreate`\n\n```ts\ntype EntityDefaultCreate = {\n view_type?: \"default\"\n search_params?: Record\n}\n```\n\n### `EntityDefaultEdit`\n\n```ts\ntype EntityDefaultEdit = {\n view_type?: \"default\"\n search_params?: Record\n summary_attributes?: string[]\n}\n```\n\n### `RedirectEntityView`\n\n```ts\ntype RedirectEntityView = {\n view_type?: \"redirect\"\n route?: string\n}\n```\n\n### `EntityId`\n\n```ts\ntype EntityId = string // uuid\n```\n\n### `BaseEntity`\n\n```ts\ntype BaseEntity = {\n _id: object\n _org: string\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _schema: string\n _title: string\n _tags?: string[]\n _created_at: string // date-time\n _updated_at: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n _changesets?: Record\n }>\n}\n```\n\n### `Entity`\n\n```ts\ntype Entity = {\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n _changesets?: Record\n }>\n}\n```\n\n### `NullableEntity`\n\n```ts\ntype NullableEntity = {\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n _changesets?: Record\n }>\n}\n```\n\n### `EntityOwner`\n\nThe user / organization owning this entity.\n\nNote: Owner implicitly has access to the entity regardless of ACLs.\n\n\n```ts\ntype EntityOwner = {\n org_id: string\n user_id?: string\n}\n```\n\n### `EntityAcl`\n\nAccess control list (ACL) for an entity. Defines sharing access to external orgs or users.\n\n```ts\ntype EntityAcl = {\n view?: string[]\n edit?: string[]\n delete?: string[]\n}\n```\n\n### `HydratedEntity`\n\nEntity with relation data resolved into the attribute values\n\n```ts\ntype HydratedEntity = {\n _relations: Array<{\n entity_id: string // uuid\n }>\n}\n```\n\n### `EntityItem`\n\n```ts\ntype EntityItem = {\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n _changesets?: Record\n }>\n}\n```\n\n### `EntityValidationError`\n\nValidation error for an entity attribute\n\n```ts\ntype EntityValidationError = {\n code: string\n params: {\n type?: string\n }\n path: string[]\n message: string\n}\n```\n\n### `EntityValidationResultSuccess`\n\nValidation result for a successful validation\n\n```ts\ntype EntityValidationResultSuccess = {\n status: \"success\"\n errors: Array<{\n code: string\n params: {\n type?: { ... }\n }\n path: string[]\n message: string\n }>\n}\n```\n\n### `EntityValidationResultError`\n\nValidation result for a failed validation\n\n```ts\ntype EntityValidationResultError = {\n status: \"error\"\n errors: Array<{\n code: string\n params: {\n type?: { ... }\n }\n path: string[]\n message: string\n }>\n}\n```\n\n### `EntityValidationResult`\n\n```ts\ntype EntityValidationResult = {\n status: \"success\"\n errors: Array<{\n code: string\n params: {\n type?: { ... }\n }\n path: string[]\n message: string\n }>\n} | {\n status: \"error\"\n errors: Array<{\n code: string\n params: {\n type?: { ... }\n }\n path: string[]\n message: string\n }>\n}\n```\n\n### `EntityValidationV2Error`\n\n```ts\ntype EntityValidationV2Error = {\n keyword: string\n instance_path: string\n schema_path: string\n params: Record\n property_name?: string\n message?: string\n schema?: object\n parent_schema?: Record\n data?: Record\n}\n```\n\n### `EntityValidationV2ResultSuccess`\n\nValidation result for a successful validation\n\n```ts\ntype EntityValidationV2ResultSuccess = {\n status: \"success\"\n errors: Array<{\n keyword: string\n instance_path: string\n schema_path: string\n params: Record\n property_name?: string\n message?: string\n schema?: object\n parent_schema?: Record\n data?: Record\n }>\n}\n```\n\n### `EntityValidationV2ResultError`\n\nValidation result for a failed validation\n\n```ts\ntype EntityValidationV2ResultError = {\n status: \"error\"\n errors: Array<{\n keyword: string\n instance_path: string\n schema_path: string\n params: Record\n property_name?: string\n message?: string\n schema?: object\n parent_schema?: Record\n data?: Record\n }>\n}\n```\n\n### `EntityValidationV2Result`\n\n```ts\ntype EntityValidationV2Result = {\n status: \"success\"\n errors: Array<{\n keyword: string\n instance_path: string\n schema_path: string\n params: Record\n property_name?: string\n message?: string\n schema?: object\n parent_schema?: Record\n data?: Record\n }>\n} | {\n status: \"error\"\n errors: Array<{\n keyword: string\n instance_path: string\n schema_path: string\n params: Record\n property_name?: string\n message?: string\n schema?: object\n parent_schema?: Record\n data?: Record\n }>\n}\n```\n\n### `HydratedEntityItem`\n\n```ts\ntype HydratedEntityItem = {\n _relations: Array<{\n entity_id: string // uuid\n }>\n}\n```\n\n### `GetRelationsResp`\n\n```ts\ntype GetRelationsResp = Array<{\n entity_id: string // uuid\n org_id?: string\n _schema?: string\n attribute: string\n _tags?: string[]\n reverse?: boolean\n} | {\n $relation?: {\n entity_id: string // uuid\n org_id?: string\n _schema?: string\n attribute: string\n _tags?: string[]\n reverse?: boolean\n }\n}>\n```\n\n### `GetRelationsRespWithPagination`\n\n```ts\ntype GetRelationsRespWithPagination = {\n hits?: number\n relations?: Array<{\n entity_id: string // uuid\n org_id?: string\n _schema?: string\n attribute: string\n _tags?: string[]\n reverse?: boolean\n } | {\n $relation?: {\n entity_id: { ... }\n org_id?: { ... }\n _schema?: { ... }\n attribute: { ... }\n _tags?: { ... }\n reverse?: { ... }\n }\n }>\n}\n```\n\n### `GetRelatedEntitiesCount`\n\n```ts\ntype GetRelatedEntitiesCount = {\n hits?: number\n}\n```\n\n### `RelationEntity`\n\n```ts\ntype RelationEntity = {\n $relation?: {\n entity_id: string // uuid\n org_id?: string\n _schema?: string\n attribute: string\n _tags?: string[]\n reverse?: boolean\n }\n}\n```\n\n### `RelationItem`\n\n```ts\ntype RelationItem = {\n entity_id: string // uuid\n org_id?: string\n _schema?: string\n attribute: string\n _tags?: string[]\n reverse?: boolean\n}\n```\n\n### `EntitySearchIncludeDeletedParam`\n\nWhether to include deleted entities in the search results\n- `true`: include deleted entities\n- `false`: exclude deleted entities\n- `only`: include only deleted entities\n\nBy default, no deleted entities are included in the search results.\n\n\n```ts\ntype EntitySearchIncludeDeletedParam = \"true\" | \"false\" | \"only\"\n```\n\n### `EntitySearchParams`\n\n```ts\ntype EntitySearchParams = {\n q: string\n include_scores?: boolean\n sort?: string | string[]\n from?: number\n size?: number\n hydrate?: boolean\n anonymize?: boolean\n fields?: string[]\n aggs?: object\n include_deleted?: \"true\" | \"false\" | \"only\"\n highlight?: unknown\n stable_for?: number\n stable_query_id?: string\n search_after?: string | number[]\n}\n```\n\n### `EntityListParams`\n\n```ts\ntype EntityListParams = {\n query?: {\n query_string: {\n query: { ... }\n fields?: { ... }\n default_operator?: { ... }\n lenient?: { ... }\n }\n }\n filter: Array<{\n term?: Record\n terms?: Record\n ids?: {\n values?: { ... }\n }\n range?: Record\n exists?: {\n field: { ... }\n }\n $and?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n $or?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n $not?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n }>\n allow_targeting_all_schemas?: boolean\n sort?: string | string[]\n from?: number\n size?: number\n hydrate?: boolean\n anonymize?: boolean\n fields?: string[]\n aggs?: object\n include_deleted?: \"true\" | \"false\" | \"only\"\n include_scores?: boolean\n highlight?: unknown\n stable_for?: number\n stable_query_id?: string\n search_after?: string | number[]\n}\n```\n\n### `SearchFilter`\n\nA subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.\n\n```ts\ntype SearchFilter = Array<{\n term?: Record\n terms?: Record\n ids?: {\n values?: string[]\n }\n range?: Record\n exists?: {\n field: string\n }\n $and?: Array<{\n term?: Record\n terms?: Record\n ids?: {\n values?: { ... }\n }\n range?: Record\n exists?: {\n field: { ... }\n }\n $and?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n $or?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n $not?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n }>\n $or?: Array<{\n term?: Record\n terms?: Record\n ids?: {\n values?: { ... }\n }\n range?: Record\n exists?: {\n field: { ... }\n }\n $and?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n $or?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n // ...\n}\n```\n\n### `SearchFilterValue`\n\nA filter field value.\n\n```ts\ntype SearchFilterValue = string | number | boolean\n```\n\n### `EntitySearchOptions`\n\n```ts\ntype EntitySearchOptions = {\n sort?: string | string[]\n from?: number\n size?: number\n hydrate?: boolean\n anonymize?: boolean\n fields?: string[]\n aggs?: object\n include_deleted?: \"true\" | \"false\" | \"only\"\n include_scores?: boolean\n stable_for?: number\n stable_query_id?: string\n search_after?: string | number[]\n}\n```\n\n### `FieldsParam`\n\nList of entity fields to include or exclude in the response\n\nUse ! to exclude fields, e.g. `!_id` to exclude the `_id` field.\n\nGlobbing and globstart (**) is supported for nested fields.\n\n\n```ts\ntype FieldsParam = string[]\n```\n\n### `EntityImportParams`\n\nThe parameters for importing entities.\n\n```ts\ntype EntityImportParams = {\n S3Reference: {\n bucket: string\n key: string\n }\n schema: string\n}\n```\n\n### `GraphQueryRequest`\n\n```ts\ntype GraphQueryRequest = {\n seed: {\n entity_id: string // uuid\n node_id: string\n }\n graph: {\n nodes: Array<{\n id: { ... }\n schema: { ... }\n cardinality?: { ... }\n fields?: { ... }\n }>\n edges: Array<{\n from: { ... }\n to: { ... }\n }>\n }\n hydrate?: boolean\n apply_changesets?: boolean\n}\n```\n\n### `GraphSeed`\n\n```ts\ntype GraphSeed = {\n entity_id: string // uuid\n node_id: string\n}\n```\n\n### `GraphDefinition`\n\n```ts\ntype GraphDefinition = {\n nodes: Array<{\n id: string\n schema: string\n cardinality?: \"one\" | \"many\"\n fields?: object\n }>\n edges: Array<{\n from: string\n to: string\n }>\n}\n```\n\n### `GraphNode`\n\n```ts\ntype GraphNode = {\n id: string\n schema: string\n cardinality?: \"one\" | \"many\"\n fields?: object\n}\n```\n\n### `GraphEdge`\n\n```ts\ntype GraphEdge = {\n from: string\n to: string\n}\n```\n\n### `GraphQueryResponse`\n\n```ts\ntype GraphQueryResponse = {\n nodes?: Record\n entityNodes?: Record\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: { ... }\n edit?: { ... }\n delete?: { ... }\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n _changesets?: Record\n } | Array<{\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: { ... }\n user_id?: { ... }\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: { ... }\n edit?: { ... }\n delete?: { ... }\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n _changesets?: Record\n }>>\n edges: Array<{\n from: string\n to: string\n }>\n}\n```\n\n### `EntitySearchResults`\n\n```ts\ntype EntitySearchResults = {\n hits?: number\n results?: Array<{\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: { ... }\n user_id?: { ... }\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: { ... }\n edit?: { ... }\n delete?: { ... }\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n _changesets?: Record\n }>\n aggregations?: object\n stable_query_id?: string\n sort_end?: string | number[]\n}\n```\n\n### `SearchMappings`\n\nAdvanced: explicit Elasticsearch index mapping definitions for entity data\n\n\n```ts\ntype SearchMappings = Record\n```\n\n### `ActivityId`\n\nSee https://github.com/ulid/spec\n\n```ts\ntype ActivityId = string // ulid\n```\n\n### `ActivityCallerContext`\n\n```ts\ntype ActivityCallerContext = {\n EpilotAuth?: {\n token?: {\n sub?: { ... }\n email?: { ... }\n cognito:username?: { ... }\n custom:ivy_user_id?: { ... }\n }\n }\n}\n```\n\n### `ActivityType`\n\nA type for the activity. Used to categorize activities in the activity feed and for event subscriptions.\n\nBuilt-in entity activity types (custom activities can be defined as well):\n- EntityCreated\n- EntityUpdated\n- EntityDeleted\n- EntitySoftDeleted\n- EntityRestored\n- RelationsAdded\n- RelationsRemove\n\n```ts\ntype ActivityType = string\n```\n\n### `Activity`\n\n```ts\ntype Activity = {\n type: string\n title: string\n message: string\n payload?: Record\n pending?: boolean\n}\n```\n\n### `EntityOperation`\n\n```ts\ntype EntityOperation = {\n entity: string // uuid\n org: string\n activity_id?: string // ulid\n activity_type?: string\n operation: \"createEntity\" | \"updateEntity\" | \"deleteEntity\" | \"softDeleteEntity\" | \"restoreEntity\" | \"relationsAdded\" | \"relationsRemoved\" | \"relationsSoftDeleted\" | \"relationsRestored\" | \"relationsDeleted\"\n params?: {\n id?: string // uuid\n slug?: string\n }\n payload?: {\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: { ... }\n user_id?: { ... }\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: { ... }\n edit?: { ... }\n delete?: { ... }\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n _changesets?: Record\n }\n diff?: {\n added?: {\n _id?: { ... }\n _org?: { ... }\n _owners?: { ... }\n _schema?: { ... }\n _title?: { ... }\n _tags?: { ... }\n _created_at?: { ... }\n _updated_at?: { ... }\n _deleted_at?: { ... }\n _acl?: { ... }\n _purpose?: { ... }\n _purpose_name?: { ... }\n _manifest?: { ... }\n _changesets?: { ... }\n }\n updated?: {\n _id?: { ... }\n _org?: { ... }\n _owners?: { ... }\n _schema?: { ... }\n _title?: { ... }\n _tags?: { ... }\n _created_at?: { ... }\n _updated_at?: { ... }\n _deleted_at?: { ... }\n _acl?: { ... }\n _purpose?: { ... }\n _purpose_name?: { ... }\n _manifest?: { ... }\n _changesets?: { ... }\n }\n deleted?: {\n _id?: { ... }\n _org?: { ... }\n _owners?: { ... }\n _schema?: { ... }\n _title?: { ... }\n _tags?: { ... }\n _created_at?: { ... }\n _updated_at?: { ... }\n _deleted_at?: { ... }\n _acl?: { ... }\n _purpose?: { ... }\n _purpose_name?: { ... }\n _manifest?: { ... }\n _changesets?: { ... }\n }\n }\n source_context?: {\n source: \"portal\" | \"epilot\" | \"erp\" | \"system\" | \"api\" | \"external\" | \"journey\" | \"automation\" | \"unknown\"\n source_label?: string\n source_system?: string\n source_reference?: string\n actor_type?: \"user\" | \"portal_user\" | \"api_client\" | \"automation\" | \"system\"\n actor_id?: string\n effective_at?: string // date-time\n // ...\n}\n```\n\n### `EntityOperationSourceContext`\n\nBilling and audit source context for the operation event.\n\n```ts\ntype EntityOperationSourceContext = {\n source: \"portal\" | \"epilot\" | \"erp\" | \"system\" | \"api\" | \"external\" | \"journey\" | \"automation\" | \"unknown\"\n source_label?: string\n source_system?: string\n source_reference?: string\n actor_type?: \"user\" | \"portal_user\" | \"api_client\" | \"automation\" | \"system\"\n actor_id?: string\n effective_at?: string // date-time\n}\n```\n\n### `BaseActivityItem`\n\n```ts\ntype BaseActivityItem = {\n _id?: string // ulid\n timestamp?: string // date-time\n type: string\n title: string\n message: string\n payload?: Record\n pending?: boolean\n caller?: {\n EpilotAuth?: {\n token?: { ... }\n }\n }\n}\n```\n\n### `ActivityItem`\n\n```ts\ntype ActivityItem = {\n operations_total?: number\n operations?: Array<{\n entity: string // uuid\n org: string\n activity_id?: string // ulid\n activity_type?: string\n operation: \"createEntity\" | \"updateEntity\" | \"deleteEntity\" | \"softDeleteEntity\" | \"restoreEntity\" | \"relationsAdded\" | \"relationsRemoved\" | \"relationsSoftDeleted\" | \"relationsRestored\" | \"relationsDeleted\"\n params?: {\n id?: { ... }\n slug?: { ... }\n }\n payload?: {\n _id?: { ... }\n _org?: { ... }\n _owners?: { ... }\n _schema?: { ... }\n _title?: { ... }\n _tags?: { ... }\n _created_at?: { ... }\n _updated_at?: { ... }\n _deleted_at?: { ... }\n _acl?: { ... }\n _purpose?: { ... }\n _purpose_name?: { ... }\n _manifest?: { ... }\n _changesets?: { ... }\n }\n diff?: {\n added?: { ... }\n updated?: { ... }\n deleted?: { ... }\n }\n source_context?: {\n source: { ... }\n source_label?: { ... }\n source_system?: { ... }\n source_reference?: { ... }\n actor_type?: { ... }\n actor_id?: { ... }\n effective_at?: { ... }\n }\n _workflow_origin?: {\n workflow_exec_id?: { ... }\n flow_template_id?: { ... }\n }\n _automation_chain?: string[]\n }>\n}\n```\n\n### `BlueprintEntityId`\n\nReference to blueprint\n\n```ts\ntype BlueprintEntityId = string // uuid\n```\n\n### `ListSavedViewsResults`\n\n```ts\ntype ListSavedViewsResults = {\n hits?: number\n results?: Array<{\n id?: string // uuid\n created_at?: string\n updated_at?: string\n }>\n}\n```\n\n### `SavedViewId`\n\nGenerated uuid for a saved view\n\n```ts\ntype SavedViewId = string // uuid\n```\n\n### `SavedViewItem`\n\n```ts\ntype SavedViewItem = {\n id?: string // uuid\n created_at?: string\n updated_at?: string\n}\n```\n\n### `SavedViewPartial`\n\nA saved entity view\n\n```ts\ntype SavedViewPartial = {\n slug?: string[]\n name?: string\n org?: string\n shared?: boolean\n isFavoritedBy?: string[]\n created_by?: {\n user_id?: string\n org_id?: string\n } | {\n source?: \"SYSTEM\" | \"BLUEPRINT\"\n }\n ui_config?: Record\n shared_with?: string[]\n}\n```\n\n### `SavedView`\n\nA saved entity view\n\n```ts\ntype SavedView = {\n slug: string[]\n name: string\n org?: string\n shared?: boolean\n isFavoritedBy?: string[]\n created_by?: {\n user_id?: string\n org_id?: string\n } | {\n source?: \"SYSTEM\" | \"BLUEPRINT\"\n }\n ui_config: Record\n shared_with?: string[]\n}\n```\n\n### `Taxonomy`\n\n```ts\ntype Taxonomy = {\n slug?: string\n name?: string\n plural?: string\n kind?: \"system\" | \"user_defined\"\n type?: \"entity\" | \"relation\" | \"system\" | \"file_collection\"\n icon?: string\n color?: string\n created_at?: string // date-time\n updated_at?: string // date-time\n deleted_at?: string // date-time\n created_by?: string\n enabled?: boolean\n order?: number\n enabled_locations?: \"account\" | \"contact\" | \"contract\" | \"email_template\" | \"file\" | \"journey\" | \"meter_counter\" | \"meter\" | \"opportunity\" | \"order\" | \"partner\" | \"price\" | \"product\" | \"submission\" | \"tax\" | \"message\" | \"portal_user\" | \"request\" | \"comment\" | \"user\" | string[]\n}\n```\n\n### `TaxonomyLocationId`\n\n```ts\ntype TaxonomyLocationId = \"account\" | \"contact\" | \"contract\" | \"email_template\" | \"file\" | \"journey\" | \"meter_counter\" | \"meter\" | \"opportunity\" | \"order\" | \"partner\" | \"price\" | \"product\" | \"submission\" | \"tax\" | \"message\" | \"portal_user\" | \"request\" | \"comment\" | \"user\"\n```\n\n### `TaxonomySearchIncludeArchivedParam`\n\nWhether to include archived labels in the search results\n- `true`: include archived labels\n- `false`: exclude archived labels\n- `only`: include only archived labels\n\nBy default, no archived labels are included in the search results.\n\n\n```ts\ntype TaxonomySearchIncludeArchivedParam = \"true\" | \"false\" | \"only\"\n```\n\n### `TaxonomyClassification`\n\n```ts\ntype TaxonomyClassification = {\n id?: string\n slug: string\n name: string\n parents?: string[]\n color?: string\n created_at?: string // date-time\n updated_at?: string // date-time\n archived?: boolean\n starred?: boolean\n enabled_locations?: \"account\" | \"contact\" | \"contract\" | \"email_template\" | \"file\" | \"journey\" | \"meter_counter\" | \"meter\" | \"opportunity\" | \"order\" | \"partner\" | \"price\" | \"product\" | \"submission\" | \"tax\" | \"message\" | \"portal_user\" | \"request\" | \"comment\" | \"user\" | string[]\n enabled_purposes?: string[]\n _manifest?: string // uuid[]\n}\n```\n\n### `ClassificationId`\n\n```ts\ntype ClassificationId = string\n```\n\n### `ClassificationIdOrPattern`\n\n```ts\ntype ClassificationIdOrPattern = string | {\n pattern: string\n}\n```\n\n### `ClassificationSlug`\n\nURL-friendly identifier for the classification\n\n```ts\ntype ClassificationSlug = string\n```\n\n### `TaxonomySlug`\n\nURL-friendly name for taxonomy\n\n```ts\ntype TaxonomySlug = string\n```\n\n### `ClassificationsUpdate`\n\n```ts\ntype ClassificationsUpdate = {\n create?: Array<{\n id?: string\n slug: string\n name: string\n parents?: string[]\n color?: string\n created_at?: string // date-time\n updated_at?: string // date-time\n archived?: boolean\n starred?: boolean\n enabled_locations?: \"account\" | \"contact\" | \"contract\" | \"email_template\" | \"file\" | \"journey\" | \"meter_counter\" | \"meter\" | \"opportunity\" | \"order\" | \"partner\" | \"price\" | \"product\" | \"submission\" | \"tax\" | \"message\" | \"portal_user\" | \"request\" | \"comment\" | \"user\" | string[]\n enabled_purposes?: string[]\n _manifest?: string // uuid[]\n }>\n update?: Array<{\n id?: string\n slug: string\n name: string\n parents?: string[]\n color?: string\n created_at?: string // date-time\n updated_at?: string // date-time\n archived?: boolean\n starred?: boolean\n enabled_locations?: \"account\" | \"contact\" | \"contract\" | \"email_template\" | \"file\" | \"journey\" | \"meter_counter\" | \"meter\" | \"opportunity\" | \"order\" | \"partner\" | \"price\" | \"product\" | \"submission\" | \"tax\" | \"message\" | \"portal_user\" | \"request\" | \"comment\" | \"user\" | string[]\n enabled_purposes?: string[]\n _manifest?: string // uuid[]\n }>\n delete?: string | string[]\n}\n```\n\n### `TaxonomyBulkJobTriggerResponse`\n\n```ts\ntype TaxonomyBulkJobTriggerResponse = {\n job_id?: string // uuid\n status?: \"PENDING\" | \"FAILED\" | \"COMPLETED\" | \"CANCELLED\"\n}\n```\n\n### `TaxonomyBulkJobStatus`\n\nThe status of the bulk job\n\n```ts\ntype TaxonomyBulkJobStatus = \"PENDING\" | \"FAILED\" | \"COMPLETED\" | \"CANCELLED\"\n```\n\n### `TaxonomyBulkJobActionType`\n\n```ts\ntype TaxonomyBulkJobActionType = \"MOVE_CLASSIFICATIONS\" | \"MERGE_CLASSIFICATIONS\" | \"DELETE_CLASSIFICATIONS\"\n```\n\n### `TaxonomyBulkJob`\n\n```ts\ntype TaxonomyBulkJob = {\n job_id?: string // uuid\n job_status?: \"PENDING\" | \"FAILED\" | \"COMPLETED\" | \"CANCELLED\"\n failure_reason?: string\n action_type?: \"MOVE_CLASSIFICATIONS\" | \"MERGE_CLASSIFICATIONS\" | \"DELETE_CLASSIFICATIONS\"\n request?: {\n target_taxonomy?: string\n target_classification?: string\n classification_ids?: string[]\n }\n output?: {\n target_entities_count?: number\n affected_entities_count?: number\n failures_count?: number\n failed_entities?: string // uuid[]\n }\n created_by?: string\n created_at?: string // date-time\n updated_at?: string // date-time\n org?: string\n}\n```\n\n### `ESClusterAssignment`\n\n```ts\ntype ESClusterAssignment = {\n orgId?: string\n cluster?: string\n}\n```\n\n### `SettingFlag`\n\n```ts\ntype SettingFlag = {\n name?: string\n enabled?: boolean\n}\n```\n\n### `ErrorObject`\n\nA generic error returned by the API\n\n```ts\ntype ErrorObject = {\n status?: number\n error?: string\n}\n```\n\n### `ChangesetCreator`\n\nIdentifies the actor that created the changeset.\n\n```ts\ntype ChangesetCreator = {\n type?: \"user\" | \"portal_user\" | \"api_client\" | \"automation\"\n id?: string\n}\n```\n\n### `Changeset`\n\nA pending proposed change for a single entity attribute, awaiting external confirmation or human approval.\n\n```ts\ntype Changeset = {\n proposed_value: unknown\n previous_value?: unknown\n created_at: string // date-time\n created_by?: {\n type?: \"user\" | \"portal_user\" | \"api_client\" | \"automation\"\n id?: string\n }\n edit_mode: \"external\" | \"approval\"\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n source?: string\n related_values?: Record\n}\n```\n\n### `ChangesetMap`\n\nMap of attribute name to pending changeset. At most one changeset per attribute.\n\n```ts\ntype ChangesetMap = Record\n}>\n```\n\n### `MeterReadingChangesetEntry`\n\nA meter readings changeset entry — service-managed by metering-api.\nStored on `Meter._meter_readings_changeset` array attribute. Each entry mirrors a\nClickHouse meter reading row plus a changeset metadata overlay.\n\nNote: `org_id` is NOT stored on the entry. The entries live on the Meter entity,\nwhic\n\n```ts\ntype MeterReadingChangesetEntry = {\n value: number\n direction?: \"feed-in\" | \"feed-out\"\n timestamp?: string // date-time\n meter_id: string // uuid\n counter_id: string // uuid\n source?: string\n reason?: string\n read_by?: string\n status?: \"valid\" | \"in-validation\" | \"implausible\"\n external_id?: string\n remark?: string\n metadata?: Record\n changeset_id: string\n edit_mode: \"external\" | \"approval\"\n match_strategy?: \"exact\" | \"fuzzy\"\n timestamp_tolerance?: \"exact\" | {\n type: \"same-day\"\n timezone?: string\n } | {\n type: \"within-seconds\"\n seconds: number\n }\n fuzzy_config?: {\n percentage_threshold?: number\n absolute_threshold?: number\n }\n created_at: string // date-time\n created_by?: {\n type?: \"user\" | \"portal_user\" | \"api_client\" | \"automation\"\n id?: string\n }\n previous?: {\n value?: number\n direction?: \"feed-in\" | \"feed-out\"\n timestamp?: string // date-time\n }\n}\n```\n\n### `EditMode`\n\nControls whether a write goes through immediately or is held as a pending entry\non the parent entity's `_changesets` map.\n\n- `direct`: write applied immediately. No changeset created.\n- `external`: write held as a pending changeset; auto-cleared on a matching direct/ERP write.\n- `approval`: write he\n\n```ts\ntype EditMode = \"direct\" | \"external\" | \"approval\"\n```\n\n### `EditModeConfig`\n\nConfiguration for `edit_mode: external` auto-clear matching.\nFields here (`match_strategy`, `fuzzy_config`) only take effect when\n`edit_mode` is `external`. They are ignored for `edit_mode: approval`,\nwhich never auto-clears and is resolved exclusively via the\n`:apply` / `:dismiss` changeset endpoin\n\n```ts\ntype EditModeConfig = {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: \"suffix\" | \"digits_only\" | \"normalize_phone\" | \"ignore_fields\" | \"set_equivalent\" | \"entry_match\" | \"relation_set\" | \"regex\"\n suffix_length?: number\n fields_to_ignore?: string[]\n regex_flags?: string\n country_code?: string\n match_on?: string\n key?: string | string[]\n mode?: \"subset\" | \"exact_set\"\n ordered?: boolean\n require_tags_match?: boolean\n pattern?: string\n }\n}\n```\n\n### `FuzzyConfig`\n\nConfiguration for fuzzy auto-clear matching on `edit_mode: external` attributes.\nNot used for `edit_mode: approval`.\n\nType compatibility with attribute shape is enforced at schema save time:\n- scalar string attributes: `suffix`, `digits_only`, `regex`\n- repeatable attributes: `set_equivalent`, `entr\n\n```ts\ntype FuzzyConfig = {\n type: \"suffix\" | \"digits_only\" | \"normalize_phone\" | \"ignore_fields\" | \"set_equivalent\" | \"entry_match\" | \"relation_set\" | \"regex\"\n suffix_length?: number\n fields_to_ignore?: string[]\n regex_flags?: string\n country_code?: string\n match_on?: string\n key?: string | string[]\n mode?: \"subset\" | \"exact_set\"\n ordered?: boolean\n require_tags_match?: boolean\n pattern?: string\n}\n```\n\n### `MatchStrategy`\n\nStrategy for auto-clearing a changeset on an `edit_mode: external` attribute\nwhen a direct write (`?direct=true`) arrives — typically an ERP inbound sync.\nIgnored for `edit_mode: approval`, which does not auto-clear and is resolved\nexclusively via the `:apply` / `:dismiss` changeset endpoints.\n- `ex\n\n```ts\ntype MatchStrategy = \"exact\" | \"fuzzy\" | \"any\"\n```\n" +"# Entity API\n\n- **Base URL:** `https://entity.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/entity](https://docs.epilot.io/api/entity)\n\n## Usage\n\n```ts\nimport { epilot } from '@epilot/sdk'\n\nepilot.authorize(() => '')\nconst { data } = await epilot.entity.listSchemas(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from '@epilot/sdk/entity'\n\nconst entityClient = getClient()\nauthorize(entityClient, () => '')\nconst { data } = await entityClient.listSchemas(...)\n```\n\n## Operations\n\n**Schemas**\n- [`listSchemas`](#listschemas)\n- [`listSchemasV2`](#listschemasv2)\n- [`getSchema`](#getschema)\n- [`putSchema`](#putschema)\n- [`deleteSchema`](#deleteschema)\n- [`getJsonSchema`](#getjsonschema)\n- [`getSchemaExample`](#getschemaexample)\n- [`getSchemaVersions`](#getschemaversions)\n- [`freezeSchema`](#freezeschema)\n- [`unfreezeSchema`](#unfreezeschema)\n- [`listAvailableCapabilities`](#listavailablecapabilities)\n- [`listSchemaBlueprints`](#listschemablueprints)\n- [`listTaxonomyClassificationsForSchema`](#listtaxonomyclassificationsforschema)\n- [`createSchemaAttribute`](#createschemaattribute)\n- [`getSchemaAttribute`](#getschemaattribute)\n- [`putSchemaAttribute`](#putschemaattribute)\n- [`deleteSchemaAttribute`](#deleteschemaattribute)\n- [`createSchemaCapability`](#createschemacapability)\n- [`getSchemaCapability`](#getschemacapability)\n- [`putSchemaCapability`](#putschemacapability)\n- [`deleteSchemaCapability`](#deleteschemacapability)\n- [`createSchemaGroup`](#createschemagroup)\n- [`getSchemaGroup`](#getschemagroup)\n- [`putSchemaGroup`](#putschemagroup)\n- [`deleteSchemaGroup`](#deleteschemagroup)\n- [`createSchemaGroupHeadline`](#createschemagroupheadline)\n- [`getSchemaGroupHeadline`](#getschemagroupheadline)\n- [`putSchemaGroupHeadline`](#putschemagroupheadline)\n- [`deleteSchemaGroupHeadline`](#deleteschemagroupheadline)\n\n**Entities**\n- [`searchEntities`](#searchentities)\n- [`listEntities`](#listentities)\n- [`queryEntityGraph`](#queryentitygraph)\n- [`createEntity`](#createentity)\n- [`validateEntity`](#validateentity)\n- [`validateEntityV2`](#validateentityv2)\n- [`upsertEntity`](#upsertentity)\n- [`getEntityV2`](#getentityv2)\n- [`restoreEntity`](#restoreentity)\n- [`reindexEntity`](#reindexentity)\n- [`getEntity`](#getentity)\n- [`updateEntity`](#updateentity)\n- [`patchEntity`](#patchentity)\n- [`deleteEntity`](#deleteentity)\n- [`autocomplete`](#autocomplete)\n- [`wipeAllEntities`](#wipeallentities)\n- [`applyChangeset`](#applychangeset)\n- [`dismissChangeset`](#dismisschangeset)\n- [`listChangesets`](#listchangesets)\n\n**Activity**\n- [`createActivity`](#createactivity)\n- [`getActivity`](#getactivity)\n- [`attachActivity`](#attachactivity)\n- [`getEntityActivityFeed`](#getentityactivityfeed)\n\n**Relations**\n- [`getRelations`](#getrelations)\n- [`addRelations`](#addrelations)\n- [`removeRelations`](#removerelations)\n- [`getRelationsV2`](#getrelationsv2)\n- [`getRelationsV3`](#getrelationsv3)\n- [`getRelatedEntitiesCount`](#getrelatedentitiescount)\n- [`updateRelation`](#updaterelation)\n- [`deleteRelation`](#deleterelation)\n\n**Import-Export**\n- [`exportEntities`](#exportentities)\n- [`importEntities`](#importentities)\n- [`abortEntityImport`](#abortentityimport)\n\n**Saved Views**\n- [`listSavedViews`](#listsavedviews)\n- [`createSavedView`](#createsavedview)\n- [`getSavedView`](#getsavedview)\n- [`updateSavedView`](#updatesavedview)\n- [`patchSavedView`](#patchsavedview)\n- [`deleteSavedView`](#deletesavedview)\n- [`listFavoriteViewsForUser`](#listfavoriteviewsforuser)\n\n**Taxonomy**\n- [`listTaxonomies`](#listtaxonomies)\n- [`createTaxonomy`](#createtaxonomy)\n- [`getTaxonomy`](#gettaxonomy)\n- [`updateTaxonomy`](#updatetaxonomy)\n- [`deleteTaxonomy`](#deletetaxonomy)\n- [`updateClassificationsForTaxonomy`](#updateclassificationsfortaxonomy)\n- [`createTaxonomyClassification`](#createtaxonomyclassification)\n- [`getTaxonomyClassification`](#gettaxonomyclassification)\n- [`updateTaxonomyClassification`](#updatetaxonomyclassification)\n- [`deleteTaxonomyClassification`](#deletetaxonomyclassification)\n- [`taxonomyAutocomplete`](#taxonomyautocomplete)\n- [`taxonomiesClassificationsSearch`](#taxonomiesclassificationssearch)\n- [`getTaxonomyBulkActionJobs`](#gettaxonomybulkactionjobs)\n- [`getTaxonomyBulkActionJobById`](#gettaxonomybulkactionjobbyid)\n- [`cancelBulkAction`](#cancelbulkaction)\n- [`bulkMoveClassifications`](#bulkmoveclassifications)\n- [`bulkMergeClassifications`](#bulkmergeclassifications)\n- [`bulkDeleteClassifications`](#bulkdeleteclassifications)\n\n**Schemas**\n- [`ExportJobId`](#exportjobid)\n- [`Language`](#language)\n- [`IsTemplate`](#istemplate)\n- [`SchemaId`](#schemaid)\n- [`EntitySchema`](#entityschema)\n- [`EntitySchemaItem`](#entityschemaitem)\n- [`GenerateEntityTableAIFiltersRequest`](#generateentitytableaifiltersrequest)\n- [`GenerateEntityTableAIFiltersResponse`](#generateentitytableaifiltersresponse)\n- [`EntityTableFilterSearch`](#entitytablefiltersearch)\n- [`EntityTableFilterOption`](#entitytablefilteroption)\n- [`EntitySchemaGroup`](#entityschemagroup)\n- [`EntitySchemaGroupWithCompositeID`](#entityschemagroupwithcompositeid)\n- [`Attribute`](#attribute)\n- [`AttributeWithCompositeID`](#attributewithcompositeid)\n- [`BaseAttribute`](#baseattribute)\n- [`TextAttribute`](#textattribute)\n- [`LinkAttribute`](#linkattribute)\n- [`InternalAttribute`](#internalattribute)\n- [`BooleanAttribute`](#booleanattribute)\n- [`DateAttribute`](#dateattribute)\n- [`CountryAttribute`](#countryattribute)\n- [`SelectAttribute`](#selectattribute)\n- [`MultiSelectAttribute`](#multiselectattribute)\n- [`StatusAttribute`](#statusattribute)\n- [`SequenceAttribute`](#sequenceattribute)\n- [`FileAttribute`](#fileattribute)\n- [`CurrencyAttribute`](#currencyattribute)\n- [`SummaryField`](#summaryfield)\n- [`EntityAction`](#entityaction)\n- [`RelationAttribute`](#relationattribute)\n- [`UserRelationAttribute`](#userrelationattribute)\n- [`PartnerOrganisationAttribute`](#partnerorganisationattribute)\n- [`PortalAccessAttribute`](#portalaccessattribute)\n- [`DefaultAddressFields`](#defaultaddressfields)\n- [`AddressAttribute`](#addressattribute)\n- [`AddressRelationAttribute`](#addressrelationattribute)\n- [`PaymentMethodRelationAttribute`](#paymentmethodrelationattribute)\n- [`InvitationEmailAttribute`](#invitationemailattribute)\n- [`AutomationAttribute`](#automationattribute)\n- [`InternalUserAttribute`](#internaluserattribute)\n- [`PurposeAttribute`](#purposeattribute)\n- [`RepeatableAttribute`](#repeatableattribute)\n- [`TagsAttribute`](#tagsattribute)\n- [`MessageEmailAddressAttribute`](#messageemailaddressattribute)\n- [`NumberAttribute`](#numberattribute)\n- [`TableAttribute`](#tableattribute)\n- [`ConsentAttribute`](#consentattribute)\n- [`OrderedListAttribute`](#orderedlistattribute)\n- [`EmailAttribute`](#emailattribute)\n- [`PhoneAttribute`](#phoneattribute)\n- [`PaymentAttribute`](#paymentattribute)\n- [`PriceComponentAttribute`](#pricecomponentattribute)\n- [`ComputedAttribute`](#computedattribute)\n- [`PartnerStatusAttribute`](#partnerstatusattribute)\n- [`SummaryAttribute`](#summaryattribute)\n- [`GroupHeadline`](#groupheadline)\n- [`GroupHeadlineWithCompositeID`](#groupheadlinewithcompositeid)\n- [`BaseConditionDefinition`](#baseconditiondefinition)\n- [`ScalarConditionDefinition`](#scalarconditiondefinition)\n- [`SelectConditionDefinition`](#selectconditiondefinition)\n- [`LocationConditionDefinition`](#locationconditiondefinition)\n- [`ConditionDefinition`](#conditiondefinition)\n- [`EntitySlug`](#entityslug)\n- [`AdjustInstallmentCapabilityConfig`](#adjustinstallmentcapabilityconfig)\n- [`EntityCapability`](#entitycapability)\n- [`EntityCapabilityWithCompositeID`](#entitycapabilitywithcompositeid)\n- [`EntityViewDisabled`](#entityviewdisabled)\n- [`EntityDefaultTable`](#entitydefaulttable)\n- [`EntityDefaultCreate`](#entitydefaultcreate)\n- [`EntityDefaultEdit`](#entitydefaultedit)\n- [`RedirectEntityView`](#redirectentityview)\n- [`EntityId`](#entityid)\n- [`BaseEntity`](#baseentity)\n- [`Entity`](#entity)\n- [`NullableEntity`](#nullableentity)\n- [`EntityOwner`](#entityowner)\n- [`EntityAcl`](#entityacl)\n- [`HydratedEntity`](#hydratedentity)\n- [`EntityItem`](#entityitem)\n- [`EntityValidationError`](#entityvalidationerror)\n- [`EntityValidationResultSuccess`](#entityvalidationresultsuccess)\n- [`EntityValidationResultError`](#entityvalidationresulterror)\n- [`EntityValidationResult`](#entityvalidationresult)\n- [`EntityValidationV2Error`](#entityvalidationv2error)\n- [`EntityValidationV2ResultSuccess`](#entityvalidationv2resultsuccess)\n- [`EntityValidationV2ResultError`](#entityvalidationv2resulterror)\n- [`EntityValidationV2Result`](#entityvalidationv2result)\n- [`HydratedEntityItem`](#hydratedentityitem)\n- [`GetRelationsResp`](#getrelationsresp)\n- [`GetRelationsRespWithPagination`](#getrelationsrespwithpagination)\n- [`GetRelatedEntitiesCount`](#getrelatedentitiescount)\n- [`RelationEntity`](#relationentity)\n- [`RelationItem`](#relationitem)\n- [`EntitySearchIncludeDeletedParam`](#entitysearchincludedeletedparam)\n- [`EntitySearchParams`](#entitysearchparams)\n- [`EntityListParams`](#entitylistparams)\n- [`SearchFilter`](#searchfilter)\n- [`SearchFilterValue`](#searchfiltervalue)\n- [`EntitySearchOptions`](#entitysearchoptions)\n- [`FieldsParam`](#fieldsparam)\n- [`EntityImportParams`](#entityimportparams)\n- [`GraphQueryRequest`](#graphqueryrequest)\n- [`GraphSeed`](#graphseed)\n- [`GraphDefinition`](#graphdefinition)\n- [`GraphNode`](#graphnode)\n- [`GraphEdge`](#graphedge)\n- [`GraphQueryResponse`](#graphqueryresponse)\n- [`EntitySearchResults`](#entitysearchresults)\n- [`SearchMappings`](#searchmappings)\n- [`ActivityId`](#activityid)\n- [`ActivityCallerContext`](#activitycallercontext)\n- [`ActivityType`](#activitytype)\n- [`Activity`](#activity)\n- [`EntityOperation`](#entityoperation)\n- [`EntityOperationSourceContext`](#entityoperationsourcecontext)\n- [`BaseActivityItem`](#baseactivityitem)\n- [`ActivityItem`](#activityitem)\n- [`BlueprintEntityId`](#blueprintentityid)\n- [`ListSavedViewsResults`](#listsavedviewsresults)\n- [`SavedViewId`](#savedviewid)\n- [`SavedViewItem`](#savedviewitem)\n- [`SavedViewPartial`](#savedviewpartial)\n- [`SavedView`](#savedview)\n- [`Taxonomy`](#taxonomy)\n- [`TaxonomyLocationId`](#taxonomylocationid)\n- [`TaxonomySearchIncludeArchivedParam`](#taxonomysearchincludearchivedparam)\n- [`TaxonomyClassification`](#taxonomyclassification)\n- [`ClassificationId`](#classificationid)\n- [`ClassificationIdOrPattern`](#classificationidorpattern)\n- [`ClassificationSlug`](#classificationslug)\n- [`TaxonomySlug`](#taxonomyslug)\n- [`ClassificationsUpdate`](#classificationsupdate)\n- [`TaxonomyBulkJobTriggerResponse`](#taxonomybulkjobtriggerresponse)\n- [`TaxonomyBulkJobStatus`](#taxonomybulkjobstatus)\n- [`TaxonomyBulkJobActionType`](#taxonomybulkjobactiontype)\n- [`TaxonomyBulkJob`](#taxonomybulkjob)\n- [`ESClusterAssignment`](#esclusterassignment)\n- [`SettingFlag`](#settingflag)\n- [`ErrorObject`](#errorobject)\n- [`ChangesetCreator`](#changesetcreator)\n- [`Changeset`](#changeset)\n- [`ChangesetMap`](#changesetmap)\n- [`MeterReadingChangesetEntry`](#meterreadingchangesetentry)\n- [`EditMode`](#editmode)\n- [`EditModeConfig`](#editmodeconfig)\n- [`FuzzyConfig`](#fuzzyconfig)\n- [`MatchStrategy`](#matchstrategy)\n\n### `listSchemas`\n\nGet the latest versions of all schemas\n\n`GET /v1/entity/schemas`\n\n```ts\nconst { data } = await client.listSchemas({\n unpublished: true,\n latest: true,\n exclude: ['...'],\n include: ['...'],\n})\n```\n\n
\nResponse\n\n```json\n{\n \"results\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"comment\": \"string\",\n \"source\": {},\n \"frozen\": true,\n \"latest\": true,\n \"_summary\": true,\n \"slug\": \"contact\",\n \"version\": 1,\n \"blueprint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"enable_setting\": [\"360_features\"],\n \"name\": \"Contact\",\n \"plural\": \"Contacts\",\n \"description\": \"Example description\",\n \"docs_url\": \"https://docs.epilot.io/docs/pricing/entities\",\n \"category\": \"customer_relations\",\n \"published\": false,\n \"draft\": false,\n \"icon\": \"person\",\n \"title_template\": \"{{first_name}} {{last_name}}\",\n \"ui_config\": {},\n \"capabilities\": [],\n \"group_settings\": [],\n \"layout_settings\": {},\n \"dialog_config\": {},\n \"attributes\": [],\n \"_purpose\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"explicit_search_mappings\": {},\n \"group_headlines\": [],\n \"conditions\": []\n }\n ]\n}\n```\n\n
\n\n---\n\n### `listSchemasV2`\n\nGet the latest versions of all schemas.\nReturns summary schemas by default (only summary attributes, no capabilities).\nUse ?full=true for complete schemas.\n\n`GET /v2/entity/schemas`\n\n```ts\nconst { data } = await client.listSchemasV2({\n full: true,\n unpublished: true,\n latest: true,\n exclude: ['...'],\n include: ['...'],\n})\n```\n\n
\nResponse\n\n```json\n{\n \"results\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"comment\": \"string\",\n \"source\": {},\n \"frozen\": true,\n \"latest\": true,\n \"_summary\": true,\n \"slug\": \"contact\",\n \"version\": 1,\n \"blueprint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"enable_setting\": [\"360_features\"],\n \"name\": \"Contact\",\n \"plural\": \"Contacts\",\n \"description\": \"Example description\",\n \"docs_url\": \"https://docs.epilot.io/docs/pricing/entities\",\n \"category\": \"customer_relations\",\n \"published\": false,\n \"draft\": false,\n \"icon\": \"person\",\n \"title_template\": \"{{first_name}} {{last_name}}\",\n \"ui_config\": {},\n \"capabilities\": [],\n \"group_settings\": [],\n \"layout_settings\": {},\n \"dialog_config\": {},\n \"attributes\": [],\n \"_purpose\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"explicit_search_mappings\": {},\n \"group_headlines\": [],\n \"conditions\": []\n }\n ]\n}\n```\n\n
\n\n---\n\n### `getSchema`\n\nBy default gets the current version of the Schema (frozen version if frozen, otherwise latest).\nPass ?latest=true to get the latest version when the schema is frozen.\nPass ?id= to get a specific versi\n\n`GET /v1/entity/schemas/{slug}`\n\n```ts\nconst { data } = await client.getSchema({\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n latest: true,\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"comment\": \"string\",\n \"source\": {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n \"frozen\": true,\n \"latest\": true,\n \"_summary\": true,\n \"slug\": \"contact\",\n \"version\": 1,\n \"blueprint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"enable_setting\": [\"360_features\"],\n \"name\": \"Contact\",\n \"plural\": \"Contacts\",\n \"description\": \"Example description\",\n \"docs_url\": \"https://docs.epilot.io/docs/pricing/entities\",\n \"category\": \"customer_relations\",\n \"published\": false,\n \"draft\": false,\n \"icon\": \"person\",\n \"title_template\": \"{{first_name}} {{last_name}}\",\n \"ui_config\": {\n \"table_view\": {\n \"view_type\": \"default\",\n \"row_actions\": [\"string\"],\n \"bulk_actions\": [\"string\"],\n \"navbar_actions\": [],\n \"enable_thumbnails\": false\n },\n \"create_view\": {\n \"view_type\": \"default\",\n \"search_params\": {}\n },\n \"edit_view\": {\n \"view_type\": \"default\",\n \"search_params\": {},\n \"summary_attributes\": [\"email\"]\n },\n \"single_view\": {\n \"view_type\": \"default\",\n \"search_params\": {},\n \"summary_attributes\": [\"email\"]\n },\n \"list_item\": {\n \"summary_attributes\": [],\n \"quick_actions\": [],\n \"ui_config\": {}\n },\n \"sharing\": {\n \"show_sharing_button\": true\n },\n \"grid_layout\": {\n \"id\": \"string\",\n \"columns\": 0,\n \"cells\": [0]\n },\n \"widget_order\": [\"string\"]\n },\n \"capabilities\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"customer_messaging\",\n \"title\": \"Messaging\",\n \"attributes\": [],\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"app_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"adjust_installment\": {\n \"journey_id\": \"adjust-installment-flow\"\n },\n \"ui_config\": {},\n \"ui_hooks\": [],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"schemas\": []\n }\n ],\n \"group_settings\": [\n {\n \"id\": \"e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"label\": \"Contact Details\",\n \"expanded\": true,\n \"order\": 1\n },\n {\n \"id\": \"e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e\",\n \"label\": \"Address Details\",\n \"expanded\": false,\n \"order\": 2,\n \"info_tooltip_title\": {}\n }\n ],\n \"layout_settings\": {\n \"grid_gap\": \"string\",\n \"grid_template_columns\": \"string\"\n },\n \"dialog_config\": {},\n \"attributes\": [\n {\n \"name\": \"email\",\n \"type\": \"email\",\n \"label\": \"Email\",\n \"required\": true\n },\n {\n \"name\": \"first_name\",\n \"type\": \"string\",\n \"label\": \"First Name\"\n }\n ],\n \"_purpose\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"explicit_search_mappings\": {\n \"image\": {\n \"type\": \"keyword\",\n \"index\": false\n }\n },\n \"group_headlines\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"layout\": \"string\",\n \"group\": \"string\",\n \"order\": 0,\n \"type\": \"headline\",\n \"enable_divider\": false,\n \"divider\": \"top_divider\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ],\n \"conditions\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"delivery_area\",\n \"label\": \"Delivery Area\",\n \"type\": \"string\"\n }\n ]\n}\n```\n\n
\n\n---\n\n### `putSchema`\n\nCreate or update a schema with a new version.\nWhen the schema is frozen, writes update the latest version without affecting the frozen version.\n\n`PUT /v1/entity/schemas/{slug}`\n\n```ts\nconst { data } = await client.putSchema(\n {\n slug: 'example',\n draft: true,\n },\n {\n slug: 'contact',\n version: 1,\n blueprint: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n feature_flag: 'FF_MY_FEATURE_FLAG',\n enable_setting: ['360_features'],\n name: 'Contact',\n plural: 'Contacts',\n description: 'Example description',\n docs_url: 'https://docs.epilot.io/docs/pricing/entities',\n category: 'customer_relations',\n published: false,\n draft: false,\n icon: 'person',\n title_template: '{{first_name}} {{last_name}}',\n ui_config: {\n table_view: {\n view_type: 'default',\n row_actions: ['string'],\n bulk_actions: ['string'],\n navbar_actions: [ /* ... */ ],\n enable_thumbnails: false\n },\n create_view: {\n view_type: 'default',\n search_params: {}\n },\n edit_view: {\n view_type: 'default',\n search_params: {},\n summary_attributes: ['email']\n },\n single_view: {\n view_type: 'default',\n search_params: {},\n summary_attributes: ['email']\n },\n list_item: {\n summary_attributes: [ /* ... */ ],\n quick_actions: [ /* ... */ ],\n ui_config: { /* ... */ }\n },\n sharing: {\n show_sharing_button: true\n },\n grid_layout: {\n id: 'string',\n columns: 0,\n cells: [0]\n },\n widget_order: ['string']\n },\n capabilities: [\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'customer_messaging',\n title: 'Messaging',\n attributes: [ /* ... */ ],\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n app_id: '123e4567-e89b-12d3-a456-426614174000',\n adjust_installment: {\n journey_id: 'adjust-installment-flow'\n },\n ui_config: { /* ... */ },\n ui_hooks: [ /* ... */ ],\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [ /* ... */ ],\n schemas: [ /* ... */ ]\n }\n ],\n group_settings: [\n {\n id: 'e18a532b-ae79-4d86-a6a5-e5dbfb579d14',\n label: 'Contact Details',\n expanded: true,\n order: 1\n },\n {\n id: 'e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e',\n label: 'Address Details',\n expanded: false,\n order: 2,\n info_tooltip_title: { /* ... */ }\n }\n ],\n layout_settings: {\n grid_gap: 'string',\n grid_template_columns: 'string'\n },\n dialog_config: {},\n attributes: [\n {\n name: 'email',\n type: 'email',\n label: 'Email',\n required: true\n },\n {\n name: 'first_name',\n type: 'string',\n label: 'First Name'\n },\n /* ... 5 more */\n ],\n _purpose: ['string'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n explicit_search_mappings: {\n image: {\n type: 'keyword',\n index: false\n }\n },\n group_headlines: [\n {\n id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n name: 'string',\n label: 'string',\n layout: 'string',\n group: 'string',\n order: 0,\n type: 'headline',\n enable_divider: false,\n divider: 'top_divider',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n }\n ],\n conditions: [\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'delivery_area',\n label: 'Delivery Area',\n type: 'string'\n }\n ]\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"comment\": \"string\",\n \"source\": {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n \"frozen\": true,\n \"latest\": true,\n \"_summary\": true,\n \"slug\": \"contact\",\n \"version\": 1,\n \"blueprint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"enable_setting\": [\"360_features\"],\n \"name\": \"Contact\",\n \"plural\": \"Contacts\",\n \"description\": \"Example description\",\n \"docs_url\": \"https://docs.epilot.io/docs/pricing/entities\",\n \"category\": \"customer_relations\",\n \"published\": false,\n \"draft\": false,\n \"icon\": \"person\",\n \"title_template\": \"{{first_name}} {{last_name}}\",\n \"ui_config\": {\n \"table_view\": {\n \"view_type\": \"default\",\n \"row_actions\": [\"string\"],\n \"bulk_actions\": [\"string\"],\n \"navbar_actions\": [],\n \"enable_thumbnails\": false\n },\n \"create_view\": {\n \"view_type\": \"default\",\n \"search_params\": {}\n },\n \"edit_view\": {\n \"view_type\": \"default\",\n \"search_params\": {},\n \"summary_attributes\": [\"email\"]\n },\n \"single_view\": {\n \"view_type\": \"default\",\n \"search_params\": {},\n \"summary_attributes\": [\"email\"]\n },\n \"list_item\": {\n \"summary_attributes\": [],\n \"quick_actions\": [],\n \"ui_config\": {}\n },\n \"sharing\": {\n \"show_sharing_button\": true\n },\n \"grid_layout\": {\n \"id\": \"string\",\n \"columns\": 0,\n \"cells\": [0]\n },\n \"widget_order\": [\"string\"]\n },\n \"capabilities\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"customer_messaging\",\n \"title\": \"Messaging\",\n \"attributes\": [],\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"app_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"adjust_installment\": {\n \"journey_id\": \"adjust-installment-flow\"\n },\n \"ui_config\": {},\n \"ui_hooks\": [],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"schemas\": []\n }\n ],\n \"group_settings\": [\n {\n \"id\": \"e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"label\": \"Contact Details\",\n \"expanded\": true,\n \"order\": 1\n },\n {\n \"id\": \"e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e\",\n \"label\": \"Address Details\",\n \"expanded\": false,\n \"order\": 2,\n \"info_tooltip_title\": {}\n }\n ],\n \"layout_settings\": {\n \"grid_gap\": \"string\",\n \"grid_template_columns\": \"string\"\n },\n \"dialog_config\": {},\n \"attributes\": [\n {\n \"name\": \"email\",\n \"type\": \"email\",\n \"label\": \"Email\",\n \"required\": true\n },\n {\n \"name\": \"first_name\",\n \"type\": \"string\",\n \"label\": \"First Name\"\n }\n ],\n \"_purpose\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"explicit_search_mappings\": {\n \"image\": {\n \"type\": \"keyword\",\n \"index\": false\n }\n },\n \"group_headlines\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"layout\": \"string\",\n \"group\": \"string\",\n \"order\": 0,\n \"type\": \"headline\",\n \"enable_divider\": false,\n \"divider\": \"top_divider\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ],\n \"conditions\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"delivery_area\",\n \"label\": \"Delivery Area\",\n \"type\": \"string\"\n }\n ]\n}\n```\n\n
\n\n---\n\n### `deleteSchema`\n\nDelete a schema, or a specific version of a schema\n\n`DELETE /v1/entity/schemas/{slug}`\n\n```ts\nconst { data } = await client.deleteSchema({\n slug: 'example',\n})\n```\n\n---\n\n### `getJsonSchema`\n\nGet formal JSON schema definition draft 2020-12 for the given epilot schema\n\n`GET /v1/entity/schemas/{slug}/json/schema`\n\n```ts\nconst { data } = await client.getJsonSchema({\n slug: 'example',\n dereference: true,\n})\n```\n\n
\nResponse\n\n```json\n{\n \"$schema\": \"http://json-schema.org/draft/2020-12/schema\",\n \"type\": \"object\",\n \"properties\": {\n \"_id\": {\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"example\": \"123e4567-e89b-12d3-a456-426614174000\"\n },\n \"_org\": {\n \"type\": \"string\",\n \"description\": \"Organization Id the entity belongs to\",\n \"readOnly\": true\n },\n \"_owners\": {\n \"type\": \"array\",\n \"readOnly\": true,\n \"items\": {}\n },\n \"_schema\": {\n \"readOnly\": true,\n \"type\": \"string\"\n },\n \"_title\": {\n \"readOnly\": true,\n \"type\": \"string\"\n },\n \"_tags\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"items\": {}\n },\n \"_manifest\": {\n \"type\": \"array\",\n \"description\": \"Manifest ID used to create/update the entity\",\n \"items\": {}\n },\n \"_created_at\": {\n \"readOnly\": true,\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"_updated_at\": {\n \"readOnly\": true,\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"_acl\": {\n \"readOnly\": true,\n \"type\": \"object\",\n \"description\": \"Access control list (ACL) for an entity. Defines sharing access to external orgs or users.\",\n \"additionalProperties\": true,\n \"properties\": {}\n },\n \"title\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"enum\": [\"Dr.\", \"Prof.\", \"Prof. Dr.\", null]\n },\n \"salutation\": {\n \"type\": \"string\",\n \"nullable\": true,\n \"enum\": [\"Mr.\", \"Ms. / Mrs.\", \"Company\", \"Contact Person\", \"Company/Contact Person\", \"Spouse\", \"Family\", \"Ownership\", \"Assembly\", \"Other\", null]\n },\n \"first_name\": {\n \"type\": \"string\"\n },\n \"last_name\": {\n \"type\": \"string\"\n },\n \"customer_number\": {\n \"type\": \"string\",\n \"nullable\": true\n },\n \"birthdate\": {\n \"type\": \"string\",\n \"format\": \"date\",\n \"nullable\": true\n },\n \"account\": {\n \"type\": \"object\",\n \"nullable\": true,\n \"properties\": {},\n \"additionalProperties\": true\n },\n \"address\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"description\": \"Addresses as a list of object, the element with index 0 is treated as the primary one.\\n\",\n \"items\": {}\n },\n \"email\": {\n \"type\": \"array\",\n \"nullable\": true,\n \"description\": \"Email addresses as a list of object, the element with index 0 is treated as the primary one.\\n\",\n \"items\": {}\n },\n \"phone\": {\n \"type\": \"array\",\n \"description\": \"Phone numbers as a list of object, the element with index 0 is treated as the primary one.\\n\",\n \"items\": {}\n }\n },\n \"required\": [\"first_name\", \"last_name\", \"_id\", \"_org\", \"_owners\", \"_schema\", \"_title\", \"_tags\", \"_created_at\", \"_updated_at\", \"_acl\"]\n}\n```\n\n
\n\n---\n\n### `getSchemaExample`\n\nGet a full example entity for the given schema\n\n`GET /v1/entity/schemas/{slug}/json/example`\n\n```ts\nconst { data } = await client.getSchemaExample({\n slug: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{}\n```\n\n
\n\n---\n\n### `getSchemaVersions`\n\nGet all versions of this schema ordered by the latest versions including drafts.\n\n`GET /v1/entity/schemas/{slug}/versions`\n\n```ts\nconst { data } = await client.getSchemaVersions({\n slug: 'example',\n versions_from: 1,\n versions_size: 1,\n drafts_from: 1,\n drafts_size: 1,\n fields: ['...'],\n})\n```\n\n
\nResponse\n\n```json\n{\n \"versions\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"comment\": \"string\",\n \"source\": {},\n \"frozen\": true,\n \"latest\": true,\n \"_summary\": true,\n \"slug\": \"contact\",\n \"version\": 1,\n \"blueprint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"enable_setting\": [\"360_features\"],\n \"name\": \"Contact\",\n \"plural\": \"Contacts\",\n \"description\": \"Example description\",\n \"docs_url\": \"https://docs.epilot.io/docs/pricing/entities\",\n \"category\": \"customer_relations\",\n \"published\": false,\n \"draft\": false,\n \"icon\": \"person\",\n \"title_template\": \"{{first_name}} {{last_name}}\",\n \"ui_config\": {},\n \"capabilities\": [],\n \"group_settings\": [],\n \"layout_settings\": {},\n \"dialog_config\": {},\n \"attributes\": [],\n \"_purpose\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"explicit_search_mappings\": {},\n \"group_headlines\": [],\n \"conditions\": []\n }\n ],\n \"drafts\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"comment\": \"string\",\n \"source\": {},\n \"frozen\": true,\n \"latest\": true,\n \"_summary\": true,\n \"slug\": \"contact\",\n \"version\": 1,\n \"blueprint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"enable_setting\": [\"360_features\"],\n \"name\": \"Contact\",\n \"plural\": \"Contacts\",\n \"description\": \"Example description\",\n \"docs_url\": \"https://docs.epilot.io/docs/pricing/entities\",\n \"category\": \"customer_relations\",\n \"published\": false,\n \"draft\": false,\n \"icon\": \"person\",\n \"title_template\": \"{{first_name}} {{last_name}}\",\n \"ui_config\": {},\n \"capabilities\": [],\n \"group_settings\": [],\n \"layout_settings\": {},\n \"dialog_config\": {},\n \"attributes\": [],\n \"_purpose\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"explicit_search_mappings\": {},\n \"group_headlines\": [],\n \"conditions\": []\n }\n ],\n \"versions_more\": true,\n \"drafts_more\": true,\n \"frozen_version\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}\n```\n\n
\n\n---\n\n### `freezeSchema`\n\nFreeze a schema at its current version, or at a specific version.\nWhen frozen, getSchema returns the frozen version by default.\nNew edits via putSchema update the latest version without affecting the \n\n`POST /v1/entity/schemas/{slug}/freeze`\n\n```ts\nconst { data } = await client.freezeSchema(\n {\n slug: 'example',\n },\n {\n version_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6'\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"comment\": \"string\",\n \"source\": {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n \"frozen\": true,\n \"latest\": true,\n \"_summary\": true,\n \"slug\": \"contact\",\n \"version\": 1,\n \"blueprint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"enable_setting\": [\"360_features\"],\n \"name\": \"Contact\",\n \"plural\": \"Contacts\",\n \"description\": \"Example description\",\n \"docs_url\": \"https://docs.epilot.io/docs/pricing/entities\",\n \"category\": \"customer_relations\",\n \"published\": false,\n \"draft\": false,\n \"icon\": \"person\",\n \"title_template\": \"{{first_name}} {{last_name}}\",\n \"ui_config\": {\n \"table_view\": {\n \"view_type\": \"default\",\n \"row_actions\": [\"string\"],\n \"bulk_actions\": [\"string\"],\n \"navbar_actions\": [],\n \"enable_thumbnails\": false\n },\n \"create_view\": {\n \"view_type\": \"default\",\n \"search_params\": {}\n },\n \"edit_view\": {\n \"view_type\": \"default\",\n \"search_params\": {},\n \"summary_attributes\": [\"email\"]\n },\n \"single_view\": {\n \"view_type\": \"default\",\n \"search_params\": {},\n \"summary_attributes\": [\"email\"]\n },\n \"list_item\": {\n \"summary_attributes\": [],\n \"quick_actions\": [],\n \"ui_config\": {}\n },\n \"sharing\": {\n \"show_sharing_button\": true\n },\n \"grid_layout\": {\n \"id\": \"string\",\n \"columns\": 0,\n \"cells\": [0]\n },\n \"widget_order\": [\"string\"]\n },\n \"capabilities\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"customer_messaging\",\n \"title\": \"Messaging\",\n \"attributes\": [],\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"app_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"adjust_installment\": {\n \"journey_id\": \"adjust-installment-flow\"\n },\n \"ui_config\": {},\n \"ui_hooks\": [],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"schemas\": []\n }\n ],\n \"group_settings\": [\n {\n \"id\": \"e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"label\": \"Contact Details\",\n \"expanded\": true,\n \"order\": 1\n },\n {\n \"id\": \"e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e\",\n \"label\": \"Address Details\",\n \"expanded\": false,\n \"order\": 2,\n \"info_tooltip_title\": {}\n }\n ],\n \"layout_settings\": {\n \"grid_gap\": \"string\",\n \"grid_template_columns\": \"string\"\n },\n \"dialog_config\": {},\n \"attributes\": [\n {\n \"name\": \"email\",\n \"type\": \"email\",\n \"label\": \"Email\",\n \"required\": true\n },\n {\n \"name\": \"first_name\",\n \"type\": \"string\",\n \"label\": \"First Name\"\n }\n ],\n \"_purpose\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"explicit_search_mappings\": {\n \"image\": {\n \"type\": \"keyword\",\n \"index\": false\n }\n },\n \"group_headlines\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"layout\": \"string\",\n \"group\": \"string\",\n \"order\": 0,\n \"type\": \"headline\",\n \"enable_divider\": false,\n \"divider\": \"top_divider\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ],\n \"conditions\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"delivery_area\",\n \"label\": \"Delivery Area\",\n \"type\": \"string\"\n }\n ]\n}\n```\n\n
\n\n---\n\n### `unfreezeSchema`\n\nUnfreeze a schema. Promotes the latest version to the current version for all users.\n\n`POST /v1/entity/schemas/{slug}/unfreeze`\n\n```ts\nconst { data } = await client.unfreezeSchema({\n slug: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"comment\": \"string\",\n \"source\": {\n \"id\": \"string\",\n \"type\": \"string\"\n },\n \"frozen\": true,\n \"latest\": true,\n \"_summary\": true,\n \"slug\": \"contact\",\n \"version\": 1,\n \"blueprint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"enable_setting\": [\"360_features\"],\n \"name\": \"Contact\",\n \"plural\": \"Contacts\",\n \"description\": \"Example description\",\n \"docs_url\": \"https://docs.epilot.io/docs/pricing/entities\",\n \"category\": \"customer_relations\",\n \"published\": false,\n \"draft\": false,\n \"icon\": \"person\",\n \"title_template\": \"{{first_name}} {{last_name}}\",\n \"ui_config\": {\n \"table_view\": {\n \"view_type\": \"default\",\n \"row_actions\": [\"string\"],\n \"bulk_actions\": [\"string\"],\n \"navbar_actions\": [],\n \"enable_thumbnails\": false\n },\n \"create_view\": {\n \"view_type\": \"default\",\n \"search_params\": {}\n },\n \"edit_view\": {\n \"view_type\": \"default\",\n \"search_params\": {},\n \"summary_attributes\": [\"email\"]\n },\n \"single_view\": {\n \"view_type\": \"default\",\n \"search_params\": {},\n \"summary_attributes\": [\"email\"]\n },\n \"list_item\": {\n \"summary_attributes\": [],\n \"quick_actions\": [],\n \"ui_config\": {}\n },\n \"sharing\": {\n \"show_sharing_button\": true\n },\n \"grid_layout\": {\n \"id\": \"string\",\n \"columns\": 0,\n \"cells\": [0]\n },\n \"widget_order\": [\"string\"]\n },\n \"capabilities\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"customer_messaging\",\n \"title\": \"Messaging\",\n \"attributes\": [],\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"app_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"adjust_installment\": {\n \"journey_id\": \"adjust-installment-flow\"\n },\n \"ui_config\": {},\n \"ui_hooks\": [],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"schemas\": []\n }\n ],\n \"group_settings\": [\n {\n \"id\": \"e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"label\": \"Contact Details\",\n \"expanded\": true,\n \"order\": 1\n },\n {\n \"id\": \"e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e\",\n \"label\": \"Address Details\",\n \"expanded\": false,\n \"order\": 2,\n \"info_tooltip_title\": {}\n }\n ],\n \"layout_settings\": {\n \"grid_gap\": \"string\",\n \"grid_template_columns\": \"string\"\n },\n \"dialog_config\": {},\n \"attributes\": [\n {\n \"name\": \"email\",\n \"type\": \"email\",\n \"label\": \"Email\",\n \"required\": true\n },\n {\n \"name\": \"first_name\",\n \"type\": \"string\",\n \"label\": \"First Name\"\n }\n ],\n \"_purpose\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"explicit_search_mappings\": {\n \"image\": {\n \"type\": \"keyword\",\n \"index\": false\n }\n },\n \"group_headlines\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"layout\": \"string\",\n \"group\": \"string\",\n \"order\": 0,\n \"type\": \"headline\",\n \"enable_divider\": false,\n \"divider\": \"top_divider\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ],\n \"conditions\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"delivery_area\",\n \"label\": \"Delivery Area\",\n \"type\": \"string\"\n }\n ]\n}\n```\n\n
\n\n---\n\n### `listAvailableCapabilities`\n\nList available capabilities for schema\n\n`GET /v1/entity/schemas/{slug}/capabilities/available`\n\n```ts\nconst { data } = await client.listAvailableCapabilities({\n slug: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"results\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"customer_messaging\",\n \"title\": \"Messaging\",\n \"attributes\": [],\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"app_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"adjust_installment\": {\n \"journey_id\": \"adjust-installment-flow\"\n },\n \"ui_config\": {},\n \"ui_hooks\": [],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"schemas\": []\n }\n ]\n}\n```\n\n
\n\n---\n\n### `listSchemaBlueprints`\n\nList canonical versions of all available schemas\n\n`GET /v1/entity/schemas/blueprints`\n\n```ts\nconst { data } = await client.listSchemaBlueprints()\n```\n\n
\nResponse\n\n```json\n{\n \"results\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"comment\": \"string\",\n \"source\": {},\n \"frozen\": true,\n \"latest\": true,\n \"_summary\": true,\n \"slug\": \"contact\",\n \"version\": 1,\n \"blueprint\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"enable_setting\": [\"360_features\"],\n \"name\": \"Contact\",\n \"plural\": \"Contacts\",\n \"description\": \"Example description\",\n \"docs_url\": \"https://docs.epilot.io/docs/pricing/entities\",\n \"category\": \"customer_relations\",\n \"published\": false,\n \"draft\": false,\n \"icon\": \"person\",\n \"title_template\": \"{{first_name}} {{last_name}}\",\n \"ui_config\": {},\n \"capabilities\": [],\n \"group_settings\": [],\n \"layout_settings\": {},\n \"dialog_config\": {},\n \"attributes\": [],\n \"_purpose\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"explicit_search_mappings\": {},\n \"group_headlines\": [],\n \"conditions\": []\n }\n ]\n}\n```\n\n
\n\n---\n\n### `searchEntities`\n\nSearch for entities. Supports ordering and pagination. [Lucene query syntax](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax) supp\n\n`POST /v1/entity:search`\n\n```ts\nconst { data } = await client.searchEntities(\n null,\n {\n q: '_schema:contact AND status:active',\n include_scores: false,\n sort: 'string',\n from: 0,\n size: 10,\n hydrate: false,\n anonymize: false,\n fields: ['_id', '_title', 'first_name', 'account', '!account.*._files', '**._product'],\n aggs: {\n 'contact-count-per-tag': {\n terms: {\n field: '_tags.keyword'\n }\n }\n },\n include_deleted: 'false',\n highlight: {},\n stable_for: 0,\n stable_query_id: 'string',\n search_after: ['string']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"hits\": 1,\n \"results\": [\n {\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ],\n \"aggregations\": {\n \"contact-count-per-tag\": {\n \"doc_count_error_upper_bound\": 0,\n \"sum_other_doc_count\": 23,\n \"buckets\": [\n {\n \"key\": \"automation\",\n \"doc_count\": 108\n },\n {\n \"key\": \"primary\",\n \"doc_count\": 66\n }\n ]\n }\n },\n \"stable_query_id\": \"string\",\n \"sort_end\": [1747905443332, \"0.000023312468\"]\n}\n```\n\n
\n\n---\n\n### `listEntities`\n\nList entities that meet the specified conditions.\n\n`POST /v1/entity:list`\n\n```ts\nconst { data } = await client.listEntities(\n null,\n {\n query: {\n query_string: {\n query: 'status:active',\n fields: ['_title', '_tags', 'status'],\n default_operator: 'OR',\n lenient: true\n }\n },\n filter: [\n {\n term: {\n _schema: 'contact'\n }\n },\n {\n terms: {\n status: ['active']\n }\n }\n ],\n allow_targeting_all_schemas: false,\n sort: 'string',\n from: 0,\n size: 10,\n hydrate: false,\n anonymize: false,\n fields: ['_id', '_title', 'first_name', 'account', '!account.*._files', '**._product'],\n aggs: {\n 'contact-count-per-tag': {\n terms: {\n field: '_tags.keyword'\n }\n }\n },\n include_deleted: 'false',\n include_scores: false,\n highlight: {},\n stable_for: 0,\n stable_query_id: 'string',\n search_after: ['string']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"hits\": 1,\n \"results\": [\n {\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ],\n \"aggregations\": {\n \"contact-count-per-tag\": {\n \"doc_count_error_upper_bound\": 0,\n \"sum_other_doc_count\": 23,\n \"buckets\": [\n {\n \"key\": \"automation\",\n \"doc_count\": 108\n },\n {\n \"key\": \"primary\",\n \"doc_count\": 66\n }\n ]\n }\n },\n \"stable_query_id\": \"string\",\n \"sort_end\": [1747905443332, \"0.000023312468\"]\n}\n```\n\n
\n\n---\n\n### `queryEntityGraph`\n\nTraverse an entity relationship graph starting from a seed entity.\n\n`POST /v1/entity:graph`\n\n```ts\nconst { data } = await client.queryEntityGraph(\n null,\n {\n seed: {\n entity_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n node_id: 'contact'\n },\n graph: {\n nodes: [\n {\n id: 'portal_user',\n schema: 'portal_user',\n cardinality: 'one'\n },\n {\n id: 'contact',\n schema: 'contact',\n cardinality: 'one'\n },\n /* ... 1 more */\n ],\n edges: [\n {\n from: 'portal_user',\n to: 'contact'\n },\n {\n from: 'contact',\n to: 'billing_accounts'\n }\n ]\n },\n hydrate: false,\n apply_changesets: false\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"nodes\": {\n \"portal_user\": [\"550e8400-e29b-41d4-a716-446655440001\"],\n \"contact\": [\"550e8400-e29b-41d4-a716-446655440002\"],\n \"billing_accounts\": [\"550e8400-e29b-41d4-a716-446655440003\", \"550e8400-e29b-41d4-a716-446655440004\"]\n },\n \"entityNodes\": {\n \"portal_user\": {\n \"_id\": \"550e8400-e29b-41d4-a716-446655440001\",\n \"_schema\": \"portal_user\"\n },\n \"contact\": {\n \"_id\": \"550e8400-e29b-41d4-a716-446655440002\",\n \"_schema\": \"contact\"\n },\n \"billing_accounts\": [\n {\n \"_id\": \"550e8400-e29b-41d4-a716-446655440003\",\n \"_schema\": \"billing_account\"\n },\n {\n \"_id\": \"550e8400-e29b-41d4-a716-446655440004\",\n \"_schema\": \"billing_account\"\n }\n ]\n },\n \"edges\": [\n {\n \"from\": \"portal_user\",\n \"to\": \"contact\"\n },\n {\n \"from\": \"contact\",\n \"to\": \"billing_accounts\"\n }\n ]\n}\n```\n\n
\n\n---\n\n### `createEntity`\n\nCreates a new entity using a key.\n\n`POST /v1/entity/{slug}`\n\n```ts\nconst { data } = await client.createEntity(\n {\n slug: 'example',\n activity_id: 'example',\n fill_activity: true,\n async: true,\n validate: true,\n },\n {\n _id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n _org: '123',\n _owners: [\n {\n org_id: '123',\n user_id: '123'\n }\n ],\n _schema: 'contact',\n _tags: ['example', 'mock'],\n _created_at: '2021-02-09T12:41:43.662Z',\n _updated_at: '2021-02-09T12:41:43.662Z',\n _acl: {\n view: ['org:456', 'org:789'],\n edit: ['org:456'],\n delete: ['org:456']\n },\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `validateEntity`\n\nValidates an entity against the schema.\n\n`POST /v1/entity/{slug}:validate`\n\n```ts\nconst { data } = await client.validateEntity(\n {\n slug: 'example',\n },\n {\n _id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n _org: '123',\n _owners: [\n {\n org_id: '123',\n user_id: '123'\n }\n ],\n _schema: 'contact',\n _tags: ['example', 'mock'],\n _created_at: '2021-02-09T12:41:43.662Z',\n _updated_at: '2021-02-09T12:41:43.662Z',\n _acl: {\n view: ['org:456', 'org:789'],\n edit: ['org:456'],\n delete: ['org:456']\n },\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"status\": \"success\",\n \"errors\": [\n {\n \"code\": \"custom\",\n \"params\": {\n \"type\": \"missing_field\"\n },\n \"path\": [\"first_name\"],\n \"message\": \"Invalid input\"\n }\n ]\n}\n```\n\n
\n\n---\n\n### `validateEntityV2`\n\nValidates an entity against the schema.\n\n`POST /v2/entity/{slug}:validate`\n\n```ts\nconst { data } = await client.validateEntityV2(\n {\n slug: 'example',\n },\n {\n _id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n _org: '123',\n _owners: [\n {\n org_id: '123',\n user_id: '123'\n }\n ],\n _schema: 'contact',\n _tags: ['example', 'mock'],\n _created_at: '2021-02-09T12:41:43.662Z',\n _updated_at: '2021-02-09T12:41:43.662Z',\n _acl: {\n view: ['org:456', 'org:789'],\n edit: ['org:456'],\n delete: ['org:456']\n },\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"status\": \"success\",\n \"errors\": [\n {\n \"keyword\": \"string\",\n \"instance_path\": \"string\",\n \"schema_path\": \"string\",\n \"params\": {},\n \"property_name\": \"string\",\n \"message\": \"string\",\n \"schema\": {},\n \"parent_schema\": {},\n \"data\": {}\n }\n ]\n}\n```\n\n
\n\n---\n\n### `upsertEntity`\n\nCreate or update an entity using `unique_key`\n\n`PATCH /v1/entity/{slug}:upsert`\n\n```ts\nconst { data } = await client.upsertEntity(\n {\n slug: 'example',\n activity_id: 'example',\n fill_activity: true,\n dry_run: true,\n async: true,\n validate: true,\n strict: true,\n },\n {\n unique_key: ['_id'],\n entity: {\n _id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n _org: '123',\n _owners: [\n {\n org_id: '123',\n user_id: '123'\n }\n ],\n _schema: 'contact',\n _tags: ['example', 'mock'],\n _created_at: '2021-02-09T12:41:43.662Z',\n _updated_at: '2021-02-09T12:41:43.662Z',\n _acl: {\n view: ['org:456', 'org:789'],\n edit: ['org:456'],\n delete: ['org:456']\n },\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n }\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `getEntityV2`\n\nGets Entity by id.\n\n`GET /v2/entity/{slug}/{id}`\n\n```ts\nconst { data } = await client.getEntityV2({\n id: '123e4567-e89b-12d3-a456-426614174000',\n slug: 'example',\n hydrate: true,\n anonymize: true,\n fields: ['...'],\n apply_changesets: true,\n})\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `restoreEntity`\n\nRestores an entity by id\n\n`PATCH /v1/entity/{slug}/{id}:restore`\n\n```ts\nconst { data } = await client.restoreEntity(\n {\n id: '123e4567-e89b-12d3-a456-426614174000',\n slug: 'example',\n activity_id: 'example',\n },\n {},\n)\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `reindexEntity`\n\nTriggers a reindex for the Entity for search.\n\n`POST /v1/entity/{slug}/{id}:reindex`\n\n```ts\nconst { data } = await client.reindexEntity(\n {\n id: '123e4567-e89b-12d3-a456-426614174000',\n slug: 'example',\n },\n {},\n)\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `getEntity`\n\nGets Entity and relations by id.\n\n`GET /v1/entity/{slug}/{id}`\n\n```ts\nconst { data } = await client.getEntity({\n id: '123e4567-e89b-12d3-a456-426614174000',\n slug: 'example',\n hydrate: true,\n anonymize: true,\n})\n```\n\n
\nResponse\n\n```json\n{\n \"entity\": {\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n },\n \"relations\": [\n {\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ]\n}\n```\n\n
\n\n---\n\n### `updateEntity`\n\nUpdates an Entity\n\n`PUT /v1/entity/{slug}/{id}`\n\n```ts\nconst { data } = await client.updateEntity(\n {\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n activity_id: 'example',\n fill_activity: true,\n async: true,\n validate: true,\n direct: true,\n },\n {\n _id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n _org: '123',\n _owners: [\n {\n org_id: '123',\n user_id: '123'\n }\n ],\n _schema: 'contact',\n _tags: ['example', 'mock'],\n _created_at: '2021-02-09T12:41:43.662Z',\n _updated_at: '2021-02-09T12:41:43.662Z',\n _acl: {\n view: ['org:456', 'org:789'],\n edit: ['org:456'],\n delete: ['org:456']\n },\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `patchEntity`\n\nPartially updates an entity with the passed in entity data.\n\n`PATCH /v1/entity/{slug}/{id}`\n\n```ts\nconst { data } = await client.patchEntity(\n {\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n activity_id: 'example',\n fill_activity: true,\n dry_run: true,\n async: true,\n validate: true,\n direct: true,\n },\n {\n _id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n _org: '123',\n _owners: [\n {\n org_id: '123',\n user_id: '123'\n }\n ],\n _schema: 'contact',\n _tags: ['example', 'mock'],\n _created_at: '2021-02-09T12:41:43.662Z',\n _updated_at: '2021-02-09T12:41:43.662Z',\n _acl: {\n view: ['org:456', 'org:789'],\n edit: ['org:456'],\n delete: ['org:456']\n },\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `deleteEntity`\n\nDeletes an Entity\n\n`DELETE /v1/entity/{slug}/{id}`\n\n```ts\nconst { data } = await client.deleteEntity({\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n activity_id: 'example',\n purge: true,\n})\n```\n\n---\n\n### `autocomplete`\n\nAutocomplete entity attributes\n\n`GET /v1/entity:autocomplete`\n\n```ts\nconst { data } = await client.autocomplete({\n anonymize: true,\n input: 'example',\n attribute: 'example',\n slug: 'example',\n size: 1,\n})\n```\n\n
\nResponse\n\n```json\n{\n \"hits\": 1,\n \"results\": [\"value\"]\n}\n```\n\n
\n\n---\n\n### `wipeAllEntities`\n\nCreates a request to queue the deletion of all entities in the system. This is a destructive operation and should only be used in sandbox environments.\n\n`POST /v1/entity:wipeAllEntities`\n\n```ts\nconst { data } = await client.wipeAllEntities(\n null,\n {\n schemas: ['contact']\n },\n)\n```\n\n---\n\n### `createActivity`\n\nCreate an activity that can be displayed in activity feeds.\n\n`POST /v1/entity/activity`\n\n```ts\nconst { data } = await client.createActivity(\n {\n entities: ['...'],\n },\n {\n type: 'string',\n title: 'My custom activity',\n message: '{{caller}} did something with {{entity payload.entity.id}}.',\n payload: {\n entity: {\n id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n schema: 'contact'\n }\n },\n pending: false\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"01F130Q52Q6MWSNS8N2AVXV4JN\",\n \"timestamp\": \"1970-01-01T00:00:00.000Z\",\n \"type\": \"string\",\n \"title\": \"My custom activity\",\n \"message\": \"{{caller}} did something with {{entity payload.entity.id}}.\",\n \"payload\": {\n \"entity\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"schema\": \"contact\"\n }\n },\n \"pending\": false,\n \"caller\": {\n \"EpilotAuth\": {\n \"token\": {\n \"sub\": \"476e9b48-42f4-4234-a2b0-4668b34626ce\",\n \"cognito:groups\": [\"Administrator\"],\n \"cognito:preferred_role\": \"arn:aws:iam::912468240823:role/base-administrator-role\",\n \"iss\": \"https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D\",\n \"custom:ivy_org_id\": \"739224\",\n \"cognito:username\": \"n.ahmad@epilot.cloud\",\n \"custom:ivy_user_id\": \"10006129\",\n \"cognito:roles\": [\"arn:aws:iam::912468240823:role/base-administrator-role\"],\n \"aud\": \"6e0jbdnger7nmoktaaflarue1l\",\n \"event_id\": \"cd5f5583-d90c-4db5-8e99-5f5dd29a4d75\",\n \"token_use\": \"id\",\n \"auth_time\": 1614333023,\n \"exp\": 1614336623,\n \"iat\": 1614333023,\n \"email\": \"n.ahmad@epilot.cloud\"\n }\n }\n }\n}\n```\n\n
\n\n---\n\n### `getActivity`\n\nGet activity by id\n\n`GET /v1/entity/activity/{id}`\n\n```ts\nconst { data } = await client.getActivity({\n anonymize: true,\n id: '123e4567-e89b-12d3-a456-426614174000',\n operations_size: 1,\n operations_from: 1,\n})\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"01F130Q52Q6MWSNS8N2AVXV4JN\",\n \"timestamp\": \"1970-01-01T00:00:00.000Z\",\n \"type\": \"string\",\n \"title\": \"My custom activity\",\n \"message\": \"{{caller}} did something with {{entity payload.entity.id}}.\",\n \"payload\": {\n \"entity\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"schema\": \"contact\"\n }\n },\n \"pending\": false,\n \"caller\": {\n \"EpilotAuth\": {\n \"token\": {}\n }\n },\n \"operations_total\": 1,\n \"operations\": [\n {\n \"entity\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"org\": \"123\",\n \"activity_id\": \"01F130Q52Q6MWSNS8N2AVXV4JN\",\n \"activity_type\": \"string\",\n \"operation\": \"createEntity\",\n \"params\": {},\n \"payload\": {},\n \"diff\": {},\n \"source_context\": {},\n \"_workflow_origin\": {},\n \"_automation_chain\": [\"string\"]\n }\n ]\n}\n```\n\n
\n\n---\n\n### `attachActivity`\n\nAttach existing activity to entity activity feeds\n\n`POST /v1/entity/activity/{id}:attach`\n\n```ts\nconst { data } = await client.attachActivity({\n id: '123e4567-e89b-12d3-a456-426614174000',\n entities: ['...'],\n})\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"01F130Q52Q6MWSNS8N2AVXV4JN\",\n \"timestamp\": \"1970-01-01T00:00:00.000Z\",\n \"type\": \"string\",\n \"title\": \"My custom activity\",\n \"message\": \"{{caller}} did something with {{entity payload.entity.id}}.\",\n \"payload\": {\n \"entity\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"schema\": \"contact\"\n }\n },\n \"pending\": false,\n \"caller\": {\n \"EpilotAuth\": {\n \"token\": {\n \"sub\": \"476e9b48-42f4-4234-a2b0-4668b34626ce\",\n \"cognito:groups\": [\"Administrator\"],\n \"cognito:preferred_role\": \"arn:aws:iam::912468240823:role/base-administrator-role\",\n \"iss\": \"https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D\",\n \"custom:ivy_org_id\": \"739224\",\n \"cognito:username\": \"n.ahmad@epilot.cloud\",\n \"custom:ivy_user_id\": \"10006129\",\n \"cognito:roles\": [\"arn:aws:iam::912468240823:role/base-administrator-role\"],\n \"aud\": \"6e0jbdnger7nmoktaaflarue1l\",\n \"event_id\": \"cd5f5583-d90c-4db5-8e99-5f5dd29a4d75\",\n \"token_use\": \"id\",\n \"auth_time\": 1614333023,\n \"exp\": 1614336623,\n \"iat\": 1614333023,\n \"email\": \"n.ahmad@epilot.cloud\"\n }\n }\n }\n}\n```\n\n
\n\n---\n\n### `applyChangeset`\n\nApplies the proposed value from a pending changeset to the entity attribute\nand removes the changeset. Used for human approval of pending changes.\n\n`POST /v1/entity/{slug}/{id}/changesets/{attribute}:apply`\n\n```ts\nconst { data } = await client.applyChangeset({\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n attribute: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `dismissChangeset`\n\nRemoves a pending changeset without applying it. The attribute value remains unchanged.\n\n`POST /v1/entity/{slug}/{id}/changesets/{attribute}:dismiss`\n\n```ts\nconst { data } = await client.dismissChangeset(\n {\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n attribute: 'example',\n },\n {\n reason: 'string'\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `listChangesets`\n\nReturns all pending changesets for an entity.\n\n`GET /v1/entity/{slug}/{id}/changesets`\n\n```ts\nconst { data } = await client.listChangesets({\n anonymize: true,\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n})\n```\n\n
\nResponse\n\n```json\n{}\n```\n\n
\n\n---\n\n### `getEntityActivityFeed`\n\nGet activity feed for an entity\n\n`GET /v1/entity/{slug}/{id}/activity`\n\n```ts\nconst { data } = await client.getEntityActivityFeed({\n anonymize: true,\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n after: 'example',\n before: 'example',\n start_date: 'example',\n end_date: 'example',\n preset_range: 'example',\n from: 1,\n size: 1,\n type: ['...'],\n include_relations: true,\n exclude_activity_groups: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"total\": 1,\n \"results\": [\n {\n \"_id\": \"01F130Q52Q6MWSNS8N2AVXV4JN\",\n \"timestamp\": \"1970-01-01T00:00:00.000Z\",\n \"type\": \"string\",\n \"title\": \"My custom activity\",\n \"message\": \"{{caller}} did something with {{entity payload.entity.id}}.\",\n \"payload\": {},\n \"pending\": false,\n \"caller\": {},\n \"operations_total\": 1,\n \"operations\": []\n }\n ]\n}\n```\n\n
\n\n---\n\n### `getRelations`\n\nReturns 1st level direct relations for an entity.\n\n`GET /v1/entity/{slug}/{id}/relations`\n\n```ts\nconst { data } = await client.getRelations({\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n hydrate: true,\n anonymize: true,\n include_reverse: true,\n from: 1,\n size: 1,\n include_schemas: ['...'],\n exclude_schemas: ['...'],\n})\n```\n\n
\nResponse\n\n```json\n[\n {\n \"entity_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"org_id\": \"string\",\n \"_schema\": \"contact\",\n \"attribute\": \"string\",\n \"_tags\": [\"string\"],\n \"reverse\": true\n },\n {\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n]\n```\n\n
\n\n---\n\n### `addRelations`\n\nRelates one or more entities to parent entity by adding items to a relation attribute\n\n`POST /v1/entity/{slug}/{id}/relations`\n\n```ts\nconst { data } = await client.addRelations(\n {\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n async: true,\n activity_id: 'example',\n },\n [\n {\n entity_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n org_id: 'string',\n _schema: 'contact',\n attribute: 'string',\n _tags: ['string'],\n reverse: true\n }\n ],\n)\n```\n\n
\nResponse\n\n```json\n{\n \"entity_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"org_id\": \"string\",\n \"_schema\": \"contact\",\n \"attribute\": \"string\",\n \"_tags\": [\"string\"],\n \"reverse\": true\n}\n```\n\n
\n\n---\n\n### `removeRelations`\n\nDisassociate one or more entities to parent entity by removing items to a relation attribute\n\n`DELETE /v1/entity/{slug}/{id}/relations`\n\n```ts\nconst { data } = await client.removeRelations(\n {\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n async: true,\n activity_id: 'example',\n },\n [\n {\n entity_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n org_id: 'string',\n _schema: 'contact',\n attribute: 'string',\n _tags: ['string'],\n reverse: true\n }\n ],\n)\n```\n\n---\n\n### `getRelationsV2`\n\nReturns 1st level direct relations for an entity with pagination.\n\n`GET /v2/entity/{slug}/{id}/relations`\n\n```ts\nconst { data } = await client.getRelationsV2({\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n hydrate: true,\n anonymize: true,\n query: 'example',\n include_reverse: true,\n from: 1,\n size: 1,\n fields: ['...'],\n})\n```\n\n
\nResponse\n\n```json\n{\n \"hits\": 1,\n \"relations\": [\n {\n \"entity_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"org_id\": \"string\",\n \"_schema\": \"contact\",\n \"attribute\": \"string\",\n \"_tags\": [\"string\"],\n \"reverse\": true\n },\n {\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ]\n}\n```\n\n
\n\n---\n\n### `getRelationsV3`\n\nReturns 1st level direct relations for an entity with pagination.\n\n`GET /v3/entity/{slug}/{id}/relations`\n\n```ts\nconst { data } = await client.getRelationsV3({\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n hydrate: true,\n anonymize: true,\n include_reverse: true,\n from: 1,\n size: 1,\n include_schemas: ['...'],\n exclude_schemas: ['...'],\n mode: 'example',\n fields: ['...'],\n include_deleted: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"hits\": 1,\n \"relations\": [\n {\n \"entity_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"org_id\": \"string\",\n \"_schema\": \"contact\",\n \"attribute\": \"string\",\n \"_tags\": [\"string\"],\n \"reverse\": true\n },\n {\n \"_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"_org\": \"123\",\n \"_owners\": [\n {\n \"org_id\": \"123\",\n \"user_id\": \"123\"\n }\n ],\n \"_schema\": \"contact\",\n \"_tags\": [\"example\", \"mock\"],\n \"_created_at\": \"2021-02-09T12:41:43.662Z\",\n \"_updated_at\": \"2021-02-09T12:41:43.662Z\",\n \"_acl\": {\n \"view\": [\"org:456\", \"org:789\"],\n \"edit\": [\"org:456\"],\n \"delete\": [\"org:456\"]\n },\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ]\n}\n```\n\n
\n\n---\n\n### `getRelatedEntitiesCount`\n\nReturns the amount of unique related entities for an entity - includes direct and reverse relations.\n\n`GET /v2/entity/{slug}/{id}/relations/count`\n\n```ts\nconst { data } = await client.getRelatedEntitiesCount({\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n exclude_schemas: ['...'],\n})\n```\n\n
\nResponse\n\n```json\n{\n \"hits\": 1\n}\n```\n\n
\n\n---\n\n### `updateRelation`\n\nUpdates an existing relation between two entities.\n\n`PUT /v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}`\n\n```ts\nconst { data } = await client.updateRelation(\n {\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n attribute: 'example',\n entity_id: 'example',\n async: true,\n activity_id: 'example',\n },\n {\n _tags: ['string']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"entity_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"org_id\": \"string\",\n \"_schema\": \"contact\",\n \"attribute\": \"string\",\n \"_tags\": [\"string\"],\n \"reverse\": true\n}\n```\n\n
\n\n---\n\n### `deleteRelation`\n\nRemoves relation between two entities\n\n`DELETE /v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}`\n\n```ts\nconst { data } = await client.deleteRelation({\n slug: 'example',\n id: '123e4567-e89b-12d3-a456-426614174000',\n attribute: 'example',\n entity_id: 'example',\n async: true,\n activity_id: 'example',\n})\n```\n\n---\n\n### `exportEntities`\n\nExport entity data in a CSV-format. The export will export data as close as possible to what is visible on Entity UI tables.\nThe values exported as in some cases, transformed to human-readable values.\n\n`POST /v1/entity:export`\n\n```ts\nconst { data } = await client.exportEntities(\n {\n job_id: 'example',\n is_template: true,\n language: 'example',\n },\n {\n q: '_schema:contact AND status:active',\n include_scores: false,\n sort: 'string',\n from: 0,\n size: 10,\n hydrate: false,\n anonymize: false,\n fields: ['_id', '_title', 'first_name', 'account', '!account.*._files', '**._product'],\n aggs: {\n 'contact-count-per-tag': {\n terms: {\n field: '_tags.keyword'\n }\n }\n },\n include_deleted: 'false',\n highlight: {},\n stable_for: 0,\n stable_query_id: 'string',\n search_after: ['string']\n },\n)\n```\n\n---\n\n### `importEntities`\n\nImport Entities\n\n`POST /v1/entity:import`\n\n```ts\nconst { data } = await client.importEntities(\n {\n job_id: 'example',\n },\n {\n S3Reference: {\n bucket: 'my-bucket',\n key: 'imports/my-import.json'\n },\n schema: 'contact'\n },\n)\n```\n\n---\n\n### `abortEntityImport`\n\nAbort a running entity import\n\n`POST /v1/entity:abortImport`\n\n```ts\nconst { data } = await client.abortEntityImport({\n job_id: 'example',\n schema: 'example',\n})\n```\n\n---\n\n### `listSavedViews`\n\nGet the Saved Views based on the schema\n\n`GET /v1/entity/views`\n\n```ts\nconst { data } = await client.listSavedViews({\n slug: 'example',\n sort: 'example',\n from: 1,\n size: 1,\n q: 'example',\n fields: ['...'],\n})\n```\n\n
\nResponse\n\n```json\n{\n \"hits\": 1,\n \"results\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"slug\": [\"contact\"],\n \"name\": \"View listing German\",\n \"org\": \"66\",\n \"shared\": true,\n \"isFavoritedBy\": [\"11701\"],\n \"created_by\": {\n \"user_id\": \"10598\",\n \"org_id\": \"739224\"\n },\n \"ui_config\": {\n \"filters\": {\n \"customer_name\": \"suresh test\",\n \"_tags\": \"360\"\n },\n \"table_layout\": {\n \"opportunity\": {\n \"page\": 1,\n \"sort\": \"_created_at:desc\",\n \"pageSize\": 25,\n \"columnSettings\": []\n }\n }\n },\n \"shared_with\": [\"112233\"]\n }\n ]\n}\n```\n\n
\n\n---\n\n### `createSavedView`\n\nCreates a new saved view\n\n`POST /v1/entity/view`\n\n```ts\nconst { data } = await client.createSavedView(\n null,\n {\n slug: ['contact'],\n name: 'View listing German',\n org: '66',\n shared: true,\n isFavoritedBy: ['11701'],\n created_by: {\n user_id: '10598',\n org_id: '739224'\n },\n ui_config: {\n filters: {\n customer_name: 'suresh test',\n _tags: '360'\n },\n table_layout: {\n opportunity: {\n page: 1,\n sort: '_created_at:desc',\n pageSize: 25,\n columnSettings: []\n }\n }\n },\n shared_with: ['112233']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"slug\": [\"contact\"],\n \"name\": \"View listing German\",\n \"org\": \"66\",\n \"shared\": true,\n \"isFavoritedBy\": [\"11701\"],\n \"created_by\": {\n \"user_id\": \"10598\",\n \"org_id\": \"739224\"\n },\n \"ui_config\": {\n \"filters\": {\n \"customer_name\": \"suresh test\",\n \"_tags\": \"360\"\n },\n \"table_layout\": {\n \"opportunity\": {\n \"page\": 1,\n \"sort\": \"_created_at:desc\",\n \"pageSize\": 25,\n \"columnSettings\": []\n }\n }\n },\n \"shared_with\": [\"112233\"]\n}\n```\n\n
\n\n---\n\n### `getSavedView`\n\nGets Saved View configuration by id.\n\n`GET /v1/entity/view/{id}`\n\n```ts\nconst { data } = await client.getSavedView({\n id: '123e4567-e89b-12d3-a456-426614174000',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"slug\": [\"contact\"],\n \"name\": \"View listing German\",\n \"org\": \"66\",\n \"shared\": true,\n \"isFavoritedBy\": [\"11701\"],\n \"created_by\": {\n \"user_id\": \"10598\",\n \"org_id\": \"739224\"\n },\n \"ui_config\": {\n \"filters\": {\n \"customer_name\": \"suresh test\",\n \"_tags\": \"360\"\n },\n \"table_layout\": {\n \"opportunity\": {\n \"page\": 1,\n \"sort\": \"_created_at:desc\",\n \"pageSize\": 25,\n \"columnSettings\": []\n }\n }\n },\n \"shared_with\": [\"112233\"]\n}\n```\n\n
\n\n---\n\n### `updateSavedView`\n\nUpdates a saved view\n\n`PUT /v1/entity/view/{id}`\n\n```ts\nconst { data } = await client.updateSavedView(\n {\n id: '123e4567-e89b-12d3-a456-426614174000',\n },\n {\n id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n created_at: 'string',\n updated_at: 'string',\n slug: ['contact'],\n name: 'View listing German',\n org: '66',\n shared: true,\n isFavoritedBy: ['11701'],\n created_by: {\n user_id: '10598',\n org_id: '739224'\n },\n ui_config: {\n filters: {\n customer_name: 'suresh test',\n _tags: '360'\n },\n table_layout: {\n opportunity: {\n page: 1,\n sort: '_created_at:desc',\n pageSize: 25,\n columnSettings: []\n }\n }\n },\n shared_with: ['112233']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"slug\": [\"contact\"],\n \"name\": \"View listing German\",\n \"org\": \"66\",\n \"shared\": true,\n \"isFavoritedBy\": [\"11701\"],\n \"created_by\": {\n \"user_id\": \"10598\",\n \"org_id\": \"739224\"\n },\n \"ui_config\": {\n \"filters\": {\n \"customer_name\": \"suresh test\",\n \"_tags\": \"360\"\n },\n \"table_layout\": {\n \"opportunity\": {\n \"page\": 1,\n \"sort\": \"_created_at:desc\",\n \"pageSize\": 25,\n \"columnSettings\": []\n }\n }\n },\n \"shared_with\": [\"112233\"]\n}\n```\n\n
\n\n---\n\n### `patchSavedView`\n\nPartially updates a saved view with the provided payload. If an updated_at is passed and the server contains a newer version of the view a `409` error is returned\n\n`PATCH /v1/entity/view/{id}`\n\n```ts\nconst { data } = await client.patchSavedView(\n {\n id: '123e4567-e89b-12d3-a456-426614174000',\n },\n {\n slug: ['contact'],\n name: 'View listing German',\n org: '66',\n shared: true,\n isFavoritedBy: ['11701'],\n created_by: {\n user_id: '10598',\n org_id: '739224'\n },\n ui_config: {\n filters: {\n customer_name: 'suresh test',\n _tags: '360'\n },\n table_layout: {\n opportunity: {\n page: 1,\n sort: '_created_at:desc',\n pageSize: 25,\n columnSettings: []\n }\n }\n },\n shared_with: ['112233']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"slug\": [\"contact\"],\n \"name\": \"View listing German\",\n \"org\": \"66\",\n \"shared\": true,\n \"isFavoritedBy\": [\"11701\"],\n \"created_by\": {\n \"user_id\": \"10598\",\n \"org_id\": \"739224\"\n },\n \"ui_config\": {\n \"filters\": {\n \"customer_name\": \"suresh test\",\n \"_tags\": \"360\"\n },\n \"table_layout\": {\n \"opportunity\": {\n \"page\": 1,\n \"sort\": \"_created_at:desc\",\n \"pageSize\": 25,\n \"columnSettings\": []\n }\n }\n },\n \"shared_with\": [\"112233\"]\n}\n```\n\n
\n\n---\n\n### `deleteSavedView`\n\nDeletes a saved view\n\n`DELETE /v1/entity/view/{id}`\n\n```ts\nconst { data } = await client.deleteSavedView({\n id: '123e4567-e89b-12d3-a456-426614174000',\n})\n```\n\n---\n\n### `listFavoriteViewsForUser`\n\nGet the Favorite Saved Views for user based on the schema\n\n`GET /v1/entity/views/favorites`\n\n```ts\nconst { data } = await client.listFavoriteViewsForUser()\n```\n\n
\nResponse\n\n```json\n{\n \"results\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"slug\": [\"contact\"],\n \"name\": \"View listing German\",\n \"org\": \"66\",\n \"shared\": true,\n \"isFavoritedBy\": [\"11701\"],\n \"created_by\": {\n \"user_id\": \"10598\",\n \"org_id\": \"739224\"\n },\n \"ui_config\": {\n \"filters\": {\n \"customer_name\": \"suresh test\",\n \"_tags\": \"360\"\n },\n \"table_layout\": {\n \"opportunity\": {\n \"page\": 1,\n \"sort\": \"_created_at:desc\",\n \"pageSize\": 25,\n \"columnSettings\": []\n }\n }\n },\n \"shared_with\": [\"112233\"]\n }\n ]\n}\n```\n\n
\n\n---\n\n### `listTaxonomies`\n\nList taxonomies in an organization\n\n`GET /v1/entity/taxonomies`\n\n```ts\nconst { data } = await client.listTaxonomies({\n include_disabled: true,\n type: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"results\": [\n {\n \"slug\": \"purpose\",\n \"name\": \"Purpose\",\n \"plural\": \"Purposes\",\n \"kind\": \"system\",\n \"type\": \"entity\",\n \"icon\": \"purpose\",\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"deleted_at\": \"1970-01-01T00:00:00.000Z\",\n \"created_by\": \"10598\",\n \"enabled\": true,\n \"order\": 10,\n \"enabled_locations\": [\"account\", \"string\"]\n }\n ]\n}\n```\n\n
\n\n---\n\n### `createTaxonomy`\n\nCreate a new taxonomy\n\n`POST /v1/entity/taxonomies`\n\n```ts\nconst { data } = await client.createTaxonomy(\n null,\n {\n slug: 'purpose',\n name: 'Purpose',\n plural: 'Purposes',\n kind: 'system',\n type: 'entity',\n icon: 'purpose',\n color: '#FF5733',\n created_at: '1970-01-01T00:00:00.000Z',\n updated_at: '1970-01-01T00:00:00.000Z',\n deleted_at: '1970-01-01T00:00:00.000Z',\n created_by: '10598',\n enabled: true,\n order: 10,\n enabled_locations: ['account', 'string']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"slug\": \"purpose\",\n \"name\": \"Purpose\",\n \"plural\": \"Purposes\",\n \"kind\": \"system\",\n \"type\": \"entity\",\n \"icon\": \"purpose\",\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"deleted_at\": \"1970-01-01T00:00:00.000Z\",\n \"created_by\": \"10598\",\n \"enabled\": true,\n \"order\": 10,\n \"enabled_locations\": [\"account\", \"string\"]\n}\n```\n\n
\n\n---\n\n### `getTaxonomy`\n\nGet taxonomy by slug\n\n`GET /v1/entity/taxonomies/{taxonomySlug}`\n\n```ts\nconst { data } = await client.getTaxonomy({\n taxonomySlug: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"slug\": \"purpose\",\n \"name\": \"Purpose\",\n \"plural\": \"Purposes\",\n \"kind\": \"system\",\n \"type\": \"entity\",\n \"icon\": \"purpose\",\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"deleted_at\": \"1970-01-01T00:00:00.000Z\",\n \"created_by\": \"10598\",\n \"enabled\": true,\n \"order\": 10,\n \"enabled_locations\": [\"account\", \"string\"]\n}\n```\n\n
\n\n---\n\n### `updateTaxonomy`\n\nUpdate a taxonomy\n\n`PUT /v1/entity/taxonomies/{taxonomySlug}`\n\n```ts\nconst { data } = await client.updateTaxonomy(\n {\n taxonomySlug: 'example',\n },\n {\n slug: 'purpose',\n name: 'Purpose',\n plural: 'Purposes',\n kind: 'system',\n type: 'entity',\n icon: 'purpose',\n color: '#FF5733',\n created_at: '1970-01-01T00:00:00.000Z',\n updated_at: '1970-01-01T00:00:00.000Z',\n deleted_at: '1970-01-01T00:00:00.000Z',\n created_by: '10598',\n enabled: true,\n order: 10,\n enabled_locations: ['account', 'string']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"slug\": \"purpose\",\n \"name\": \"Purpose\",\n \"plural\": \"Purposes\",\n \"kind\": \"system\",\n \"type\": \"entity\",\n \"icon\": \"purpose\",\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"deleted_at\": \"1970-01-01T00:00:00.000Z\",\n \"created_by\": \"10598\",\n \"enabled\": true,\n \"order\": 10,\n \"enabled_locations\": [\"account\", \"string\"]\n}\n```\n\n
\n\n---\n\n### `deleteTaxonomy`\n\nDelete a taxonomy\n\n`DELETE /v1/entity/taxonomies/{taxonomySlug}`\n\n```ts\nconst { data } = await client.deleteTaxonomy({\n taxonomySlug: 'example',\n permanent: true,\n})\n```\n\n---\n\n### `updateClassificationsForTaxonomy`\n\nUpdate the classifications for a taxonomy\n\n`POST /v1/entity/taxonomies/{taxonomySlug}/classifications`\n\n```ts\nconst { data } = await client.updateClassificationsForTaxonomy(\n {\n taxonomySlug: 'example',\n },\n {\n create: [\n {\n id: 'taxonomy-slug:classification-slug',\n slug: 'wallbox-pv',\n name: 'Wallbox PV',\n parents: ['taxonomy-slug:classification-slug'],\n color: '#FF5733',\n created_at: '1970-01-01T00:00:00.000Z',\n updated_at: '1970-01-01T00:00:00.000Z',\n archived: false,\n starred: false,\n enabled_locations: ['account', 'string'],\n enabled_purposes: ['string'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n }\n ],\n update: [\n {\n id: 'taxonomy-slug:classification-slug',\n slug: 'wallbox-pv',\n name: 'Wallbox PV',\n parents: ['taxonomy-slug:classification-slug'],\n color: '#FF5733',\n created_at: '1970-01-01T00:00:00.000Z',\n updated_at: '1970-01-01T00:00:00.000Z',\n archived: false,\n starred: false,\n enabled_locations: ['account', 'string'],\n enabled_purposes: ['string'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n }\n ],\n delete: ['taxonomy-slug:classification-slug', 'taxonomy-slug:classification-slug']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"created\": [\n {\n \"id\": \"taxonomy-slug:classification-slug\",\n \"slug\": \"wallbox-pv\",\n \"name\": \"Wallbox PV\",\n \"parents\": [\"taxonomy-slug:classification-slug\"],\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"archived\": false,\n \"starred\": false,\n \"enabled_locations\": [\"account\", \"string\"],\n \"enabled_purposes\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ],\n \"updated\": [\n {\n \"id\": \"taxonomy-slug:classification-slug\",\n \"slug\": \"wallbox-pv\",\n \"name\": \"Wallbox PV\",\n \"parents\": [\"taxonomy-slug:classification-slug\"],\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"archived\": false,\n \"starred\": false,\n \"enabled_locations\": [\"account\", \"string\"],\n \"enabled_purposes\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ],\n \"deleted\": [\"taxonomy-slug:classification-slug\"]\n}\n```\n\n
\n\n---\n\n### `createTaxonomyClassification`\n\nCreate a new classification for a taxonomy\n\n`POST /v2/entity/taxonomies/classifications`\n\n```ts\nconst { data } = await client.createTaxonomyClassification(\n null,\n {\n id: 'taxonomy-slug:classification-slug',\n slug: 'wallbox-pv',\n name: 'Wallbox PV',\n parents: ['taxonomy-slug:classification-slug'],\n color: '#FF5733',\n created_at: '1970-01-01T00:00:00.000Z',\n updated_at: '1970-01-01T00:00:00.000Z',\n archived: false,\n starred: false,\n enabled_locations: ['account', 'string'],\n enabled_purposes: ['string'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"taxonomy-slug:classification-slug\",\n \"slug\": \"wallbox-pv\",\n \"name\": \"Wallbox PV\",\n \"parents\": [\"taxonomy-slug:classification-slug\"],\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"archived\": false,\n \"starred\": false,\n \"enabled_locations\": [\"account\", \"string\"],\n \"enabled_purposes\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `getTaxonomyClassification`\n\nGet a classification for a taxonomy by slug\n\n`GET /v2/entity/taxonomies/classifications/{classificationSlug}`\n\n```ts\nconst { data } = await client.getTaxonomyClassification({\n classificationSlug: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"taxonomy-slug:classification-slug\",\n \"slug\": \"wallbox-pv\",\n \"name\": \"Wallbox PV\",\n \"parents\": [\"taxonomy-slug:classification-slug\"],\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"archived\": false,\n \"starred\": false,\n \"enabled_locations\": [\"account\", \"string\"],\n \"enabled_purposes\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `updateTaxonomyClassification`\n\nUpdate a classification for a taxonomy\n\n`PUT /v2/entity/taxonomies/classifications/{classificationSlug}`\n\n```ts\nconst { data } = await client.updateTaxonomyClassification(\n {\n classificationSlug: 'example',\n },\n {\n id: 'taxonomy-slug:classification-slug',\n slug: 'wallbox-pv',\n name: 'Wallbox PV',\n parents: ['taxonomy-slug:classification-slug'],\n color: '#FF5733',\n created_at: '1970-01-01T00:00:00.000Z',\n updated_at: '1970-01-01T00:00:00.000Z',\n archived: false,\n starred: false,\n enabled_locations: ['account', 'string'],\n enabled_purposes: ['string'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"taxonomy-slug:classification-slug\",\n \"slug\": \"wallbox-pv\",\n \"name\": \"Wallbox PV\",\n \"parents\": [\"taxonomy-slug:classification-slug\"],\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"archived\": false,\n \"starred\": false,\n \"enabled_locations\": [\"account\", \"string\"],\n \"enabled_purposes\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `deleteTaxonomyClassification`\n\nDelete a classification for a taxonomy\n\n`DELETE /v2/entity/taxonomies/classifications/{classificationSlug}`\n\n```ts\nconst { data } = await client.deleteTaxonomyClassification({\n classificationSlug: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"taxonomy-slug:classification-slug\",\n \"slug\": \"wallbox-pv\",\n \"name\": \"Wallbox PV\",\n \"parents\": [\"taxonomy-slug:classification-slug\"],\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"archived\": false,\n \"starred\": false,\n \"enabled_locations\": [\"account\", \"string\"],\n \"enabled_purposes\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n}\n```\n\n
\n\n---\n\n### `taxonomyAutocomplete`\n\nTaxonomies autocomplete\n\n`GET /v1/entity/taxonomies/{taxonomySlug}:autocomplete`\n\n```ts\nconst { data } = await client.taxonomyAutocomplete({\n taxonomySlug: 'example',\n query: 'example',\n size: 1,\n})\n```\n\n
\nResponse\n\n```json\n{\n \"results\": [\n {\n \"id\": \"taxonomy-slug:classification-slug\",\n \"slug\": \"wallbox-pv\",\n \"name\": \"Wallbox PV\",\n \"parents\": [\"taxonomy-slug:classification-slug\"],\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"archived\": false,\n \"starred\": false,\n \"enabled_locations\": [\"account\", \"string\"],\n \"enabled_purposes\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ]\n}\n```\n\n
\n\n---\n\n### `taxonomiesClassificationsSearch`\n\nList taxonomy classifications in an organization based on taxonomy slug\n\n`POST /v1/entity/taxonomies/classifications:search`\n\n```ts\nconst { data } = await client.taxonomiesClassificationsSearch(\n {\n taxonomySlug: ['...'],\n query: 'example',\n archived: true,\n include_archived: 'example',\n exclude_types: ['...'],\n },\n {\n classificationIds: [\n 'taxonomy-slug:classification-slug',\n {\n pattern: 'taxonomy-slug:*'\n }\n ]\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"results\": [\n {\n \"id\": \"taxonomy-slug:classification-slug\",\n \"slug\": \"wallbox-pv\",\n \"name\": \"Wallbox PV\",\n \"parents\": [\"taxonomy-slug:classification-slug\"],\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"archived\": false,\n \"starred\": false,\n \"enabled_locations\": [\"account\", \"string\"],\n \"enabled_purposes\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ],\n \"hits\": 10\n}\n```\n\n
\n\n---\n\n### `listTaxonomyClassificationsForSchema`\n\nList taxonomy classifications for a given schema\n\n`GET /v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}`\n\n```ts\nconst { data } = await client.listTaxonomyClassificationsForSchema({\n slug: 'example',\n taxonomySlug: 'example',\n query: 'example',\n size: 1,\n})\n```\n\n
\nResponse\n\n```json\n{\n \"results\": [\n {\n \"id\": \"taxonomy-slug:classification-slug\",\n \"slug\": \"wallbox-pv\",\n \"name\": \"Wallbox PV\",\n \"parents\": [\"taxonomy-slug:classification-slug\"],\n \"color\": \"#FF5733\",\n \"created_at\": \"1970-01-01T00:00:00.000Z\",\n \"updated_at\": \"1970-01-01T00:00:00.000Z\",\n \"archived\": false,\n \"starred\": false,\n \"enabled_locations\": [\"account\", \"string\"],\n \"enabled_purposes\": [\"string\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"]\n }\n ]\n}\n```\n\n
\n\n---\n\n### `getTaxonomyBulkActionJobs`\n\nGets bulk actions jobs by job status:\n- ```` = all active jobs\n- PENDING = all active jobs\n- FAILED = all failed jobs\n- COMPLETED = all completed jobs\n\n`GET /v1/entity/taxonomies/bulk-jobs`\n\n```ts\nconst { data } = await client.getTaxonomyBulkActionJobs({\n status: ['...'],\n size: 1,\n created_after: 'example',\n sort_pending_first: true,\n scope: 'example',\n})\n```\n\n
\nResponse\n\n```json\n[\n {\n \"job_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"PENDING\",\n \"action_type\": \"MOVE_CLASSIFICATIONS\",\n \"created_by\": \"10598\",\n \"created_at\": \"2024-01-01T00:00:00.000Z\",\n \"updated_at\": \"2024-01-01T00:00:00.000Z\",\n \"org\": \"66\"\n }\n]\n```\n\n
\n\n---\n\n### `getTaxonomyBulkActionJobById`\n\nGets a bulk action job by job id\n\n`GET /v1/entity/taxonomies/bulk-jobs/{job_id}`\n\n```ts\nconst { data } = await client.getTaxonomyBulkActionJobById({\n job_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"job_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"PENDING\",\n \"action_type\": \"MOVE_CLASSIFICATIONS\",\n \"created_by\": \"10598\",\n \"created_at\": \"2024-01-01T00:00:00.000Z\",\n \"updated_at\": \"2024-01-01T00:00:00.000Z\",\n \"org\": \"66\"\n}\n```\n\n
\n\n---\n\n### `cancelBulkAction`\n\nCancels a running bulk action job. The job status will be updated to CANCELLED\nand the job will be stopped.\n\n`POST /v1/entity/taxonomies/bulk-jobs/{job_id}/cancel`\n\n```ts\nconst { data } = await client.cancelBulkAction({\n job_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"job_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"status\": \"PENDING\",\n \"action_type\": \"MOVE_CLASSIFICATIONS\",\n \"created_by\": \"10598\",\n \"created_at\": \"2024-01-01T00:00:00.000Z\",\n \"updated_at\": \"2024-01-01T00:00:00.000Z\",\n \"org\": \"66\"\n}\n```\n\n
\n\n---\n\n### `bulkMoveClassifications`\n\nMoves classifications from one taxonomy to another, through a bulk async operation which\nalso updates all references from the old classification to the new one under the target taxonomy.\n\n`POST /v1/entity/taxonomies/classifications:move`\n\n```ts\nconst { data } = await client.bulkMoveClassifications(\n null,\n {\n job_id: 'string',\n target_taxonomy: 'purpose',\n classification_ids: ['taxonomy-slug:classification-slug']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"job_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"status\": \"PENDING\"\n}\n```\n\n
\n\n---\n\n### `bulkMergeClassifications`\n\nMerges classifications from one taxonomy into one individual classification, through a bulk async operation which\nalso updates all references from the old Classifications to the new one.\n\n`POST /v1/entity/taxonomies/classifications:merge`\n\n```ts\nconst { data } = await client.bulkMergeClassifications(\n null,\n {\n job_id: 'string',\n target_classification: 'purpose',\n classification_ids: ['taxonomy-slug:classification-slug']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"job_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"status\": \"PENDING\"\n}\n```\n\n
\n\n---\n\n### `bulkDeleteClassifications`\n\nPermanently deletes taxonomy classifications. The classifications are deleted through a bulk\nasync operation which also deletes all references of the deleted classifications from the entities\nreferenc\n\n`POST /v1/entity/taxonomies/classifications:delete`\n\n```ts\nconst { data } = await client.bulkDeleteClassifications(\n null,\n {\n job_id: 'string',\n classification_ids: ['taxonomy-slug:classification-slug']\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"job_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"status\": \"PENDING\"\n}\n```\n\n
\n\n---\n\n### `createSchemaAttribute`\n\nCreate a schema attribute\n\n`POST /v1/entity/schemas/attributes`\n\n```ts\nconst { data } = await client.createSchemaAttribute(\n null,\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'string',\n label: 'string',\n placeholder: 'string',\n hidden: false,\n show_in_table: true,\n sortable: true,\n required: false,\n readonly: false,\n deprecated: false,\n variant_overridable: false,\n default_value: {},\n group: 'string',\n order: 0,\n layout: 'full_width',\n hide_label: true,\n icon: 'string',\n render_condition: 'string',\n data_classification: 'public',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n constraints: {\n disablePast: true\n },\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [\n {\n name: 'string',\n enabled: true\n }\n ],\n value_formatter: 'string',\n preview_value_formatter: 'string',\n entity_builder_disable_edit: false,\n protected: true,\n info_helpers: {\n hint_text: 'string',\n hint_text_key: 'string',\n hint_custom_component: 'string',\n hint_tooltip_placement: 'top'\n },\n explicit_searchable: false,\n exclude_from_search: false,\n repeatable: true,\n has_primary: true,\n edit_mode: 'direct',\n edit_mode_config: {\n match_strategy: 'exact',\n fuzzy_config: {\n type: 'suffix',\n suffix_length: 0,\n fields_to_ignore: ['string'],\n regex_flags: 'string',\n country_code: 'string',\n match_on: 'string',\n key: 'string',\n mode: 'subset',\n ordered: true,\n require_tags_match: true,\n pattern: 'string'\n }\n },\n type: 'string',\n multiline: true,\n rich_text: true,\n rows: 3\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {\n \"disablePast\": true\n },\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {\n \"hint_text\": \"string\",\n \"hint_text_key\": \"string\",\n \"hint_custom_component\": \"string\",\n \"hint_tooltip_placement\": \"top\"\n },\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {\n \"match_strategy\": \"exact\",\n \"fuzzy_config\": {\n \"type\": \"suffix\",\n \"suffix_length\": 0,\n \"fields_to_ignore\": [\"string\"],\n \"regex_flags\": \"string\",\n \"country_code\": \"string\",\n \"match_on\": \"string\",\n \"key\": \"string\",\n \"mode\": \"subset\",\n \"ordered\": true,\n \"require_tags_match\": true,\n \"pattern\": \"string\"\n }\n },\n \"type\": \"string\",\n \"multiline\": true,\n \"rich_text\": true,\n \"rows\": 3\n}\n```\n\n
\n\n---\n\n### `getSchemaAttribute`\n\nGet a schema attribute from given attribute ID\n\n`GET /v1/entity/schemas/attributes/{composite_id}`\n\n```ts\nconst { data } = await client.getSchemaAttribute({\n composite_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {\n \"disablePast\": true\n },\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {\n \"hint_text\": \"string\",\n \"hint_text_key\": \"string\",\n \"hint_custom_component\": \"string\",\n \"hint_tooltip_placement\": \"top\"\n },\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {\n \"match_strategy\": \"exact\",\n \"fuzzy_config\": {\n \"type\": \"suffix\",\n \"suffix_length\": 0,\n \"fields_to_ignore\": [\"string\"],\n \"regex_flags\": \"string\",\n \"country_code\": \"string\",\n \"match_on\": \"string\",\n \"key\": \"string\",\n \"mode\": \"subset\",\n \"ordered\": true,\n \"require_tags_match\": true,\n \"pattern\": \"string\"\n }\n },\n \"type\": \"string\",\n \"multiline\": true,\n \"rich_text\": true,\n \"rows\": 3\n}\n```\n\n
\n\n---\n\n### `putSchemaAttribute`\n\nUpdates an attribute in the schema\n\n`PUT /v1/entity/schemas/attributes/{composite_id}`\n\n```ts\nconst { data } = await client.putSchemaAttribute(\n {\n composite_id: 'example',\n },\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'string',\n label: 'string',\n placeholder: 'string',\n hidden: false,\n show_in_table: true,\n sortable: true,\n required: false,\n readonly: false,\n deprecated: false,\n variant_overridable: false,\n default_value: {},\n group: 'string',\n order: 0,\n layout: 'full_width',\n hide_label: true,\n icon: 'string',\n render_condition: 'string',\n data_classification: 'public',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n constraints: {\n disablePast: true\n },\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [\n {\n name: 'string',\n enabled: true\n }\n ],\n value_formatter: 'string',\n preview_value_formatter: 'string',\n entity_builder_disable_edit: false,\n protected: true,\n info_helpers: {\n hint_text: 'string',\n hint_text_key: 'string',\n hint_custom_component: 'string',\n hint_tooltip_placement: 'top'\n },\n explicit_searchable: false,\n exclude_from_search: false,\n repeatable: true,\n has_primary: true,\n edit_mode: 'direct',\n edit_mode_config: {\n match_strategy: 'exact',\n fuzzy_config: {\n type: 'suffix',\n suffix_length: 0,\n fields_to_ignore: ['string'],\n regex_flags: 'string',\n country_code: 'string',\n match_on: 'string',\n key: 'string',\n mode: 'subset',\n ordered: true,\n require_tags_match: true,\n pattern: 'string'\n }\n },\n type: 'string',\n multiline: true,\n rich_text: true,\n rows: 3\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {\n \"disablePast\": true\n },\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {\n \"hint_text\": \"string\",\n \"hint_text_key\": \"string\",\n \"hint_custom_component\": \"string\",\n \"hint_tooltip_placement\": \"top\"\n },\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {\n \"match_strategy\": \"exact\",\n \"fuzzy_config\": {\n \"type\": \"suffix\",\n \"suffix_length\": 0,\n \"fields_to_ignore\": [\"string\"],\n \"regex_flags\": \"string\",\n \"country_code\": \"string\",\n \"match_on\": \"string\",\n \"key\": \"string\",\n \"mode\": \"subset\",\n \"ordered\": true,\n \"require_tags_match\": true,\n \"pattern\": \"string\"\n }\n },\n \"type\": \"string\",\n \"multiline\": true,\n \"rich_text\": true,\n \"rows\": 3\n}\n```\n\n
\n\n---\n\n### `deleteSchemaAttribute`\n\nDeletes an attribute from a schema\n\n`DELETE /v1/entity/schemas/attributes/{composite_id}`\n\n```ts\nconst { data } = await client.deleteSchemaAttribute({\n composite_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {\n \"disablePast\": true\n },\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {\n \"hint_text\": \"string\",\n \"hint_text_key\": \"string\",\n \"hint_custom_component\": \"string\",\n \"hint_tooltip_placement\": \"top\"\n },\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {\n \"match_strategy\": \"exact\",\n \"fuzzy_config\": {\n \"type\": \"suffix\",\n \"suffix_length\": 0,\n \"fields_to_ignore\": [\"string\"],\n \"regex_flags\": \"string\",\n \"country_code\": \"string\",\n \"match_on\": \"string\",\n \"key\": \"string\",\n \"mode\": \"subset\",\n \"ordered\": true,\n \"require_tags_match\": true,\n \"pattern\": \"string\"\n }\n },\n \"type\": \"string\",\n \"multiline\": true,\n \"rich_text\": true,\n \"rows\": 3\n}\n```\n\n
\n\n---\n\n### `createSchemaCapability`\n\nCreate a schema capability\n\n`POST /v1/entity/schemas/capabilities`\n\n```ts\nconst { data } = await client.createSchemaCapability(\n null,\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'customer_messaging',\n title: 'Messaging',\n attributes: [\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'string',\n label: 'string',\n placeholder: 'string',\n hidden: false,\n show_in_table: true,\n sortable: true,\n required: false,\n readonly: false,\n deprecated: false,\n variant_overridable: false,\n default_value: {},\n group: 'string',\n order: 0,\n layout: 'full_width',\n hide_label: true,\n icon: 'string',\n render_condition: 'string',\n data_classification: 'public',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n constraints: { /* ... */ },\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [ /* ... */ ],\n value_formatter: 'string',\n preview_value_formatter: 'string',\n entity_builder_disable_edit: false,\n protected: true,\n info_helpers: { /* ... */ },\n explicit_searchable: false,\n exclude_from_search: false,\n repeatable: true,\n has_primary: true,\n edit_mode: 'direct',\n edit_mode_config: { /* ... */ },\n type: 'string',\n multiline: true,\n rich_text: true,\n rows: 3\n },\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'string',\n label: 'string',\n placeholder: 'string',\n hidden: false,\n show_in_table: true,\n sortable: true,\n required: false,\n readonly: false,\n deprecated: false,\n variant_overridable: false,\n default_value: {},\n group: 'string',\n order: 0,\n layout: 'full_width',\n hide_label: true,\n icon: 'string',\n render_condition: 'string',\n data_classification: 'public',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n constraints: { /* ... */ },\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [ /* ... */ ],\n value_formatter: 'string',\n preview_value_formatter: 'string',\n entity_builder_disable_edit: false,\n protected: true,\n info_helpers: { /* ... */ },\n explicit_searchable: false,\n exclude_from_search: false,\n repeatable: true,\n has_primary: true,\n edit_mode: 'direct',\n edit_mode_config: { /* ... */ },\n type: 'link'\n },\n /* ... 33 more */\n ],\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n app_id: '123e4567-e89b-12d3-a456-426614174000',\n adjust_installment: {\n journey_id: 'adjust-installment-flow'\n },\n ui_config: {\n is_filterable: true\n },\n ui_hooks: [\n {\n hook: 'EntityDetailsV2:Tab',\n render_condition: '_is_composite_price = \"false\"',\n order: 10,\n title: 'Notes',\n group_expanded: true,\n import: '@epilot360/notes',\n component: 'PricingItems',\n route: 'notes',\n icon: 'email',\n disabled: true,\n header: true,\n requiredPermission: { /* ... */ }\n }\n ],\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [\n {\n name: 'string',\n enabled: true\n }\n ],\n schemas: [\n {\n schema: 'contact'\n }\n ],\n composite_id: 'contact:97644baa-083f-4e49-9188-fcff2ecaad7d',\n schema: 'contact'\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"customer_messaging\",\n \"title\": \"Messaging\",\n \"attributes\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {},\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {},\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {},\n \"type\": \"string\",\n \"multiline\": true,\n \"rich_text\": true,\n \"rows\": 3\n },\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {},\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {},\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {},\n \"type\": \"link\"\n }\n ],\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"app_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"adjust_installment\": {\n \"journey_id\": \"adjust-installment-flow\"\n },\n \"ui_config\": {\n \"is_filterable\": true\n },\n \"ui_hooks\": [\n {\n \"hook\": \"EntityDetailsV2:Tab\",\n \"render_condition\": \"_is_composite_price = \\\"false\\\"\",\n \"order\": 10,\n \"title\": \"Notes\",\n \"group_expanded\": true,\n \"import\": \"@epilot360/notes\",\n \"component\": \"PricingItems\",\n \"route\": \"notes\",\n \"icon\": \"email\",\n \"disabled\": true,\n \"header\": true,\n \"requiredPermission\": {}\n }\n ],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"schemas\": [\n {\n \"schema\": \"contact\"\n }\n ],\n \"composite_id\": \"contact:97644baa-083f-4e49-9188-fcff2ecaad7d\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `getSchemaCapability`\n\nGet a schema capability from given capability ID\n\n`GET /v1/entity/schemas/capabilities/{composite_id}`\n\n```ts\nconst { data } = await client.getSchemaCapability({\n composite_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"customer_messaging\",\n \"title\": \"Messaging\",\n \"attributes\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {},\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {},\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {},\n \"type\": \"string\",\n \"multiline\": true,\n \"rich_text\": true,\n \"rows\": 3\n },\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {},\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {},\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {},\n \"type\": \"link\"\n }\n ],\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"app_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"adjust_installment\": {\n \"journey_id\": \"adjust-installment-flow\"\n },\n \"ui_config\": {\n \"is_filterable\": true\n },\n \"ui_hooks\": [\n {\n \"hook\": \"EntityDetailsV2:Tab\",\n \"render_condition\": \"_is_composite_price = \\\"false\\\"\",\n \"order\": 10,\n \"title\": \"Notes\",\n \"group_expanded\": true,\n \"import\": \"@epilot360/notes\",\n \"component\": \"PricingItems\",\n \"route\": \"notes\",\n \"icon\": \"email\",\n \"disabled\": true,\n \"header\": true,\n \"requiredPermission\": {}\n }\n ],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"schemas\": [\n {\n \"schema\": \"contact\"\n }\n ],\n \"composite_id\": \"contact:97644baa-083f-4e49-9188-fcff2ecaad7d\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `putSchemaCapability`\n\nAdds or updates an capability in the schema\n\n`PUT /v1/entity/schemas/capabilities/{composite_id}`\n\n```ts\nconst { data } = await client.putSchemaCapability(\n {\n composite_id: 'example',\n },\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'customer_messaging',\n title: 'Messaging',\n attributes: [\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'string',\n label: 'string',\n placeholder: 'string',\n hidden: false,\n show_in_table: true,\n sortable: true,\n required: false,\n readonly: false,\n deprecated: false,\n variant_overridable: false,\n default_value: {},\n group: 'string',\n order: 0,\n layout: 'full_width',\n hide_label: true,\n icon: 'string',\n render_condition: 'string',\n data_classification: 'public',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n constraints: { /* ... */ },\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [ /* ... */ ],\n value_formatter: 'string',\n preview_value_formatter: 'string',\n entity_builder_disable_edit: false,\n protected: true,\n info_helpers: { /* ... */ },\n explicit_searchable: false,\n exclude_from_search: false,\n repeatable: true,\n has_primary: true,\n edit_mode: 'direct',\n edit_mode_config: { /* ... */ },\n type: 'string',\n multiline: true,\n rich_text: true,\n rows: 3\n },\n {\n id: 'd5839b94-ba20-4225-a78e-76951d352bd6',\n name: 'string',\n label: 'string',\n placeholder: 'string',\n hidden: false,\n show_in_table: true,\n sortable: true,\n required: false,\n readonly: false,\n deprecated: false,\n variant_overridable: false,\n default_value: {},\n group: 'string',\n order: 0,\n layout: 'full_width',\n hide_label: true,\n icon: 'string',\n render_condition: 'string',\n data_classification: 'public',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n constraints: { /* ... */ },\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [ /* ... */ ],\n value_formatter: 'string',\n preview_value_formatter: 'string',\n entity_builder_disable_edit: false,\n protected: true,\n info_helpers: { /* ... */ },\n explicit_searchable: false,\n exclude_from_search: false,\n repeatable: true,\n has_primary: true,\n edit_mode: 'direct',\n edit_mode_config: { /* ... */ },\n type: 'link'\n },\n /* ... 33 more */\n ],\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n app_id: '123e4567-e89b-12d3-a456-426614174000',\n adjust_installment: {\n journey_id: 'adjust-installment-flow'\n },\n ui_config: {\n is_filterable: true\n },\n ui_hooks: [\n {\n hook: 'EntityDetailsV2:Tab',\n render_condition: '_is_composite_price = \"false\"',\n order: 10,\n title: 'Notes',\n group_expanded: true,\n import: '@epilot360/notes',\n component: 'PricingItems',\n route: 'notes',\n icon: 'email',\n disabled: true,\n header: true,\n requiredPermission: { /* ... */ }\n }\n ],\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [\n {\n name: 'string',\n enabled: true\n }\n ],\n schemas: [\n {\n schema: 'contact'\n }\n ],\n composite_id: 'contact:97644baa-083f-4e49-9188-fcff2ecaad7d',\n schema: 'contact'\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"customer_messaging\",\n \"title\": \"Messaging\",\n \"attributes\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {},\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {},\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {},\n \"type\": \"string\",\n \"multiline\": true,\n \"rich_text\": true,\n \"rows\": 3\n },\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {},\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {},\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {},\n \"type\": \"link\"\n }\n ],\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"app_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"adjust_installment\": {\n \"journey_id\": \"adjust-installment-flow\"\n },\n \"ui_config\": {\n \"is_filterable\": true\n },\n \"ui_hooks\": [\n {\n \"hook\": \"EntityDetailsV2:Tab\",\n \"render_condition\": \"_is_composite_price = \\\"false\\\"\",\n \"order\": 10,\n \"title\": \"Notes\",\n \"group_expanded\": true,\n \"import\": \"@epilot360/notes\",\n \"component\": \"PricingItems\",\n \"route\": \"notes\",\n \"icon\": \"email\",\n \"disabled\": true,\n \"header\": true,\n \"requiredPermission\": {}\n }\n ],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"schemas\": [\n {\n \"schema\": \"contact\"\n }\n ],\n \"composite_id\": \"contact:97644baa-083f-4e49-9188-fcff2ecaad7d\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `deleteSchemaCapability`\n\nDeletes a Capability from a schema\n\n`DELETE /v1/entity/schemas/capabilities/{composite_id}`\n\n```ts\nconst { data } = await client.deleteSchemaCapability({\n composite_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"customer_messaging\",\n \"title\": \"Messaging\",\n \"attributes\": [\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {},\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {},\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {},\n \"type\": \"string\",\n \"multiline\": true,\n \"rich_text\": true,\n \"rows\": 3\n },\n {\n \"id\": \"d5839b94-ba20-4225-a78e-76951d352bd6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"placeholder\": \"string\",\n \"hidden\": false,\n \"show_in_table\": true,\n \"sortable\": true,\n \"required\": false,\n \"readonly\": false,\n \"deprecated\": false,\n \"variant_overridable\": false,\n \"default_value\": {},\n \"group\": \"string\",\n \"order\": 0,\n \"layout\": \"full_width\",\n \"hide_label\": true,\n \"icon\": \"string\",\n \"render_condition\": \"string\",\n \"data_classification\": \"public\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"constraints\": {},\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [],\n \"value_formatter\": \"string\",\n \"preview_value_formatter\": \"string\",\n \"entity_builder_disable_edit\": false,\n \"protected\": true,\n \"info_helpers\": {},\n \"explicit_searchable\": false,\n \"exclude_from_search\": false,\n \"repeatable\": true,\n \"has_primary\": true,\n \"edit_mode\": \"direct\",\n \"edit_mode_config\": {},\n \"type\": \"link\"\n }\n ],\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"app_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"adjust_installment\": {\n \"journey_id\": \"adjust-installment-flow\"\n },\n \"ui_config\": {\n \"is_filterable\": true\n },\n \"ui_hooks\": [\n {\n \"hook\": \"EntityDetailsV2:Tab\",\n \"render_condition\": \"_is_composite_price = \\\"false\\\"\",\n \"order\": 10,\n \"title\": \"Notes\",\n \"group_expanded\": true,\n \"import\": \"@epilot360/notes\",\n \"component\": \"PricingItems\",\n \"route\": \"notes\",\n \"icon\": \"email\",\n \"disabled\": true,\n \"header\": true,\n \"requiredPermission\": {}\n }\n ],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"schemas\": [\n {\n \"schema\": \"contact\"\n }\n ],\n \"composite_id\": \"contact:97644baa-083f-4e49-9188-fcff2ecaad7d\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `createSchemaGroup`\n\nCreate a schema group\n\n`POST /v1/entity/schemas/group`\n\n```ts\nconst { data } = await client.createSchemaGroup(\n null,\n {\n label: 'Contact Details',\n id: 'e18a532b-ae79-4d86-a6a5-e5dbfb579d14',\n order: 0,\n expanded: false,\n render_condition: '_is_composite_price = \"false\"',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [\n {\n name: 'string',\n enabled: true\n }\n ],\n info_tooltip_title: {\n key: 'string',\n default: 'string'\n },\n composite_id: 'contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14',\n schema: 'contact'\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"label\": \"Contact Details\",\n \"id\": \"e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"order\": 0,\n \"expanded\": false,\n \"render_condition\": \"_is_composite_price = \\\"false\\\"\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"info_tooltip_title\": {\n \"key\": \"string\",\n \"default\": \"string\"\n },\n \"composite_id\": \"contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `getSchemaGroup`\n\nGet a schema group from given group composite ID\n\n`GET /v1/entity/schemas/group/{composite_id}`\n\n```ts\nconst { data } = await client.getSchemaGroup({\n composite_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"label\": \"Contact Details\",\n \"id\": \"e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"order\": 0,\n \"expanded\": false,\n \"render_condition\": \"_is_composite_price = \\\"false\\\"\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"info_tooltip_title\": {\n \"key\": \"string\",\n \"default\": \"string\"\n },\n \"composite_id\": \"contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `putSchemaGroup`\n\nAdds or updates an capability in the schema\n\n`PUT /v1/entity/schemas/group/{composite_id}`\n\n```ts\nconst { data } = await client.putSchemaGroup(\n {\n composite_id: 'example',\n },\n {\n label: 'Contact Details',\n id: 'e18a532b-ae79-4d86-a6a5-e5dbfb579d14',\n order: 0,\n expanded: false,\n render_condition: '_is_composite_price = \"false\"',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n feature_flag: 'FF_MY_FEATURE_FLAG',\n settings_flag: [\n {\n name: 'string',\n enabled: true\n }\n ],\n info_tooltip_title: {\n key: 'string',\n default: 'string'\n },\n composite_id: 'contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14',\n schema: 'contact'\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"label\": \"Contact Details\",\n \"id\": \"e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"order\": 0,\n \"expanded\": false,\n \"render_condition\": \"_is_composite_price = \\\"false\\\"\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"info_tooltip_title\": {\n \"key\": \"string\",\n \"default\": \"string\"\n },\n \"composite_id\": \"contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `deleteSchemaGroup`\n\nDeletes a Capability from a schema\n\n`DELETE /v1/entity/schemas/group/{composite_id}`\n\n```ts\nconst { data } = await client.deleteSchemaGroup({\n composite_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"label\": \"Contact Details\",\n \"id\": \"e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"order\": 0,\n \"expanded\": false,\n \"render_condition\": \"_is_composite_price = \\\"false\\\"\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"feature_flag\": \"FF_MY_FEATURE_FLAG\",\n \"settings_flag\": [\n {\n \"name\": \"string\",\n \"enabled\": true\n }\n ],\n \"info_tooltip_title\": {\n \"key\": \"string\",\n \"default\": \"string\"\n },\n \"composite_id\": \"contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `createSchemaGroupHeadline`\n\nCreate a headline in a schema group\n\n`POST /v1/entity/schemas/headline`\n\n```ts\nconst { data } = await client.createSchemaGroupHeadline(\n null,\n {\n id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n name: 'string',\n label: 'string',\n layout: 'string',\n group: 'string',\n order: 0,\n type: 'headline',\n enable_divider: false,\n divider: 'top_divider',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n composite_id: 'contact:97644baa-083f-4e49-9188-fcff2ecaad7d',\n schema: 'contact'\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"layout\": \"string\",\n \"group\": \"string\",\n \"order\": 0,\n \"type\": \"headline\",\n \"enable_divider\": false,\n \"divider\": \"top_divider\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"composite_id\": \"contact:97644baa-083f-4e49-9188-fcff2ecaad7d\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `getSchemaGroupHeadline`\n\nGet a group headline from schema from given headline composite ID\n\n`GET /v1/entity/schemas/headline/{composite_id}`\n\n```ts\nconst { data } = await client.getSchemaGroupHeadline({\n composite_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"layout\": \"string\",\n \"group\": \"string\",\n \"order\": 0,\n \"type\": \"headline\",\n \"enable_divider\": false,\n \"divider\": \"top_divider\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"composite_id\": \"contact:97644baa-083f-4e49-9188-fcff2ecaad7d\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `putSchemaGroupHeadline`\n\nAdds or updates a group headline in the schema\n\n`PUT /v1/entity/schemas/headline/{composite_id}`\n\n```ts\nconst { data } = await client.putSchemaGroupHeadline(\n {\n composite_id: 'example',\n },\n {\n id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',\n name: 'string',\n label: 'string',\n layout: 'string',\n group: 'string',\n order: 0,\n type: 'headline',\n enable_divider: false,\n divider: 'top_divider',\n _purpose: ['taxonomy-slug:classification-slug'],\n _manifest: ['123e4567-e89b-12d3-a456-426614174000'],\n composite_id: 'contact:97644baa-083f-4e49-9188-fcff2ecaad7d',\n schema: 'contact'\n },\n)\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"layout\": \"string\",\n \"group\": \"string\",\n \"order\": 0,\n \"type\": \"headline\",\n \"enable_divider\": false,\n \"divider\": \"top_divider\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"composite_id\": \"contact:97644baa-083f-4e49-9188-fcff2ecaad7d\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n### `deleteSchemaGroupHeadline`\n\nDeletes a group headline from a schema\n\n`DELETE /v1/entity/schemas/headline/{composite_id}`\n\n```ts\nconst { data } = await client.deleteSchemaGroupHeadline({\n composite_id: 'example',\n})\n```\n\n
\nResponse\n\n```json\n{\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"label\": \"string\",\n \"layout\": \"string\",\n \"group\": \"string\",\n \"order\": 0,\n \"type\": \"headline\",\n \"enable_divider\": false,\n \"divider\": \"top_divider\",\n \"_purpose\": [\"taxonomy-slug:classification-slug\"],\n \"_manifest\": [\"123e4567-e89b-12d3-a456-426614174000\"],\n \"composite_id\": \"contact:97644baa-083f-4e49-9188-fcff2ecaad7d\",\n \"schema\": \"contact\"\n}\n```\n\n
\n\n---\n\n## Schemas\n\n### `ExportJobId`\n\nThe unique identifier of the import job.\n\n```ts\ntype ExportJobId = string\n```\n\n### `Language`\n\nExport headers translation Language\n\n```ts\ntype Language = string\n```\n\n### `IsTemplate`\n\nPass 'true' to generate import template\n\n```ts\ntype IsTemplate = boolean\n```\n\n### `SchemaId`\n\nGenerated uuid for schema\n\n```ts\ntype SchemaId = string // uuid\n```\n\n### `EntitySchema`\n\nThe \"type\" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.\n\n```ts\ntype EntitySchema = {\n slug: string\n version?: number\n blueprint?: string // uuid\n feature_flag?: string\n enable_setting?: string[]\n name: string\n plural: string\n description?: string\n docs_url?: string // uri\n category?: string\n published?: boolean\n draft?: boolean\n icon?: string\n title_template?: string\n ui_config?: {\n table_view?: {\n view_type?: { ... }\n row_actions?: { ... }\n bulk_actions?: { ... }\n navbar_actions?: { ... }\n enable_thumbnails?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n create_view?: {\n view_type?: { ... }\n search_params?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n edit_view?: {\n view_type?: { ... }\n search_params?: { ... }\n summary_attributes?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n single_view?: {\n view_type?: { ... }\n search_params?: { ... }\n summary_attributes?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n list_item?: {\n summary_attributes?: { ... }\n quick_actions?: { ... }\n ui_config?: { ... }\n }\n sharing?: {\n show_sharing_button?: { ... }\n }\n grid_layout?: {\n id?: { ... }\n columns?: { ... }\n cells?: { ... }\n }\n widget_order?: string[]\n }\n capabilities: Array<{\n id?: string\n name: string\n title?: string\n attributes?: Array<{\n id?: { ... }\n name: { ... }\n label: { ... }\n placeholder?: { ... }\n hidden?: { ... }\n show_in_table?: { ... }\n sortable?: { ... }\n required?: { ... }\n readonly?: { ... }\n deprecated?: { ... }\n variant_overridable?: { ... }\n default_value?: { ... }\n group?: { ... }\n order?: { ... }\n layout?: { ... }\n hide_label?: { ... }\n icon?: { ... }\n render_condition?: { ... }\n data_classification?: { ... }\n _purpose?: { ... }\n _manifest?: { ... }\n constraints?: { ... }\n feature_flag?: { ... }\n // ...\n}\n```\n\n### `EntitySchemaItem`\n\n```ts\ntype EntitySchemaItem = {\n id?: string // uuid\n created_at?: string\n updated_at?: string\n comment?: string\n source?: {\n id?: string\n type?: string\n }\n frozen?: boolean\n latest?: boolean\n _summary?: boolean\n slug: string\n version?: number\n blueprint?: string // uuid\n feature_flag?: string\n enable_setting?: string[]\n name: string\n plural: string\n description?: string\n docs_url?: string // uri\n category?: string\n published?: boolean\n draft?: boolean\n icon?: string\n title_template?: string\n ui_config?: {\n table_view?: {\n view_type?: { ... }\n row_actions?: { ... }\n bulk_actions?: { ... }\n navbar_actions?: { ... }\n enable_thumbnails?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n create_view?: {\n view_type?: { ... }\n search_params?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n edit_view?: {\n view_type?: { ... }\n search_params?: { ... }\n summary_attributes?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n single_view?: {\n view_type?: { ... }\n search_params?: { ... }\n summary_attributes?: { ... }\n } | {\n view_type?: { ... }\n route?: { ... }\n } | {\n view_type?: { ... }\n }\n list_item?: {\n summary_attributes?: { ... }\n quick_actions?: { ... }\n ui_config?: { ... }\n }\n sharing?: {\n show_sharing_button?: { ... }\n }\n grid_layout?: {\n id?: { ... }\n columns?: { ... }\n cells?: { ... }\n }\n widget_order?: string[]\n }\n capabilities: Array<{\n id?: string\n name: string\n title?: string\n attributes?: Array<{\n id?: { ... }\n name: { ... }\n label: { ... }\n placeholder?: { ... }\n hidden?: { ... }\n show_in_table?: { ... }\n sortable?: { ... }\n required?: { ... }\n readonly?: { ... }\n deprecated?: { ... }\n variant_overridable?: { ... }\n default_value?: { ... }\n // ...\n}\n```\n\n### `GenerateEntityTableAIFiltersRequest`\n\n```ts\ntype GenerateEntityTableAIFiltersRequest = {\n prompt: string\n main_entity_slug: string\n filter_options: Array<{\n type?: \"search\" | \"filter\"\n label: string\n label_type?: string\n name?: string\n group?: string\n allowedSchemas?: string[]\n relatedOptions?: Array<{\n type?: { ... }\n label: { ... }\n label_type?: { ... }\n name?: { ... }\n group?: { ... }\n allowedSchemas?: { ... }\n relatedOptions?: { ... }\n }>\n }>\n}\n```\n\n### `GenerateEntityTableAIFiltersResponse`\n\n```ts\ntype GenerateEntityTableAIFiltersResponse = Array<{\n label: string\n type: string\n value: string\n}>\n```\n\n### `EntityTableFilterSearch`\n\n```ts\ntype EntityTableFilterSearch = {\n label: string\n type: string\n value: string\n}\n```\n\n### `EntityTableFilterOption`\n\n```ts\ntype EntityTableFilterOption = {\n type?: \"search\" | \"filter\"\n label: string\n label_type?: string\n name?: string\n group?: string\n allowedSchemas?: string[]\n relatedOptions?: Array<{\n type?: \"search\" | \"filter\"\n label: string\n label_type?: string\n name?: string\n group?: string\n allowedSchemas?: string[]\n relatedOptions?: Array<{\n type?: { ... }\n label: { ... }\n label_type?: { ... }\n name?: { ... }\n group?: { ... }\n allowedSchemas?: { ... }\n relatedOptions?: { ... }\n }>\n }>\n}\n```\n\n### `EntitySchemaGroup`\n\n```ts\ntype EntitySchemaGroup = {\n label: string\n id?: string\n order?: number\n expanded?: boolean\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n info_tooltip_title?: {\n key?: string\n default?: string\n }\n}\n```\n\n### `EntitySchemaGroupWithCompositeID`\n\n```ts\ntype EntitySchemaGroupWithCompositeID = {\n label: string\n id?: string\n order?: number\n expanded?: boolean\n render_condition?: string\n _purpose?: string[]\n _manifest?: string // uuid[]\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n info_tooltip_title?: {\n key?: string\n default?: string\n }\n composite_id?: string\n schema?: string\n}\n```\n\n### `Attribute`\n\n```ts\ntype Attribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"string\"\n multiline?: boolean\n rich_text?: boolean\n rows?: number | string\n} | {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n // ...\n}\n```\n\n### `AttributeWithCompositeID`\n\n```ts\ntype AttributeWithCompositeID = {\n composite_id?: string\n schema?: string\n}\n```\n\n### `BaseAttribute`\n\n```ts\ntype BaseAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n}\n```\n\n### `TextAttribute`\n\n```ts\ntype TextAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"string\"\n multiline?: boolean\n rich_text?: boolean\n rows?: number | string\n}\n```\n\n### `LinkAttribute`\n\n```ts\ntype LinkAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"link\"\n}\n```\n\n### `InternalAttribute`\n\n```ts\ntype InternalAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"internal\"\n}\n```\n\n### `BooleanAttribute`\n\n```ts\ntype BooleanAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"boolean\"\n display_type?: \"switch\" | \"checkbox\"\n}\n```\n\n### `DateAttribute`\n\n```ts\ntype DateAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"date\" | \"datetime\"\n}\n```\n\n### `CountryAttribute`\n\n```ts\ntype CountryAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"country\"\n}\n```\n\n### `SelectAttribute`\n\n```ts\ntype SelectAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"select\" | \"radio\"\n options?: Array<{\n value: string\n title?: string\n } | string>\n allow_any?: boolean\n}\n```\n\n### `MultiSelectAttribute`\n\n```ts\ntype MultiSelectAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"multiselect\" | \"checkbox\"\n disable_case_sensitive?: boolean\n allow_extra_options?: boolean\n options?: Array\n allow_any?: boolean\n}\n```\n\n### `StatusAttribute`\n\n```ts\ntype StatusAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"status\"\n options?: Array\n}\n```\n\n### `SequenceAttribute`\n\n```ts\ntype SequenceAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"sequence\"\n prefix?: string\n start_number?: number\n}\n```\n\n### `FileAttribute`\n\n```ts\ntype FileAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"image\" | \"file\"\n multiple?: boolean\n allowed_extensions?: string[]\n display_images_landscaped?: boolean\n enable_description?: boolean\n default_access_control?: \"public-read\" | \"private\"\n file_size_bytes?: number\n}\n```\n\n### `CurrencyAttribute`\n\n```ts\ntype CurrencyAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"currency\"\n currency_selector_only?: boolean\n currency: Array<{\n code: string\n description: string\n symbol: string\n flag?: string\n }>\n}\n```\n\n### `SummaryField`\n\nSummary Fields are displayed inside list view as a resume of the relation entity.\n\n```ts\ntype SummaryField = {\n field?: string\n display_as?: string\n}\n```\n\n### `EntityAction`\n\nAn entity action configured from the entity schema\n\n```ts\ntype EntityAction = {\n action: string\n label: string\n icon?: string\n permission?: string\n}\n```\n\n### `RelationAttribute`\n\n```ts\ntype RelationAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"list-view\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"relation\"\n relation_type?: \"has_many\" | \"has_one\"\n reverse_attributes?: Record\n relation_affinity_mode?: \"weak\" | \"strong\"\n enable_relation_picker?: boolean\n details_view_mode_enabled?: boolean\n relation_picker_filter?: {\n q: string\n }\n actions?: Array<{\n action_type?: \"add_existing\" | \"create_new\" | \"create_from_existing\"\n label?: string\n default?: boolean\n feature_flag?: string\n settings_flag?: Array<{\n name?: { ... }\n enabled?: { ... }\n }>\n new_entity_item?: Record\n }>\n drawer_size?: \"small\" | \"medium\" | \"large\"\n summary_fields?: Array\n allowedSchemas?: string[]\n enable_relation_tags?: boolean\n add_button_label?: string\n search_placeholder?: string\n}\n```\n\n### `UserRelationAttribute`\n\n```ts\ntype UserRelationAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"relation_user\"\n multiple?: boolean\n}\n```\n\n### `PartnerOrganisationAttribute`\n\n```ts\ntype PartnerOrganisationAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"partner_organisation\"\n}\n```\n\n### `PortalAccessAttribute`\n\n```ts\ntype PortalAccessAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"portal_access\"\n}\n```\n\n### `DefaultAddressFields`\n\nDefault fields visible on addresses\n\nValid values are:\n - postal_code (default)\n - city (default)\n - street (default)\n - street_number (default)\n - plot_area\n - plot_of_land\n - suburb\n - country\n - postbox\n - additional_info\n - coordinates\n - start_date\n - end_date\n - salutation\n - ti\n\n```ts\ntype DefaultAddressFields = string[]\n```\n\n### `AddressAttribute`\n\n```ts\ntype AddressAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"address\"\n default_address_fields?: string[]\n}\n```\n\n### `AddressRelationAttribute`\n\n```ts\ntype AddressRelationAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"relation_address\"\n default_address_fields?: string[]\n}\n```\n\n### `PaymentMethodRelationAttribute`\n\n```ts\ntype PaymentMethodRelationAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"relation_payment_method\"\n}\n```\n\n### `InvitationEmailAttribute`\n\n```ts\ntype InvitationEmailAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"invitation_email\"\n}\n```\n\n### `AutomationAttribute`\n\n```ts\ntype AutomationAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"automation\"\n}\n```\n\n### `InternalUserAttribute`\n\n```ts\ntype InternalUserAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"internal_user\"\n}\n```\n\n### `PurposeAttribute`\n\n```ts\ntype PurposeAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"purpose\"\n}\n```\n\n### `RepeatableAttribute`\n\n```ts\ntype RepeatableAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n}\n```\n\n### `TagsAttribute`\n\n```ts\ntype TagsAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"tags\"\n options?: string[]\n suggestions?: string[]\n}\n```\n\n### `MessageEmailAddressAttribute`\n\n```ts\ntype MessageEmailAddressAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"message_email_address\"\n address?: string\n send_status?: string\n email_type?: string\n}\n```\n\n### `NumberAttribute`\n\n```ts\ntype NumberAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"number\"\n data_type?: \"number\" | \"string\"\n format?: string\n show_separator?: boolean\n}\n```\n\n### `TableAttribute`\n\n```ts\ntype TableAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"table\"\n columns?: Array<{\n name: string\n label: string\n type?: \"string\" | \"number\" | \"date\" | \"boolean\"\n width?: string\n required?: boolean\n bold?: boolean\n }>\n min_rows?: number\n max_rows?: number\n transposed?: boolean\n column_header?: {\n template?: string\n start?: number\n }\n}\n```\n\n### `ConsentAttribute`\n\n```ts\ntype ConsentAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"consent\"\n topic: string\n identifiers?: string[]\n}\n```\n\n### `OrderedListAttribute`\n\n```ts\ntype OrderedListAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"ordered_list\"\n}\n```\n\n### `EmailAttribute`\n\n```ts\ntype EmailAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"email\"\n}\n```\n\n### `PhoneAttribute`\n\n```ts\ntype PhoneAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"phone\"\n}\n```\n\n### `PaymentAttribute`\n\n```ts\ntype PaymentAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"payment\"\n}\n```\n\n### `PriceComponentAttribute`\n\n```ts\ntype PriceComponentAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"price_component\"\n}\n```\n\n### `ComputedAttribute`\n\n```ts\ntype ComputedAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"computed\"\n computed?: boolean\n amount_field?: string\n currency_field?: string\n}\n```\n\n### `PartnerStatusAttribute`\n\n```ts\ntype PartnerStatusAttribute = {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: string\n hint_text_key?: string\n hint_custom_component?: string\n hint_tooltip_placement?: string\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: { ... }\n suffix_length?: { ... }\n fields_to_ignore?: { ... }\n regex_flags?: { ... }\n country_code?: { ... }\n match_on?: { ... }\n key?: { ... }\n mode?: { ... }\n ordered?: { ... }\n require_tags_match?: { ... }\n pattern?: { ... }\n }\n }\n type: \"partner_status\"\n}\n```\n\n### `SummaryAttribute`\n\nRepresents an expanded version of an attribute to be displayed in the list item summary.\nThis configuration can be used in the following way:\n```js\n{\n \"label\": \"Price components\"\n \"value\": \"{{item.prices.length}} price components\"\n \"show_as_tag\": true\n \"render_condition\": \"is_composite_price = \"\n\n```ts\ntype SummaryAttribute = {\n label: string\n value: string\n show_as_tag?: boolean\n tag_color?: string\n render_condition?: string\n feature_flag?: string\n settings_flag?: Array<{\n name?: string\n enabled?: boolean\n }>\n display_mode?: \"inline\" | \"block\"\n content_line_cap?: number\n content_wrap?: \"normal\" | \"nowrap\" | \"pre\" | \"pre-wrap\"\n hide_label?: boolean\n highlight_container?: boolean\n}\n```\n\n### `GroupHeadline`\n\n```ts\ntype GroupHeadline = {\n id?: string // uuid\n name: string\n label: string\n layout?: string\n group: string\n order?: number\n type: \"headline\"\n enable_divider?: boolean\n divider?: \"top_divider\" | \"bottom_divider\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n}\n```\n\n### `GroupHeadlineWithCompositeID`\n\n```ts\ntype GroupHeadlineWithCompositeID = {\n id?: string // uuid\n name: string\n label: string\n layout?: string\n group: string\n order?: number\n type: \"headline\"\n enable_divider?: boolean\n divider?: \"top_divider\" | \"bottom_divider\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n composite_id?: string\n schema?: string\n}\n```\n\n### `BaseConditionDefinition`\n\n```ts\ntype BaseConditionDefinition = {\n id: string // uuid\n name: string\n label: string\n}\n```\n\n### `ScalarConditionDefinition`\n\n```ts\ntype ScalarConditionDefinition = {\n id: string // uuid\n name: string\n label: string\n type: \"string\" | \"number\" | \"date\" | \"daterange\" | \"boolean\"\n}\n```\n\n### `SelectConditionDefinition`\n\n```ts\ntype SelectConditionDefinition = {\n id: string // uuid\n name: string\n label: string\n type: \"select\"\n values?: string[]\n}\n```\n\n### `LocationConditionDefinition`\n\n```ts\ntype LocationConditionDefinition = {\n id: string // uuid\n name: string\n label: string\n type: \"location\"\n format?: \"zipcode\" | \"zipcode_town\"\n}\n```\n\n### `ConditionDefinition`\n\nOne dimension that conditional variants of an entity type are keyed by. `type`\ndiscriminates the variants: only a `select` condition carries `values`, and only a\n`location` condition carries `format`.\n\n\n```ts\ntype ConditionDefinition = {\n id: string // uuid\n name: string\n label: string\n type: \"string\" | \"number\" | \"date\" | \"daterange\" | \"boolean\"\n} | {\n id: string // uuid\n name: string\n label: string\n type: \"select\"\n values?: string[]\n} | {\n id: string // uuid\n name: string\n label: string\n type: \"location\"\n format?: \"zipcode\" | \"zipcode_town\"\n}\n```\n\n### `EntitySlug`\n\nURL-friendly identifier for the entity schema\n\n```ts\ntype EntitySlug = string\n```\n\n### `AdjustInstallmentCapabilityConfig`\n\nConfiguration for adjusting a contract installment through a Journey.\n\n```ts\ntype AdjustInstallmentCapabilityConfig = {\n journey_id: string\n}\n```\n\n### `EntityCapability`\n\nCapabilities the Entity has. Turn features on/off for entities.\n\n```ts\ntype EntityCapability = {\n id?: string\n name: string\n title?: string\n attributes?: Array<{\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: { ... }\n enabled?: { ... }\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: { ... }\n hint_text_key?: { ... }\n hint_custom_component?: { ... }\n hint_tooltip_placement?: { ... }\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: { ... }\n fuzzy_config?: { ... }\n }\n type: \"string\"\n multiline?: boolean\n rich_text?: boolean\n rows?: number | string\n } | {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: { ... }\n enabled?: { ... }\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: { ... }\n hint_text_key?: { ... }\n hint_custom_component?: { ... }\n hint_tooltip_placement?: { ... }\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: { ... }\n // ...\n}\n```\n\n### `EntityCapabilityWithCompositeID`\n\n```ts\ntype EntityCapabilityWithCompositeID = {\n id?: string\n name: string\n title?: string\n attributes?: Array<{\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: { ... }\n enabled?: { ... }\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: { ... }\n hint_text_key?: { ... }\n hint_custom_component?: { ... }\n hint_tooltip_placement?: { ... }\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: { ... }\n fuzzy_config?: { ... }\n }\n type: \"string\"\n multiline?: boolean\n rich_text?: boolean\n rows?: number | string\n } | {\n id?: string\n name: string\n label: string\n placeholder?: string\n hidden?: boolean\n show_in_table?: boolean\n sortable?: boolean\n required?: boolean\n readonly?: boolean\n deprecated?: boolean\n variant_overridable?: boolean\n default_value?: unknown\n group?: string\n order?: number\n layout?: string\n hide_label?: boolean\n icon?: string\n render_condition?: string\n data_classification?: \"public\" | \"pii\"\n _purpose?: string[]\n _manifest?: string // uuid[]\n constraints?: object\n feature_flag?: string\n settings_flag?: Array<{\n name?: { ... }\n enabled?: { ... }\n }>\n value_formatter?: string\n preview_value_formatter?: string\n entity_builder_disable_edit?: boolean\n protected?: boolean\n info_helpers?: {\n hint_text?: { ... }\n hint_text_key?: { ... }\n hint_custom_component?: { ... }\n hint_tooltip_placement?: { ... }\n }\n explicit_searchable?: boolean\n exclude_from_search?: boolean\n repeatable?: boolean\n has_primary?: boolean\n edit_mode?: \"direct\" | \"external\" | \"approval\"\n edit_mode_config?: {\n match_strategy?: { ... }\n // ...\n}\n```\n\n### `EntityViewDisabled`\n\n```ts\ntype EntityViewDisabled = {\n view_type?: \"disabled\"\n}\n```\n\n### `EntityDefaultTable`\n\n```ts\ntype EntityDefaultTable = {\n view_type?: \"default\"\n row_actions?: Array\n bulk_actions?: Array\n navbar_actions?: Array<{\n type: string\n options?: Array<{\n label: { ... }\n params?: { ... }\n }>\n }>\n enable_thumbnails?: boolean\n}\n```\n\n### `EntityDefaultCreate`\n\n```ts\ntype EntityDefaultCreate = {\n view_type?: \"default\"\n search_params?: Record\n}\n```\n\n### `EntityDefaultEdit`\n\n```ts\ntype EntityDefaultEdit = {\n view_type?: \"default\"\n search_params?: Record\n summary_attributes?: string[]\n}\n```\n\n### `RedirectEntityView`\n\n```ts\ntype RedirectEntityView = {\n view_type?: \"redirect\"\n route?: string\n}\n```\n\n### `EntityId`\n\n```ts\ntype EntityId = string // uuid\n```\n\n### `BaseEntity`\n\n```ts\ntype BaseEntity = {\n _id: object\n _org: string\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _schema: string\n _title: string\n _tags?: string[]\n _created_at: string // date-time\n _updated_at: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n _changesets?: Record\n }>\n}\n```\n\n### `Entity`\n\n```ts\ntype Entity = {\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n _changesets?: Record\n }>\n}\n```\n\n### `NullableEntity`\n\n```ts\ntype NullableEntity = {\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n _changesets?: Record\n }>\n}\n```\n\n### `EntityOwner`\n\nThe user / organization owning this entity.\n\nNote: Owner implicitly has access to the entity regardless of ACLs.\n\n\n```ts\ntype EntityOwner = {\n org_id: string\n user_id?: string\n}\n```\n\n### `EntityAcl`\n\nAccess control list (ACL) for an entity. Defines sharing access to external orgs or users.\n\n```ts\ntype EntityAcl = {\n view?: string[]\n edit?: string[]\n delete?: string[]\n}\n```\n\n### `HydratedEntity`\n\nEntity with relation data resolved into the attribute values\n\n```ts\ntype HydratedEntity = {\n _relations: Array<{\n entity_id: string // uuid\n }>\n}\n```\n\n### `EntityItem`\n\n```ts\ntype EntityItem = {\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n _changesets?: Record\n }>\n}\n```\n\n### `EntityValidationError`\n\nValidation error for an entity attribute\n\n```ts\ntype EntityValidationError = {\n code: string\n params: {\n type?: string\n }\n path: string[]\n message: string\n}\n```\n\n### `EntityValidationResultSuccess`\n\nValidation result for a successful validation\n\n```ts\ntype EntityValidationResultSuccess = {\n status: \"success\"\n errors: Array<{\n code: string\n params: {\n type?: { ... }\n }\n path: string[]\n message: string\n }>\n}\n```\n\n### `EntityValidationResultError`\n\nValidation result for a failed validation\n\n```ts\ntype EntityValidationResultError = {\n status: \"error\"\n errors: Array<{\n code: string\n params: {\n type?: { ... }\n }\n path: string[]\n message: string\n }>\n}\n```\n\n### `EntityValidationResult`\n\n```ts\ntype EntityValidationResult = {\n status: \"success\"\n errors: Array<{\n code: string\n params: {\n type?: { ... }\n }\n path: string[]\n message: string\n }>\n} | {\n status: \"error\"\n errors: Array<{\n code: string\n params: {\n type?: { ... }\n }\n path: string[]\n message: string\n }>\n}\n```\n\n### `EntityValidationV2Error`\n\n```ts\ntype EntityValidationV2Error = {\n keyword: string\n instance_path: string\n schema_path: string\n params: Record\n property_name?: string\n message?: string\n schema?: object\n parent_schema?: Record\n data?: Record\n}\n```\n\n### `EntityValidationV2ResultSuccess`\n\nValidation result for a successful validation\n\n```ts\ntype EntityValidationV2ResultSuccess = {\n status: \"success\"\n errors: Array<{\n keyword: string\n instance_path: string\n schema_path: string\n params: Record\n property_name?: string\n message?: string\n schema?: object\n parent_schema?: Record\n data?: Record\n }>\n}\n```\n\n### `EntityValidationV2ResultError`\n\nValidation result for a failed validation\n\n```ts\ntype EntityValidationV2ResultError = {\n status: \"error\"\n errors: Array<{\n keyword: string\n instance_path: string\n schema_path: string\n params: Record\n property_name?: string\n message?: string\n schema?: object\n parent_schema?: Record\n data?: Record\n }>\n}\n```\n\n### `EntityValidationV2Result`\n\n```ts\ntype EntityValidationV2Result = {\n status: \"success\"\n errors: Array<{\n keyword: string\n instance_path: string\n schema_path: string\n params: Record\n property_name?: string\n message?: string\n schema?: object\n parent_schema?: Record\n data?: Record\n }>\n} | {\n status: \"error\"\n errors: Array<{\n keyword: string\n instance_path: string\n schema_path: string\n params: Record\n property_name?: string\n message?: string\n schema?: object\n parent_schema?: Record\n data?: Record\n }>\n}\n```\n\n### `HydratedEntityItem`\n\n```ts\ntype HydratedEntityItem = {\n _relations: Array<{\n entity_id: string // uuid\n }>\n}\n```\n\n### `GetRelationsResp`\n\n```ts\ntype GetRelationsResp = Array<{\n entity_id: string // uuid\n org_id?: string\n _schema?: string\n attribute: string\n _tags?: string[]\n reverse?: boolean\n} | {\n $relation?: {\n entity_id: string // uuid\n org_id?: string\n _schema?: string\n attribute: string\n _tags?: string[]\n reverse?: boolean\n }\n}>\n```\n\n### `GetRelationsRespWithPagination`\n\n```ts\ntype GetRelationsRespWithPagination = {\n hits?: number\n relations?: Array<{\n entity_id: string // uuid\n org_id?: string\n _schema?: string\n attribute: string\n _tags?: string[]\n reverse?: boolean\n } | {\n $relation?: {\n entity_id: { ... }\n org_id?: { ... }\n _schema?: { ... }\n attribute: { ... }\n _tags?: { ... }\n reverse?: { ... }\n }\n }>\n}\n```\n\n### `GetRelatedEntitiesCount`\n\n```ts\ntype GetRelatedEntitiesCount = {\n hits?: number\n}\n```\n\n### `RelationEntity`\n\n```ts\ntype RelationEntity = {\n $relation?: {\n entity_id: string // uuid\n org_id?: string\n _schema?: string\n attribute: string\n _tags?: string[]\n reverse?: boolean\n }\n}\n```\n\n### `RelationItem`\n\n```ts\ntype RelationItem = {\n entity_id: string // uuid\n org_id?: string\n _schema?: string\n attribute: string\n _tags?: string[]\n reverse?: boolean\n}\n```\n\n### `EntitySearchIncludeDeletedParam`\n\nWhether to include deleted entities in the search results\n- `true`: include deleted entities\n- `false`: exclude deleted entities\n- `only`: include only deleted entities\n\nBy default, no deleted entities are included in the search results.\n\n\n```ts\ntype EntitySearchIncludeDeletedParam = \"true\" | \"false\" | \"only\"\n```\n\n### `EntitySearchParams`\n\n```ts\ntype EntitySearchParams = {\n q: string\n include_scores?: boolean\n sort?: string | string[]\n from?: number\n size?: number\n hydrate?: boolean\n anonymize?: boolean\n fields?: string[]\n aggs?: object\n include_deleted?: \"true\" | \"false\" | \"only\"\n highlight?: unknown\n stable_for?: number\n stable_query_id?: string\n search_after?: string | number[]\n}\n```\n\n### `EntityListParams`\n\n```ts\ntype EntityListParams = {\n query?: {\n query_string: {\n query: { ... }\n fields?: { ... }\n default_operator?: { ... }\n lenient?: { ... }\n }\n }\n filter: Array<{\n term?: Record\n terms?: Record\n ids?: {\n values?: { ... }\n }\n range?: Record\n exists?: {\n field: { ... }\n }\n $and?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n $or?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n $not?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n }>\n allow_targeting_all_schemas?: boolean\n sort?: string | string[]\n from?: number\n size?: number\n hydrate?: boolean\n anonymize?: boolean\n fields?: string[]\n aggs?: object\n include_deleted?: \"true\" | \"false\" | \"only\"\n include_scores?: boolean\n highlight?: unknown\n stable_for?: number\n stable_query_id?: string\n search_after?: string | number[]\n}\n```\n\n### `SearchFilter`\n\nA subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.\n\n```ts\ntype SearchFilter = Array<{\n term?: Record\n terms?: Record\n ids?: {\n values?: string[]\n }\n range?: Record\n exists?: {\n field: string\n }\n $and?: Array<{\n term?: Record\n terms?: Record\n ids?: {\n values?: { ... }\n }\n range?: Record\n exists?: {\n field: { ... }\n }\n $and?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n $or?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n $not?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n }>\n $or?: Array<{\n term?: Record\n terms?: Record\n ids?: {\n values?: { ... }\n }\n range?: Record\n exists?: {\n field: { ... }\n }\n $and?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n exists?: { ... }\n $and?: { ... }\n $or?: { ... }\n $not?: { ... }\n }>\n $or?: Array<{\n term?: { ... }\n terms?: { ... }\n ids?: { ... }\n range?: { ... }\n // ...\n}\n```\n\n### `SearchFilterValue`\n\nA filter field value.\n\n```ts\ntype SearchFilterValue = string | number | boolean\n```\n\n### `EntitySearchOptions`\n\n```ts\ntype EntitySearchOptions = {\n sort?: string | string[]\n from?: number\n size?: number\n hydrate?: boolean\n anonymize?: boolean\n fields?: string[]\n aggs?: object\n include_deleted?: \"true\" | \"false\" | \"only\"\n include_scores?: boolean\n stable_for?: number\n stable_query_id?: string\n search_after?: string | number[]\n}\n```\n\n### `FieldsParam`\n\nList of entity fields to include or exclude in the response\n\nUse ! to exclude fields, e.g. `!_id` to exclude the `_id` field.\n\nGlobbing and globstart (**) is supported for nested fields.\n\n\n```ts\ntype FieldsParam = string[]\n```\n\n### `EntityImportParams`\n\nThe parameters for importing entities.\n\n```ts\ntype EntityImportParams = {\n S3Reference: {\n bucket: string\n key: string\n }\n schema: string\n}\n```\n\n### `GraphQueryRequest`\n\n```ts\ntype GraphQueryRequest = {\n seed: {\n entity_id: string // uuid\n node_id: string\n }\n graph: {\n nodes: Array<{\n id: { ... }\n schema: { ... }\n cardinality?: { ... }\n fields?: { ... }\n }>\n edges: Array<{\n from: { ... }\n to: { ... }\n }>\n }\n hydrate?: boolean\n apply_changesets?: boolean\n}\n```\n\n### `GraphSeed`\n\n```ts\ntype GraphSeed = {\n entity_id: string // uuid\n node_id: string\n}\n```\n\n### `GraphDefinition`\n\n```ts\ntype GraphDefinition = {\n nodes: Array<{\n id: string\n schema: string\n cardinality?: \"one\" | \"many\"\n fields?: object\n }>\n edges: Array<{\n from: string\n to: string\n }>\n}\n```\n\n### `GraphNode`\n\n```ts\ntype GraphNode = {\n id: string\n schema: string\n cardinality?: \"one\" | \"many\"\n fields?: object\n}\n```\n\n### `GraphEdge`\n\n```ts\ntype GraphEdge = {\n from: string\n to: string\n}\n```\n\n### `GraphQueryResponse`\n\n```ts\ntype GraphQueryResponse = {\n nodes?: Record\n entityNodes?: Record\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: { ... }\n edit?: { ... }\n delete?: { ... }\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n _changesets?: Record\n } | Array<{\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: { ... }\n user_id?: { ... }\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: { ... }\n edit?: { ... }\n delete?: { ... }\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n _changesets?: Record\n }>>\n edges: Array<{\n from: string\n to: string\n }>\n}\n```\n\n### `EntitySearchResults`\n\n```ts\ntype EntitySearchResults = {\n hits?: number\n results?: Array<{\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: { ... }\n user_id?: { ... }\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: { ... }\n edit?: { ... }\n delete?: { ... }\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n _changesets?: Record\n }>\n aggregations?: object\n stable_query_id?: string\n sort_end?: string | number[]\n}\n```\n\n### `SearchMappings`\n\nAdvanced: explicit Elasticsearch index mapping definitions for entity data\n\n\n```ts\ntype SearchMappings = Record\n```\n\n### `ActivityId`\n\nSee https://github.com/ulid/spec\n\n```ts\ntype ActivityId = string // ulid\n```\n\n### `ActivityCallerContext`\n\n```ts\ntype ActivityCallerContext = {\n EpilotAuth?: {\n token?: {\n sub?: { ... }\n email?: { ... }\n cognito:username?: { ... }\n custom:ivy_user_id?: { ... }\n }\n }\n}\n```\n\n### `ActivityType`\n\nA type for the activity. Used to categorize activities in the activity feed and for event subscriptions.\n\nBuilt-in entity activity types (custom activities can be defined as well):\n- EntityCreated\n- EntityUpdated\n- EntityDeleted\n- EntitySoftDeleted\n- EntityRestored\n- RelationsAdded\n- RelationsRemove\n\n```ts\ntype ActivityType = string\n```\n\n### `Activity`\n\n```ts\ntype Activity = {\n type: string\n title: string\n message: string\n payload?: Record\n pending?: boolean\n}\n```\n\n### `EntityOperation`\n\n```ts\ntype EntityOperation = {\n entity: string // uuid\n org: string\n activity_id?: string // ulid\n activity_type?: string\n operation: \"createEntity\" | \"updateEntity\" | \"deleteEntity\" | \"softDeleteEntity\" | \"restoreEntity\" | \"relationsAdded\" | \"relationsRemoved\" | \"relationsSoftDeleted\" | \"relationsRestored\" | \"relationsDeleted\"\n params?: {\n id?: string // uuid\n slug?: string\n }\n payload?: {\n _id?: object\n _org?: string\n _owners?: Array<{\n org_id: { ... }\n user_id?: { ... }\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _deleted_at?: string // date-time\n _acl?: {\n view?: { ... }\n edit?: { ... }\n delete?: { ... }\n }\n _purpose?: string[]\n _purpose_name?: string[]\n _manifest?: string // uuid[]\n _changesets?: Record\n }\n diff?: {\n added?: {\n _id?: { ... }\n _org?: { ... }\n _owners?: { ... }\n _schema?: { ... }\n _title?: { ... }\n _tags?: { ... }\n _created_at?: { ... }\n _updated_at?: { ... }\n _deleted_at?: { ... }\n _acl?: { ... }\n _purpose?: { ... }\n _purpose_name?: { ... }\n _manifest?: { ... }\n _changesets?: { ... }\n }\n updated?: {\n _id?: { ... }\n _org?: { ... }\n _owners?: { ... }\n _schema?: { ... }\n _title?: { ... }\n _tags?: { ... }\n _created_at?: { ... }\n _updated_at?: { ... }\n _deleted_at?: { ... }\n _acl?: { ... }\n _purpose?: { ... }\n _purpose_name?: { ... }\n _manifest?: { ... }\n _changesets?: { ... }\n }\n deleted?: {\n _id?: { ... }\n _org?: { ... }\n _owners?: { ... }\n _schema?: { ... }\n _title?: { ... }\n _tags?: { ... }\n _created_at?: { ... }\n _updated_at?: { ... }\n _deleted_at?: { ... }\n _acl?: { ... }\n _purpose?: { ... }\n _purpose_name?: { ... }\n _manifest?: { ... }\n _changesets?: { ... }\n }\n }\n source_context?: {\n source: \"portal\" | \"epilot\" | \"erp\" | \"system\" | \"api\" | \"external\" | \"journey\" | \"automation\" | \"unknown\"\n source_label?: string\n source_system?: string\n source_reference?: string\n actor_type?: \"user\" | \"portal_user\" | \"api_client\" | \"automation\" | \"system\"\n actor_id?: string\n effective_at?: string // date-time\n // ...\n}\n```\n\n### `EntityOperationSourceContext`\n\nBilling and audit source context for the operation event.\n\n```ts\ntype EntityOperationSourceContext = {\n source: \"portal\" | \"epilot\" | \"erp\" | \"system\" | \"api\" | \"external\" | \"journey\" | \"automation\" | \"unknown\"\n source_label?: string\n source_system?: string\n source_reference?: string\n actor_type?: \"user\" | \"portal_user\" | \"api_client\" | \"automation\" | \"system\"\n actor_id?: string\n effective_at?: string // date-time\n}\n```\n\n### `BaseActivityItem`\n\n```ts\ntype BaseActivityItem = {\n _id?: string // ulid\n timestamp?: string // date-time\n type: string\n title: string\n message: string\n payload?: Record\n pending?: boolean\n caller?: {\n EpilotAuth?: {\n token?: { ... }\n }\n }\n}\n```\n\n### `ActivityItem`\n\n```ts\ntype ActivityItem = {\n operations_total?: number\n operations?: Array<{\n entity: string // uuid\n org: string\n activity_id?: string // ulid\n activity_type?: string\n operation: \"createEntity\" | \"updateEntity\" | \"deleteEntity\" | \"softDeleteEntity\" | \"restoreEntity\" | \"relationsAdded\" | \"relationsRemoved\" | \"relationsSoftDeleted\" | \"relationsRestored\" | \"relationsDeleted\"\n params?: {\n id?: { ... }\n slug?: { ... }\n }\n payload?: {\n _id?: { ... }\n _org?: { ... }\n _owners?: { ... }\n _schema?: { ... }\n _title?: { ... }\n _tags?: { ... }\n _created_at?: { ... }\n _updated_at?: { ... }\n _deleted_at?: { ... }\n _acl?: { ... }\n _purpose?: { ... }\n _purpose_name?: { ... }\n _manifest?: { ... }\n _changesets?: { ... }\n }\n diff?: {\n added?: { ... }\n updated?: { ... }\n deleted?: { ... }\n }\n source_context?: {\n source: { ... }\n source_label?: { ... }\n source_system?: { ... }\n source_reference?: { ... }\n actor_type?: { ... }\n actor_id?: { ... }\n effective_at?: { ... }\n }\n _workflow_origin?: {\n workflow_exec_id?: { ... }\n flow_template_id?: { ... }\n }\n _automation_chain?: string[]\n }>\n}\n```\n\n### `BlueprintEntityId`\n\nReference to blueprint\n\n```ts\ntype BlueprintEntityId = string // uuid\n```\n\n### `ListSavedViewsResults`\n\n```ts\ntype ListSavedViewsResults = {\n hits?: number\n results?: Array<{\n id?: string // uuid\n created_at?: string\n updated_at?: string\n }>\n}\n```\n\n### `SavedViewId`\n\nGenerated uuid for a saved view\n\n```ts\ntype SavedViewId = string // uuid\n```\n\n### `SavedViewItem`\n\n```ts\ntype SavedViewItem = {\n id?: string // uuid\n created_at?: string\n updated_at?: string\n}\n```\n\n### `SavedViewPartial`\n\nA saved entity view\n\n```ts\ntype SavedViewPartial = {\n slug?: string[]\n name?: string\n org?: string\n shared?: boolean\n isFavoritedBy?: string[]\n created_by?: {\n user_id?: string\n org_id?: string\n } | {\n source?: \"SYSTEM\" | \"BLUEPRINT\"\n }\n ui_config?: Record\n shared_with?: string[]\n}\n```\n\n### `SavedView`\n\nA saved entity view\n\n```ts\ntype SavedView = {\n slug: string[]\n name: string\n org?: string\n shared?: boolean\n isFavoritedBy?: string[]\n created_by?: {\n user_id?: string\n org_id?: string\n } | {\n source?: \"SYSTEM\" | \"BLUEPRINT\"\n }\n ui_config: Record\n shared_with?: string[]\n}\n```\n\n### `Taxonomy`\n\n```ts\ntype Taxonomy = {\n slug?: string\n name?: string\n plural?: string\n kind?: \"system\" | \"user_defined\"\n type?: \"entity\" | \"relation\" | \"system\" | \"file_collection\"\n icon?: string\n color?: string\n created_at?: string // date-time\n updated_at?: string // date-time\n deleted_at?: string // date-time\n created_by?: string\n enabled?: boolean\n order?: number\n enabled_locations?: \"account\" | \"contact\" | \"contract\" | \"email_template\" | \"file\" | \"journey\" | \"meter_counter\" | \"meter\" | \"opportunity\" | \"order\" | \"partner\" | \"price\" | \"product\" | \"submission\" | \"tax\" | \"message\" | \"portal_user\" | \"request\" | \"comment\" | \"user\" | string[]\n}\n```\n\n### `TaxonomyLocationId`\n\n```ts\ntype TaxonomyLocationId = \"account\" | \"contact\" | \"contract\" | \"email_template\" | \"file\" | \"journey\" | \"meter_counter\" | \"meter\" | \"opportunity\" | \"order\" | \"partner\" | \"price\" | \"product\" | \"submission\" | \"tax\" | \"message\" | \"portal_user\" | \"request\" | \"comment\" | \"user\"\n```\n\n### `TaxonomySearchIncludeArchivedParam`\n\nWhether to include archived labels in the search results\n- `true`: include archived labels\n- `false`: exclude archived labels\n- `only`: include only archived labels\n\nBy default, no archived labels are included in the search results.\n\n\n```ts\ntype TaxonomySearchIncludeArchivedParam = \"true\" | \"false\" | \"only\"\n```\n\n### `TaxonomyClassification`\n\n```ts\ntype TaxonomyClassification = {\n id?: string\n slug: string\n name: string\n parents?: string[]\n color?: string\n created_at?: string // date-time\n updated_at?: string // date-time\n archived?: boolean\n starred?: boolean\n enabled_locations?: \"account\" | \"contact\" | \"contract\" | \"email_template\" | \"file\" | \"journey\" | \"meter_counter\" | \"meter\" | \"opportunity\" | \"order\" | \"partner\" | \"price\" | \"product\" | \"submission\" | \"tax\" | \"message\" | \"portal_user\" | \"request\" | \"comment\" | \"user\" | string[]\n enabled_purposes?: string[]\n _manifest?: string // uuid[]\n}\n```\n\n### `ClassificationId`\n\n```ts\ntype ClassificationId = string\n```\n\n### `ClassificationIdOrPattern`\n\n```ts\ntype ClassificationIdOrPattern = string | {\n pattern: string\n}\n```\n\n### `ClassificationSlug`\n\nURL-friendly identifier for the classification\n\n```ts\ntype ClassificationSlug = string\n```\n\n### `TaxonomySlug`\n\nURL-friendly name for taxonomy\n\n```ts\ntype TaxonomySlug = string\n```\n\n### `ClassificationsUpdate`\n\n```ts\ntype ClassificationsUpdate = {\n create?: Array<{\n id?: string\n slug: string\n name: string\n parents?: string[]\n color?: string\n created_at?: string // date-time\n updated_at?: string // date-time\n archived?: boolean\n starred?: boolean\n enabled_locations?: \"account\" | \"contact\" | \"contract\" | \"email_template\" | \"file\" | \"journey\" | \"meter_counter\" | \"meter\" | \"opportunity\" | \"order\" | \"partner\" | \"price\" | \"product\" | \"submission\" | \"tax\" | \"message\" | \"portal_user\" | \"request\" | \"comment\" | \"user\" | string[]\n enabled_purposes?: string[]\n _manifest?: string // uuid[]\n }>\n update?: Array<{\n id?: string\n slug: string\n name: string\n parents?: string[]\n color?: string\n created_at?: string // date-time\n updated_at?: string // date-time\n archived?: boolean\n starred?: boolean\n enabled_locations?: \"account\" | \"contact\" | \"contract\" | \"email_template\" | \"file\" | \"journey\" | \"meter_counter\" | \"meter\" | \"opportunity\" | \"order\" | \"partner\" | \"price\" | \"product\" | \"submission\" | \"tax\" | \"message\" | \"portal_user\" | \"request\" | \"comment\" | \"user\" | string[]\n enabled_purposes?: string[]\n _manifest?: string // uuid[]\n }>\n delete?: string | string[]\n}\n```\n\n### `TaxonomyBulkJobTriggerResponse`\n\n```ts\ntype TaxonomyBulkJobTriggerResponse = {\n job_id?: string // uuid\n status?: \"PENDING\" | \"FAILED\" | \"COMPLETED\" | \"CANCELLED\"\n}\n```\n\n### `TaxonomyBulkJobStatus`\n\nThe status of the bulk job\n\n```ts\ntype TaxonomyBulkJobStatus = \"PENDING\" | \"FAILED\" | \"COMPLETED\" | \"CANCELLED\"\n```\n\n### `TaxonomyBulkJobActionType`\n\n```ts\ntype TaxonomyBulkJobActionType = \"MOVE_CLASSIFICATIONS\" | \"MERGE_CLASSIFICATIONS\" | \"DELETE_CLASSIFICATIONS\"\n```\n\n### `TaxonomyBulkJob`\n\n```ts\ntype TaxonomyBulkJob = {\n job_id?: string // uuid\n job_status?: \"PENDING\" | \"FAILED\" | \"COMPLETED\" | \"CANCELLED\"\n failure_reason?: string\n action_type?: \"MOVE_CLASSIFICATIONS\" | \"MERGE_CLASSIFICATIONS\" | \"DELETE_CLASSIFICATIONS\"\n request?: {\n target_taxonomy?: string\n target_classification?: string\n classification_ids?: string[]\n }\n output?: {\n target_entities_count?: number\n affected_entities_count?: number\n failures_count?: number\n failed_entities?: string // uuid[]\n }\n created_by?: string\n created_at?: string // date-time\n updated_at?: string // date-time\n org?: string\n}\n```\n\n### `ESClusterAssignment`\n\n```ts\ntype ESClusterAssignment = {\n orgId?: string\n cluster?: string\n}\n```\n\n### `SettingFlag`\n\n```ts\ntype SettingFlag = {\n name?: string\n enabled?: boolean\n}\n```\n\n### `ErrorObject`\n\nA generic error returned by the API\n\n```ts\ntype ErrorObject = {\n status?: number\n error?: string\n}\n```\n\n### `ChangesetCreator`\n\nIdentifies the actor that created the changeset.\n\n```ts\ntype ChangesetCreator = {\n type?: \"user\" | \"portal_user\" | \"api_client\" | \"automation\"\n id?: string\n}\n```\n\n### `Changeset`\n\nA pending proposed change for a single entity attribute, awaiting external confirmation or human approval.\n\n```ts\ntype Changeset = {\n proposed_value: unknown\n previous_value?: unknown\n created_at: string // date-time\n created_by?: {\n type?: \"user\" | \"portal_user\" | \"api_client\" | \"automation\"\n id?: string\n }\n edit_mode: \"external\" | \"approval\"\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n source?: string\n related_values?: Record\n}\n```\n\n### `ChangesetMap`\n\nMap of attribute name to pending changeset. At most one changeset per attribute.\n\n```ts\ntype ChangesetMap = Record\n}>\n```\n\n### `MeterReadingChangesetEntry`\n\nA meter readings changeset entry — service-managed by metering-api.\nStored on `Meter._meter_readings_changeset` array attribute. Each entry mirrors a\nClickHouse meter reading row plus a changeset metadata overlay.\n\nNote: `org_id` is NOT stored on the entry. The entries live on the Meter entity,\nwhic\n\n```ts\ntype MeterReadingChangesetEntry = {\n value: number\n direction?: \"feed-in\" | \"feed-out\"\n timestamp?: string // date-time\n meter_id: string // uuid\n counter_id: string // uuid\n source?: string\n reason?: string\n read_by?: string\n status?: \"valid\" | \"in-validation\" | \"implausible\"\n external_id?: string\n remark?: string\n metadata?: Record\n changeset_id: string\n edit_mode: \"external\" | \"approval\"\n match_strategy?: \"exact\" | \"fuzzy\"\n timestamp_tolerance?: \"exact\" | {\n type: \"same-day\"\n timezone?: string\n } | {\n type: \"within-seconds\"\n seconds: number\n }\n fuzzy_config?: {\n percentage_threshold?: number\n absolute_threshold?: number\n }\n created_at: string // date-time\n created_by?: {\n type?: \"user\" | \"portal_user\" | \"api_client\" | \"automation\"\n id?: string\n }\n previous?: {\n value?: number\n direction?: \"feed-in\" | \"feed-out\"\n timestamp?: string // date-time\n }\n}\n```\n\n### `EditMode`\n\nControls whether a write goes through immediately or is held as a pending entry\non the parent entity's `_changesets` map.\n\n- `direct`: write applied immediately. No changeset created.\n- `external`: write held as a pending changeset; auto-cleared on a matching direct/ERP write.\n- `approval`: write he\n\n```ts\ntype EditMode = \"direct\" | \"external\" | \"approval\"\n```\n\n### `EditModeConfig`\n\nConfiguration for `edit_mode: external` auto-clear matching.\nFields here (`match_strategy`, `fuzzy_config`) only take effect when\n`edit_mode` is `external`. They are ignored for `edit_mode: approval`,\nwhich never auto-clears and is resolved exclusively via the\n`:apply` / `:dismiss` changeset endpoin\n\n```ts\ntype EditModeConfig = {\n match_strategy?: \"exact\" | \"fuzzy\" | \"any\"\n fuzzy_config?: {\n type: \"suffix\" | \"digits_only\" | \"normalize_phone\" | \"ignore_fields\" | \"set_equivalent\" | \"entry_match\" | \"relation_set\" | \"regex\"\n suffix_length?: number\n fields_to_ignore?: string[]\n regex_flags?: string\n country_code?: string\n match_on?: string\n key?: string | string[]\n mode?: \"subset\" | \"exact_set\"\n ordered?: boolean\n require_tags_match?: boolean\n pattern?: string\n }\n}\n```\n\n### `FuzzyConfig`\n\nConfiguration for fuzzy auto-clear matching on `edit_mode: external` attributes.\nNot used for `edit_mode: approval`.\n\nType compatibility with attribute shape is enforced at schema save time:\n- scalar string attributes: `suffix`, `digits_only`, `regex`\n- repeatable attributes: `set_equivalent`, `entr\n\n```ts\ntype FuzzyConfig = {\n type: \"suffix\" | \"digits_only\" | \"normalize_phone\" | \"ignore_fields\" | \"set_equivalent\" | \"entry_match\" | \"relation_set\" | \"regex\"\n suffix_length?: number\n fields_to_ignore?: string[]\n regex_flags?: string\n country_code?: string\n match_on?: string\n key?: string | string[]\n mode?: \"subset\" | \"exact_set\"\n ordered?: boolean\n require_tags_match?: boolean\n pattern?: string\n}\n```\n\n### `MatchStrategy`\n\nStrategy for auto-clearing a changeset on an `edit_mode: external` attribute\nwhen a direct write (`?direct=true`) arrives — typically an ERP inbound sync.\nIgnored for `edit_mode: approval`, which does not auto-clear and is resolved\nexclusively via the `:apply` / `:dismiss` changeset endpoints.\n- `ex\n\n```ts\ntype MatchStrategy = \"exact\" | \"fuzzy\" | \"any\"\n```\n" diff --git a/packages/epilot-sdk-v2/src/types/entity.d.ts b/packages/epilot-sdk-v2/src/types/entity.d.ts index 64527fc4..8b3c7fc4 100644 --- a/packages/epilot-sdk-v2/src/types/entity.d.ts +++ b/packages/epilot-sdk-v2/src/types/entity.d.ts @@ -835,6 +835,15 @@ export declare namespace Components { */ DefaultAddressFields; } + /** + * Configuration for adjusting a contract installment through a Journey. + */ + export interface AdjustInstallmentCapabilityConfig { + /** + * ID of the Flow Journey to open when adjusting the installment. + */ + journey_id: 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 | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Address attribute */ AddressAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Tags */ TagsAttribute | /* Message emil address */ MessageEmailAddressAttribute | /* Numeric input */ NumberAttribute | /* Dynamic data table with configurable columns. Data is stored as an array of objects where each object represents a row. */ TableAttribute | /* 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. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute | /* Shared Partner Organisations */ PartnerOrganisationAttribute | /* Portal access configuration */ PortalAccessAttribute | /* Phone number */ PhoneAttribute | /* Email address */ EmailAttribute | /* Payment method */ PaymentAttribute | /* Price component */ PriceComponentAttribute; /** * a readonly computed ID for the attribute including schema slug and the attribute ID @@ -3313,6 +3322,7 @@ export declare namespace Components { * 123e4567-e89b-12d3-a456-426614174000 */ app_id?: string; + adjust_installment?: /* Configuration for adjusting a contract installment through a Journey. */ AdjustInstallmentCapabilityConfig; ui_config?: { /** * Whether the capability is filterable @@ -3458,6 +3468,7 @@ export declare namespace Components { * 123e4567-e89b-12d3-a456-426614174000 */ app_id?: string; + adjust_installment?: /* Configuration for adjusting a contract installment through a Journey. */ AdjustInstallmentCapabilityConfig; ui_config?: { /** * Whether the capability is filterable @@ -19437,6 +19448,7 @@ export type ActivityItem = Components.Schemas.ActivityItem; export type ActivityType = Components.Schemas.ActivityType; export type AddressAttribute = Components.Schemas.AddressAttribute; export type AddressRelationAttribute = Components.Schemas.AddressRelationAttribute; +export type AdjustInstallmentCapabilityConfig = Components.Schemas.AdjustInstallmentCapabilityConfig; export type Attribute = Components.Schemas.Attribute; export type AttributeWithCompositeID = Components.Schemas.AttributeWithCompositeID; export type AutomationAttribute = Components.Schemas.AutomationAttribute; From dc80ff9dbc5121f4b2db3e01900f0656a1e2e6d4 Mon Sep 17 00:00:00 2001 From: Richard Griffiths Date: Wed, 5 Aug 2026 18:38:33 +0200 Subject: [PATCH 2/2] chore(entity-client): regenerate client from spec --- clients/entity-client/package.json | 2 +- clients/entity-client/src/openapi.d.ts | 26 ++++++++++++++++++++++---- clients/entity-client/src/openapi.json | 2 +- 3 files changed, 24 insertions(+), 6 deletions(-) diff --git a/clients/entity-client/package.json b/clients/entity-client/package.json index 5c748bd0..afeb48f9 100644 --- a/clients/entity-client/package.json +++ b/clients/entity-client/package.json @@ -1,6 +1,6 @@ { "name": "@epilot/entity-client", - "version": "7.3.0", + "version": "7.3.1", "description": "JavaScript client library for the epilot Core Entity API", "main": "dist/index.js", "types": "dist/index.d.ts", diff --git a/clients/entity-client/src/openapi.d.ts b/clients/entity-client/src/openapi.d.ts index cd882d4b..cd805082 100644 --- a/clients/entity-client/src/openapi.d.ts +++ b/clients/entity-client/src/openapi.d.ts @@ -836,6 +836,10 @@ declare namespace Components { } /** * Configuration for adjusting a contract installment through a Journey. + * example: + * { + * "journey_id": "adjust-installment-flow" + * } */ export interface AdjustInstallmentCapabilityConfig { /** @@ -3321,7 +3325,14 @@ declare namespace Components { * 123e4567-e89b-12d3-a456-426614174000 */ app_id?: string; - adjust_installment?: /* Configuration for adjusting a contract installment through a Journey. */ AdjustInstallmentCapabilityConfig; + adjust_installment?: /** + * Configuration for adjusting a contract installment through a Journey. + * example: + * { + * "journey_id": "adjust-installment-flow" + * } + */ + AdjustInstallmentCapabilityConfig; ui_config?: { /** * Whether the capability is filterable @@ -3467,7 +3478,14 @@ declare namespace Components { * 123e4567-e89b-12d3-a456-426614174000 */ app_id?: string; - adjust_installment?: /* Configuration for adjusting a contract installment through a Journey. */ AdjustInstallmentCapabilityConfig; + adjust_installment?: /** + * Configuration for adjusting a contract installment through a Journey. + * example: + * { + * "journey_id": "adjust-installment-flow" + * } + */ + AdjustInstallmentCapabilityConfig; ui_config?: { /** * Whether the capability is filterable @@ -15431,7 +15449,7 @@ declare namespace Paths { /** * ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z). * example: - * 2023-01-01T00:00:00.000Z + * 2023-01-01T00:00:00Z */ export type CreatedAfter = string; // date-time /** @@ -15457,7 +15475,7 @@ declare namespace Paths { created_after?: /** * ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z). * example: - * 2023-01-01T00:00:00.000Z + * 2023-01-01T00:00:00Z */ Parameters.CreatedAfter /* date-time */; sort_pending_first?: /* When true, sorts PENDING status jobs to the top of the results. */ Parameters.SortPendingFirst; diff --git a/clients/entity-client/src/openapi.json b/clients/entity-client/src/openapi.json index 52b2246e..ed7a4c2d 100644 --- a/clients/entity-client/src/openapi.json +++ b/clients/entity-client/src/openapi.json @@ -3947,7 +3947,7 @@ "description": "ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).", "type": "string", "format": "date-time", - "example": "2023-01-01T00:00:00.000Z" + "example": "2023-01-01T00:00:00Z" } }, {