@epilot/entity-client 6.12.0 → 6.13.0

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.
package/dist/client.d.ts CHANGED
File without changes
package/dist/client.js CHANGED
File without changes
File without changes
@@ -1 +1 @@
1
- (()=>{"use strict";var e={390: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"}],"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}(390),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","style":"form","explode":false},{"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/index.d.ts CHANGED
File without changes
package/dist/index.js CHANGED
File without changes
@@ -558,7 +558,9 @@
558
558
  },
559
559
  {
560
560
  "in": "query",
561
- "name": "type"
561
+ "name": "type",
562
+ "style": "form",
563
+ "explode": false
562
564
  },
563
565
  {
564
566
  "in": "query",
@@ -723,6 +725,11 @@
723
725
  {
724
726
  "in": "query",
725
727
  "name": "fields"
728
+ },
729
+ {
730
+ "in": "query",
731
+ "name": "include_deleted",
732
+ "required": false
726
733
  }
727
734
  ],
728
735
  "responses": {}
@@ -1005,8 +1012,7 @@
1005
1012
  },
1006
1013
  {
1007
1014
  "in": "query",
1008
- "name": "permanent",
1009
- "default": false
1015
+ "name": "permanent"
1010
1016
  }
1011
1017
  ],
1012
1018
  "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,12 +6449,23 @@ 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
  */
6162
6462
  repeatable?: boolean;
6163
6463
  has_primary?: boolean;
6164
6464
  type: "number";
6465
+ /**
6466
+ * Optional data type override. When set to 'number', the value is stored as a number instead of a string. Defaults to 'string'.
6467
+ */
6468
+ data_type?: "number" | "string";
6165
6469
  format?: string;
6166
6470
  /**
6167
6471
  * Whether or not to show a thousands separator
@@ -6309,6 +6613,13 @@ declare namespace Components {
6309
6613
  *
6310
6614
  */
6311
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;
6312
6623
  /**
6313
6624
  * The attribute is a repeatable
6314
6625
  */
