@epilot/entity-client 4.31.2 → 4.32.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.
@@ -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}:restore":{"patch":{"operationId":"restoreEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}":{"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":{}}},"/v1/entity/schemas/headline":{"post":{"operationId":"createSchemaGroupHeadline","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/headline/{composite_id}":{"get":{"operationId":"getSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}}},"components":{"parameters":{"EntityIdPathParam":{"name":"id","in":"path","required":true},"EntitySlugPathParam":{"name":"slug","in":"path","required":true},"EntitySlugPathPriceParam":{"name":"slug","in":"path","required":true},"TaxonomySlugQueryParam":{"name":"taxonomySlug","in":"query","required":true},"TaxonomySlugPathParam":{"name":"taxonomySlug","in":"path","required":true},"TaxonomySlugQueryParamOptional":{"name":"taxonomySlug","in":"query"},"TaxonomyClassificationSlugPathParam":{"name":"classificationSlug","in":"path","required":true},"SavedViewIdPathParam":{"name":"id","in":"path","required":true},"AsyncOperationQueryParam":{"name":"async","in":"query","required":false},"HydrateEntitiesQueryParam":{"name":"hydrate","in":"query"},"ActivityIdQueryParam":{"name":"activity_id","in":"query","required":false},"ActivityIdPathParam":{"name":"id","in":"path","required":true},"FromPageQueryParam":{"name":"from","in":"query"},"IncludeReverseDeprecatedQueryParam":{"name":"include_reverse","in":"query","deprecated":true},"IncludeReverseQueryParam":{"name":"include_reverse","in":"query"},"IncludeSchemasQueryParam":{"name":"include_schemas","in":"query","required":false,"style":"form","explode":false},"ExcludeSchemasQueryParam":{"name":"exclude_schemas","in":"query","required":false,"style":"form","explode":false},"EntityRelationsModeQueryParam":{"name":"mode","in":"query","required":false},"DryRunQueryParam":{"name":"dry_run","in":"query","required":false},"FillActivityQueryParam":{"name":"fill_activity","in":"query","required":false}}},"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"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}:validate":{"post":{"operationId":"validateEntityV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"},{"name":"strict","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}":{"get":{"operationId":"getEntityV2","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"fields","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}:restore":{"patch":{"operationId":"restoreEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}],"responses":{}},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"in":"query","name":"purge","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":{}}},"/v1/entity/schemas/headline":{"post":{"operationId":"createSchemaGroupHeadline","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/headline/{composite_id}":{"get":{"operationId":"getSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}}},"components":{"parameters":{"EntityIdPathParam":{"name":"id","in":"path","required":true},"EntitySlugPathParam":{"name":"slug","in":"path","required":true},"EntitySlugPathPriceParam":{"name":"slug","in":"path","required":true},"TaxonomySlugQueryParam":{"name":"taxonomySlug","in":"query","required":true},"TaxonomySlugPathParam":{"name":"taxonomySlug","in":"path","required":true},"TaxonomySlugQueryParamOptional":{"name":"taxonomySlug","in":"query"},"TaxonomyClassificationSlugPathParam":{"name":"classificationSlug","in":"path","required":true},"SavedViewIdPathParam":{"name":"id","in":"path","required":true},"AsyncOperationQueryParam":{"name":"async","in":"query","required":false},"HydrateEntitiesQueryParam":{"name":"hydrate","in":"query"},"ActivityIdQueryParam":{"name":"activity_id","in":"query","required":false},"ActivityIdPathParam":{"name":"id","in":"path","required":true},"FromPageQueryParam":{"name":"from","in":"query"},"IncludeReverseDeprecatedQueryParam":{"name":"include_reverse","in":"query","deprecated":true},"IncludeReverseQueryParam":{"name":"include_reverse","in":"query"},"IncludeSchemasQueryParam":{"name":"include_schemas","in":"query","required":false,"style":"form","explode":false},"ExcludeSchemasQueryParam":{"name":"exclude_schemas","in":"query","required":false,"style":"form","explode":false},"EntityRelationsModeQueryParam":{"name":"mode","in":"query","required":false},"DryRunQueryParam":{"name":"dry_run","in":"query","required":false},"FillActivityQueryParam":{"name":"fill_activity","in":"query","required":false},"ValidateEntityQueryParam":{"name":"validate","in":"query"}}},"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})})();
@@ -158,6 +158,9 @@
158
158
  },
