@epilot/entity-client 4.29.2 → 4.30.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/README.md CHANGED
@@ -7,7 +7,7 @@
7
7
 
8
8
  Client library for epilot [Entity API](https://docs.epilot.io/api/entity)
9
9
 
10
- Uses [`openapi-client-axios`](https://github.com/anttiviljami/openapi-client-axios)
10
+ Uses [`openapi-client-axios`](https://github.com/openapistack/openapi-client-axios)
11
11
 
12
12
  ## Installation
13
13
 
@@ -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"}],"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/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/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","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"},{"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}":{"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"}],"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"}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"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/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"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"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"}],"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"}],"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":{}},"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"}],"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}: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":[{"$ref":"#/components/parameters/TaxonomySlugQueryParamOptional"},{"in":"query","name":"query"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"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":{}}},"/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/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/public/idp/.well-known/jwks.json":{"get":{"operationId":"getESPublicJwks","responses":{}}},"/v1/entity/public/idp/.well-known/openid-configuration":{"get":{"operationId":"getESTokenOIDC","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}}},"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={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"}],"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/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/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","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"},{"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"}],"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"}],"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"}],"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","default":false}],"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/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"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"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"}],"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":{}},"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"}],"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}: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":[{"$ref":"#/components/parameters/TaxonomySlugQueryParamOptional"},{"in":"query","name":"query"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"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":{}}},"/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/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":{}}}},"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}}},"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})})();
@@ -240,6 +240,23 @@
240
240
  "responses": {}
241
241
  }
242
242
  },
243
+ "/v1/entity/{slug}/{id}:restore": {
244
+ "patch": {
245
+ "operationId": "restoreEntity",
246
+ "parameters": [
247
+ {
248
+ "$ref": "#/components/parameters/EntityIdPathParam"
249
+ },
250
+ {
251
+ "$ref": "#/components/parameters/EntitySlugPathParam"
252
+ },
253
+ {
254
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
255
+ }
256
+ ],
257
+ "responses": {}
258
+ }
259
+ },
243
260
  "/v1/entity/{slug}/{id}": {
244
261
  "get": {
245
262
  "operationId": "getEntity",
@@ -323,6 +340,11 @@
323
340
  },
324
341
  {
325
342
  "$ref": "#/components/parameters/ActivityIdQueryParam"
343
+ },
344
+ {
345
+ "in": "query",
346
+ "name": "purge",
347
+ "default": false
326
348
  }
327
349
  ],
328
350
  "responses": {}
@@ -512,6 +534,9 @@
512
534
  },
513
535
  {
514
536
  "$ref": "#/components/parameters/AsyncOperationQueryParam"
537
+ },
538
+ {
539
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
515
540
  }
516
541
  ],
517
542
  "requestBody": {
@@ -1122,18 +1147,6 @@
1122
1147
  ],
1123
1148
  "responses": {}
1124
1149
  }
1125
- },
1126
- "/v1/entity/public/idp/.well-known/jwks.json": {
1127
- "get": {
1128
- "operationId": "getESPublicJwks",
1129
- "responses": {}
1130
- }
1131
- },
1132
- "/v1/entity/public/idp/.well-known/openid-configuration": {
1133
- "get": {
1134
- "operationId": "getESTokenOIDC",
1135
- "responses": {}
1136
- }
1137
1150
  }
1138
1151
  },
1139
1152
  "components": {
package/dist/openapi.d.ts CHANGED
@@ -721,7 +721,10 @@ declare namespace Components {
721
721
  * "delete": [
722
722
  * "org:456"
723
723
  * ]
724
- * }
724
+ * },
725
+ * "_manifest": [
726
+ * "123e4567-e89b-12d3-a456-426614174000"
727
+ * ]
725
728
  * }
726
729
  */
