@epilot/entity-client 6.11.4 → 6.12.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/definition.js +1 -1
  2. package/dist/openapi-runtime.json +6 -2
  3. package/dist/openapi.d.ts +448 -8
  4. package/dist/openapi.json +59 -9
  5. package/package.json +1 -1
package/dist/definition.js CHANGED
@@ -1 +1 @@
1
- (()=>{"use strict";var e={914:function(e,t,a){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=r(a(240));t.default=n.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"}],"responses":{}}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"}],"responses":{}},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/schema":{"get":{"operationId":"getJsonSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"dereference"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/example":{"get":{"operationId":"getSchemaExample","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/versions":{"get":{"operationId":"getSchemaVersions","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"versions_from"},{"in":"query","name":"versions_size"},{"in":"query","name":"drafts_from"},{"in":"query","name":"drafts_size"},{"in":"query","name":"fields","required":false,"style":"form","explode":false}],"responses":{}}},"/v1/entity/schemas/{slug}/capabilities/available":{"get":{"operationId":"listAvailableCapabilities","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints","responses":{}}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:list":{"post":{"operationId":"listEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:graph":{"post":{"operationId":"queryEntityGraph","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}:validate":{"post":{"operationId":"validateEntityV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"},{"name":"strict","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}":{"get":{"operationId":"getEntityV2","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"fields","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}:restore":{"patch":{"operationId":"restoreEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}:reindex":{"post":{"operationId":"reindexEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}],"responses":{}},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"in":"query","name":"purge"}],"responses":{}}},"/v1/entity:autocomplete":{"get":{"operationId":"autocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"slug","in":"query"},{"name":"size","in":"query"}],"responses":{}}},"/v1/entity:wipeAllEntities":{"post":{"operationId":"wipeAllEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}],"responses":{}}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"start_date"},{"in":"query","name":"end_date"},{"in":"query","name":"preset_range"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"},{"in":"query","name":"exclude_activity_groups"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"removeRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"query"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"fields"}],"responses":{}}},"/v3/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV3","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseDeprecatedQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"},{"$ref":"#/components/parameters/EntityRelationsModeQueryParam"},{"in":"query","name":"fields"}],"responses":{}}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"responses":{}}},"/v1/entity:export":{"post":{"operationId":"exportEntities","parameters":[{"in":"query","name":"job_id"},{"in":"query","name":"is_template"},{"in":"query","name":"language"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/views":{"get":{"operationId":"listSavedViews","parameters":[{"in":"query","name":"slug","required":false},{"in":"query","name":"sort","required":false},{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"in":"query","name":"fields","required":false}],"responses":{}}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser","responses":{}}},"/v1/entity/taxonomies":{"get":{"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"},{"in":"query","name":"type"}],"responses":{}},"post":{"operationId":"createTaxonomy","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"permanent","default":false}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/taxonomies/classifications":{"post":{"operationId":"createTaxonomyClassification","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/taxonomies/classifications/{classificationSlug}":{"get":{"operationId":"getTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}],"responses":{}}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"in":"query","name":"taxonomySlug"},{"in":"query","name":"query"},{"in":"query","name":"archived","deprecated":true},{"in":"query","name":"include_archived"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}":{"get":{"operationId":"listTaxonomyClassificationsForSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs":{"get":{"operationId":"getTaxonomyBulkActionJobs","parameters":[{"in":"query","name":"status"},{"in":"query","name":"size"},{"in":"query","name":"created_after"},{"in":"query","name":"sort_pending_first"},{"in":"query","name":"scope"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}":{"get":{"operationId":"getTaxonomyBulkActionJobById","parameters":[{"in":"path","name":"job_id","required":true}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}/cancel":{"post":{"operationId":"cancelBulkAction","parameters":[{"name":"job_id","in":"path","required":true}],"responses":{}}},"/v1/entity/taxonomies/classifications:move":{"post":{"operationId":"bulkMoveClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/classifications:merge":{"post":{"operationId":"bulkMergeClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/classifications:delete":{"post":{"operationId":"bulkDeleteClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/attributes":{"post":{"operationId":"createSchemaAttribute","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/attributes/{composite_id}":{"get":{"operationId":"getSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/capabilities":{"post":{"operationId":"createSchemaCapability","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/capabilities/{composite_id}":{"get":{"operationId":"getSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/group":{"post":{"operationId":"createSchemaGroup","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/group/{composite_id}":{"get":{"operationId":"getSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/headline":{"post":{"operationId":"createSchemaGroupHeadline","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/headline/{composite_id}":{"get":{"operationId":"getSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}}},"components":{"parameters":{"EntityIdPathParam":{"name":"id","in":"path","required":true},"EntitySlugPathParam":{"name":"slug","in":"path","required":true},"EntitySlugPathPriceParam":{"name":"slug","in":"path","required":true},"TaxonomySlugQueryParam":{"name":"taxonomySlug","in":"query","required":true},"TaxonomySlugPathParam":{"name":"taxonomySlug","in":"path","required":true},"TaxonomySlugQueryParamOptional":{"name":"taxonomySlug","in":"query"},"TaxonomyClassificationSlugPathParam":{"name":"classificationSlug","in":"path","required":true},"SavedViewIdPathParam":{"name":"id","in":"path","required":true},"AsyncOperationQueryParam":{"name":"async","in":"query","required":false},"HydrateEntitiesQueryParam":{"name":"hydrate","in":"query"},"ActivityIdQueryParam":{"name":"activity_id","in":"query","required":false},"ActivityIdPathParam":{"name":"id","in":"path","required":true},"FromPageQueryParam":{"name":"from","in":"query"},"IncludeReverseDeprecatedQueryParam":{"name":"include_reverse","in":"query","deprecated":true},"IncludeReverseQueryParam":{"name":"include_reverse","in":"query"},"IncludeSchemasQueryParam":{"name":"include_schemas","in":"query","required":false,"style":"form","explode":false},"ExcludeSchemasQueryParam":{"name":"exclude_schemas","in":"query","required":false,"style":"form","explode":false},"EntityRelationsModeQueryParam":{"name":"mode","in":"query","required":false},"DryRunQueryParam":{"name":"dry_run","in":"query","required":false},"FillActivityQueryParam":{"name":"fill_activity","in":"query","required":false},"ValidateEntityQueryParam":{"name":"validate","in":"query"}},"responses":{"BadRequestError":{"content":{"application/json":{}}},"NotFoundError":{"content":{"application/json":{}}},"TooManyRequestsError":{"headers":{"Retry-After":{}},"content":{"application/json":{}}}}},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},a=function a(r){var n=t[r];if(void 0!==n)return n.exports;var s=t[r]={exports:{}};return e[r].call(s.exports,s,s.exports,a),s.exports}(914),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
1
+ (()=>{"use strict";var e={330:function(e,t,a){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=r(a(466));t.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"}],"responses":{}}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"}],"responses":{}},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/schema":{"get":{"operationId":"getJsonSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"dereference"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/example":{"get":{"operationId":"getSchemaExample","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/versions":{"get":{"operationId":"getSchemaVersions","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"versions_from"},{"in":"query","name":"versions_size"},{"in":"query","name":"drafts_from"},{"in":"query","name":"drafts_size"},{"in":"query","name":"fields","required":false,"style":"form","explode":false}],"responses":{}}},"/v1/entity/schemas/{slug}/capabilities/available":{"get":{"operationId":"listAvailableCapabilities","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints","responses":{}}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:list":{"post":{"operationId":"listEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:graph":{"post":{"operationId":"queryEntityGraph","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}:validate":{"post":{"operationId":"validateEntityV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"},{"name":"strict","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}":{"get":{"operationId":"getEntityV2","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"fields","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}:restore":{"patch":{"operationId":"restoreEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}:reindex":{"post":{"operationId":"reindexEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}],"responses":{}},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"in":"query","name":"purge"}],"responses":{}}},"/v1/entity:autocomplete":{"get":{"operationId":"autocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"slug","in":"query"},{"name":"size","in":"query"}],"responses":{}}},"/v1/entity:wipeAllEntities":{"post":{"operationId":"wipeAllEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}],"responses":{}}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"start_date"},{"in":"query","name":"end_date"},{"in":"query","name":"preset_range"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"},{"in":"query","name":"exclude_activity_groups"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"removeRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"query"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"fields"}],"responses":{}}},"/v3/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV3","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseDeprecatedQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"},{"$ref":"#/components/parameters/EntityRelationsModeQueryParam"},{"in":"query","name":"fields"},{"in":"query","name":"include_deleted","required":false}],"responses":{}}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"responses":{}}},"/v1/entity:export":{"post":{"operationId":"exportEntities","parameters":[{"in":"query","name":"job_id"},{"in":"query","name":"is_template"},{"in":"query","name":"language"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/views":{"get":{"operationId":"listSavedViews","parameters":[{"in":"query","name":"slug","required":false},{"in":"query","name":"sort","required":false},{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"in":"query","name":"fields","required":false}],"responses":{}}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser","responses":{}}},"/v1/entity/taxonomies":{"get":{"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"},{"in":"query","name":"type"}],"responses":{}},"post":{"operationId":"createTaxonomy","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"permanent"}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/taxonomies/classifications":{"post":{"operationId":"createTaxonomyClassification","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/taxonomies/classifications/{classificationSlug}":{"get":{"operationId":"getTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}],"responses":{}}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"in":"query","name":"taxonomySlug"},{"in":"query","name":"query"},{"in":"query","name":"archived","deprecated":true},{"in":"query","name":"include_archived"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}":{"get":{"operationId":"listTaxonomyClassificationsForSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs":{"get":{"operationId":"getTaxonomyBulkActionJobs","parameters":[{"in":"query","name":"status"},{"in":"query","name":"size"},{"in":"query","name":"created_after"},{"in":"query","name":"sort_pending_first"},{"in":"query","name":"scope"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}":{"get":{"operationId":"getTaxonomyBulkActionJobById","parameters":[{"in":"path","name":"job_id","required":true}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}/cancel":{"post":{"operationId":"cancelBulkAction","parameters":[{"name":"job_id","in":"path","required":true}],"responses":{}}},"/v1/entity/taxonomies/classifications:move":{"post":{"operationId":"bulkMoveClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/classifications:merge":{"post":{"operationId":"bulkMergeClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/classifications:delete":{"post":{"operationId":"bulkDeleteClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/attributes":{"post":{"operationId":"createSchemaAttribute","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/attributes/{composite_id}":{"get":{"operationId":"getSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/capabilities":{"post":{"operationId":"createSchemaCapability","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/capabilities/{composite_id}":{"get":{"operationId":"getSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/group":{"post":{"operationId":"createSchemaGroup","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/group/{composite_id}":{"get":{"operationId":"getSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/headline":{"post":{"operationId":"createSchemaGroupHeadline","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/headline/{composite_id}":{"get":{"operationId":"getSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}}},"components":{"parameters":{"EntityIdPathParam":{"name":"id","in":"path","required":true},"EntitySlugPathParam":{"name":"slug","in":"path","required":true},"EntitySlugPathPriceParam":{"name":"slug","in":"path","required":true},"TaxonomySlugQueryParam":{"name":"taxonomySlug","in":"query","required":true},"TaxonomySlugPathParam":{"name":"taxonomySlug","in":"path","required":true},"TaxonomySlugQueryParamOptional":{"name":"taxonomySlug","in":"query"},"TaxonomyClassificationSlugPathParam":{"name":"classificationSlug","in":"path","required":true},"SavedViewIdPathParam":{"name":"id","in":"path","required":true},"AsyncOperationQueryParam":{"name":"async","in":"query","required":false},"HydrateEntitiesQueryParam":{"name":"hydrate","in":"query"},"ActivityIdQueryParam":{"name":"activity_id","in":"query","required":false},"ActivityIdPathParam":{"name":"id","in":"path","required":true},"FromPageQueryParam":{"name":"from","in":"query"},"IncludeReverseDeprecatedQueryParam":{"name":"include_reverse","in":"query","deprecated":true},"IncludeReverseQueryParam":{"name":"include_reverse","in":"query"},"IncludeSchemasQueryParam":{"name":"include_schemas","in":"query","required":false,"style":"form","explode":false},"ExcludeSchemasQueryParam":{"name":"exclude_schemas","in":"query","required":false,"style":"form","explode":false},"EntityRelationsModeQueryParam":{"name":"mode","in":"query","required":false},"DryRunQueryParam":{"name":"dry_run","in":"query","required":false},"FillActivityQueryParam":{"name":"fill_activity","in":"query","required":false},"ValidateEntityQueryParam":{"name":"validate","in":"query"}},"responses":{"BadRequestError":{"content":{"application/json":{}}},"NotFoundError":{"content":{"application/json":{}}},"TooManyRequestsError":{"headers":{"Retry-After":{}},"content":{"application/json":{}}}}},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},a=function a(r){var n=t[r];if(void 0!==n)return n.exports;var s=t[r]={exports:{}};return e[r].call(s.exports,s,s.exports,a),s.exports}(330),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
package/dist/openapi-runtime.json CHANGED
@@ -723,6 +723,11 @@
723
723
  {
724
724
  "in": "query",
725
725
  "name": "fields"
726
+ },
727
+ {
728
+ "in": "query",
729
+ "name": "include_deleted",
730
+ "required": false
726
731
  }
727
732
  ],
728
733
  "responses": {}
@@ -1005,8 +1010,7 @@
1005
1010
  },