159
159
  {
160
160
  "$ref": "#/components/parameters/AsyncOperationQueryParam"
161
+ },
162
+ {
163
+ "$ref": "#/components/parameters/ValidateEntityQueryParam"
161
164
  }
162
165
  ],
163
166
  "requestBody": {
@@ -184,6 +187,22 @@
184
187
  "responses": {}
185
188
  }
186
189
  },
190
+ "/v2/entity/{slug}:validate": {
191
+ "post": {
192
+ "operationId": "validateEntityV2",
193
+ "parameters": [
194
+ {
195
+ "$ref": "#/components/parameters/EntitySlugPathPriceParam"
196
+ }
197
+ ],
198
+ "requestBody": {
199
+ "content": {
200
+ "application/json": {}
201
+ }
202
+ },
203
+ "responses": {}
204
+ }
205
+ },
187
206
  "/v1/entity/{slug}:upsert": {
188
207
  "patch": {
189
208
  "operationId": "upsertEntity",
@@ -203,6 +222,9 @@
203
222
  {
204
223
  "$ref": "#/components/parameters/AsyncOperationQueryParam"
205
224
  },
225
+ {
226
+ "$ref": "#/components/parameters/ValidateEntityQueryParam"
227
+ },
206
228
  {
207
229
  "name": "strict",
208
230
  "in": "query",
@@ -295,6 +317,9 @@
295
317
  },
296
318
  {
297
319
  "$ref": "#/components/parameters/AsyncOperationQueryParam"
320
+ },
321
+ {
322
+ "$ref": "#/components/parameters/ValidateEntityQueryParam"
298
323
  }
299
324
  ],
300
325
  "requestBody": {
@@ -324,6 +349,9 @@
324
349
  },
325
350
  {
326
351
  "$ref": "#/components/parameters/AsyncOperationQueryParam"
352
+ },
353
+ {
354
+ "$ref": "#/components/parameters/ValidateEntityQueryParam"
327
355
  }
328
356
  ],
329
357
  "requestBody": {
@@ -1306,6 +1334,10 @@
1306
1334
  "name": "fill_activity",
1307
1335
  "in": "query",
1308
1336
  "required": false
1337
+ },
1338
+ "ValidateEntityQueryParam": {
1339
+ "name": "validate",
1340
+ "in": "query"
1309
1341
  }
1310
1342
  }
1311
1343
  },
package/dist/openapi.d.ts CHANGED
@@ -60,6 +60,7 @@ declare namespace Components {
60
60
  export type TaxonomySlugPathParam = string;
61
61
  export type TaxonomySlugQueryParam = string;
62
62
  export type TaxonomySlugQueryParamOptional = string;
63
+ export type ValidateEntityQueryParam = boolean;
63
64
  }