727
730
  export interface BaseEntity {
@@ -753,6 +756,10 @@ declare namespace Components {
753
756
  _updated_at: string | null; // date-time
754
757
  _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
755
758
  _purpose?: string[] | null;
759
+ /**
760
+ * Manifest ID used to create/update the entity
761
+ */
762
+ _manifest?: string /* uuid */[] | null;
756
763
  }
757
764
  /**
758
765
  * Reference to blueprint
@@ -1621,7 +1628,10 @@ declare namespace Components {
1621
1628
  * "delete": [
1622
1629
  * "org:456"
1623
1630
  * ]
1624
- * }
1631
+ * },
1632
+ * "_manifest": [
1633
+ * "123e4567-e89b-12d3-a456-426614174000"
1634
+ * ]
1625
1635
  * }
1626
1636
  */
1627
1637
  export interface Entity {
@@ -1653,6 +1663,10 @@ declare namespace Components {
1653
1663
  _updated_at?: string | null; // date-time
1654
1664
  _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
1655
1665
  _purpose?: string[] | null;
1666
+ /**
1667
+ * Manifest ID used to create/update the entity
1668
+ */
1669
+ _manifest?: string /* uuid */[] | null;
1656
1670
  }
1657
1671
  /**
1658
1672
  * Access control list (ACL) for an entity. Defines sharing access to external orgs or users.
@@ -2035,7 +2049,11 @@ declare namespace Components {
2035
2049
  * "org:456",
2036
2050
  * "org:456"
2037
2051
  * ]
2038
- * }
2052
+ * },
2053
+ * "_manifest": [
2054
+ * "123e4567-e89b-12d3-a456-426614174000",
2055
+ * "123e4567-e89b-12d3-a456-426614174000"
2056
+ * ]
2039
2057
  * }
2040
2058
  */
2041
2059
  export interface EntityItem {
@@ -2067,6 +2085,10 @@ declare namespace Components {
2067
2085
  _updated_at: string | null; // date-time
2068
2086
  _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
2069
2087
  _purpose?: string[] | null;
2088
+ /**
2089
+ * Manifest ID used to create/update the entity
2090
+ */
2091
+ _manifest?: string /* uuid */[] | null;
2070
2092
  }
2071
2093
  export interface EntityListParams {
2072
2094
  filter: /**
@@ -2137,6 +2159,16 @@ declare namespace Components {
2137
2159
  aggs?: {
2138
2160
  [key: string]: any;
2139
2161
  };
2162
+ include_archived?: /**
2163
+ * Whether to include archived entities in the search results
2164
+ * - `true`: include archived entities
2165
+ * - `false`: exclude archived entities
2166
+ * - `only`: include only archived entities
2167
+ *
2168
+ * By default, no archived entities are included in the search results.
2169
+ *
2170
+ */
2171
+ EntitySearchArchiveParam;
2140
2172
  }
2141
2173
  export interface EntityOperation {
2142
2174
  entity: EntityId /* uuid */;
@@ -2198,6 +2230,9 @@ declare namespace Components {
2198
2230
  * "org:456"
2199
2231
  * ]
2200
2232
  * },
2233
+ * "_manifest": [
2234
+ * "123e4567-e89b-12d3-a456-426614174000"
2235
+ * ],
2201
2236
  * "status": "Inactive"
2202
2237
  * }
2203
2238
  */
@@ -2230,6 +2265,10 @@ declare namespace Components {
2230
2265
  _updated_at?: string | null; // date-time
2231
2266
  _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
2232
2267
  _purpose?: string[] | null;
2268
+ /**
2269
+ * Manifest ID used to create/update the entity
2270
+ */
2271
+ _manifest?: string /* uuid */[] | null;
2233
2272
  };
2234
2273
  diff?: {
2235
2274
  added?: /**
@@ -2261,7 +2300,10 @@ declare namespace Components {
2261
2300
  * "delete": [
2262
2301
  * "org:456"
2263
2302
  * ]
2264
- * }
2303
+ * },
2304
+ * "_manifest": [
2305
+ * "123e4567-e89b-12d3-a456-426614174000"
2306
+ * ]
2265
2307
  * }
2266
2308
  */
2267
2309
  Entity;
@@ -2294,7 +2336,10 @@ declare namespace Components {
2294
2336
  * "delete": [
2295
2337
  * "org:456"
2296
2338
  * ]
2297
- * }
2339
+ * },
2340
+ * "_manifest": [
2341
+ * "123e4567-e89b-12d3-a456-426614174000"
2342
+ * ]
2298
2343
  * }
2299
2344
  */
2300
2345
  Entity;
@@ -2327,7 +2372,10 @@ declare namespace Components {
2327
2372
  * "delete": [
2328
2373
  * "org:456"
2329
2374
  * ]
2330
- * }
2375
+ * },
2376
+ * "_manifest": [
2377
+ * "123e4567-e89b-12d3-a456-426614174000"
2378
+ * ]
2331
2379
  * }
2332
2380
  */
2333
2381
  Entity;
@@ -2921,6 +2969,16 @@ declare namespace Components {
2921
2969
  */
2922
2970
  SearchMappings;
2923
2971
  }
2972
+ /**
2973
+ * Whether to include archived entities in the search results
2974
+ * - `true`: include archived entities
2975
+ * - `false`: exclude archived entities
2976
+ * - `only`: include only archived entities
2977
+ *
2978
+ * By default, no archived entities are included in the search results.
2979
+ *
2980
+ */
2981
+ export type EntitySearchArchiveParam = "true" | "false" | "only";
2924
2982
  export interface EntitySearchOptions {
2925
2983
  /**
2926
2984
  * You can pass one sort field or an array of sort fields. Each sort field can be a string
@@ -2967,6 +3025,16 @@ declare namespace Components {
2967
3025
  aggs?: {
2968
3026
  [key: string]: any;
2969
3027
  };
3028
+ include_archived?: /**
3029
+ * Whether to include archived entities in the search results
3030
+ * - `true`: include archived entities
3031
+ * - `false`: exclude archived entities
3032
+ * - `only`: include only archived entities
3033
+ *
3034
+ * By default, no archived entities are included in the search results.
3035
+ *
3036
+ */
3037
+ EntitySearchArchiveParam;
2970
3038
  }
2971
3039
  export interface EntitySearchParams {
2972
3040
  /**
@@ -3024,6 +3092,16 @@ declare namespace Components {
3024
3092
  aggs?: {
3025
3093
  [key: string]: any;
3026
3094
  };
3095
+ include_archived?: /**
3096
+ * Whether to include archived entities in the search results
3097
+ * - `true`: include archived entities
3098
+ * - `false`: exclude archived entities
3099
+ * - `only`: include only archived entities
3100
+ *
3101
+ * By default, no archived entities are included in the search results.
3102
+ *
3103
+ */
3104
+ EntitySearchArchiveParam;
3027
3105
  }