@@ -6457,6 +6768,13 @@ declare namespace Components {
6457
6768
  *
6458
6769
  */
6459
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;
6460
6778
  /**
6461
6779
  * The attribute is a repeatable
6462
6780
  */
@@ -6605,6 +6923,13 @@ declare namespace Components {
6605
6923
  *
6606
6924
  */
6607
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;
6608
6933
  /**
6609
6934
  * The attribute is a repeatable
6610
6935
  */
@@ -6753,6 +7078,13 @@ declare namespace Components {
6753
7078
  *
6754
7079
  */
6755
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;
6756
7088
  /**
6757
7089
  * The attribute is a repeatable
6758
7090
  */
@@ -6901,6 +7233,13 @@ declare namespace Components {
6901
7233
  *
6902
7234
  */
6903
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;
6904
7243
  /**
6905
7244
  * The attribute is a repeatable
6906
7245
  */
@@ -7049,6 +7388,13 @@ declare namespace Components {
7049
7388
  *
7050
7389
  */
7051
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;
7052
7398
  /**
7053
7399
  * The attribute is a repeatable
7054
7400
  */
@@ -7197,6 +7543,13 @@ declare namespace Components {
7197
7543
  *
7198
7544
  */
7199
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;
7200
7553
  /**
7201
7554
  * The attribute is a repeatable
7202
7555
  */
@@ -7345,6 +7698,13 @@ declare namespace Components {
7345
7698
  *
7346
7699
  */
7347
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;
7348
7708
  /**
7349
7709
  * The attribute is a repeatable
7350
7710
  */
@@ -7493,6 +7853,13 @@ declare namespace Components {
7493
7853
  *
7494
7854
  */
7495
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;
7496
7863
  /**
7497
7864
  * The attribute is a repeatable
7498
7865
  */
@@ -7656,6 +8023,13 @@ declare namespace Components {
7656
8023
  *
7657
8024
  */
7658
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;
7659
8033
  /**
7660
8034
  * Relations are always repeatables
7661
8035
  */
@@ -7848,6 +8222,10 @@ declare namespace Components {
7848
8222
  delete?: string[];
7849
8223
  };
7850
8224
  _purpose?: string[] | null;
8225
+ /**
8226
+ * Automatically computed purpose names from _purpose attribute
8227
+ */
8228
+ _purpose_name?: string[] | null;
7851
8229
  /**
7852
8230
  * Manifest ID used to create/update the entity
7853
8231
  */
@@ -8014,6 +8392,13 @@ declare namespace Components {
8014
8392
  *
8015
8393
  */
8016
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;
8017
8402
  /**
8018
8403
  * The attribute is a repeatable
8019
8404
  */
@@ -8562,6 +8947,13 @@ declare namespace Components {
8562
8947
  *
8563
8948
  */
8564
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;
8565
8957
  /**
8566
8958
  * The attribute is a repeatable
8567
8959
  */
@@ -8718,6 +9110,13 @@ declare namespace Components {
8718
9110
  *
8719
9111
  */
8720
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;
8721
9120
  /**
8722
9121
  * The attribute is a repeatable
8723
9122
  */
@@ -8883,6 +9282,13 @@ declare namespace Components {
8883
9282
  *
8884
9283
  */
8885
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;
8886
9292
  /**
8887
9293
  * The attribute is a repeatable
8888
9294
  */
@@ -9127,6 +9533,13 @@ declare namespace Components {
9127
9533
  *
9128
9534
  */
9129
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;
9130
9543
  /**
9131
9544
  * The attribute is a repeatable
9132
9545
  */
@@ -9306,6 +9719,14 @@ declare namespace Components {
9306
9719
  * Starred taxonomy classifications can represent "favorites" or commonly used classifications
9307
9720
  */
9308
9721
  starred?: boolean;
9722
+ /**
9723
+ * List of locations where the classification is enabled to be used. If empty, it's enabled for all locations.
9724
+ */
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[];
9309
9730
  /**
9310
9731
  * Manifest ID used to create/update the taxonomy classification
9311
9732
  */
@@ -9469,6 +9890,13 @@ declare namespace Components {
9469
9890
  *
9470
9891
  */
9471
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;
9472
9900
  /**
9473
9901
  * The attribute is a repeatable
9474
9902
  */
@@ -9630,6 +10058,13 @@ declare namespace Components {
9630
10058
  *
9631
10059
  */
9632
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;
9633
10068
  /**
9634
10069
  * The attribute is a repeatable
9635
10070
  */
@@ -10662,9 +11097,12 @@ declare namespace Paths {
10662
11097
  export type StartDate = string; // date-time
10663
11098
  /**
10664
11099
  * example:
10665
- * SyncActivity
11100
+ * [
11101
+ * "EntityUpdated",
11102
+ * "EntityCreated"
11103
+ * ]
10666
11104
  */
10667
- export type Type = string;
11105
+ export type Type = string[];
10668
11106
  }
10669
11107
  export interface PathParameters {
10670
11108
  slug: Parameters.Slug;
@@ -10684,7 +11122,10 @@ declare namespace Paths {
10684
11122
  size?: Parameters.Size;
10685
11123
  type?: /**
10686
11124
  * example:
10687
- * SyncActivity
11125
+ * [
11126
+ * "EntityUpdated",
11127
+ * "EntityCreated"
11128
+ * ]
10688
11129
  */
10689
11130
  Parameters.Type;
10690
11131
  include_relations?: Parameters.IncludeRelations;
@@ -11304,6 +11745,16 @@ declare namespace Paths {
11304
11745
  export type From = number;
11305
11746
  export type Hydrate = boolean;
11306
11747
  export type Id = Components.Schemas.EntityId /* uuid */;
11748
+ export type IncludeDeleted = /**
11749
+ * Whether to include deleted entities in the search results
11750
+ * - `true`: include deleted entities
11751
+ * - `false`: exclude deleted entities
11752
+ * - `only`: include only deleted entities
11753
+ *
11754
+ * By default, no deleted entities are included in the search results.
11755
+ *
11756
+ */
11757
+ Components.Schemas.EntitySearchIncludeDeletedParam;
11307
11758
  export type IncludeReverse = boolean;
11308
11759
  export type IncludeSchemas = /**
11309
11760
  * URL-friendly identifier for the entity schema
@@ -11333,6 +11784,7 @@ declare namespace Paths {
11333
11784
  exclude_schemas?: Parameters.ExcludeSchemas;
11334
11785
  mode?: Parameters.Mode;
11335
11786
  fields?: Parameters.Fields;
11787
+ include_deleted?: Parameters.IncludeDeleted;
11336
11788
  }
11337
11789
  namespace Responses {
11338
11790
  export type $200 = Components.Schemas.GetRelationsRespWithPagination;
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.2.0",
5
+ "version": "2.7.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": [
@@ -1883,10 +1883,18 @@
1883
1883
  {
1884
1884
  "in": "query",
1885
1885
  "name": "type",
1886
- "description": "Filter by activity type",
1886
+ "description": "Filter by activity type(s)",
1887
+ "style": "form",
1888
+ "explode": false,
1887
1889
  "schema": {
1888
- "type": "string",
1889
- "example": "SyncActivity"
1890
+ "type": "array",
1891
+ "items": {
1892
+ "type": "string"
1893
+ },
1894
+ "example": [
1895
+ "EntityUpdated",
1896
+ "EntityCreated"
1897
+ ]
1890
1898
  }
1891
1899
  },
1892
1900
  {
@@ -2284,6 +2292,15 @@
2284
2292
  "schema": {
2285
2293
  "$ref": "#/components/schemas/FieldsParam"
2286
2294
  }
2295
+ },
2296
+ {
2297
+ "in": "query",
2298
+ "name": "include_deleted",
2299
+ "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",
2300
+ "required": false,
2301
+ "schema": {
2302
+ "$ref": "#/components/schemas/EntitySearchIncludeDeletedParam"
2303
+ }
2287
2304
  }
2288
2305
  ],
2289
2306
  "responses": {
@@ -2986,9 +3003,9 @@
2986
3003
  "name": "permanent",
2987
3004
  "description": "⚠️ NOT IMPLEMENTED - If true, the taxonomy will be permanently deleted",
2988
3005
  "schema": {
2989
- "type": "boolean"
2990
- },
2991
- "default": false
3006
+ "type": "boolean",
3007
+ "default": false
3008
+ }
2992
3009
  }
2993
3010
  ],
2994
3011
  "responses": {
@@ -5194,6 +5211,11 @@
5194
5211
  "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
5212
  "default": false
5196
5213
  },
5214
+ "exclude_from_search": {
5215
+ "type": "boolean",
5216
+ "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",
5217
+ "default": false
5218
+ },
5197
5219
  "repeatable": {
5198
5220
  "description": "The attribute is a repeatable",
5199
5221
  "type": "boolean"
@@ -5938,7 +5960,7 @@
5938
5960
  "DefaultAddressFields": {
5939
5961
  "type": "array",
5940
5962
  "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",
5963
+ "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
5964
  "items": {
5943
5965
  "type": "string"
5944
5966
  }
@@ -6188,6 +6210,15 @@
6188
6210
  "number"
6189
6211
  ]
6190
6212
  },
6213
+ "data_type": {
6214
+ "type": "string",
6215
+ "enum": [
6216
+ "number",
6217
+ "string"
6218
+ ],
6219
+ "default": "string",
6220
+ "description": "Optional data type override. When set to 'number', the value is stored as a number instead of a string. Defaults to 'string'."
6221
+ },
6191
6222
  "format": {
6192
6223
  "type": "string"
6193
6224
  },
@@ -6973,6 +7004,14 @@
6973
7004
  },
6974
7005
  "nullable": true
6975
7006
  },
7007
+ "_purpose_name": {
7008
+ "description": "Automatically computed purpose names from _purpose attribute",
7009
+ "type": "array",
7010
+ "items": {
7011
+ "type": "string"
7012
+ },
7013
+ "nullable": true
7014
+ },
6976
7015
  "_manifest": {
6977
7016
  "type": "array",
6978
7017
  "description": "Manifest ID used to create/update the entity",
@@ -8377,13 +8416,34 @@
8377
8416
  "type": "object",
8378
8417
  "properties": {
8379
8418
  "added": {
8380
- "$ref": "#/components/schemas/Entity"
8419
+ "allOf": [
8420
+ {
8421
+ "description": "New attributes added to the entity as part of the operation"
8422
+ },
8423
+ {
8424
+ "$ref": "#/components/schemas/Entity"
8425
+ }
8426
+ ]
8381
8427
  },
8382
8428
  "updated": {
8383
- "$ref": "#/components/schemas/Entity"
8429
+ "allOf": [
8430
+ {
8431
+ "description": "Attributes updated in the entity. Note: These values contain the previous values before the update!"
8432
+ },
8433
+ {
8434
+ "$ref": "#/components/schemas/Entity"
8435
+ }
8436
+ ]
8384
8437
  },
8385
8438
  "deleted": {
8386
- "$ref": "#/components/schemas/Entity"
8439
+ "allOf": [
8440
+ {
8441
+ "description": "Attributes removed from the entity as part of the operation"
8442
+ },
8443
+ {
8444
+ "$ref": "#/components/schemas/Entity"
8445
+ }
8446
+ ]
8387
8447
  }
8388
8448
  }
8389
8449
  }
@@ -8772,6 +8832,27 @@
8772
8832
  "description": "Starred taxonomy classifications can represent \"favorites\" or commonly used classifications",
8773
8833
  "default": false
8774
8834
  },
8835
+ "enabled_locations": {
8836
+ "description": "List of locations where the classification is enabled to be used. If empty, it's enabled for all locations.",
8837
+ "type": "array",
8838
+ "items": {
8839
+ "anyOf": [
8840
+ {
8841
+ "$ref": "#/components/schemas/TaxonomyLocationId"
8842
+ },
8843
+ {
8844
+ "type": "string"
8845
+ }
8846
+ ]
8847
+ }
8848
+ },
8849
+ "enabled_purposes": {
8850
+ "description": "List of purpose slugs where the classification is enabled to be used. If empty, it's enabled for all purposes.",
8851
+ "type": "array",
8852
+ "items": {
8853
+ "type": "string"
8854
+ }
8855
+ },
8775
8856
  "_manifest": {
8776
8857
  "type": "array",
8777
8858
  "description": "Manifest ID used to create/update the taxonomy classification",
@@ -9965,9 +10046,6 @@
9965
10046
  }
9966
10047
  },
9967
10048
  "servers": [
9968
- {
9969
- "url": "https://entity.sls.epilot.io"
9970
- },
9971
10049
  {
9972
10050
  "url": "https://entity.sls.epilot.io"
9973
10051
  }
File without changes
File without changes
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/entity-client",
3
- "version": "6.12.0",
3
+ "version": "6.13.0",
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",