64
65
  export interface PathParameters {
65
66
  EntityIdPathParam?: Parameters.EntityIdPathParam;
@@ -89,6 +90,7 @@ declare namespace Components {
89
90
  EntityRelationsModeQueryParam?: Parameters.EntityRelationsModeQueryParam;
90
91
  DryRunQueryParam?: Parameters.DryRunQueryParam;
91
92
  FillActivityQueryParam?: Parameters.FillActivityQueryParam;
93
+ ValidateEntityQueryParam?: Parameters.ValidateEntityQueryParam;
92
94
  }
93
95
  namespace Schemas {
94
96
  export interface Activity {
@@ -2476,6 +2478,16 @@ declare namespace Components {
2476
2478
  * Contacts
2477
2479
  */
2478
2480
  plural: string;
2481
+ /**
2482
+ * example:
2483
+ * Example description
2484
+ */
2485
+ description?: string;
2486
+ /**
2487
+ * example:
2488
+ * https://docs.epilot.io/docs/pricing/entities
2489
+ */
2490
+ docs_url?: string; // uri
2479
2491
  /**
2480
2492
  * example:
2481
2493
  * false
@@ -2835,6 +2847,16 @@ declare namespace Components {
2835
2847
  * Contacts
2836
2848
  */
2837
2849
  plural: string;
2850
+ /**
2851
+ * example:
2852
+ * Example description
2853
+ */
2854
+ description?: string;
2855
+ /**
2856
+ * example:
2857
+ * https://docs.epilot.io/docs/pricing/entities
2858
+ */
2859
+ docs_url?: string; // uri
2838
2860
  /**
2839
2861
  * example:
2840
2862
  * false
@@ -3335,6 +3357,71 @@ declare namespace Components {
3335
3357
  errors: [
3336
3358
  ];
3337
3359
  }
3360
+ export interface EntityValidationV2Error {
3361
+ /**
3362
+ * validation keyword.
3363
+ */
3364
+ keyword: string;
3365
+ /**
3366
+ * JSON Pointer to the location in the data instance (e.g., `"/prop/1/subProp"`).
3367
+ */
3368
+ instance_path: string;
3369
+ /**
3370
+ * JSON Pointer to the location of the failing keyword in the schema.
3371
+ */
3372
+ schema_path: string;
3373
+ /**
3374
+ * Additional information about error.
3375
+ */
3376
+ params: {
3377
+ [name: string]: any;
3378
+ };
3379
+ /**
3380
+ * Set for errors in `propertyNames` keyword schema. `instance_path` still points to the object in this case.
3381
+ */
3382
+ property_name?: string;
3383
+ /**
3384
+ * The error message.
3385
+ */
3386
+ message?: string;
3387
+ /**
3388
+ * The value of the failing keyword in the schema.
3389
+ */
3390
+ schema?: {
3391
+ [key: string]: any;
3392
+ };
3393
+ /**
3394
+ * The schema containing the keyword.
3395
+ */
3396
+ parent_schema?: {
3397
+ [name: string]: any;
3398
+ };
3399
+ /**
3400
+ * The data validated by the keyword.
3401
+ */
3402
+ data?: {
3403
+ [name: string]: any;
3404
+ };
3405
+ }
3406
+ export type EntityValidationV2Result = /* Validation result for a successful validation */ EntityValidationV2ResultSuccess | /* Validation result for a failed validation */ EntityValidationV2ResultError;
3407
+ /**
3408
+ * Validation result for a failed validation
3409
+ */
3410
+ export interface EntityValidationV2ResultError {
3411
+ status: "error";
3412
+ errors: [
3413
+ EntityValidationV2Error,
3414
+ ...EntityValidationV2Error[]
3415
+ ];
3416
+ }
3417
+ /**
3418
+ * Validation result for a successful validation
3419
+ */
3420
+ export interface EntityValidationV2ResultSuccess {
3421
+ status: "success";
3422
+ errors: [
3423
+ ];
3424
+ }
3338
3425
  export interface EntityViewDisabled {
3339
3426
  view_type?: "disabled";
3340
3427
  }
@@ -3597,6 +3684,11 @@ declare namespace Components {
3597
3684
  type: "headline";
3598
3685
  enable_divider?: boolean;
3599
3686
  divider?: "top_divider" | "bottom_divider";
3687
+ _purpose?: /**
3688
+ * example:
3689
+ * taxonomy-slug:classification-slug
3690
+ */
3691
+ ClassificationId[];
3600
3692
  /**
3601
3693
  * Manifest ID used to create/update the schema group headline
3602
3694
  */
@@ -3621,6 +3713,11 @@ declare namespace Components {
3621
3713
  type: "headline";
3622
3714
  enable_divider?: boolean;
3623
3715
  divider?: "top_divider" | "bottom_divider";
3716
+ _purpose?: /**
3717
+ * example:
3718
+ * taxonomy-slug:classification-slug
3719
+ */
3720
+ ClassificationId[];
3624
3721
  /**
3625
3722
  * Manifest ID used to create/update the schema group headline
3626
3723
  */
@@ -7404,6 +7501,7 @@ declare namespace Paths {
7404
7501
  * contact
7405
7502
  */
7406
7503
  Components.Schemas.EntitySlug;
7504
+ export type Validate = boolean;
7407
7505
  }
7408
7506
  export interface PathParameters {
7409
7507
  slug: Parameters.Slug;
@@ -7412,6 +7510,7 @@ declare namespace Paths {
7412
7510
  activity_id?: Parameters.ActivityId;
7413
7511
  fill_activity?: Parameters.FillActivity;
7414
7512
  async?: Parameters.Async;
7513
+ validate?: Parameters.Validate;
7415
7514
  }
7416
7515
  export type RequestBody = /**
7417
7516
  * example:
@@ -7497,6 +7596,7 @@ declare namespace Paths {
7497
7596
  * }
7498
7597
  */
7499
7598
  Components.Schemas.EntityItem;
7599
+ export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
7500
7600
  }
7501
7601
  }
7502
7602
  namespace CreateSavedView {
@@ -8847,6 +8947,7 @@ declare namespace Paths {
8847
8947
  * contact
8848
8948
  */
8849
8949
  Components.Schemas.EntitySlug;
8950
+ export type Validate = boolean;
8850
8951
  }
8851
8952
  export interface PathParameters {
8852
8953
  slug: Parameters.Slug;
@@ -8857,6 +8958,7 @@ declare namespace Paths {
8857
8958
  fill_activity?: Parameters.FillActivity;
8858
8959
  dry_run?: Parameters.DryRun;
8859
8960
  async?: Parameters.Async;
8961
+ validate?: Parameters.Validate;
8860
8962
  }
8861
8963
  export type RequestBody = /**
8862
8964
  * example:
@@ -8944,6 +9046,7 @@ declare namespace Paths {
8944
9046
  Components.Schemas.EntityItem;
8945
9047
  export interface $409 {
8946
9048
  }
9049
+ export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
8947
9050
  }
8948
9051
  }
8949
9052
  namespace PutSchema {
@@ -9250,6 +9353,7 @@ declare namespace Paths {
9250
9353
  * contact
9251
9354
  */
9252
9355
  Components.Schemas.EntitySlug;
9356
+ export type Validate = boolean;
9253
9357
  }
9254
9358
  export interface PathParameters {
9255
9359
  slug: Parameters.Slug;
@@ -9259,6 +9363,7 @@ declare namespace Paths {
9259
9363
  activity_id?: Parameters.ActivityId;
9260
9364
  fill_activity?: Parameters.FillActivity;
9261
9365
  async?: Parameters.Async;
9366
+ validate?: Parameters.Validate;
9262
9367
  }
9263
9368
  export type RequestBody = /**
9264
9369
  * example:
@@ -9344,6 +9449,7 @@ declare namespace Paths {
9344
9449
  * }
9345
9450
  */
9346
9451
  Components.Schemas.EntityItem;
9452
+ export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
9347
9453
  }
9348
9454
  }
9349
9455
  namespace UpdateRelation {
@@ -9438,6 +9544,7 @@ declare namespace Paths {
9438
9544
  */
9439
9545
  Components.Schemas.EntitySlug;
9440
9546
  export type Strict = boolean;
9547
+ export type Validate = boolean;
9441
9548
  }
9442
9549
  export interface PathParameters {
9443
9550
  slug: Parameters.Slug;
@@ -9447,6 +9554,7 @@ declare namespace Paths {
9447
9554
  fill_activity?: Parameters.FillActivity;
9448
9555
  dry_run?: Parameters.DryRun;
9449
9556
  async?: Parameters.Async;
9557
+ validate?: Parameters.Validate;
9450
9558
  strict?: Parameters.Strict;
9451
9559
  }
9452
9560
  export interface RequestBody {
@@ -9593,6 +9701,7 @@ declare namespace Paths {
9593
9701
  }
9594
9702
  export interface $409 {
9595
9703
  }
9704
+ export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
9596
9705
  }
9597
9706
  }
9598
9707
  namespace ValidateEntity {
@@ -9653,6 +9762,64 @@ declare namespace Paths {
9653
9762
  export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationResultError;
9654
9763
  }
9655
9764
  }
9765
+ namespace ValidateEntityV2 {
9766
+ namespace Parameters {
9767
+ /**
9768
+ * URL-friendly identifier for the entity schema
9769
+ * example:
9770
+ * price
9771
+ */
9772
+ export type Slug = string;
9773
+ }
9774
+ export interface PathParameters {
9775
+ slug: /**
9776
+ * URL-friendly identifier for the entity schema
9777
+ * example:
9778
+ * price
9779
+ */
9780
+ Parameters.Slug;
9781
+ }
9782
+ export type RequestBody = /**
9783
+ * example:
9784
+ * {
9785
+ * "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
9786
+ * "_org": "123",
9787
+ * "_owners": [
9788
+ * {
9789
+ * "org_id": "123",
9790
+ * "user_id": "123"
9791
+ * }
9792
+ * ],
9793
+ * "_schema": "contact",
9794
+ * "_tags": [
9795
+ * "example",
9796
+ * "mock"
9797
+ * ],
9798
+ * "_created_at": "2021-02-09T12:41:43.662Z",
9799
+ * "_updated_at": "2021-02-09T12:41:43.662Z",
9800
+ * "_acl": {
9801
+ * "view": [
9802
+ * "org:456",
9803
+ * "org:789"
9804
+ * ],
9805
+ * "edit": [
9806
+ * "org:456"
9807
+ * ],
9808
+ * "delete": [
9809
+ * "org:456"
9810
+ * ]
9811
+ * },
9812
+ * "_manifest": [
9813
+ * "123e4567-e89b-12d3-a456-426614174000"
9814
+ * ]
9815
+ * }
9816
+ */
9817
+ Components.Schemas.Entity;
9818
+ namespace Responses {
9819
+ export type $200 = /* Validation result for a successful validation */ Components.Schemas.EntityValidationV2ResultSuccess;
9820
+ export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
9821
+ }
9822
+ }
9656
9823
  }
9657
9824
 
9658
9825
  export interface OperationMethods {
@@ -9869,6 +10036,16 @@ export interface OperationMethods {
9869
10036
  data?: Paths.ValidateEntity.RequestBody,
9870
10037
  config?: AxiosRequestConfig
9871
10038
  ): OperationResponse<Paths.ValidateEntity.Responses.$200>
10039
+ /**
10040
+ * validateEntityV2 - validateEntityV2
10041
+ *
10042
+ * Validates an entity against the schema.
10043
+ */
10044
+ 'validateEntityV2'(
10045
+ parameters?: Parameters<Paths.ValidateEntityV2.PathParameters> | null,
10046
+ data?: Paths.ValidateEntityV2.RequestBody,
10047
+ config?: AxiosRequestConfig
10048
+ ): OperationResponse<Paths.ValidateEntityV2.Responses.$200>
9872
10049
  /**
9873
10050
  * upsertEntity - upsertEntity
9874
10051
  *
@@ -10234,7 +10411,11 @@ export interface OperationMethods {
10234
10411
  /**
10235
10412
  * exportEntities - exportEntities
10236
10413
  *
10237
- * create export file of entities
10414
+ * Export entity data in a CSV-format. The export will export data as close as possible to what is visible on Entity UI tables.
10415
+ * The values exported as in some cases, transformed to human-readable values.
10416
+ *
10417
+ * To force the export of raw values, use the `#` prefix in front of your field name when specifying the field on the `fields` param.
10418
+ *
10238
10419
  */
10239
10420
  'exportEntities'(
10240
10421
  parameters?: Parameters<Paths.ExportEntities.QueryParameters> | null,
@@ -10830,6 +11011,18 @@ export interface PathsDictionary {
10830
11011
  config?: AxiosRequestConfig
10831
11012
  ): OperationResponse<Paths.ValidateEntity.Responses.$200>
10832
11013
  }
11014
+ ['/v2/entity/{slug}:validate']: {
11015
+ /**
11016
+ * validateEntityV2 - validateEntityV2
11017
+ *
11018
+ * Validates an entity against the schema.
11019
+ */
11020
+ 'post'(
11021
+ parameters?: Parameters<Paths.ValidateEntityV2.PathParameters> | null,
11022
+ data?: Paths.ValidateEntityV2.RequestBody,
11023
+ config?: AxiosRequestConfig
11024
+ ): OperationResponse<Paths.ValidateEntityV2.Responses.$200>
11025
+ }
10833
11026
  ['/v1/entity/{slug}:upsert']: {
10834
11027
  /**
10835
11028
  * upsertEntity - upsertEntity
@@ -11224,7 +11417,11 @@ export interface PathsDictionary {
11224
11417
  /**
11225
11418
  * exportEntities - exportEntities
11226
11419
  *
11227
- * create export file of entities
11420
+ * Export entity data in a CSV-format. The export will export data as close as possible to what is visible on Entity UI tables.
11421
+ * The values exported as in some cases, transformed to human-readable values.
11422
+ *
11423
+ * To force the export of raw values, use the `#` prefix in front of your field name when specifying the field on the `fields` param.
11424
+ *
11228
11425
  */
11229
11426
  'post'(
11230
11427
  parameters?: Parameters<Paths.ExportEntities.QueryParameters> | null,
@@ -11680,6 +11877,10 @@ export type EntityValidationError = Components.Schemas.EntityValidationError;
11680
11877
  export type EntityValidationResult = Components.Schemas.EntityValidationResult;
11681
11878
  export type EntityValidationResultError = Components.Schemas.EntityValidationResultError;
11682
11879
  export type EntityValidationResultSuccess = Components.Schemas.EntityValidationResultSuccess;
11880
+ export type EntityValidationV2Error = Components.Schemas.EntityValidationV2Error;
11881
+ export type EntityValidationV2Result = Components.Schemas.EntityValidationV2Result;
11882
+ export type EntityValidationV2ResultError = Components.Schemas.EntityValidationV2ResultError;
11883
+ export type EntityValidationV2ResultSuccess = Components.Schemas.EntityValidationV2ResultSuccess;
11683
11884
  export type EntityViewDisabled = Components.Schemas.EntityViewDisabled;
11684
11885
  export type ExportJobId = Components.Schemas.ExportJobId;
11685
11886
  export type FieldsParam = Components.Schemas.FieldsParam;
package/dist/openapi.json CHANGED
@@ -744,6 +744,9 @@
744
744
  },
745
745
  {
746
746
  "$ref": "#/components/parameters/AsyncOperationQueryParam"
747
+ },
748
+ {
749
+ "$ref": "#/components/parameters/ValidateEntityQueryParam"
747
750
  }
748
751
  ],
749
752
  "requestBody": {
@@ -800,6 +803,16 @@
800
803
  }
801
804
  }
802
805
  }
806
+ },
807
+ "422": {
808
+ "description": "Entity validation error when `?validate=true`",
809
+ "content": {
810
+ "application/json": {
811
+ "schema": {
812
+ "$ref": "#/components/schemas/EntityValidationV2ResultError"
813
+ }
814
+ }
815
+ }
803
816
  }
804
817
  }
805
818
  }