3028
3106
  export interface EntitySearchResults {
3029
3107
  /**
@@ -3070,7 +3148,11 @@ declare namespace Components {
3070
3148
  * "org:456",
3071
3149
  * "org:456"
3072
3150
  * ]
3073
- * }
3151
+ * },
3152
+ * "_manifest": [
3153
+ * "123e4567-e89b-12d3-a456-426614174000",
3154
+ * "123e4567-e89b-12d3-a456-426614174000"
3155
+ * ]
3074
3156
  * }
3075
3157
  */
3076
3158
  EntityItem[];
@@ -3426,7 +3508,10 @@ declare namespace Components {
3426
3508
  * "delete": [
3427
3509
  * "org:456"
3428
3510
  * ]
3429
- * }
3511
+ * },
3512
+ * "_manifest": [
3513
+ * "123e4567-e89b-12d3-a456-426614174000"
3514
+ * ]
3430
3515
  * }
3431
3516
  */
3432
3517
  RelationEntity)[];
@@ -3536,6 +3621,9 @@ declare namespace Components {
3536
3621
  * "org:456"
3537
3622
  * ]
3538
3623
  * },
3624
+ * "_manifest": [
3625
+ * "123e4567-e89b-12d3-a456-426614174000"
3626
+ * ],
3539
3627
  * "_relations": [
3540
3628
  * {
3541
3629
  * "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
@@ -3622,6 +3710,10 @@ declare namespace Components {
3622
3710
  _updated_at: string | null; // date-time
3623
3711
  _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
3624
3712
  _purpose?: string[] | null;
3713
+ /**
3714
+ * Manifest ID used to create/update the entity
3715
+ */
3716
+ _manifest?: string /* uuid */[] | null;
3625
3717
  _relations: {
3626
3718
  entity_id: EntityId /* uuid */;
3627
3719
  }[];
@@ -5395,7 +5487,11 @@ declare namespace Components {
5395
5487
  * "org:456",
5396
5488
  * "org:456"
5397
5489
  * ]
5398
- * }
5490
+ * },
5491
+ * "_manifest": [
5492
+ * "123e4567-e89b-12d3-a456-426614174000",
5493
+ * "123e4567-e89b-12d3-a456-426614174000"
5494
+ * ]
5399
5495
  * }
5400
5496
  */
5401
5497
  new_entity_item?: {
@@ -5427,6 +5523,10 @@ declare namespace Components {
5427
5523
  _updated_at: string | null; // date-time
5428
5524
  _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
5429
5525
  _purpose?: string[] | null;
5526
+ /**
5527
+ * Manifest ID used to create/update the entity
5528
+ */
5529
+ _manifest?: string /* uuid */[] | null;
5430
5530
  };
5431
5531
  }[];
5432
5532
  drawer_size?: "small" | "medium" | "large";
@@ -5480,7 +5580,10 @@ declare namespace Components {
5480
5580
  * "delete": [
5481
5581
  * "org:456"
5482
5582
  * ]
5483
- * }
5583
+ * },
5584
+ * "_manifest": [
5585
+ * "123e4567-e89b-12d3-a456-426614174000"
5586
+ * ]
5484
5587
  * }
5485
5588
  */
5486
5589
  export interface RelationEntity {
@@ -5512,6 +5615,10 @@ declare namespace Components {
5512
5615
  _updated_at: string | null; // date-time
5513
5616
  _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
5514
5617
  _purpose?: string[] | null;
5618
+ /**
5619
+ * Manifest ID used to create/update the entity
5620
+ */
5621
+ _manifest?: string /* uuid */[] | null;
5515
5622
  $relation?: RelationItem;
5516
5623
  }
5517
5624
  export interface RelationItem {
@@ -7141,7 +7248,10 @@ declare namespace Paths {
7141
7248
  * "delete": [
7142
7249
  * "org:456"
7143
7250
  * ]
7144
- * }
7251
+ * },
7252
+ * "_manifest": [
7253
+ * "123e4567-e89b-12d3-a456-426614174000"
7254
+ * ]
7145
7255
  * }
7146
7256
  */
7147
7257
  Components.Schemas.Entity;
@@ -7185,7 +7295,11 @@ declare namespace Paths {
7185
7295
  * "org:456",
7186
7296
  * "org:456"
7187
7297
  * ]
7188
- * }
7298
+ * },
7299
+ * "_manifest": [
7300
+ * "123e4567-e89b-12d3-a456-426614174000",
7301
+ * "123e4567-e89b-12d3-a456-426614174000"
7302
+ * ]
7189
7303
  * }
7190
7304
  */
7191
7305
  Components.Schemas.EntityItem;