1006
1011
  {
1007
1012
  "in": "query",
1008
- "name": "permanent",
1009
- "default": false
1013
+ "name": "permanent"
1010
1014
  }
1011
1015
  ],
1012
1016
  "responses": {}
package/dist/openapi.d.ts CHANGED
@@ -489,6 +489,13 @@ declare namespace Components {
489
489
  *
490
490
  */
491
491
  explicit_searchable?: boolean;
492
+ /**
493
+ * When set to true, this attribute will be excluded from search fields.
494
+ * Use this for fields that should not be matched during entity search operations,
495
+ * such as internal hashes or identifiers that might accidentally match search terms.
496
+ *
497
+ */
498
+ exclude_from_search?: boolean;
492
499
  /**
493
500
  * The attribute is a repeatable
494
501
  */
@@ -507,6 +514,7 @@ declare namespace Components {
507
514
  * - plot_of_land
508
515
  * - suburb
509
516
  * - country
517
+ * - postbox
510
518
  * - additional_info
511
519
  * - coordinates
512
520
  * - start_date
@@ -515,6 +523,7 @@ declare namespace Components {
515
523
  * - title
516
524
  * - first_name
517
525
  * - last_name
526
+ * - name_suffix
518
527
  * - company_name
519
528
  *
520
529
  */
@@ -661,6 +670,13 @@ declare namespace Components {
661
670
  *
662
671
  */
663
672
  explicit_searchable?: boolean;
673
+ /**
674
+ * When set to true, this attribute will be excluded from search fields.
675
+ * Use this for fields that should not be matched during entity search operations,
676
+ * such as internal hashes or identifiers that might accidentally match search terms.
677
+ *
678
+ */
679
+ exclude_from_search?: boolean;
664
680
  /**
665
681
  * The attribute is a repeatable
666
682
  */
@@ -679,6 +695,7 @@ declare namespace Components {
679
695
  * - plot_of_land
680
696
  * - suburb
681
697
  * - country
698
+ * - postbox
682
699
  * - additional_info
683
700
  * - coordinates
684
701
  * - start_date
@@ -687,6 +704,7 @@ declare namespace Components {
687
704
  * - title
688
705
  * - first_name
689
706
  * - last_name
707
+ * - name_suffix
690
708
  * - company_name
691
709
  *
692
710
  */
@@ -850,6 +868,13 @@ declare namespace Components {
850
868
  *
851
869
  */
852
870
  explicit_searchable?: boolean;
871
+ /**
872
+ * When set to true, this attribute will be excluded from search fields.
873
+ * Use this for fields that should not be matched during entity search operations,
874
+ * such as internal hashes or identifiers that might accidentally match search terms.
875
+ *
876
+ */
877
+ exclude_from_search?: boolean;
853
878
  /**
854
879
  * The attribute is a repeatable
855
880
  */
@@ -1052,6 +1077,13 @@ declare namespace Components {
1052
1077
  *
1053
1078
  */
1054
1079
  explicit_searchable?: boolean;
1080
+ /**
1081
+ * When set to true, this attribute will be excluded from search fields.
1082
+ * Use this for fields that should not be matched during entity search operations,
1083
+ * such as internal hashes or identifiers that might accidentally match search terms.
1084
+ *
1085
+ */
1086
+ exclude_from_search?: boolean;
1055
1087
  /**
1056
1088
  * The attribute is a repeatable
1057
1089
  */
@@ -1131,6 +1163,10 @@ declare namespace Components {
1131
1163
  delete?: string[];
1132
1164
  };
1133
1165
  _purpose?: string[] | null;
1166
+ /**
1167
+ * Automatically computed purpose names from _purpose attribute
1168
+ */
1169
+ _purpose_name?: string[] | null;
1134
1170
  /**
1135
1171
  * Manifest ID used to create/update the entity
1136
1172
  */
@@ -1281,6 +1317,13 @@ declare namespace Components {
1281
1317
  *
1282
1318
  */
1283
1319
  explicit_searchable?: boolean;
1320
+ /**
1321
+ * When set to true, this attribute will be excluded from search fields.
1322
+ * Use this for fields that should not be matched during entity search operations,
1323
+ * such as internal hashes or identifiers that might accidentally match search terms.
1324
+ *
1325
+ */
1326
+ exclude_from_search?: boolean;
1284
1327
  /**
1285
1328
  * The attribute is a repeatable
1286
1329
  */
@@ -1472,6 +1515,13 @@ declare namespace Components {
1472
1515
  *
1473
1516
  */
1474
1517
  explicit_searchable?: boolean;
1518
+ /**
1519
+ * When set to true, this attribute will be excluded from search fields.
1520
+ * Use this for fields that should not be matched during entity search operations,
1521
+ * such as internal hashes or identifiers that might accidentally match search terms.
1522
+ *
1523
+ */
1524
+ exclude_from_search?: boolean;
1475
1525
  /**
1476
1526
  * The attribute is a repeatable
1477
1527
  */
@@ -1629,6 +1679,13 @@ declare namespace Components {
1629
1679
  *
1630
1680
  */
1631
1681
  explicit_searchable?: boolean;
1682
+ /**
1683
+ * When set to true, this attribute will be excluded from search fields.
1684
+ * Use this for fields that should not be matched during entity search operations,
1685
+ * such as internal hashes or identifiers that might accidentally match search terms.
1686
+ *
1687
+ */
1688
+ exclude_from_search?: boolean;
1632
1689
  /**
1633
1690
  * The attribute is a repeatable
1634
1691
  */
@@ -1779,6 +1836,13 @@ declare namespace Components {
1779
1836
  *
1780
1837
  */
1781
1838
  explicit_searchable?: boolean;
1839
+ /**
1840
+ * When set to true, this attribute will be excluded from search fields.
1841
+ * Use this for fields that should not be matched during entity search operations,
1842
+ * such as internal hashes or identifiers that might accidentally match search terms.
1843
+ *
1844
+ */
1845
+ exclude_from_search?: boolean;
1782
1846
  /**
1783
1847
  * The attribute is a repeatable
1784
1848
  */
@@ -1927,6 +1991,13 @@ declare namespace Components {
1927
1991
  *
1928
1992
  */
1929
1993
  explicit_searchable?: boolean;
1994
+ /**
1995
+ * When set to true, this attribute will be excluded from search fields.
1996
+ * Use this for fields that should not be matched during entity search operations,
1997
+ * such as internal hashes or identifiers that might accidentally match search terms.
1998
+ *
1999
+ */
2000
+ exclude_from_search?: boolean;
1930
2001
  /**
1931
2002
  * The attribute is a repeatable
1932
2003
  */
@@ -2085,6 +2156,13 @@ declare namespace Components {
2085
2156
  *
2086
2157
  */
2087
2158
  explicit_searchable?: boolean;
2159
+ /**
2160
+ * When set to true, this attribute will be excluded from search fields.
2161
+ * Use this for fields that should not be matched during entity search operations,
2162
+ * such as internal hashes or identifiers that might accidentally match search terms.
2163
+ *
2164
+ */
2165
+ exclude_from_search?: boolean;
2088
2166
  /**
2089
2167
  * The attribute is a repeatable
2090
2168
  */
@@ -2104,6 +2182,7 @@ declare namespace Components {
2104
2182
  * - plot_of_land
2105
2183
  * - suburb
2106
2184
  * - country
2185
+ * - postbox
2107
2186
  * - additional_info
2108
2187
  * - coordinates
2109
2188
  * - start_date
@@ -2112,6 +2191,7 @@ declare namespace Components {
2112
2191
  * - title
2113
2192
  * - first_name
2114
2193
  * - last_name
2194
+ * - name_suffix
2115
2195
  * - company_name
2116
2196
  *
2117
2197
  */
@@ -2267,6 +2347,13 @@ declare namespace Components {
2267
2347
  *
2268
2348
  */
2269
2349
  explicit_searchable?: boolean;
2350
+ /**
2351
+ * When set to true, this attribute will be excluded from search fields.
2352
+ * Use this for fields that should not be matched during entity search operations,
2353
+ * such as internal hashes or identifiers that might accidentally match search terms.
2354
+ *
2355
+ */
2356
+ exclude_from_search?: boolean;
2270
2357
  /**
2271
2358
  * The attribute is a repeatable
2272
2359
  */
@@ -2347,6 +2434,10 @@ declare namespace Components {
2347
2434
  delete?: string[];
2348
2435
  };
2349
2436
  _purpose?: string[] | null;
2437
+ /**
2438
+ * Automatically computed purpose names from _purpose attribute
2439
+ */
2440
+ _purpose_name?: string[] | null;
2350
2441
  /**
2351
2442
  * Manifest ID used to create/update the entity
2352
2443
  */
@@ -2814,6 +2905,10 @@ declare namespace Components {
2814
2905
  delete?: string[];
2815
2906
  };
2816
2907
  _purpose?: string[] | null;
2908
+ /**
2909
+ * Automatically computed purpose names from _purpose attribute
2910
+ */
2911
+ _purpose_name?: string[] | null;
2817
2912
  /**
2818
2913
  * Manifest ID used to create/update the entity
2819
2914
  */
@@ -3088,13 +3183,18 @@ declare namespace Components {
3088
3183
  delete?: string[];
3089
3184
  };
3090
3185
  _purpose?: string[] | null;
3186
+ /**
3187
+ * Automatically computed purpose names from _purpose attribute
3188
+ */
3189
+ _purpose_name?: string[] | null;
3091
3190
  /**
3092
3191
  * Manifest ID used to create/update the entity
3093
3192
  */
3094
3193
  _manifest?: string /* uuid */[] | null;
3095
3194
  };
3096
3195
  diff?: {
3097
- added?: /**
3196
+ /**
3197
+ * New attributes added to the entity as part of the operation
3098
3198
  * example:
3099
3199
  * {
3100
3200
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -3129,8 +3229,55 @@ declare namespace Components {
3129
3229
  * ]
3130
3230
  * }
3131
3231
  */
3132
- Entity;
3133
- updated?: /**
3232
+ added?: {
3233
+ [name: string]: any;
3234
+ _id?: string; // uuid
3235
+ /**
3236
+ * Organization Id the entity belongs to
3237
+ */
3238
+ _org?: string;
3239
+ _owners?: /**
3240
+ * The user / organization owning this entity.
3241
+ *
3242
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
3243
+ *
3244
+ */
3245
+ EntityOwner[];
3246
+ _schema?: /**
3247
+ * URL-friendly identifier for the entity schema
3248
+ * example:
3249
+ * contact
3250
+ */
3251
+ EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
3252
+ /**
3253
+ * Title of entity
3254
+ */
3255
+ _title?: string | null;
3256
+ _tags?: string[] | null;
3257
+ _created_at?: string | null; // date-time
3258
+ _updated_at?: string | null; // date-time
3259
+ _deleted_at?: string | null; // date-time
3260
+ /**
3261
+ * Access control list (ACL) for an entity. Defines sharing access to external orgs or users.
3262
+ */
3263
+ _acl?: {
3264
+ [name: string]: any;
3265
+ view?: string[];
3266
+ edit?: string[];
3267
+ delete?: string[];
3268
+ };
3269
+ _purpose?: string[] | null;
3270
+ /**
3271
+ * Automatically computed purpose names from _purpose attribute
3272
+ */
3273
+ _purpose_name?: string[] | null;
3274
+ /**
3275
+ * Manifest ID used to create/update the entity
3276
+ */
3277
+ _manifest?: string /* uuid */[] | null;
3278
+ };
3279
+ /**
3280
+ * Attributes updated in the entity. Note: These values contain the previous values before the update!
3134
3281
  * example:
3135
3282
  * {
3136
3283
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -3165,8 +3312,55 @@ declare namespace Components {
3165
3312
  * ]
3166
3313
  * }
3167
3314
  */
3168
- Entity;
3169
- deleted?: /**
3315
+ updated?: {
3316
+ [name: string]: any;
3317
+ _id?: string; // uuid
3318
+ /**
3319
+ * Organization Id the entity belongs to
3320
+ */
3321
+ _org?: string;
3322
+ _owners?: /**
3323
+ * The user / organization owning this entity.
3324
+ *
3325
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
3326
+ *
3327
+ */
3328
+ EntityOwner[];
3329
+ _schema?: /**
3330
+ * URL-friendly identifier for the entity schema
3331
+ * example:
3332
+ * contact
3333
+ */
3334
+ EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
3335
+ /**
3336
+ * Title of entity
3337
+ */
3338
+ _title?: string | null;
3339
+ _tags?: string[] | null;
3340
+ _created_at?: string | null; // date-time
3341
+ _updated_at?: string | null; // date-time
3342
+ _deleted_at?: string | null; // date-time
3343
+ /**
3344
+ * Access control list (ACL) for an entity. Defines sharing access to external orgs or users.
3345
+ */
3346
+ _acl?: {
3347
+ [name: string]: any;
3348
+ view?: string[];
3349
+ edit?: string[];
3350
+ delete?: string[];
3351
+ };
3352
+ _purpose?: string[] | null;
3353
+ /**
3354
+ * Automatically computed purpose names from _purpose attribute
3355
+ */
3356
+ _purpose_name?: string[] | null;
3357
+ /**
3358
+ * Manifest ID used to create/update the entity
3359
+ */
3360
+ _manifest?: string /* uuid */[] | null;
3361
+ };
3362
+ /**
3363
+ * Attributes removed from the entity as part of the operation
3170
3364
  * example:
3171
3365
  * {
3172
3366
  * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
@@ -3201,7 +3395,53 @@ declare namespace Components {
3201
3395
  * ]
3202
3396
  * }
3203
3397
  */
3204
- Entity;
3398
+ deleted?: {
3399
+ [name: string]: any;
3400
+ _id?: string; // uuid
3401
+ /**
3402
+ * Organization Id the entity belongs to
3403
+ */
3404
+ _org?: string;
3405
+ _owners?: /**
3406
+ * The user / organization owning this entity.
3407
+ *
3408
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
3409
+ *
3410
+ */
3411
+ EntityOwner[];
3412
+ _schema?: /**
3413
+ * URL-friendly identifier for the entity schema
3414
+ * example:
3415
+ * contact
3416
+ */
3417
+ EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
3418
+ /**
3419
+ * Title of entity
3420
+ */
3421
+ _title?: string | null;
3422
+ _tags?: string[] | null;
3423
+ _created_at?: string | null; // date-time
3424
+ _updated_at?: string | null; // date-time
3425
+ _deleted_at?: string | null; // date-time
3426
+ /**
3427
+ * Access control list (ACL) for an entity. Defines sharing access to external orgs or users.
3428
+ */
3429
+ _acl?: {
3430
+ [name: string]: any;
3431
+ view?: string[];
3432
+ edit?: string[];
3433
+ delete?: string[];
3434
+ };
3435
+ _purpose?: string[] | null;
3436
+ /**
3437
+ * Automatically computed purpose names from _purpose attribute
3438
+ */
3439
+ _purpose_name?: string[] | null;
3440
+ /**
3441
+ * Manifest ID used to create/update the entity
3442
+ */
3443
+ _manifest?: string /* uuid */[] | null;
3444
+ };
3205
3445
  };
3206
3446
  }
3207
3447
  /**
@@ -4486,6 +4726,13 @@ declare namespace Components {
4486
4726
  *
4487
4727
  */
4488
4728
  explicit_searchable?: boolean;
4729
+ /**
4730
+ * When set to true, this attribute will be excluded from search fields.
4731
+ * Use this for fields that should not be matched during entity search operations,
4732
+ * such as internal hashes or identifiers that might accidentally match search terms.
4733
+ *
4734
+ */
4735
+ exclude_from_search?: boolean;
4489
4736
  /**
4490
4737
  * The attribute is a repeatable
4491
4738
  */
@@ -5084,6 +5331,10 @@ declare namespace Components {
5084
5331
  delete?: string[];
5085
5332
  };
5086
5333
  _purpose?: string[] | null;
5334
+ /**
5335
+ * Automatically computed purpose names from _purpose attribute
5336
+ */
5337
+ _purpose_name?: string[] | null;
5087
5338
  /**
5088
5339
  * Manifest ID used to create/update the entity
5089
5340
  */
@@ -5233,6 +5484,13 @@ declare namespace Components {
5233
5484
  *
5234
5485
  */
5235
5486
  explicit_searchable?: boolean;
5487
+ /**
5488
+ * When set to true, this attribute will be excluded from search fields.
5489
+ * Use this for fields that should not be matched during entity search operations,
5490
+ * such as internal hashes or identifiers that might accidentally match search terms.
5491
+ *
5492
+ */
5493
+ exclude_from_search?: boolean;
5236
5494
  /**
5237
5495
  * The attribute is a repeatable
5238
5496
  */
@@ -5381,6 +5639,13 @@ declare namespace Components {
5381
5639
  *
5382
5640
  */
5383
5641
  explicit_searchable?: boolean;
5642
+ /**
5643
+ * When set to true, this attribute will be excluded from search fields.
5644
+ * Use this for fields that should not be matched during entity search operations,
5645
+ * such as internal hashes or identifiers that might accidentally match search terms.
5646
+ *
5647
+ */
5648
+ exclude_from_search?: boolean;
5384
5649
  /**
5385
5650
  * The attribute is a repeatable
5386
5651
  */
@@ -5529,6 +5794,13 @@ declare namespace Components {
5529
5794
  *
5530
5795
  */
5531
5796
  explicit_searchable?: boolean;
5797
+ /**
5798
+ * When set to true, this attribute will be excluded from search fields.
5799
+ * Use this for fields that should not be matched during entity search operations,
5800
+ * such as internal hashes or identifiers that might accidentally match search terms.
5801
+ *
5802
+ */
5803
+ exclude_from_search?: boolean;
5532
5804
  /**
5533
5805
  * The attribute is a repeatable
5534
5806
  */
@@ -5685,6 +5957,13 @@ declare namespace Components {
5685
5957
  *
5686
5958
  */
5687
5959
  explicit_searchable?: boolean;
5960
+ /**
5961
+ * When set to true, this attribute will be excluded from search fields.
5962
+ * Use this for fields that should not be matched during entity search operations,
5963
+ * such as internal hashes or identifiers that might accidentally match search terms.
5964
+ *
5965
+ */
5966
+ exclude_from_search?: boolean;
5688
5967
  /**
5689
5968
  * The attribute is a repeatable
5690
5969
  */
@@ -5841,6 +6120,13 @@ declare namespace Components {
5841
6120
  *
5842
6121
  */
5843
6122
  explicit_searchable?: boolean;
6123
+ /**
6124
+ * When set to true, this attribute will be excluded from search fields.
6125
+ * Use this for fields that should not be matched during entity search operations,
6126
+ * such as internal hashes or identifiers that might accidentally match search terms.
6127
+ *
6128
+ */
6129
+ exclude_from_search?: boolean;
5844
6130
  /**
5845
6131
  * The attribute is a repeatable
5846
6132
  */
@@ -5992,6 +6278,13 @@ declare namespace Components {
5992
6278
  *
5993
6279
  */
5994
6280
  explicit_searchable?: boolean;
6281
+ /**
6282
+ * When set to true, this attribute will be excluded from search fields.
6283
+ * Use this for fields that should not be matched during entity search operations,
6284
+ * such as internal hashes or identifiers that might accidentally match search terms.
6285
+ *
6286
+ */
6287
+ exclude_from_search?: boolean;
5995
6288
  /**
5996
6289
  * The attribute is a repeatable
5997
6290
  */
@@ -6156,6 +6449,13 @@ declare namespace Components {
6156
6449
  *
6157
6450
  */
6158
6451
  explicit_searchable?: boolean;
6452
+ /**
6453
+ * When set to true, this attribute will be excluded from search fields.
6454
+ * Use this for fields that should not be matched during entity search operations,
6455
+ * such as internal hashes or identifiers that might accidentally match search terms.
6456
+ *
6457
+ */
6458
+ exclude_from_search?: boolean;
6159
6459
  /**
6160
6460
  * The attribute is a repeatable
6161
6461
  */
@@ -6313,6 +6613,13 @@ declare namespace Components {
6313
6613
  *
6314
6614
  */
6315
6615
  explicit_searchable?: boolean;
6616
+ /**
6617
+ * When set to true, this attribute will be excluded from search fields.
6618
+ * Use this for fields that should not be matched during entity search operations,
6619
+ * such as internal hashes or identifiers that might accidentally match search terms.
6620
+ *
6621
+ */
6622
+ exclude_from_search?: boolean;
6316
6623
  /**
6317
6624
  * The attribute is a repeatable
6318
6625
  */
@@ -6461,6 +6768,13 @@ declare namespace Components {
6461
6768
  *
6462
6769
  */
6463
6770
  explicit_searchable?: boolean;
6771
+ /**
6772
+ * When set to true, this attribute will be excluded from search fields.
6773
+ * Use this for fields that should not be matched during entity search operations,
6774
+ * such as internal hashes or identifiers that might accidentally match search terms.
6775
+ *
6776
+ */
6777
+ exclude_from_search?: boolean;
6464
6778
  /**
6465
6779
  * The attribute is a repeatable
6466
6780
  */
@@ -6609,6 +6923,13 @@ declare namespace Components {
6609
6923
  *
6610
6924
  */
6611
6925
  explicit_searchable?: boolean;
6926
+ /**
6927
+ * When set to true, this attribute will be excluded from search fields.
6928
+ * Use this for fields that should not be matched during entity search operations,
6929
+ * such as internal hashes or identifiers that might accidentally match search terms.
6930
+ *
6931
+ */
6932
+ exclude_from_search?: boolean;
6612
6933
  /**
6613
6934
  * The attribute is a repeatable
6614
6935
  */
@@ -6757,6 +7078,13 @@ declare namespace Components {
6757
7078
  *
6758
7079
  */
6759
7080
  explicit_searchable?: boolean;
7081
+ /**
7082
+ * When set to true, this attribute will be excluded from search fields.
7083
+ * Use this for fields that should not be matched during entity search operations,
7084
+ * such as internal hashes or identifiers that might accidentally match search terms.
7085
+ *
7086
+ */
7087
+ exclude_from_search?: boolean;
6760
7088
  /**
6761
7089
  * The attribute is a repeatable
6762
7090
  */
@@ -6905,6 +7233,13 @@ declare namespace Components {
6905
7233
  *
6906
7234
  */
6907
7235
  explicit_searchable?: boolean;
7236
+ /**
7237
+ * When set to true, this attribute will be excluded from search fields.
7238
+ * Use this for fields that should not be matched during entity search operations,
7239
+ * such as internal hashes or identifiers that might accidentally match search terms.
7240
+ *
7241
+ */
7242
+ exclude_from_search?: boolean;
6908
7243
  /**
6909
7244
  * The attribute is a repeatable
6910
7245
  */
@@ -7053,6 +7388,13 @@ declare namespace Components {
7053
7388
  *
7054
7389
  */
7055
7390
  explicit_searchable?: boolean;
7391
+ /**
7392
+ * When set to true, this attribute will be excluded from search fields.
7393
+ * Use this for fields that should not be matched during entity search operations,
7394
+ * such as internal hashes or identifiers that might accidentally match search terms.
7395
+ *
7396
+ */
7397
+ exclude_from_search?: boolean;
7056
7398
  /**
7057
7399
  * The attribute is a repeatable
7058
7400
  */
@@ -7201,6 +7543,13 @@ declare namespace Components {
7201
7543
  *
7202
7544
  */
7203
7545
  explicit_searchable?: boolean;
7546
+ /**
7547
+ * When set to true, this attribute will be excluded from search fields.
7548
+ * Use this for fields that should not be matched during entity search operations,
7549
+ * such as internal hashes or identifiers that might accidentally match search terms.
7550
+ *
7551
+ */
7552
+ exclude_from_search?: boolean;
7204
7553
  /**
7205
7554
  * The attribute is a repeatable
7206
7555
  */
@@ -7349,6 +7698,13 @@ declare namespace Components {
7349
7698
  *
7350
7699
  */
7351
7700
  explicit_searchable?: boolean;
7701
+ /**
7702
+ * When set to true, this attribute will be excluded from search fields.
7703
+ * Use this for fields that should not be matched during entity search operations,
7704
+ * such as internal hashes or identifiers that might accidentally match search terms.
7705
+ *
7706
+ */
7707
+ exclude_from_search?: boolean;
7352
7708
  /**
7353
7709
  * The attribute is a repeatable
7354
7710
  */
@@ -7497,6 +7853,13 @@ declare namespace Components {
7497
7853
  *
7498
7854
  */
7499
7855
  explicit_searchable?: boolean;
7856
+ /**
7857
+ * When set to true, this attribute will be excluded from search fields.
7858
+ * Use this for fields that should not be matched during entity search operations,
7859
+ * such as internal hashes or identifiers that might accidentally match search terms.
7860
+ *
7861
+ */
7862
+ exclude_from_search?: boolean;
7500
7863
  /**
7501
7864
  * The attribute is a repeatable
7502
7865
  */
@@ -7660,6 +8023,13 @@ declare namespace Components {
7660
8023
  *
7661
8024
  */
7662
8025
  explicit_searchable?: boolean;
8026
+ /**
8027
+ * When set to true, this attribute will be excluded from search fields.
8028
+ * Use this for fields that should not be matched during entity search operations,
8029
+ * such as internal hashes or identifiers that might accidentally match search terms.
8030
+ *
8031
+ */
8032
+ exclude_from_search?: boolean;
7663
8033
  /**
7664
8034
  * Relations are always repeatables
7665
8035
  */
@@ -7852,6 +8222,10 @@ declare namespace Components {
7852
8222
  delete?: string[];
7853
8223
  };
7854
8224
  _purpose?: string[] | null;
8225
+ /**
8226
+ * Automatically computed purpose names from _purpose attribute
8227
+ */
8228
+ _purpose_name?: string[] | null;
7855
8229
  /**
7856
8230
  * Manifest ID used to create/update the entity
7857
8231
  */
@@ -8018,6 +8392,13 @@ declare namespace Components {
8018
8392
  *
8019
8393
  */
8020
8394
  explicit_searchable?: boolean;
8395
+ /**
8396
+ * When set to true, this attribute will be excluded from search fields.
8397
+ * Use this for fields that should not be matched during entity search operations,
8398
+ * such as internal hashes or identifiers that might accidentally match search terms.
8399
+ *
8400
+ */
8401
+ exclude_from_search?: boolean;
8021
8402
  /**
8022
8403
  * The attribute is a repeatable
8023
8404
  */
@@ -8566,6 +8947,13 @@ declare namespace Components {
8566
8947
  *
8567
8948
  */
8568
8949
  explicit_searchable?: boolean;
8950
+ /**
8951
+ * When set to true, this attribute will be excluded from search fields.
8952
+ * Use this for fields that should not be matched during entity search operations,
8953
+ * such as internal hashes or identifiers that might accidentally match search terms.
8954
+ *
8955
+ */
8956
+ exclude_from_search?: boolean;
8569
8957
  /**
8570
8958
  * The attribute is a repeatable
8571
8959
  */
@@ -8722,6 +9110,13 @@ declare namespace Components {
8722
9110
  *
8723
9111
  */
8724
9112
  explicit_searchable?: boolean;
9113
+ /**
9114
+ * When set to true, this attribute will be excluded from search fields.
9115
+ * Use this for fields that should not be matched during entity search operations,
9116
+ * such as internal hashes or identifiers that might accidentally match search terms.
9117
+ *
9118
+ */
9119
+ exclude_from_search?: boolean;
8725
9120
  /**
8726
9121
  * The attribute is a repeatable
8727
9122
  */
@@ -8887,6 +9282,13 @@ declare namespace Components {
8887
9282
  *
8888
9283
  */
8889
9284
  explicit_searchable?: boolean;
9285
+ /**
9286
+ * When set to true, this attribute will be excluded from search fields.
9287
+ * Use this for fields that should not be matched during entity search operations,
9288
+ * such as internal hashes or identifiers that might accidentally match search terms.
9289
+ *
9290
+ */
9291
+ exclude_from_search?: boolean;
8890
9292
  /**
8891
9293
  * The attribute is a repeatable
8892
9294
  */
@@ -9131,6 +9533,13 @@ declare namespace Components {
9131
9533
  *
9132
9534
  */
9133
9535
  explicit_searchable?: boolean;
9536
+ /**
9537
+ * When set to true, this attribute will be excluded from search fields.
9538
+ * Use this for fields that should not be matched during entity search operations,
9539
+ * such as internal hashes or identifiers that might accidentally match search terms.
9540
+ *
9541
+ */
9542
+ exclude_from_search?: boolean;
9134
9543
  /**
9135
9544
  * The attribute is a repeatable
9136
9545
  */
@@ -9314,6 +9723,10 @@ declare namespace Components {
9314
9723
  * List of locations where the classification is enabled to be used. If empty, it's enabled for all locations.
9315
9724
  */
9316
9725
  enabled_locations?: (TaxonomyLocationId | string)[];
9726
+ /**
9727
+ * List of purpose slugs where the classification is enabled to be used. If empty, it's enabled for all purposes.
9728
+ */
9729
+ enabled_purposes?: string[];
9317
9730
  /**
9318
9731
  * Manifest ID used to create/update the taxonomy classification
9319
9732
  */
@@ -9477,6 +9890,13 @@ declare namespace Components {
9477
9890
  *
9478
9891
  */
9479
9892
  explicit_searchable?: boolean;
9893
+ /**
9894
+ * When set to true, this attribute will be excluded from search fields.
9895
+ * Use this for fields that should not be matched during entity search operations,
9896
+ * such as internal hashes or identifiers that might accidentally match search terms.
9897
+ *
9898
+ */
9899
+ exclude_from_search?: boolean;
9480
9900
  /**
9481
9901
  * The attribute is a repeatable
9482
9902
  */
@@ -9638,6 +10058,13 @@ declare namespace Components {
9638
10058
  *
9639
10059
  */
9640
10060
  explicit_searchable?: boolean;
10061
+ /**
10062
+ * When set to true, this attribute will be excluded from search fields.
10063
+ * Use this for fields that should not be matched during entity search operations,
10064
+ * such as internal hashes or identifiers that might accidentally match search terms.
10065
+ *
10066
+ */
10067
+ exclude_from_search?: boolean;
9641
10068
  /**
9642
10069
  * The attribute is a repeatable
9643
10070
  */
@@ -11312,6 +11739,16 @@ declare namespace Paths {
11312
11739
  export type From = number;
11313
11740
  export type Hydrate = boolean;
11314
11741
  export type Id = Components.Schemas.EntityId /* uuid */;
11742
+ export type IncludeDeleted = /**
11743
+ * Whether to include deleted entities in the search results
11744
+ * - `true`: include deleted entities
11745
+ * - `false`: exclude deleted entities
11746
+ * - `only`: include only deleted entities
11747
+ *
11748
+ * By default, no deleted entities are included in the search results.
11749
+ *
11750
+ */
11751
+ Components.Schemas.EntitySearchIncludeDeletedParam;
11315
11752
  export type IncludeReverse = boolean;
11316
11753
  export type IncludeSchemas = /**
11317
11754
  * URL-friendly identifier for the entity schema
@@ -11341,6 +11778,7 @@ declare namespace Paths {
11341
11778
  exclude_schemas?: Parameters.ExcludeSchemas;
11342
11779
  mode?: Parameters.Mode;
11343
11780
  fields?: Parameters.Fields;
11781
+ include_deleted?: Parameters.IncludeDeleted;
11344
11782
  }
11345
11783
  namespace Responses {
11346
11784
  export type $200 = Components.Schemas.GetRelationsRespWithPagination;
@@ -11645,7 +12083,7 @@ declare namespace Paths {
11645
12083
  /**
11646
12084
  * ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).
11647
12085
  * example:
11648
- * 2023-01-01T00:00:00.000Z
12086
+ * 2023-01-01T00:00:00Z
11649
12087
  */
11650
12088
  export type CreatedAfter = string; // date-time
11651
12089
  /**
@@ -11671,7 +12109,7 @@ declare namespace Paths {
11671
12109
  created_after?: /**
11672
12110
  * ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).
11673
12111
  * example:
11674
- * 2023-01-01T00:00:00.000Z
12112
+ * 2023-01-01T00:00:00Z
11675
12113
  */
11676
12114
  Parameters.CreatedAfter /* date-time */;
11677
12115
  sort_pending_first?: /* When true, sorts PENDING status jobs to the top of the results. */ Parameters.SortPendingFirst;
@@ -13037,6 +13475,7 @@ declare namespace Paths {
13037
13475
  }
13038
13476
  }
13039
13477
 
13478
+
13040
13479
  export interface OperationMethods {
13041
13480
  /**
13042
13481
  * listSchemas - listSchemas
@@ -15355,6 +15794,7 @@ export interface PathsDictionary {
15355
15794
 
15356
15795
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
15357
15796
 
15797
+
15358
15798
  export type Activity = Components.Schemas.Activity;
15359
15799
  export type ActivityCallerContext = Components.Schemas.ActivityCallerContext;
15360
15800
  export type ActivityId = Components.Schemas.ActivityId;
package/dist/openapi.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "openapi": "3.0.2",
3
3
  "info": {
4
4
  "title": "Entity API",
5
- "version": "2.3.0",
5
+ "version": "2.6.0",
6
6
  "description": "Flexible data layer for epilot Entities.\n\nUse this API configure and access your business objects like Contacts, Opportunities and Products.\n\n[Feature Documentation](https://docs.epilot.io/docs/entities/flexible-entities)\n"
7
7
  },
8
8
  "tags": [
@@ -2284,6 +2284,15 @@
2284
2284
  "schema": {
2285
2285
  "$ref": "#/components/schemas/FieldsParam"
2286
2286
  }
2287
+ },
2288
+ {
2289
+ "in": "query",
2290
+ "name": "include_deleted",
2291
+ "description": "Whether to include relations to/from deleted entities\n- `true`: include relations to/from deleted entities\n- `false`: exclude relations to/from deleted entities (default)\n- `only`: include only relations to/from deleted entities\n",
2292
+ "required": false,
2293
+ "schema": {
2294
+ "$ref": "#/components/schemas/EntitySearchIncludeDeletedParam"
2295
+ }
2287
2296
  }
2288
2297
  ],
2289
2298
  "responses": {
@@ -2986,9 +2995,9 @@
2986
2995
  "name": "permanent",
2987
2996
  "description": "⚠️ NOT IMPLEMENTED - If true, the taxonomy will be permanently deleted",
2988
2997
  "schema": {
2989
- "type": "boolean"
2990
- },
2991
- "default": false
2998
+ "type": "boolean",
2999
+ "default": false
3000
+ }
2992
3001
  }
2993
3002
  ],
2994
3003
  "responses": {
@@ -3438,7 +3447,7 @@
3438
3447
  "description": "ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).",
3439
3448
  "type": "string",
3440
3449
  "format": "date-time",
3441
- "example": "2023-01-01T00:00:00.000Z"
3450
+ "example": "2023-01-01T00:00:00Z"
3442
3451
  }
3443
3452
  },
3444
3453
  {
@@ -5194,6 +5203,11 @@
5194
5203
  "description": "When set to true, this attribute will always be searchable regardless of\nthe ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields\nthat must always be included in search operations.\n",
5195
5204
  "default": false
5196
5205
  },
5206
+ "exclude_from_search": {
5207
+ "type": "boolean",
5208
+ "description": "When set to true, this attribute will be excluded from search fields.\nUse this for fields that should not be matched during entity search operations,\nsuch as internal hashes or identifiers that might accidentally match search terms.\n",
5209
+ "default": false
5210
+ },
5197
5211
  "repeatable": {
5198
5212
  "description": "The attribute is a repeatable",
5199
5213
  "type": "boolean"
@@ -5938,7 +5952,7 @@
5938
5952
  "DefaultAddressFields": {
5939
5953
  "type": "array",
5940
5954
  "nullable": true,
5941
- "description": "Default 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 - additional_info\n - coordinates\n - start_date\n - end_date\n - salutation\n - title\n - first_name\n - last_name\n - company_name\n",
5955
+ "description": "Default 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 - title\n - first_name\n - last_name\n - name_suffix\n - company_name\n",
5942
5956
  "items": {
5943
5957
  "type": "string"
5944
5958
  }
@@ -6982,6 +6996,14 @@
6982
6996
  },
6983
6997
  "nullable": true
6984
6998
  },
6999
+ "_purpose_name": {
7000
+ "description": "Automatically computed purpose names from _purpose attribute",
7001
+ "type": "array",
7002
+ "items": {
7003
+ "type": "string"
7004
+ },
7005
+ "nullable": true
7006
+ },
6985
7007
  "_manifest": {
6986
7008
  "type": "array",
6987
7009
  "description": "Manifest ID used to create/update the entity",
@@ -8386,13 +8408,34 @@
8386
8408
  "type": "object",
8387
8409
  "properties": {
8388
8410
  "added": {
8389
- "$ref": "#/components/schemas/Entity"
8411
+ "allOf": [
8412
+ {
8413
+ "description": "New attributes added to the entity as part of the operation"
8414
+ },
8415
+ {
8416
+ "$ref": "#/components/schemas/Entity"
8417
+ }
8418
+ ]
8390
8419
  },
8391
8420
  "updated": {
8392
- "$ref": "#/components/schemas/Entity"
8421
+ "allOf": [
8422
+ {
8423
+ "description": "Attributes updated in the entity. Note: These values contain the previous values before the update!"
8424
+ },
8425
+ {
8426
+ "$ref": "#/components/schemas/Entity"
8427
+ }
8428
+ ]
8393
8429
  },
8394
8430
  "deleted": {
8395
- "$ref": "#/components/schemas/Entity"
8431
+ "allOf": [
8432
+ {
8433
+ "description": "Attributes removed from the entity as part of the operation"
8434
+ },
8435
+ {
8436
+ "$ref": "#/components/schemas/Entity"
8437
+ }
8438
+ ]
8396
8439
  }
8397
8440
  }
8398
8441
  }
@@ -8795,6 +8838,13 @@
8795
8838
  ]
8796
8839
  }
8797
8840
  },
8841
+ "enabled_purposes": {
8842
+ "description": "List of purpose slugs where the classification is enabled to be used. If empty, it's enabled for all purposes.",
8843
+ "type": "array",
8844
+ "items": {
8845
+ "type": "string"
8846
+ }
8847
+ },
8798
8848
  "_manifest": {
8799
8849
  "type": "array",
8800
8850
  "description": "Manifest ID used to create/update the taxonomy classification",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/entity-client",
3
- "version": "6.11.4",
3
+ "version": "6.12.1",
4
4
  "description": "JavaScript client library for the epilot Core Entity API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",