@@ -858,6 +871,60 @@
858
871
  }
859
872
  }
860
873
  },
874
+ "/v2/entity/{slug}:validate": {
875
+ "post": {
876
+ "operationId": "validateEntityV2",
877
+ "summary": "validateEntityV2",
878
+ "description": "Validates an entity against the schema.",
879
+ "tags": [
880
+ "Entities"
881
+ ],
882
+ "parameters": [
883
+ {
884
+ "$ref": "#/components/parameters/EntitySlugPathPriceParam"
885
+ }
886
+ ],
887
+ "requestBody": {
888
+ "content": {
889
+ "application/json": {
890
+ "schema": {
891
+ "$ref": "#/components/schemas/Entity"
892
+ },
893
+ "examples": {
894
+ "Valid Price": {
895
+ "$ref": "#/components/examples/PriceEntity"
896
+ },
897
+ "Invalid Price": {
898
+ "$ref": "#/components/examples/EmptyGenericEntity"
899
+ }
900
+ }
901
+ }
902
+ }
903
+ },
904
+ "responses": {
905
+ "200": {
906
+ "description": "Success",
907
+ "content": {
908
+ "application/json": {
909
+ "schema": {
910
+ "$ref": "#/components/schemas/EntityValidationV2ResultSuccess"
911
+ }
912
+ }
913
+ }
914
+ },
915
+ "422": {
916
+ "description": "Error",
917
+ "content": {
918
+ "application/json": {
919
+ "schema": {
920
+ "$ref": "#/components/schemas/EntityValidationV2ResultError"
921
+ }
922
+ }
923
+ }
924
+ }
925
+ }
926
+ }
927
+ },
861
928
  "/v1/entity/{slug}:upsert": {
862
929
  "patch": {
863
930
  "operationId": "upsertEntity",
@@ -882,6 +949,9 @@
882
949
  {
883
950
  "$ref": "#/components/parameters/AsyncOperationQueryParam"
884
951
  },
952
+ {
953
+ "$ref": "#/components/parameters/ValidateEntityQueryParam"
954
+ },
885
955
  {
886
956
  "name": "strict",
887
957
  "description": "Strict mode = return 409 if more than one entity is matched",
@@ -948,6 +1018,16 @@
948
1018
  },
949
1019
  "409": {
950
1020
  "description": "Conflict: multiple entities were matched with `unique_key`"
1021
+ },
1022
+ "422": {
1023
+ "description": "Entity validation error when `?validate=true`",
1024
+ "content": {
1025
+ "application/json": {
1026
+ "schema": {
1027
+ "$ref": "#/components/schemas/EntityValidationV2ResultError"
1028
+ }
1029
+ }
1030
+ }
951
1031
  }
952
1032
  }
953
1033
  }