@@ -7232,6 +7346,7 @@ declare namespace Paths {
7232
7346
  */
7233
7347
  Components.Schemas.ActivityId /* ulid */;
7234
7348
  export type Id = Components.Schemas.EntityId /* uuid */;
7349
+ export type Purge = boolean;
7235
7350
  export type Slug = /**
7236
7351
  * URL-friendly identifier for the entity schema
7237
7352
  * example:
@@ -7245,6 +7360,7 @@ declare namespace Paths {
7245
7360
  }
7246
7361
  export interface QueryParameters {
7247
7362
  activity_id?: Parameters.ActivityId;
7363
+ purge?: Parameters.Purge;
7248
7364
  }
7249
7365
  namespace Responses {
7250
7366
  export interface $200 {
@@ -7442,60 +7558,6 @@ declare namespace Paths {
7442
7558
  export type $200 = Components.Schemas.ActivityItem;
7443
7559
  }
7444
7560
  }
7445
- namespace GetESPublicJwks {
7446
- namespace Responses {
7447
- export interface $200 {
7448
- keys?: {
7449
- /**
7450
- * example:
7451
- * RS256
7452
- */
7453
- alg?: string;
7454
- /**
7455
- * example:
7456
- * AQAB
7457
- */
7458
- e?: string;
7459
- /**
7460
- * example:
7461
- * tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw=
7462
- */
7463
- kid?: string;
7464
- /**
7465
- * example:
7466
- * RSA
7467
- */
7468
- kty?: string;
7469
- /**
7470
- * example:
7471
- * h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ
7472
- */
7473
- n?: string;
7474
- /**
7475
- * example:
7476
- * sig
7477
- */
7478
- use?: string;
7479
- }[];
7480
- }
7481
- }
7482
- }
7483
- namespace GetESTokenOIDC {
7484
- namespace Responses {
7485
- export interface $200 {
7486
- /**
7487
- * example:
7488
- * https://entity.dev.sls.epilot.io/v1/entity/public/idp
7489
- */
7490
- issuer?: string; // uri
7491
- /**
7492
- * example:
7493
- * https://entity.dev.sls.epilot.io/v1/entity/public/idp/.well-known/jwks.json
7494
- */
7495
- jwks_uri?: string; // uri
7496
- }
7497
- }
7498
- }
7499
7561
  namespace GetEntity {
7500
7562
  namespace Parameters {
7501
7563
  export type Hydrate = boolean;
@@ -7555,7 +7617,11 @@ declare namespace Paths {
7555
7617
  * "org:456",
7556
7618
  * "org:456"
7557
7619
  * ]
7558
- * }
7620
+ * },
7621
+ * "_manifest": [
7622
+ * "123e4567-e89b-12d3-a456-426614174000",
7623
+ * "123e4567-e89b-12d3-a456-426614174000"
7624
+ * ]
7559
7625
  * }
7560
7626
  */
7561
7627
  Components.Schemas.EntityItem;
@@ -7598,7 +7664,11 @@ declare namespace Paths {
7598
7664
  * "org:456",
7599
7665
  * "org:456"
7600
7666
  * ]
7601
- * }
7667
+ * },
7668
+ * "_manifest": [
7669
+ * "123e4567-e89b-12d3-a456-426614174000",
7670
+ * "123e4567-e89b-12d3-a456-426614174000"
7671
+ * ]
7602
7672
  * }
7603
7673
  */
7604
7674
  Components.Schemas.EntityItem[];
@@ -7729,7 +7799,11 @@ declare namespace Paths {
7729
7799
  * "org:456",
7730
7800
  * "org:456"
7731
7801
  * ]
7732
- * }
7802
+ * },
7803
+ * "_manifest": [
7804
+ * "123e4567-e89b-12d3-a456-426614174000",
7805
+ * "123e4567-e89b-12d3-a456-426614174000"
7806
+ * ]
7733
7807
  * }
7734
7808
  */
7735
7809
  Components.Schemas.EntityItem;
@@ -7800,6 +7874,15 @@ declare namespace Paths {
7800
7874
  * "type": "string"
7801
7875
  * }
7802
7876
  * },
7877
+ * "_manifest": {
7878
+ * "type": "array",
7879
+ * "description": "Manifest ID used to create/update the entity",
7880
+ * "items": {
7881
+ * "type": "string",
7882
+ * "format": "uuid",
7883
+ * "example": "123e4567-e89b-12d3-a456-426614174000"
7884
+ * }
7885
+ * },
7803
7886
  * "_created_at": {
7804
7887
  * "readOnly": true,
7805
7888
  * "type": "string",
@@ -8566,7 +8649,10 @@ declare namespace Paths {
8566
8649
  * "delete": [
8567
8650
  * "org:456"
8568
8651
  * ]
8569
- * }
8652
+ * },
8653
+ * "_manifest": [
8654
+ * "123e4567-e89b-12d3-a456-426614174000"
8655
+ * ]
8570
8656
  * }
8571
8657
  */
8572
8658
  Components.Schemas.Entity;
@@ -8610,7 +8696,11 @@ declare namespace Paths {
8610
8696
  * "org:456",
8611
8697
  * "org:456"
8612
8698
  * ]
8613
- * }
8699
+ * },
8700
+ * "_manifest": [
8701
+ * "123e4567-e89b-12d3-a456-426614174000",
8702
+ * "123e4567-e89b-12d3-a456-426614174000"
8703
+ * ]
8614
8704
  * }
8615
8705
  */
8616
8706
  Components.Schemas.EntityItem;
@@ -8701,6 +8791,12 @@ declare namespace Paths {
8701
8791
  }
