@epilot/entity-client 4.29.3 → 4.30.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +22 -0
- package/dist/openapi.d.ts +162 -0
- package/dist/openapi.json +69 -2
- package/package.json +1 -1
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={914:function(e,t,a){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=r(a(240));t.default=n.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"}],"responses":{}}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"}],"responses":{}},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/schema":{"get":{"operationId":"getJsonSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"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"},{"$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})})();
|
|
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": {}
|
package/dist/openapi.d.ts
CHANGED
|
@@ -2159,6 +2159,16 @@ declare namespace Components {
|
|
|
2159
2159
|
aggs?: {
|
|
2160
2160
|
[key: string]: any;
|
|
2161
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;
|
|
2162
2172
|
}
|
|
2163
2173
|
export interface EntityOperation {
|
|
2164
2174
|
entity: EntityId /* uuid */;
|
|
@@ -2959,6 +2969,16 @@ declare namespace Components {
|
|
|
2959
2969
|
*/
|
|
2960
2970
|
SearchMappings;
|
|
2961
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";
|
|
2962
2982
|
export interface EntitySearchOptions {
|
|
2963
2983
|
/**
|
|
2964
2984
|
* You can pass one sort field or an array of sort fields. Each sort field can be a string
|
|
@@ -3005,6 +3025,16 @@ declare namespace Components {
|
|
|
3005
3025
|
aggs?: {
|
|
3006
3026
|
[key: string]: any;
|
|
3007
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;
|
|
3008
3038
|
}
|
|
3009
3039
|
export interface EntitySearchParams {
|
|
3010
3040
|
/**
|
|
@@ -3062,6 +3092,16 @@ declare namespace Components {
|
|
|
3062
3092
|
aggs?: {
|
|
3063
3093
|
[key: string]: any;
|
|
3064
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;
|
|
3065
3105
|
}
|
|
3066
3106
|
export interface EntitySearchResults {
|
|
3067
3107
|
/**
|
|
@@ -7306,6 +7346,7 @@ declare namespace Paths {
|
|
|
7306
7346
|
*/
|
|
7307
7347
|
Components.Schemas.ActivityId /* ulid */;
|
|
7308
7348
|
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
7349
|
+
export type Purge = boolean;
|
|
7309
7350
|
export type Slug = /**
|
|
7310
7351
|
* URL-friendly identifier for the entity schema
|
|
7311
7352
|
* example:
|
|
@@ -7319,6 +7360,7 @@ declare namespace Paths {
|
|
|
7319
7360
|
}
|
|
7320
7361
|
export interface QueryParameters {
|
|
7321
7362
|
activity_id?: Parameters.ActivityId;
|
|
7363
|
+
purge?: Parameters.Purge;
|
|
7322
7364
|
}
|
|
7323
7365
|
namespace Responses {
|
|
7324
7366
|
export interface $200 {
|
|
@@ -8778,6 +8820,83 @@ declare namespace Paths {
|
|
|
8778
8820
|
}
|
|
8779
8821
|
}
|
|
8780
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
|
+
}
|
|
8781
8900
|
namespace SearchEntities {
|
|
8782
8901
|
export type RequestBody = Components.Schemas.EntitySearchParams;
|
|
8783
8902
|
namespace Responses {
|
|
@@ -9207,6 +9326,8 @@ declare namespace Paths {
|
|
|
9207
9326
|
* }
|
|
9208
9327
|
*/
|
|
9209
9328
|
Components.Schemas.EntityItem;
|
|
9329
|
+
export interface $405 {
|
|
9330
|
+
}
|
|
9210
9331
|
export interface $409 {
|
|
9211
9332
|
}
|
|
9212
9333
|
}
|
|
@@ -9516,6 +9637,21 @@ export interface OperationMethods {
|
|
|
9516
9637
|
data?: any,
|
|
9517
9638
|
config?: AxiosRequestConfig
|
|
9518
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>
|
|
9519
9655
|
/**
|
|
9520
9656
|
* getEntity - getEntity
|
|
9521
9657
|
*
|
|
@@ -9670,6 +9806,10 @@ export interface OperationMethods {
|
|
|
9670
9806
|
*
|
|
9671
9807
|
* If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityDeleted`
|
|
9672
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
|
+
*
|
|
9673
9813
|
*/
|
|
9674
9814
|
'deleteEntity'(
|
|
9675
9815
|
parameters?: Parameters<Paths.DeleteEntity.QueryParameters & Paths.DeleteEntity.PathParameters> | null,
|
|
@@ -10422,6 +10562,23 @@ export interface PathsDictionary {
|
|
|
10422
10562
|
config?: AxiosRequestConfig
|
|
10423
10563
|
): OperationResponse<Paths.GetEntityV2.Responses.$200>
|
|
10424
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
|
+
}
|
|
10425
10582
|
['/v1/entity/{slug}/{id}']: {
|
|
10426
10583
|
/**
|
|
10427
10584
|
* getEntity - getEntity
|
|
@@ -10577,6 +10734,10 @@ export interface PathsDictionary {
|
|
|
10577
10734
|
*
|
|
10578
10735
|
* If no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityDeleted`
|
|
10579
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
|
+
*
|
|
10580
10741
|
*/
|
|
10581
10742
|
'delete'(
|
|
10582
10743
|
parameters?: Parameters<Paths.DeleteEntity.QueryParameters & Paths.DeleteEntity.PathParameters> | null,
|
|
@@ -11161,6 +11322,7 @@ export type EntitySchema = Components.Schemas.EntitySchema;
|
|
|
11161
11322
|
export type EntitySchemaGroup = Components.Schemas.EntitySchemaGroup;
|
|
11162
11323
|
export type EntitySchemaGroupWithCompositeID = Components.Schemas.EntitySchemaGroupWithCompositeID;
|
|
11163
11324
|
export type EntitySchemaItem = Components.Schemas.EntitySchemaItem;
|
|
11325
|
+
export type EntitySearchArchiveParam = Components.Schemas.EntitySearchArchiveParam;
|
|
11164
11326
|
export type EntitySearchOptions = Components.Schemas.EntitySearchOptions;
|
|
11165
11327
|
export type EntitySearchParams = Components.Schemas.EntitySearchParams;
|
|
11166
11328
|
export type EntitySearchResults = Components.Schemas.EntitySearchResults;
|
package/dist/openapi.json
CHANGED
|
@@ -943,6 +943,9 @@
|
|
|
943
943
|
}
|
|
944
944
|
}
|
|
945
945
|
},
|
|
946
|
+
"405": {
|
|
947
|
+
"description": "Archived entities cannot be updated. You'll need to recover the entity first before updating."
|
|
948
|
+
},
|
|
946
949
|
"409": {
|
|
947
950
|
"description": "Conflict: multiple entities were matched with `unique_key`"
|
|
948
951
|
}
|
|
@@ -992,6 +995,45 @@
|
|
|
992
995
|
}
|
|
993
996
|
}
|
|
994
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
|
+
},
|
|
995
1037
|
"/v1/entity/{slug}/{id}": {
|
|
996
1038
|
"get": {
|
|
997
1039
|
"operationId": "getEntity",
|
|
@@ -1139,7 +1181,7 @@
|
|
|
1139
1181
|
"delete": {
|
|
1140
1182
|
"operationId": "deleteEntity",
|
|
1141
1183
|
"summary": "deleteEntity",
|
|
1142
|
-
"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",
|
|
1143
1185
|
"tags": [
|
|
1144
1186
|
"Entities"
|
|
1145
1187
|
],
|
|
@@ -1152,6 +1194,15 @@
|
|
|
1152
1194
|
},
|
|
1153
1195
|
{
|
|
1154
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
|
+
}
|
|
1155
1206
|
}
|
|
1156
1207
|
],
|
|
1157
1208
|
"responses": {
|
|
@@ -5693,6 +5744,16 @@
|
|
|
5693
5744
|
"attribute"
|
|
5694
5745
|
]
|
|
5695
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
|
+
},
|
|
5696
5757
|
"EntitySearchParams": {
|
|
5697
5758
|
"allOf": [
|
|
5698
5759
|
{
|
|
@@ -5713,7 +5774,10 @@
|
|
|
5713
5774
|
"size": {},
|
|
5714
5775
|
"hydrate": {},
|
|
5715
5776
|
"fields": {},
|
|
5716
|
-
"aggs": {}
|
|
5777
|
+
"aggs": {},
|
|
5778
|
+
"include_archived": {
|
|
5779
|
+
"$ref": "#/components/schemas/EntitySearchArchiveParam"
|
|
5780
|
+
}
|
|
5717
5781
|
},
|
|
5718
5782
|
"additionalProperties": false,
|
|
5719
5783
|
"required": [
|
|
@@ -5972,6 +6036,9 @@
|
|
|
5972
6036
|
}
|
|
5973
6037
|
}
|
|
5974
6038
|
}
|
|
6039
|
+
},
|
|
6040
|
+
"include_archived": {
|
|
6041
|
+
"$ref": "#/components/schemas/EntitySearchArchiveParam"
|
|
5975
6042
|
}
|
|
5976
6043
|
}
|
|
5977
6044
|
},
|