@@ -1109,6 +1189,9 @@
1109
1189
  },
1110
1190
  {
1111
1191
  "$ref": "#/components/parameters/AsyncOperationQueryParam"
1192
+ },
1193
+ {
1194
+ "$ref": "#/components/parameters/ValidateEntityQueryParam"
1112
1195
  }
1113
1196
  ],
1114
1197
  "requestBody": {
@@ -1131,6 +1214,16 @@
1131
1214
  }
1132
1215
  }
1133
1216
  }
1217
+ },
1218
+ "422": {
1219
+ "description": "Entity validation error when `?validate=true`",
1220
+ "content": {
1221
+ "application/json": {
1222
+ "schema": {
1223
+ "$ref": "#/components/schemas/EntityValidationV2ResultError"
1224
+ }
1225
+ }
1226
+ }
1134
1227
  }
1135
1228
  }
1136
1229
  },
@@ -1159,6 +1252,9 @@
1159
1252
  },
1160
1253
  {
1161
1254
  "$ref": "#/components/parameters/AsyncOperationQueryParam"
1255
+ },
1256
+ {
1257
+ "$ref": "#/components/parameters/ValidateEntityQueryParam"
1162
1258
  }
1163
1259
  ],
1164
1260
  "requestBody": {
@@ -1185,6 +1281,16 @@
1185
1281
  },