8702
8792
  namespace RemoveRelations {
8703
8793
  namespace Parameters {
8794
+ export type ActivityId = /**
8795
+ * See https://github.com/ulid/spec
8796
+ * example:
8797
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
8798
+ */
8799
+ Components.Schemas.ActivityId /* ulid */;
8704
8800
  export type Async = boolean;
8705
8801
  export type Id = Components.Schemas.EntityId /* uuid */;
8706
8802
  export type Slug = /**
@@ -8716,6 +8812,7 @@ declare namespace Paths {
8716
8812
  }
8717
8813
  export interface QueryParameters {
8718
8814
  async?: Parameters.Async;
8815
+ activity_id?: Parameters.ActivityId;
8719
8816
  }
8720
8817
  export type RequestBody = Components.Schemas.RelationItem[];
8721
8818
  namespace Responses {
@@ -8723,6 +8820,83 @@ declare namespace Paths {
8723
8820
  }
8724
8821
  }
8725
8822
  }
8823
+ namespace RestoreEntity {
8824
+ namespace Parameters {
8825
+ export type ActivityId = /**
8826
+ * See https://github.com/ulid/spec
8827
+ * example:
8828
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
8829
+ */
8830
+ Components.Schemas.ActivityId /* ulid */;
8831
+ export type Id = Components.Schemas.EntityId /* uuid */;
8832
+ export type Slug = /**
8833
+ * URL-friendly identifier for the entity schema
8834
+ * example:
8835
+ * contact
8836
+ */
8837
+ Components.Schemas.EntitySlug;
8838
+ }
8839
+ export interface PathParameters {
8840
+ id: Parameters.Id;
8841
+ slug: Parameters.Slug;
8842
+ }
8843
+ export interface QueryParameters {
8844
+ activity_id?: Parameters.ActivityId;
8845
+ }
8846
+ namespace Responses {
8847
+ export type $200 = /**
8848
+ * example:
8849
+ * {
8850
+ * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
8851
+ * "_org": "123",
8852
+ * "_owners": [
8853
+ * {
8854
+ * "org_id": "123",
8855
+ * "user_id": "123"
8856
+ * },
8857
+ * {
8858
+ * "org_id": "123",
8859
+ * "user_id": "123"
8860
+ * }
8861
+ * ],
8862
+ * "_schema": "contact",
8863
+ * "_tags": [
8864
+ * "example",
8865
+ * "mock",
8866
+ * "example",
8867
+ * "mock"
8868
+ * ],
8869
+ * "_created_at": "2021-02-09T12:41:43.662Z",
8870
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
8871
+ * "_acl": {
8872
+ * "view": [
8873
+ * "org:456",
8874
+ * "org:789",
8875
+ * "org:456",
8876
+ * "org:789"
8877
+ * ],
8878
+ * "edit": [
8879
+ * "org:456",
8880
+ * "org:456"
8881
+ * ],
8882
+ * "delete": [
8883
+ * "org:456",
8884
+ * "org:456"
8885
+ * ]
8886
+ * },
8887
+ * "_manifest": [
8888
+ * "123e4567-e89b-12d3-a456-426614174000",
8889
+ * "123e4567-e89b-12d3-a456-426614174000"
8890
+ * ]
8891
+ * }
8892
+ */
8893
+ Components.Schemas.EntityItem;
8894
+ export interface $400 {
8895
+ }
8896
+ export interface $404 {
8897
+ }
8898
+ }
8899
+ }
8726
8900
  namespace SearchEntities {
8727
8901
  export type RequestBody = Components.Schemas.EntitySearchParams;
8728
8902
  namespace Responses {
@@ -8852,7 +9026,10 @@ declare namespace Paths {
8852
9026
  * "delete": [
8853
9027
  * "org:456"
8854
9028
  * ]
8855
- * }
9029
+ * },
9030
+ * "_manifest": [
9031
+ * "123e4567-e89b-12d3-a456-426614174000"
9032
+ * ]
8856
9033
  * }
8857
9034
  */
8858
9035
  Components.Schemas.Entity;
@@ -8896,7 +9073,11 @@ declare namespace Paths {
8896
9073
  * "org:456",
8897
9074
  * "org:456"
8898
9075
  * ]
8899
- * }
9076
+ * },
9077
+ * "_manifest": [
9078
+ * "123e4567-e89b-12d3-a456-426614174000",
9079
+ * "123e4567-e89b-12d3-a456-426614174000"
9080
+ * ]
8900
9081
  * }
8901
9082
  */
8902
9083
  Components.Schemas.EntityItem;
@@ -9042,7 +9223,10 @@ declare namespace Paths {
9042
9223
  * "delete": [
9043
9224
  * "org:456"
9044
9225
  * ]
9045
- * }
9226
+ * },
9227
+ * "_manifest": [
9228
+ * "123e4567-e89b-12d3-a456-426614174000"
9229
+ * ]
9046
9230
  * }
9047
9231
  */
9048
9232
  Components.Schemas.Entity;
@@ -9087,7 +9271,11 @@ declare namespace Paths {
9087
9271
  * "org:456",
9088
9272
  * "org:456"
9089
9273
  * ]
9090
- * }
9274
+ * },
9275
+ * "_manifest": [
9276
+ * "123e4567-e89b-12d3-a456-426614174000",
9277
+ * "123e4567-e89b-12d3-a456-426614174000"
9278
+ * ]
9091
9279
  * }
9092
9280
  */
9093
9281
  Components.Schemas.EntityItem;
@@ -9130,10 +9318,16 @@ declare namespace Paths {
9130
9318
  * "org:456",
9131
9319
  * "org:456"
9132
9320
  * ]
9133
- * }
9321
+ * },
9322
+ * "_manifest": [
9323
+ * "123e4567-e89b-12d3-a456-426614174000",
9324
+ * "123e4567-e89b-12d3-a456-426614174000"
9325
+ * ]
9134
9326
  * }
9135
9327
  */
9136
9328
  Components.Schemas.EntityItem;
9329
+ export interface $405 {
9330
+ }
9137
9331
  export interface $409 {
9138
9332
  }
9139
9333
  }
@@ -9184,7 +9378,10 @@ declare namespace Paths {
9184
9378
  * "delete": [
9185
9379
  * "org:456"
9186
9380
  * ]
9187
- * }
9381
+ * },
9382
+ * "_manifest": [
9383
+ * "123e4567-e89b-12d3-a456-426614174000"
9384
+ * ]
9188
9385
  * }
9189
9386
  */
9190
9387
  Components.Schemas.Entity;
@@ -9440,6 +9637,21 @@ export interface OperationMethods {
9440
9637
  data?: any,
9441
9638
  config?: AxiosRequestConfig
9442
9639
  ): OperationResponse<Paths.GetEntityV2.Responses.$200>
9640
+ /**
9641
+ * restoreEntity - restoreEntity
9642
+ *
9643
+ * Restores an entity by id
9644
+ *
9645
+ * ## Activity
9646
+ *
9647
+ * If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityRestore`
9648
+ *
9649
+ */
9650
+ 'restoreEntity'(
9651
+ parameters?: Parameters<Paths.RestoreEntity.QueryParameters & Paths.RestoreEntity.PathParameters> | null,
9652
+ data?: any,
9653
+ config?: AxiosRequestConfig
9654
+ ): OperationResponse<Paths.RestoreEntity.Responses.$200>
9443
9655
  /**
9444
9656
  * getEntity - getEntity
9445
9657
  *
@@ -9594,6 +9806,10 @@ export interface OperationMethods {
9594
9806
  *
9595
9807
  * If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityDeleted`
9596
9808
  *
9809
+ * ## Deletion Mode
9810
+ *
9811
+ * All entities are soft deleted by default. To force an actual deletion from the system, provide `purge:true` to delete the entity and all its activity history permanently.
9812
+ *
9597
9813
  */
9598
9814
  'deleteEntity'(
9599
9815
  parameters?: Parameters<Paths.DeleteEntity.QueryParameters & Paths.DeleteEntity.PathParameters> | null,
@@ -10075,30 +10291,6 @@ export interface OperationMethods {
10075
10291
  data?: any,
10076
10292
  config?: AxiosRequestConfig
10077
10293
  ): OperationResponse<Paths.DeleteSchemaGroup.Responses.$200>
10078
- /**
10079
- * getESPublicJwks - getESPublicJwks
10080
- *
10081
- * Get jwks public key set to verify tokens generated by this API for Elasticsearch authentication
10082
- */
10083
- 'getESPublicJwks'(
10084
- parameters?: Parameters<UnknownParamsObject> | null,
10085
- data?: any,
10086
- config?: AxiosRequestConfig
10087
- ): OperationResponse<Paths.GetESPublicJwks.Responses.$200>
10088
- /**
10089
- * getESTokenOIDC - getESTokenOIDC
10090
- *
10091
- * OpenID Connect configuration for Entity API serving as public identity provider
10092
- *
10093
- * Note: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to
10094
- * automate the process of verifying JWT tokens.
10095
- *
10096
- */
10097
- 'getESTokenOIDC'(
10098
- parameters?: Parameters<UnknownParamsObject> | null,
10099
- data?: any,
10100
- config?: AxiosRequestConfig
10101
- ): OperationResponse<Paths.GetESTokenOIDC.Responses.$200>
10102
10294
  }
10103
10295
 
10104
10296
  export interface PathsDictionary {
@@ -10370,6 +10562,23 @@ export interface PathsDictionary {
10370
10562
  config?: AxiosRequestConfig
10371
10563
  ): OperationResponse<Paths.GetEntityV2.Responses.$200>
10372
10564
  }
10565
+ ['/v1/entity/{slug}/{id}:restore']: {
10566
+ /**
10567
+ * restoreEntity - restoreEntity
10568
+ *
10569
+ * Restores an entity by id
10570
+ *
10571
+ * ## Activity
10572
+ *
10573
+ * If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityRestore`
10574
+ *
10575
+ */
10576
+ 'patch'(
10577
+ parameters?: Parameters<Paths.RestoreEntity.QueryParameters & Paths.RestoreEntity.PathParameters> | null,
10578
+ data?: any,
10579
+ config?: AxiosRequestConfig
10580
+ ): OperationResponse<Paths.RestoreEntity.Responses.$200>
10581
+ }
10373
10582
  ['/v1/entity/{slug}/{id}']: {
10374
10583
  /**
10375
10584
  * getEntity - getEntity
@@ -10525,6 +10734,10 @@ export interface PathsDictionary {
10525
10734
  *
10526
10735
  * If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityDeleted`
10527
10736
  *
10737
+ * ## Deletion Mode
10738
+ *
10739
+ * All entities are soft deleted by default. To force an actual deletion from the system, provide `purge:true` to delete the entity and all its activity history permanently.
10740
+ *
10528
10741
  */
10529
10742
  'delete'(
10530
10743
  parameters?: Parameters<Paths.DeleteEntity.QueryParameters & Paths.DeleteEntity.PathParameters> | null,
@@ -11065,34 +11278,6 @@ export interface PathsDictionary {
11065
11278
  config?: AxiosRequestConfig
11066
11279
  ): OperationResponse<Paths.DeleteSchemaGroup.Responses.$200>
11067
11280
  }
11068
- ['/v1/entity/public/idp/.well-known/jwks.json']: {
11069
- /**
11070
- * getESPublicJwks - getESPublicJwks
11071
- *
11072
- * Get jwks public key set to verify tokens generated by this API for Elasticsearch authentication
11073
- */
11074
- 'get'(
11075
- parameters?: Parameters<UnknownParamsObject> | null,
11076
- data?: any,
11077
- config?: AxiosRequestConfig
11078
- ): OperationResponse<Paths.GetESPublicJwks.Responses.$200>
11079
- }
11080
- ['/v1/entity/public/idp/.well-known/openid-configuration']: {
11081
- /**
11082
- * getESTokenOIDC - getESTokenOIDC
11083
- *
11084
- * OpenID Connect configuration for Entity API serving as public identity provider
11085
- *
11086
- * Note: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to
11087
- * automate the process of verifying JWT tokens.
11088
- *
11089
- */
11090
- 'get'(
11091
- parameters?: Parameters<UnknownParamsObject> | null,
11092
- data?: any,
11093
- config?: AxiosRequestConfig
11094
- ): OperationResponse<Paths.GetESTokenOIDC.Responses.$200>
11095
- }
11096
11281
  }