1186
1282
  "409": {
1187
1283
  "description": "Conflict: newer version exists"
1284
+ },
1285
+ "422": {
1286
+ "description": "Entity validation error when `?validate=true`",
1287
+ "content": {
1288
+ "application/json": {
1289
+ "schema": {
1290
+ "$ref": "#/components/schemas/EntityValidationV2ResultError"
1291
+ }
1292
+ }
1293
+ }
1188
1294
  }
1189
1295
  }
1190
1296
  },
@@ -2031,7 +2137,7 @@
2031
2137
  "post": {
2032
2138
  "operationId": "exportEntities",
2033
2139
  "summary": "exportEntities",
2034
- "description": "create export file of entities",
2140
+ "description": "Export entity data in a CSV-format. The export will export data as close as possible to what is visible on Entity UI tables.\nThe values exported as in some cases, transformed to human-readable values.\n\nTo force the export of raw values, use the `#` prefix in front of your field name when specifying the field on the `fields` param.\n",
2035
2141
  "tags": [
2036
2142
  "Export"
2037
2143
  ],
@@ -3431,6 +3537,15 @@
3431
3537
  "type": "string",
3432
3538
  "example": "Contacts"
3433
3539
  },
3540
+ "description": {
3541
+ "type": "string",
3542
+ "example": "Example description"
3543
+ },
3544
+ "docs_url": {
3545
+ "type": "string",
3546
+ "format": "uri",
3547
+ "example": "https://docs.epilot.io/docs/pricing/entities"
3548
+ },
3434
3549
  "published": {
3435
3550
  "type": "boolean",
3436
3551
  "example": false
@@ -5220,6 +5335,12 @@
5220
5335
  "bottom_divider"
5221
5336
  ]