11097
11282
 
11098
11283
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
@@ -11137,6 +11322,7 @@ export type EntitySchema = Components.Schemas.EntitySchema;
11137
11322
  export type EntitySchemaGroup = Components.Schemas.EntitySchemaGroup;
11138
11323
  export type EntitySchemaGroupWithCompositeID = Components.Schemas.EntitySchemaGroupWithCompositeID;
11139
11324
  export type EntitySchemaItem = Components.Schemas.EntitySchemaItem;
11325
+ export type EntitySearchArchiveParam = Components.Schemas.EntitySearchArchiveParam;
11140
11326
  export type EntitySearchOptions = Components.Schemas.EntitySearchOptions;
11141
11327
  export type EntitySearchParams = Components.Schemas.EntitySearchParams;
11142
11328
  export type EntitySearchResults = Components.Schemas.EntitySearchResults;
package/dist/openapi.json CHANGED
@@ -253,6 +253,15 @@
253
253
  "type": "string"
254
254
  }
255
255
  },
256
+ "_manifest": {
257
+ "type": "array",
258
+ "description": "Manifest ID used to create/update the entity",
259
+ "items": {
260
+ "type": "string",
261
+ "format": "uuid",
262
+ "example": "123e4567-e89b-12d3-a456-426614174000"
263
+ }
264
+ },
256
265
  "_created_at": {
257
266
  "readOnly": true,
258
267
  "type": "string",
@@ -934,6 +943,9 @@
934
943
  }
935
944
  }
936
945
  },
946
+ "405": {
947
+ "description": "Archived entities cannot be updated. You'll need to recover the entity first before updating."
948
+ },
937
949
  "409": {
938
950
  "description": "Conflict: multiple entities were matched with `unique_key`"
939
951
  }
@@ -983,6 +995,45 @@
983
995
  }
984
996
  }
985
997
  },
998
+ "/v1/entity/{slug}/{id}:restore": {
999
+ "patch": {
1000
+ "operationId": "restoreEntity",
1001
+ "summary": "restoreEntity",
1002
+ "description": "Restores an entity by id\n\n## Activity\n\nIf no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityRestore`\n",
1003
+ "tags": [
1004
+ "Entities"
1005
+ ],
1006
+ "parameters": [
1007
+ {
1008
+ "$ref": "#/components/parameters/EntityIdPathParam"
1009
+ },
1010
+ {
1011
+ "$ref": "#/components/parameters/EntitySlugPathParam"
1012
+ },
1013
+ {
1014
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
1015
+ }
1016
+ ],
1017
+ "responses": {
1018
+ "200": {
1019
+ "description": "The restored entity",
1020
+ "content": {
1021
+ "application/json": {
1022
+ "schema": {
1023
+ "$ref": "#/components/schemas/EntityItem"
1024
+ }
1025
+ }
1026
+ }
1027
+ },
1028
+ "400": {
1029
+ "description": "The entity is not archived"
1030
+ },
1031
+ "404": {
1032
+ "description": "The entity was not found"
1033
+ }
1034
+ }
1035
+ }
1036
+ },
986
1037
  "/v1/entity/{slug}/{id}": {
987
1038
  "get": {
988
1039
  "operationId": "getEntity",
@@ -1130,7 +1181,7 @@
1130
1181
  "delete": {
1131
1182
  "operationId": "deleteEntity",
1132
1183
  "summary": "deleteEntity",
1133
- "description": "Deletes an Entity\n\n## Activity\n\nIf no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityDeleted`\n",
1184
+ "description": "Deletes an Entity\n\n## Activity\n\nIf no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityDeleted`\n\n## Deletion Mode\n\nAll entities are soft deleted by default. To force an actual deletion from the system, provide `purge:true` to delete the entity and all its activity history permanently.\n",
1134
1185
  "tags": [
1135
1186
  "Entities"
1136
1187
  ],
@@ -1143,6 +1194,15 @@
1143
1194
  },
1144
1195
  {
1145
1196
  "$ref": "#/components/parameters/ActivityIdQueryParam"
1197
+ },
1198
+ {
1199
+ "in": "query",
1200
+ "name": "purge",
1201
+ "description": "Permanently deletes the entity when set to `true`",
1202
+ "default": false,
1203
+ "schema": {
1204
+ "type": "boolean"
1205
+ }
1146
1206
  }
1147
1207
  ],
1148
1208
  "responses": {
@@ -1634,6 +1694,9 @@
1634
1694
  },
1635
1695
  {
1636
1696
  "$ref": "#/components/parameters/AsyncOperationQueryParam"
1697
+ },
1698
+ {
1699
+ "$ref": "#/components/parameters/ActivityIdQueryParam"
1637
1700
  }
1638
1701
  ],
1639
1702
  "requestBody": {
@@ -3145,98 +3208,6 @@
3145
3208
  }
3146
3209
  }
3147
3210
  }
3148
- },
3149
- "/v1/entity/public/idp/.well-known/jwks.json": {
3150
- "get": {
3151
- "operationId": "getESPublicJwks",
3152
- "summary": "getESPublicJwks",
3153
- "description": "Get jwks public key set to verify tokens generated by this API for Elasticsearch authentication",
3154
- "tags": [
3155
- "Public"
3156
- ],
3157
- "security": [],
3158
- "responses": {
3159
- "200": {
3160
- "description": "Set of jwks",
3161
- "content": {
3162
- "application/json": {
3163
- "schema": {
3164
- "type": "object",
3165
- "properties": {
3166
- "keys": {
3167
- "type": "array",
3168
- "items": {
3169
- "type": "object",
3170
- "properties": {
3171
- "alg": {
3172
- "type": "string",
3173
- "example": "RS256"
3174
- },
3175
- "e": {
3176
- "type": "string",
3177
- "example": "AQAB"
3178
- },
3179
- "kid": {
3180
- "type": "string",
3181
- "example": "tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw="
3182
- },
3183
- "kty": {
3184
- "type": "string",
3185
- "example": "RSA"
3186
- },
3187
- "n": {
3188
- "type": "string",
3189
- "example": "h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ"
3190
- },
3191
- "use": {
3192
- "type": "string",
3193
- "example": "sig"
3194
- }
3195
- }
3196
- }
3197
- }
3198
- }
3199
- }
3200
- }
3201
- }
3202
- }
3203
- }
3204
- }
3205
- },
3206
- "/v1/entity/public/idp/.well-known/openid-configuration": {
3207
- "get": {
3208
- "operationId": "getESTokenOIDC",
3209
- "summary": "getESTokenOIDC",
3210
- "description": "OpenID Connect configuration for Entity API serving as public identity provider\n\nNote: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to\nautomate the process of verifying JWT tokens.\n",
3211
- "tags": [
3212
- "Public"
3213
- ],
3214
- "security": [],
3215
- "responses": {
3216
- "200": {
3217
- "description": "OpenID Configuration",
3218
- "content": {
3219
- "application/json": {
3220
- "schema": {
3221
- "type": "object",
3222
- "properties": {
3223
- "issuer": {
3224
- "type": "string",
3225
- "format": "uri",
3226
- "example": "https://entity.dev.sls.epilot.io/v1/entity/public/idp"
3227
- },
3228
- "jwks_uri": {
3229
- "type": "string",
3230
- "format": "uri",
3231
- "example": "https://entity.dev.sls.epilot.io/v1/entity/public/idp/.well-known/jwks.json"
3232
- }
3233
- }
3234
- }
3235
- }
3236
- }
3237
- }
3238
- }
3239
- }
3240
3211
  }
3241
3212
  },
3242
3213
  "components": {
@@ -5409,6 +5380,16 @@
5409
5380
  "type": "string"
5410
5381
  },
5411
5382
  "nullable": true
5383
+ },
5384
+ "_manifest": {
5385
+ "type": "array",
5386
+ "description": "Manifest ID used to create/update the entity",
5387
+ "items": {
5388
+ "type": "string",
5389
+ "format": "uuid",
5390
+ "example": "123e4567-e89b-12d3-a456-426614174000"
5391
+ },
5392
+ "nullable": true
5412
5393
  }
5413
5394
  },
5414
5395
  "example": {
@@ -5438,7 +5419,10 @@
5438
5419
  "delete": [
5439
5420
  "org:456"
5440
5421
  ]
5441
- }
5422
+ },
5423
+ "_manifest": [
5424
+ "123e4567-e89b-12d3-a456-426614174000"
5425
+ ]
5442
5426
  }
5443
5427
  },
5444
5428
  "EntityOwner": {
@@ -5760,6 +5744,16 @@
5760
5744
  "attribute"
5761
5745
  ]
5762
5746
  },
5747
+ "EntitySearchArchiveParam": {
5748
+ "type": "string",
5749
+ "enum": [
5750
+ true,
5751
+ false,
5752
+ "only"
5753
+ ],
5754
+ "description": "Whether to include archived entities in the search results\n- `true`: include archived entities\n- `false`: exclude archived entities\n- `only`: include only archived entities\n\nBy default, no archived entities are included in the search results.\n",
5755
+ "default": false
5756
+ },
5763
5757
  "EntitySearchParams": {
5764
5758
  "allOf": [
5765
5759
  {
@@ -5780,7 +5774,10 @@
5780
5774
  "size": {},
5781
5775
  "hydrate": {},
5782
5776
  "fields": {},
5783
- "aggs": {}
5777
+ "aggs": {},
5778
+ "include_archived": {
5779
+ "$ref": "#/components/schemas/EntitySearchArchiveParam"
5780
+ }
5784
5781
  },
5785
5782
  "additionalProperties": false,
5786
5783
  "required": [
@@ -6039,6 +6036,9 @@
6039
6036
  }
6040
6037
  }
6041
6038
  }
6039
+ },
6040
+ "include_archived": {
6041
+ "$ref": "#/components/schemas/EntitySearchArchiveParam"
6042
6042
  }
6043
6043
  }
6044
6044
  },
@@ -7589,9 +7589,6 @@
7589
7589
  }
7590
7590
  },
7591
7591
  "servers": [
7592
- {
7593
- "url": "https://entity.sls.epilot.io"
7594
- },
7595
7592
  {
7596
7593
  "url": "https://entity.sls.epilot.io"
7597
7594
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/entity-client",
3
- "version": "4.29.2",
3
+ "version": "4.30.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",
@@ -27,7 +27,7 @@
27
27
  "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/entity.yaml",
28
28
  "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
29
29
  "build": "tsc && npm run build:patch && npm run bundle-definition",
30
- "build:patch": "sed -i '' '/^__exportStar.*openapi.*$/d' dist/index.js",
30
+ "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
31
31
  "build:watch": "npm run build && tsc -w",
32
32
  "release-alpha": "npm version prerelease --preid alpha",
33
33
  "lint": "../../node_modules/eslint/bin/eslint.js src"