5222
5337
  },
5338
+ "_purpose": {
5339
+ "type": "array",
5340
+ "items": {
5341
+ "$ref": "#/components/schemas/ClassificationId"
5342
+ }
5343
+ },
5223
5344
  "_manifest": {
5224
5345
  "type": "array",
5225
5346
  "description": "Manifest ID used to create/update the schema group headline",
@@ -5929,6 +6050,112 @@
5929
6050
  }
5930
6051
  ]
5931
6052
  },
6053
+ "EntityValidationV2Error": {
6054
+ "type": "object",
6055
+ "properties": {
6056
+ "keyword": {
6057
+ "type": "string",
6058
+ "description": "validation keyword."
6059
+ },
6060
+ "instance_path": {
6061
+ "type": "string",
6062
+ "description": "JSON Pointer to the location in the data instance (e.g., `\"/prop/1/subProp\"`)."
6063
+ },
6064
+ "schema_path": {
6065
+ "type": "string",
6066
+ "description": "JSON Pointer to the location of the failing keyword in the schema."
6067
+ },
6068
+ "params": {
6069
+ "type": "object",
6070
+ "description": "Additional information about error.",
6071
+ "additionalProperties": true
6072
+ },
6073
+ "property_name": {
6074
+ "type": "string",
6075
+ "description": "Set for errors in `propertyNames` keyword schema. `instance_path` still points to the object in this case."
6076
+ },
6077
+ "message": {
6078
+ "type": "string",
6079
+ "description": "The error message."
6080
+ },
6081
+ "schema": {
6082
+ "type": "object",
6083
+ "description": "The value of the failing keyword in the schema."
6084
+ },
6085
+ "parent_schema": {
6086
+ "type": "object",
6087
+ "description": "The schema containing the keyword.",
6088
+ "additionalProperties": true
6089
+ },
6090
+ "data": {
6091
+ "type": "object",
6092
+ "description": "The data validated by the keyword.",
6093
+ "additionalProperties": true
6094
+ }
6095
+ },
6096
+ "required": [
6097
+ "keyword",
6098
+ "instance_path",
6099
+ "schema_path",
6100
+ "params"
6101
+ ]
6102
+ },
6103
+ "EntityValidationV2ResultSuccess": {
6104
+ "type": "object",
6105
+ "description": "Validation result for a successful validation",
6106
+ "properties": {
6107
+ "status": {
6108
+ "type": "string",
6109
+ "enum": [
6110
+ "success"
6111
+ ]
6112
+ },
6113
+ "errors": {
6114
+ "type": "array",
6115
+ "maxItems": 0,
6116
+ "items": {
6117
+ "$ref": "#/components/schemas/EntityValidationV2Error"
6118
+ }
6119
+ }
6120
+ },
6121
+ "required": [
6122
+ "status",
6123
+ "errors"
6124
+ ]
6125
+ },
6126
+ "EntityValidationV2ResultError": {
6127
+ "type": "object",
6128
+ "description": "Validation result for a failed validation",
6129
+ "properties": {
6130
+ "status": {
6131
+ "type": "string",
6132
+ "enum": [
6133
+ "error"
6134
+ ]
6135
+ },
6136
+ "errors": {
6137
+ "type": "array",
6138
+ "minItems": 1,
6139
+ "items": {
6140
+ "$ref": "#/components/schemas/EntityValidationV2Error"
6141
+ }
6142
+ }
6143
+ },
6144
+ "required": [
6145
+ "status",
6146
+ "errors"
6147
+ ]
6148
+ },
6149
+ "EntityValidationV2Result": {
6150
+ "oneOf": [
6151
+ {
6152
+ "$ref": "#/components/schemas/EntityValidationV2ResultSuccess"
6153
+ },
6154
+ {
6155
+ "$ref": "#/components/schemas/EntityValidationV2ResultError"
6156
+ }
6157
+ ]
6158
+ },
5932
6159
  "HydratedEntityItem": {
5933
6160
  "allOf": [
5934
6161
  {
@@ -7225,6 +7452,15 @@
7225
7452
  "type": "boolean",
7226
7453
  "default": false
7227
7454
  }
7455
+ },
7456
+ "ValidateEntityQueryParam": {
7457
+ "name": "validate",
7458
+ "description": "When true, enables entity validation against the entity schema.",
7459
+ "in": "query",
7460
+ "schema": {
7461
+ "default": false,
7462
+ "type": "boolean"
7463
+ }
7228
7464
  }
7229
7465
  },
7230
7466
  "examples": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/entity-client",
3
- "version": "4.31.2",
3
+ "version": "4.32.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",