@epilot/entity-client 6.8.0 → 6.9.0-alpha.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={390:function(e,t,a){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=r(a(466));t.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"}],"responses":{}}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"}],"responses":{}},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/schema":{"get":{"operationId":"getJsonSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"dereference"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/example":{"get":{"operationId":"getSchemaExample","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/versions":{"get":{"operationId":"getSchemaVersions","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"versions_from"},{"in":"query","name":"versions_size"},{"in":"query","name":"drafts_from"},{"in":"query","name":"drafts_size"},{"in":"query","name":"fields","required":false,"style":"form","explode":false}],"responses":{}}},"/v1/entity/schemas/{slug}/capabilities/available":{"get":{"operationId":"listAvailableCapabilities","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints","responses":{}}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:list":{"post":{"operationId":"listEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}:validate":{"post":{"operationId":"validateEntityV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"},{"name":"strict","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}":{"get":{"operationId":"getEntityV2","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"fields","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}:restore":{"patch":{"operationId":"restoreEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}:reindex":{"post":{"operationId":"reindexEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}],"responses":{}},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"in":"query","name":"purge"}],"responses":{}}},"/v1/entity:autocomplete":{"get":{"operationId":"autocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"slug","in":"query"},{"name":"size","in":"query"}],"responses":{}}},"/v1/entity:wipeAllEntities":{"post":{"operationId":"wipeAllEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}],"responses":{}}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"start_date"},{"in":"query","name":"end_date"},{"in":"query","name":"preset_range"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"},{"in":"query","name":"exclude_activity_groups"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"removeRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"query"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"fields"}],"responses":{}}},"/v3/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV3","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseDeprecatedQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"},{"$ref":"#/components/parameters/EntityRelationsModeQueryParam"},{"in":"query","name":"fields"}],"responses":{}}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"responses":{}}},"/v1/entity:export":{"post":{"operationId":"exportEntities","parameters":[{"in":"query","name":"job_id"},{"in":"query","name":"is_template"},{"in":"query","name":"language"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/views":{"get":{"operationId":"listSavedViews","parameters":[{"in":"query","name":"slug","required":false},{"in":"query","name":"sort","required":false},{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"in":"query","name":"fields","required":false}],"responses":{}}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser","responses":{}}},"/v1/entity/taxonomies":{"get":{"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"},{"in":"query","name":"type"}],"responses":{}},"post":{"operationId":"createTaxonomy","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"permanent"}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/taxonomies/classifications":{"post":{"operationId":"createTaxonomyClassification","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/taxonomies/classifications/{classificationSlug}":{"get":{"operationId":"getTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}],"responses":{}}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"in":"query","name":"taxonomySlug"},{"in":"query","name":"query"},{"in":"query","name":"archived","deprecated":true},{"in":"query","name":"include_archived"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}":{"get":{"operationId":"listTaxonomyClassificationsForSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs":{"get":{"operationId":"getTaxonomyBulkActionJobs","parameters":[{"in":"query","name":"status"},{"in":"query","name":"size"},{"in":"query","name":"created_after"},{"in":"query","name":"sort_pending_first"},{"in":"query","name":"scope"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}":{"get":{"operationId":"getTaxonomyBulkActionJobById","parameters":[{"in":"path","name":"job_id","required":true}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}/cancel":{"post":{"operationId":"cancelBulkAction","parameters":[{"name":"job_id","in":"path","required":true}],"responses":{}}},"/v1/entity/taxonomies/classifications:move":{"post":{"operationId":"bulkMoveClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/classifications:merge":{"post":{"operationId":"bulkMergeClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/classifications:delete":{"post":{"operationId":"bulkDeleteClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/attributes":{"post":{"operationId":"createSchemaAttribute","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/attributes/{composite_id}":{"get":{"operationId":"getSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/capabilities":{"post":{"operationId":"createSchemaCapability","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/capabilities/{composite_id}":{"get":{"operationId":"getSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/group":{"post":{"operationId":"createSchemaGroup","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/group/{composite_id}":{"get":{"operationId":"getSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/headline":{"post":{"operationId":"createSchemaGroupHeadline","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/headline/{composite_id}":{"get":{"operationId":"getSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}}},"components":{"parameters":{"EntityIdPathParam":{"name":"id","in":"path","required":true},"EntitySlugPathParam":{"name":"slug","in":"path","required":true},"EntitySlugPathPriceParam":{"name":"slug","in":"path","required":true},"TaxonomySlugQueryParam":{"name":"taxonomySlug","in":"query","required":true},"TaxonomySlugPathParam":{"name":"taxonomySlug","in":"path","required":true},"TaxonomySlugQueryParamOptional":{"name":"taxonomySlug","in":"query"},"TaxonomyClassificationSlugPathParam":{"name":"classificationSlug","in":"path","required":true},"SavedViewIdPathParam":{"name":"id","in":"path","required":true},"AsyncOperationQueryParam":{"name":"async","in":"query","required":false},"HydrateEntitiesQueryParam":{"name":"hydrate","in":"query"},"ActivityIdQueryParam":{"name":"activity_id","in":"query","required":false},"ActivityIdPathParam":{"name":"id","in":"path","required":true},"FromPageQueryParam":{"name":"from","in":"query"},"IncludeReverseDeprecatedQueryParam":{"name":"include_reverse","in":"query","deprecated":true},"IncludeReverseQueryParam":{"name":"include_reverse","in":"query"},"IncludeSchemasQueryParam":{"name":"include_schemas","in":"query","required":false,"style":"form","explode":false},"ExcludeSchemasQueryParam":{"name":"exclude_schemas","in":"query","required":false,"style":"form","explode":false},"EntityRelationsModeQueryParam":{"name":"mode","in":"query","required":false},"DryRunQueryParam":{"name":"dry_run","in":"query","required":false},"FillActivityQueryParam":{"name":"fill_activity","in":"query","required":false},"ValidateEntityQueryParam":{"name":"validate","in":"query"}},"responses":{"NotFoundError":{"content":{"application/json":{}}},"TooManyRequestsError":{"headers":{"Retry-After":{}},"content":{"application/json":{}}}}},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},a=function a(r){var n=t[r];if(void 0!==n)return n.exports;var s=t[r]={exports:{}};return e[r].call(s.exports,s,s.exports,a),s.exports}(390),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
1
+ (()=>{"use strict";var e={466:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"}],"responses":{}}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"}],"responses":{}},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/schema":{"get":{"operationId":"getJsonSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"dereference"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/example":{"get":{"operationId":"getSchemaExample","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/versions":{"get":{"operationId":"getSchemaVersions","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"versions_from"},{"in":"query","name":"versions_size"},{"in":"query","name":"drafts_from"},{"in":"query","name":"drafts_size"},{"in":"query","name":"fields","required":false,"style":"form","explode":false}],"responses":{}}},"/v1/entity/schemas/{slug}/capabilities/available":{"get":{"operationId":"listAvailableCapabilities","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints","responses":{}}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:list":{"post":{"operationId":"listEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}:validate":{"post":{"operationId":"validateEntityV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"},{"name":"strict","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}":{"get":{"operationId":"getEntityV2","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"fields","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}:restore":{"patch":{"operationId":"restoreEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}:reindex":{"post":{"operationId":"reindexEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}],"responses":{}},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"in":"query","name":"purge"}],"responses":{}}},"/v1/entity:autocomplete":{"get":{"operationId":"autocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"slug","in":"query"},{"name":"size","in":"query"}],"responses":{}}},"/v1/entity:wipeAllEntities":{"post":{"operationId":"wipeAllEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}],"responses":{}}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"start_date"},{"in":"query","name":"end_date"},{"in":"query","name":"preset_range"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"},{"in":"query","name":"exclude_activity_groups"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"removeRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"query"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"fields"}],"responses":{}}},"/v3/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV3","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseDeprecatedQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"},{"$ref":"#/components/parameters/EntityRelationsModeQueryParam"},{"in":"query","name":"fields"}],"responses":{}}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"responses":{}}},"/v1/entity:export":{"post":{"operationId":"exportEntities","parameters":[{"in":"query","name":"job_id"},{"in":"query","name":"is_template"},{"in":"query","name":"language"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/views":{"get":{"operationId":"listSavedViews","parameters":[{"in":"query","name":"slug","required":false},{"in":"query","name":"sort","required":false},{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"in":"query","name":"fields","required":false}],"responses":{}}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser","responses":{}}},"/v1/entity/taxonomies":{"get":{"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"},{"in":"query","name":"type"}],"responses":{}},"post":{"operationId":"createTaxonomy","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"permanent"}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/taxonomies/classifications":{"post":{"operationId":"createTaxonomyClassification","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/taxonomies/classifications/{classificationSlug}":{"get":{"operationId":"getTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}],"responses":{}}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"in":"query","name":"taxonomySlug"},{"in":"query","name":"query"},{"in":"query","name":"archived","deprecated":true},{"in":"query","name":"include_archived"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}":{"get":{"operationId":"listTaxonomyClassificationsForSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs":{"get":{"operationId":"getTaxonomyBulkActionJobs","parameters":[{"in":"query","name":"status"},{"in":"query","name":"size"},{"in":"query","name":"created_after"},{"in":"query","name":"sort_pending_first"},{"in":"query","name":"scope"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}":{"get":{"operationId":"getTaxonomyBulkActionJobById","parameters":[{"in":"path","name":"job_id","required":true}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}/cancel":{"post":{"operationId":"cancelBulkAction","parameters":[{"name":"job_id","in":"path","required":true}],"responses":{}}},"/v1/entity/taxonomies/classifications:move":{"post":{"operationId":"bulkMoveClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/classifications:merge":{"post":{"operationId":"bulkMergeClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/classifications:delete":{"post":{"operationId":"bulkDeleteClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/attributes":{"post":{"operationId":"createSchemaAttribute","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/attributes/{composite_id}":{"get":{"operationId":"getSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/capabilities":{"post":{"operationId":"createSchemaCapability","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/capabilities/{composite_id}":{"get":{"operationId":"getSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/group":{"post":{"operationId":"createSchemaGroup","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/group/{composite_id}":{"get":{"operationId":"getSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/headline":{"post":{"operationId":"createSchemaGroupHeadline","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/headline/{composite_id}":{"get":{"operationId":"getSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}}},"components":{"parameters":{"EntityIdPathParam":{"name":"id","in":"path","required":true},"EntitySlugPathParam":{"name":"slug","in":"path","required":true},"EntitySlugPathPriceParam":{"name":"slug","in":"path","required":true},"TaxonomySlugQueryParam":{"name":"taxonomySlug","in":"query","required":true},"TaxonomySlugPathParam":{"name":"taxonomySlug","in":"path","required":true},"TaxonomySlugQueryParamOptional":{"name":"taxonomySlug","in":"query"},"TaxonomyClassificationSlugPathParam":{"name":"classificationSlug","in":"path","required":true},"SavedViewIdPathParam":{"name":"id","in":"path","required":true},"AsyncOperationQueryParam":{"name":"async","in":"query","required":false},"HydrateEntitiesQueryParam":{"name":"hydrate","in":"query"},"ActivityIdQueryParam":{"name":"activity_id","in":"query","required":false},"ActivityIdPathParam":{"name":"id","in":"path","required":true},"FromPageQueryParam":{"name":"from","in":"query"},"IncludeReverseDeprecatedQueryParam":{"name":"include_reverse","in":"query","deprecated":true},"IncludeReverseQueryParam":{"name":"include_reverse","in":"query"},"IncludeSchemasQueryParam":{"name":"include_schemas","in":"query","required":false,"style":"form","explode":false},"ExcludeSchemasQueryParam":{"name":"exclude_schemas","in":"query","required":false,"style":"form","explode":false},"EntityRelationsModeQueryParam":{"name":"mode","in":"query","required":false},"DryRunQueryParam":{"name":"dry_run","in":"query","required":false},"FillActivityQueryParam":{"name":"fill_activity","in":"query","required":false},"ValidateEntityQueryParam":{"name":"validate","in":"query"}},"responses":{"NotFoundError":{"content":{"application/json":{}}},"TooManyRequestsError":{"headers":{"Retry-After":{}},"content":{"application/json":{}}}}},"servers":[{"url":"https://entity.sls.epilot.io"}]}')},757:function(e,t,a){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=r(a(466));t.default=n.default}},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}(757),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
package/dist/openapi.d.ts CHANGED
@@ -31,19 +31,19 @@ declare namespace Components {
31
31
  * example:
32
32
  * contact
33
33
  */
34
- Schemas.EntitySlug;
34
+ Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
35
35
  /**
36
36
  * URL-friendly identifier for the entity schema
37
37
  * example:
38
38
  * price
39
39
  */
40
- export type EntitySlugPathPriceParam = string;
40
+ export type EntitySlugPathPriceParam = string; // ^[a-zA-Z0-9_-]+$
41
41
  export type ExcludeSchemasQueryParam = /**
42
42
  * URL-friendly identifier for the entity schema
43
43
  * example:
44
44
  * contact
45
45
  */
46
- Schemas.EntitySlug[];
46
+ Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
47
47
  export type FillActivityQueryParam = boolean;
48
48
  export type FromPageQueryParam = number;
49
49
  export type HydrateEntitiesQueryParam = boolean;
@@ -54,7 +54,7 @@ declare namespace Components {
54
54
  * example:
55
55
  * contact
56
56
  */
57
- Schemas.EntitySlug[];
57
+ Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
58
58
  export type SavedViewIdPathParam = /* Generated uuid for a saved view */ Schemas.SavedViewId /* uuid */;
59
59
  export type TaxonomyClassificationSlugPathParam = string;
60
60
  export type TaxonomySlugPathParam = string;
@@ -70,7 +70,7 @@ declare namespace Components {
70
70
  * example:
71
71
  * price
72
72
  */
73
- Parameters.EntitySlugPathPriceParam;
73
+ Parameters.EntitySlugPathPriceParam /* ^[a-zA-Z0-9_-]+$ */;
74
74
  TaxonomySlugPathParam?: Parameters.TaxonomySlugPathParam;
75
75
  TaxonomyClassificationSlugPathParam?: Parameters.TaxonomyClassificationSlugPathParam;
76
76
  SavedViewIdPathParam?: Parameters.SavedViewIdPathParam;
@@ -615,7 +615,7 @@ declare namespace Components {
615
615
  */
616
616
  DefaultAddressFields;
617
617
  }
618
- export type Attribute = /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Address attribute */ AddressAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Tags */ TagsAttribute | /* Message emil address */ MessageEmailAddressAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute | /* Shared Partner Organisations */ PartnerOrganisationAttribute | /* Phone number */ PhoneAttribute | /* Email address */ EmailAttribute | /* Payment method */ PaymentAttribute | /* Price component */ PriceComponentAttribute;
618
+ export type Attribute = /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Address attribute */ AddressAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Tags */ TagsAttribute | /* Message emil address */ MessageEmailAddressAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute | /* Shared Partner Organisations */ PartnerOrganisationAttribute | /* Portal access configuration */ PortalAccessAttribute | /* Phone number */ PhoneAttribute | /* Email address */ EmailAttribute | /* Payment method */ PaymentAttribute | /* Price component */ PriceComponentAttribute;
619
619
  /**
620
620
  * a readonly computed ID for the attribute including schema slug and the attribute ID
621
621
  */
@@ -631,7 +631,7 @@ declare namespace Components {
631
631
  * contact
632
632
  */
633
633
  schema?: string;
634
- } & (/* a readonly computed ID for the attribute including schema slug and the attribute ID */ /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Address attribute */ AddressAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Tags */ TagsAttribute | /* Message emil address */ MessageEmailAddressAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute | /* Shared Partner Organisations */ PartnerOrganisationAttribute | /* Phone number */ PhoneAttribute | /* Email address */ EmailAttribute | /* Payment method */ PaymentAttribute | /* Price component */ PriceComponentAttribute);
634
+ } & (/* a readonly computed ID for the attribute including schema slug and the attribute ID */ /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Address attribute */ AddressAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Tags */ TagsAttribute | /* Message emil address */ MessageEmailAddressAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute | /* Shared Partner Organisations */ PartnerOrganisationAttribute | /* Portal access configuration */ PortalAccessAttribute | /* Phone number */ PhoneAttribute | /* Email address */ EmailAttribute | /* Payment method */ PaymentAttribute | /* Price component */ PriceComponentAttribute);
635
635
  /**
636
636
  * Automation entity
637
637
  */
@@ -1009,7 +1009,7 @@ declare namespace Components {
1009
1009
  * example:
1010
1010
  * contact
1011
1011
  */
1012
- EntitySlug;
1012
+ EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
1013
1013
  /**
1014
1014
  * Title of entity
1015
1015
  */
@@ -1184,6 +1184,18 @@ declare namespace Components {
1184
1184
  * taxonomy-slug:classification-slug
1185
1185
  */
1186
1186
  export type ClassificationId = string;
1187
+ export type ClassificationIdOrPattern = /**
1188
+ * example:
1189
+ * taxonomy-slug:classification-slug
1190
+ */
1191
+ ClassificationId | {
1192
+ /**
1193
+ * Wildcard pattern to match classification IDs starting with the prefix before ':*'
1194
+ * example:
1195
+ * taxonomy-slug:*
1196
+ */
1197
+ pattern: string;
1198
+ };
1187
1199
  /**
1188
1200
  * URL-friendly identifier for the classification
1189
1201
  * example:
@@ -2164,7 +2176,7 @@ declare namespace Components {
2164
2176
  * example:
2165
2177
  * contact
2166
2178
  */
2167
- EntitySlug;
2179
+ EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
2168
2180
  /**
2169
2181
  * Title of entity
2170
2182
  */
@@ -2631,7 +2643,7 @@ declare namespace Components {
2631
2643
  * example:
2632
2644
  * contact
2633
2645
  */
2634
- EntitySlug;
2646
+ EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
2635
2647
  /**
2636
2648
  * Title of entity
2637
2649
  */
@@ -2803,7 +2815,7 @@ declare namespace Components {
2803
2815
  * example:
2804
2816
  * contact
2805
2817
  */
2806
- EntitySlug;
2818
+ EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
2807
2819
  };
2808
2820
  /**
2809
2821
  * example:
@@ -2860,7 +2872,7 @@ declare namespace Components {
2860
2872
  * example:
2861
2873
  * contact
2862
2874
  */
2863
- EntitySlug;
2875
+ EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
2864
2876
  /**
2865
2877
  * Title of entity
2866
2878
  */
@@ -3022,7 +3034,7 @@ declare namespace Components {
3022
3034
  * example:
3023
3035
  * contact
3024
3036
  */
3025
- EntitySlug;
3037
+ EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
3026
3038
  version?: number;
3027
3039
  blueprint?: /* Reference to blueprint */ BlueprintEntityId /* uuid */;
3028
3040
  /**
@@ -3402,7 +3414,7 @@ declare namespace Components {
3402
3414
  * example:
3403
3415
  * contact
3404
3416
  */
3405
- EntitySlug;
3417
+ EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
3406
3418
  version?: number;
3407
3419
  blueprint?: /* Reference to blueprint */ BlueprintEntityId /* uuid */;
3408
3420
  /**
@@ -3930,7 +3942,7 @@ declare namespace Components {
3930
3942
  * example:
3931
3943
  * contact
3932
3944
  */
3933
- export type EntitySlug = string;
3945
+ export type EntitySlug = string; // ^[a-zA-Z0-9_-]+$
3934
3946
  export interface EntityTableFilterOption {
3935
3947
  /**
3936
3948
  * The type of filter option
@@ -4603,7 +4615,7 @@ declare namespace Components {
4603
4615
  * example:
4604
4616
  * contact
4605
4617
  */
4606
- EntitySlug;
4618
+ EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
4607
4619
  /**
4608
4620
  * Title of entity
4609
4621
  */
@@ -6503,6 +6515,147 @@ declare namespace Components {
6503
6515
  has_primary?: boolean;
6504
6516
  type: "phone";
6505
6517
  }
6518
+ /**
6519
+ * Portal access configuration
6520
+ */
6521
+ export interface PortalAccessAttribute {
6522
+ /**
6523
+ * ID for the entity attribute
6524
+ * example:
6525
+ * d5839b94-ba20-4225-a78e-76951d352bd6
6526
+ */
6527
+ id?: string;
6528
+ name: string;
6529
+ label: string;
6530
+ placeholder?: string;
6531
+ /**
6532
+ * Do not render attribute in entity views
6533
+ */
6534
+ hidden?: boolean;
6535
+ /**
6536
+ * Render as a column in table views. When defined, overrides `hidden`
6537
+ */
6538
+ show_in_table?: boolean;
6539
+ /**
6540
+ * Allow sorting by this attribute in table views if `show_in_table` is true
6541
+ */
6542
+ sortable?: boolean;
6543
+ required?: boolean;
6544
+ readonly?: boolean;
6545
+ deprecated?: boolean;
6546
+ default_value?: any;
6547
+ /**
6548
+ * Which group the attribute should appear in. Accepts group ID or group name
6549
+ */
6550
+ group?: string;
6551
+ /**
6552
+ * Attribute sort order (ascending) in group
6553
+ * example:
6554
+ * 0
6555
+ */
6556
+ order?: number;
6557
+ /**
6558
+ * example:
6559
+ * full_width
6560
+ */
6561
+ layout?: string;
6562
+ /**
6563
+ * When set to true, will hide the label of the field.
6564
+ */
6565
+ hide_label?: boolean;
6566
+ /**
6567
+ * Code name of the icon to used to represent this attribute.
6568
+ * The value must be a valid @epilot/base-elements Icon name
6569
+ *
6570
+ */
6571
+ icon?: string;
6572
+ /**
6573
+ * Defines the conditional rendering expression for showing this field.
6574
+ * When a valid expression is parsed, their evaluation defines the visibility of this attribute.
6575
+ * Note: Empty or invalid expression have no effect on the field visibility.
6576
+ *
6577
+ */
6578
+ render_condition?: string;
6579
+ _purpose?: /**
6580
+ * example:
6581
+ * taxonomy-slug:classification-slug
6582
+ */
6583
+ ClassificationId[];
6584
+ /**
6585
+ * Manifest ID used to create/update the schema attribute
6586
+ */
6587
+ _manifest?: string /* uuid */[] | null;
6588
+ /**
6589
+ * A set of constraints applicable to the attribute.
6590
+ * These constraints should and will be enforced by the attribute renderer.
6591
+ *
6592
+ * example:
6593
+ * {
6594
+ * "disablePast": true
6595
+ * }
6596
+ */
6597
+ constraints?: {
6598
+ [key: string]: any;
6599
+ };
6600
+ /**
6601
+ * This attribute should only be active when the feature flag is enabled
6602
+ * example:
6603
+ * FF_MY_FEATURE_FLAG
6604
+ */
6605
+ feature_flag?: string;
6606
+ /**
6607
+ * This attribute should only be active when one of the provided settings have the correct value
6608
+ */
6609
+ settings_flag?: SettingFlag[];
6610
+ value_formatter?: string;
6611
+ preview_value_formatter?: string;
6612
+ /**
6613
+ * Setting to `true` disables editing the attribute on the entity builder UI
6614
+ */
6615
+ entity_builder_disable_edit?: boolean;
6616
+ /**
6617
+ * Setting to `true` prevents the attribute from being modified / deleted
6618
+ */
6619
+ protected?: boolean;
6620
+ /**
6621
+ * A set of configurations meant to document and assist the user in filling the attribute.
6622
+ */
6623
+ info_helpers?: {
6624
+ /**
6625
+ * The text to be displayed in the attribute hint helper.
6626
+ * When specified it overrides the `hint_text_key` configuration.
6627
+ *
6628
+ */
6629
+ hint_text?: string;
6630
+ /**
6631
+ * The key of the hint text to be displayed in the attribute hint helper.
6632
+ * The key should be a valid i18n key.
6633
+ *
6634
+ */
6635
+ hint_text_key?: string;
6636
+ /**
6637
+ * The name of the custom component to be used as the hint helper.
6638
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
6639
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
6640
+ *
6641
+ */
6642
+ hint_custom_component?: string;
6643
+ /**
6644
+ * The placement of the hint tooltip.
6645
+ * The value should be a valid `@mui/core` tooltip placement.
6646
+ *
6647
+ * example:
6648
+ * top
6649
+ */
6650
+ hint_tooltip_placement?: string;
6651
+ };
6652
+ /**
6653
+ * The attribute is a repeatable
6654
+ */
6655
+ repeatable?: boolean;
6656
+ has_primary?: boolean;
6657
+ type: "portal_access";
6658
+ }
6506
6659
  /**
6507
6660
  * Price component
6508
6661
  */
@@ -7039,7 +7192,7 @@ declare namespace Components {
7039
7192
  * example:
7040
7193
  * contact
7041
7194
  */
7042
- EntitySlug[];
7195
+ EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
7043
7196
  /**
7044
7197
  * When enable_relation_tags is set to true the user will be able to set tags(labels) in each relation item.
7045
7198
  */
@@ -7107,7 +7260,7 @@ declare namespace Components {
7107
7260
  * example:
7108
7261
  * contact
7109
7262
  */
7110
- EntitySlug;
7263
+ EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
7111
7264
  /**
7112
7265
  * Title of entity
7113
7266
  */
@@ -7297,7 +7450,7 @@ declare namespace Components {
7297
7450
  * example:
7298
7451
  * contact
7299
7452
  */
7300
- EntitySlug[];
7453
+ EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
7301
7454
  /**
7302
7455
  * User-friendly identifier for the saved view
7303
7456
  * example:
@@ -7374,7 +7527,7 @@ declare namespace Components {
7374
7527
  * example:
7375
7528
  * contact
7376
7529
  */
7377
- EntitySlug[];
7530
+ EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
7378
7531
  /**
7379
7532
  * User-friendly identifier for the saved view
7380
7533
  * example:
@@ -7444,7 +7597,7 @@ declare namespace Components {
7444
7597
  * example:
7445
7598
  * contact
7446
7599
  */
7447
- EntitySlug[];
7600
+ EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
7448
7601
  /**
7449
7602
  * User-friendly identifier for the saved view
7450
7603
  * example:
@@ -8534,6 +8687,10 @@ declare namespace Components {
8534
8687
  * Archived classification are not visible in the UI
8535
8688
  */
8536
8689
  archived?: boolean;
8690
+ /**
8691
+ * Starred taxonomy classifications can represent "favorites" or commonly used classifications
8692
+ */
8693
+ starred?: boolean;
8537
8694
  /**
8538
8695
  * Manifest ID used to create/update the taxonomy classification
8539
8696
  */
@@ -8870,7 +9027,7 @@ declare namespace Paths {
8870
9027
  * example:
8871
9028
  * contact
8872
9029
  */
8873
- Components.Schemas.EntitySlug;
9030
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
8874
9031
  }
8875
9032
  export interface PathParameters {
8876
9033
  slug: Parameters.Slug;
@@ -8946,7 +9103,7 @@ declare namespace Paths {
8946
9103
  * example:
8947
9104
  * contact
8948
9105
  */
8949
- Components.Schemas.EntitySlug;
9106
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
8950
9107
  }
8951
9108
  export interface QueryParameters {
8952
9109
  input?: Parameters.Input;
@@ -9146,7 +9303,7 @@ declare namespace Paths {
9146
9303
  * example:
9147
9304
  * contact
9148
9305
  */
9149
- Components.Schemas.EntitySlug;
9306
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
9150
9307
  export type Validate = boolean;
9151
9308
  }
9152
9309
  export interface PathParameters {
@@ -9350,6 +9507,8 @@ declare namespace Paths {
9350
9507
  export type RequestBody = Components.Schemas.TaxonomyClassification;
9351
9508
  namespace Responses {
9352
9509
  export type $201 = Components.Schemas.TaxonomyClassification;
9510
+ export interface $409 {
9511
+ }
9353
9512
  export type $429 = /**
9354
9513
  * A generic error returned by the API
9355
9514
  * example:
@@ -9376,7 +9535,7 @@ declare namespace Paths {
9376
9535
  * example:
9377
9536
  * contact
9378
9537
  */
9379
- Components.Schemas.EntitySlug;
9538
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
9380
9539
  }
9381
9540
  export interface PathParameters {
9382
9541
  slug: Parameters.Slug;
@@ -9417,7 +9576,7 @@ declare namespace Paths {
9417
9576
  * example:
9418
9577
  * contact
9419
9578
  */
9420
- Components.Schemas.EntitySlug;
9579
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
9421
9580
  }
9422
9581
  export interface PathParameters {
9423
9582
  slug: Parameters.Slug;
@@ -9480,7 +9639,7 @@ declare namespace Paths {
9480
9639
  * example:
9481
9640
  * contact
9482
9641
  */
9483
- Components.Schemas.EntitySlug;
9642
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
9484
9643
  }
9485
9644
  export interface PathParameters {
9486
9645
  slug: Parameters.Slug;
@@ -9729,7 +9888,7 @@ declare namespace Paths {
9729
9888
  * example:
9730
9889
  * contact
9731
9890
  */
9732
- Components.Schemas.EntitySlug;
9891
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
9733
9892
  }
9734
9893
  export interface PathParameters {
9735
9894
  id: Parameters.Id;
@@ -9870,7 +10029,7 @@ declare namespace Paths {
9870
10029
  * example:
9871
10030
  * contact
9872
10031
  */
9873
- Components.Schemas.EntitySlug;
10032
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
9874
10033
  export type StartDate = string; // date-time
9875
10034
  /**
9876
10035
  * example:
@@ -9953,7 +10112,7 @@ declare namespace Paths {
9953
10112
  * example:
9954
10113
  * contact
9955
10114
  */
9956
- Components.Schemas.EntitySlug;
10115
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
9957
10116
  }
9958
10117
  export interface PathParameters {
9959
10118
  id: Parameters.Id;
@@ -10030,7 +10189,7 @@ declare namespace Paths {
10030
10189
  * example:
10031
10190
  * contact
10032
10191
  */
10033
- Components.Schemas.EntitySlug;
10192
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
10034
10193
  }
10035
10194
  export interface PathParameters {
10036
10195
  slug: Parameters.Slug;
@@ -10349,14 +10508,14 @@ declare namespace Paths {
10349
10508
  * example:
10350
10509
  * contact
10351
10510
  */
10352
- Components.Schemas.EntitySlug[];
10511
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
10353
10512
  export type Id = Components.Schemas.EntityId /* uuid */;
10354
10513
  export type Slug = /**
10355
10514
  * URL-friendly identifier for the entity schema
10356
10515
  * example:
10357
10516
  * contact
10358
10517
  */
10359
- Components.Schemas.EntitySlug;
10518
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
10360
10519
  }
10361
10520
  export interface PathParameters {
10362
10521
  slug: Parameters.Slug;
@@ -10385,7 +10544,7 @@ declare namespace Paths {
10385
10544
  * example:
10386
10545
  * contact
10387
10546
  */
10388
- Components.Schemas.EntitySlug[];
10547
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
10389
10548
  export type From = number;
10390
10549
  export type Hydrate = boolean;
10391
10550
  export type Id = Components.Schemas.EntityId /* uuid */;
@@ -10395,14 +10554,14 @@ declare namespace Paths {
10395
10554
  * example:
10396
10555
  * contact
10397
10556
  */
10398
- Components.Schemas.EntitySlug[];
10557
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
10399
10558
  export type Size = number;
10400
10559
  export type Slug = /**
10401
10560
  * URL-friendly identifier for the entity schema
10402
10561
  * example:
10403
10562
  * contact
10404
10563
  */
10405
- Components.Schemas.EntitySlug;
10564
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
10406
10565
  }
10407
10566
  export interface PathParameters {
10408
10567
  slug: Parameters.Slug;
@@ -10460,7 +10619,7 @@ declare namespace Paths {
10460
10619
  * example:
10461
10620
  * contact
10462
10621
  */
10463
- Components.Schemas.EntitySlug;
10622
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
10464
10623
  }
10465
10624
  export interface PathParameters {
10466
10625
  slug: Parameters.Slug;
@@ -10494,7 +10653,7 @@ declare namespace Paths {
10494
10653
  * example:
10495
10654
  * contact
10496
10655
  */
10497
- Components.Schemas.EntitySlug[];
10656
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
10498
10657
  export type Fields = /**
10499
10658
  * List of entity fields to include or exclude in the response
10500
10659
  *
@@ -10522,7 +10681,7 @@ declare namespace Paths {
10522
10681
  * example:
10523
10682
  * contact
10524
10683
  */
10525
- Components.Schemas.EntitySlug[];
10684
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
10526
10685
  export type Mode = "direct" | "reverse" | "both";
10527
10686
  export type Size = number;
10528
10687
  export type Slug = /**
@@ -10530,7 +10689,7 @@ declare namespace Paths {
10530
10689
  * example:
10531
10690
  * contact
10532
10691
  */
10533
- Components.Schemas.EntitySlug;
10692
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
10534
10693
  }
10535
10694
  export interface PathParameters {
10536
10695
  slug: Parameters.Slug;
@@ -10587,7 +10746,7 @@ declare namespace Paths {
10587
10746
  * example:
10588
10747
  * contact
10589
10748
  */
10590
- Components.Schemas.EntitySlug;
10749
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
10591
10750
  }
10592
10751
  export interface PathParameters {
10593
10752
  slug: Parameters.Slug;
@@ -10671,7 +10830,7 @@ declare namespace Paths {
10671
10830
  * example:
10672
10831
  * contact
10673
10832
  */
10674
- Components.Schemas.EntitySlug;
10833
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
10675
10834
  }
10676
10835
  export interface PathParameters {
10677
10836
  slug: Parameters.Slug;
@@ -10764,7 +10923,7 @@ declare namespace Paths {
10764
10923
  * example:
10765
10924
  * contact
10766
10925
  */
10767
- Components.Schemas.EntitySlug;
10926
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
10768
10927
  export type VersionsFrom = number;
10769
10928
  export type VersionsSize = number;
10770
10929
  }
@@ -10951,7 +11110,7 @@ declare namespace Paths {
10951
11110
  * example:
10952
11111
  * contact
10953
11112
  */
10954
- Components.Schemas.EntitySlug;
11113
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
10955
11114
  }
10956
11115
  export interface PathParameters {
10957
11116
  slug: Parameters.Slug;
@@ -11011,7 +11170,7 @@ declare namespace Paths {
11011
11170
  * example:
11012
11171
  * contact
11013
11172
  */
11014
- Components.Schemas.EntitySlug;
11173
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
11015
11174
  export type Sort = string;
11016
11175
  }
11017
11176
  export interface QueryParameters {
@@ -11069,7 +11228,7 @@ declare namespace Paths {
11069
11228
  * example:
11070
11229
  * contact
11071
11230
  */
11072
- Components.Schemas.EntitySlug;
11231
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
11073
11232
  export type TaxonomySlug = string;
11074
11233
  }
11075
11234
  export interface PathParameters {
@@ -11103,7 +11262,7 @@ declare namespace Paths {
11103
11262
  * example:
11104
11263
  * contact
11105
11264
  */
11106
- Components.Schemas.EntitySlug;
11265
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
11107
11266
  export type Validate = boolean;
11108
11267
  }
11109
11268
  export interface PathParameters {
@@ -11226,7 +11385,7 @@ declare namespace Paths {
11226
11385
  * example:
11227
11386
  * contact
11228
11387
  */
11229
- Components.Schemas.EntitySlug;
11388
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
11230
11389
  }
11231
11390
  export interface PathParameters {
11232
11391
  slug: Parameters.Slug;
@@ -11336,7 +11495,7 @@ declare namespace Paths {
11336
11495
  * example:
11337
11496
  * contact
11338
11497
  */
11339
- Components.Schemas.EntitySlug;
11498
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
11340
11499
  }
11341
11500
  export interface PathParameters {
11342
11501
  id: Parameters.Id;
@@ -11425,7 +11584,7 @@ declare namespace Paths {
11425
11584
  * example:
11426
11585
  * contact
11427
11586
  */
11428
- Components.Schemas.EntitySlug;
11587
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
11429
11588
  }
11430
11589
  export interface PathParameters {
11431
11590
  slug: Parameters.Slug;
@@ -11473,7 +11632,7 @@ declare namespace Paths {
11473
11632
  * example:
11474
11633
  * contact
11475
11634
  */
11476
- Components.Schemas.EntitySlug;
11635
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
11477
11636
  }
11478
11637
  export interface PathParameters {
11479
11638
  id: Parameters.Id;
@@ -11604,11 +11763,7 @@ declare namespace Paths {
11604
11763
  include_archived?: Parameters.IncludeArchived;
11605
11764
  }
11606
11765
  export interface RequestBody {
11607
- classificationIds?: /**
11608
- * example:
11609
- * taxonomy-slug:classification-slug
11610
- */
11611
- Components.Schemas.ClassificationId[];
11766
+ classificationIds?: Components.Schemas.ClassificationIdOrPattern[];
11612
11767
  }
11613
11768
  namespace Responses {
11614
11769
  export interface $200 {
@@ -11701,7 +11856,7 @@ declare namespace Paths {
11701
11856
  * example:
11702
11857
  * contact
11703
11858
  */
11704
- Components.Schemas.EntitySlug;
11859
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
11705
11860
  export type Validate = boolean;
11706
11861
  }
11707
11862
  export interface PathParameters {
@@ -11818,7 +11973,7 @@ declare namespace Paths {
11818
11973
  * example:
11819
11974
  * contact
11820
11975
  */
11821
- Components.Schemas.EntitySlug;
11976
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
11822
11977
  }
11823
11978
  export interface PathParameters {
11824
11979
  slug: Parameters.Slug;
@@ -11900,7 +12055,7 @@ declare namespace Paths {
11900
12055
  * example:
11901
12056
  * contact
11902
12057
  */
11903
- Components.Schemas.EntitySlug;
12058
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */;
11904
12059
  export type Strict = boolean;
11905
12060
  export type Validate = boolean;
11906
12061
  }
@@ -12078,7 +12233,7 @@ declare namespace Paths {
12078
12233
  * example:
12079
12234
  * price
12080
12235
  */
12081
- export type Slug = string;
12236
+ export type Slug = string; // ^[a-zA-Z0-9_-]+$
12082
12237
  }
12083
12238
  export interface PathParameters {
12084
12239
  slug: /**
@@ -12086,7 +12241,7 @@ declare namespace Paths {
12086
12241
  * example:
12087
12242
  * price
12088
12243
  */
12089
- Parameters.Slug;
12244
+ Parameters.Slug /* ^[a-zA-Z0-9_-]+$ */;
12090
12245
  }
12091
12246
  export type RequestBody = /**
12092
12247
  * example:
@@ -12145,7 +12300,7 @@ declare namespace Paths {
12145
12300
  * example:
12146
12301
  * price
12147
12302
  */
12148
- export type Slug = string;
12303
+ export type Slug = string; // ^[a-zA-Z0-9_-]+$
12149
12304
  }
12150
12305
  export interface PathParameters {
12151
12306
  slug: /**
@@ -12153,7 +12308,7 @@ declare namespace Paths {
12153
12308
  * example:
12154
12309
  * price
12155
12310
  */
12156
- Parameters.Slug;
12311
+ Parameters.Slug /* ^[a-zA-Z0-9_-]+$ */;
12157
12312
  }
12158
12313
  export type RequestBody = /**
12159
12314
  * example:
@@ -12212,7 +12367,7 @@ declare namespace Paths {
12212
12367
  * example:
12213
12368
  * contact
12214
12369
  */
12215
- Components.Schemas.EntitySlug[];
12370
+ Components.Schemas.EntitySlug /* ^[a-zA-Z0-9_-]+$ */[];
12216
12371
  }
12217
12372
  namespace Responses {
12218
12373
  export interface $201 {
@@ -14522,6 +14677,7 @@ export type BaseEntity = Components.Schemas.BaseEntity;
14522
14677
  export type BlueprintEntityId = Components.Schemas.BlueprintEntityId;
14523
14678
  export type BooleanAttribute = Components.Schemas.BooleanAttribute;
14524
14679
  export type ClassificationId = Components.Schemas.ClassificationId;
14680
+ export type ClassificationIdOrPattern = Components.Schemas.ClassificationIdOrPattern;
14525
14681
  export type ClassificationSlug = Components.Schemas.ClassificationSlug;
14526
14682
  export type ClassificationsUpdate = Components.Schemas.ClassificationsUpdate;
14527
14683
  export type ComputedAttribute = Components.Schemas.ComputedAttribute;
@@ -14595,6 +14751,7 @@ export type PartnerStatusAttribute = Components.Schemas.PartnerStatusAttribute;
14595
14751
  export type PaymentAttribute = Components.Schemas.PaymentAttribute;
14596
14752
  export type PaymentMethodRelationAttribute = Components.Schemas.PaymentMethodRelationAttribute;
14597
14753
  export type PhoneAttribute = Components.Schemas.PhoneAttribute;
14754
+ export type PortalAccessAttribute = Components.Schemas.PortalAccessAttribute;
14598
14755
  export type PriceComponentAttribute = Components.Schemas.PriceComponentAttribute;
14599
14756
  export type PurposeAttribute = Components.Schemas.PurposeAttribute;
14600
14757
  export type RedirectEntityView = Components.Schemas.RedirectEntityView;
package/dist/openapi.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "openapi": "3.0.2",
3
3
  "info": {
4
4
  "title": "Entity API",
5
- "version": "1.0.0",
5
+ "version": "2.0.0",
6
6
  "description": "Flexible data layer for epilot Entities.\n\nUse this API configure and access your business objects like Contacts, Opportunities and Products.\n\n[Feature Documentation](https://docs.epilot.io/docs/entities/flexible-entities)\n"
7
7
  },
8
8
  "tags": [
@@ -3051,6 +3051,9 @@
3051
3051
  }
3052
3052
  }
3053
3053
  },
3054
+ "409": {
3055
+ "description": "Taxonomy classification already exists"
3056
+ },
3054
3057
  "429": {
3055
3058
  "$ref": "#/components/responses/TooManyRequestsError"
3056
3059
  }
@@ -3269,7 +3272,7 @@
3269
3272
  "classificationIds": {
3270
3273
  "type": "array",
3271
3274
  "items": {
3272
- "$ref": "#/components/schemas/ClassificationId"
3275
+ "$ref": "#/components/schemas/ClassificationIdOrPattern"
3273
3276
  }
3274
3277
  }
3275
3278
  }
@@ -4964,6 +4967,9 @@
4964
4967
  {
4965
4968
  "$ref": "#/components/schemas/PartnerOrganisationAttribute"
4966
4969
  },
4970
+ {
4971
+ "$ref": "#/components/schemas/PortalAccessAttribute"
4972
+ },
4967
4973
  {
4968
4974
  "$ref": "#/components/schemas/PhoneAttribute"
4969
4975
  },
@@ -5864,6 +5870,25 @@
5864
5870
  }
5865
5871
  ]
5866
5872
  },
5873
+ "PortalAccessAttribute": {
5874
+ "allOf": [
5875
+ {
5876
+ "$ref": "#/components/schemas/BaseAttribute"
5877
+ },
5878
+ {
5879
+ "type": "object",
5880
+ "description": "Portal access configuration",
5881
+ "properties": {
5882
+ "type": {
5883
+ "type": "string",
5884
+ "enum": [
5885
+ "portal_access"
5886
+ ]
5887
+ }
5888
+ }
5889
+ }
5890
+ ]
5891
+ },
5867
5892
  "DefaultAddressFields": {
5868
5893
  "type": "array",
5869
5894
  "nullable": true,
@@ -6481,6 +6506,7 @@
6481
6506
  "EntitySlug": {
6482
6507
  "description": "URL-friendly identifier for the entity schema",
6483
6508
  "type": "string",
6509
+ "pattern": "^[a-zA-Z0-9_-]+$",
6484
6510
  "example": "contact"
6485
6511
  },
6486
6512
  "EntityCapability": {
@@ -8412,6 +8438,11 @@
8412
8438
  "description": "Archived classification are not visible in the UI",
8413
8439
  "default": false
8414
8440
  },
8441
+ "starred": {
8442
+ "type": "boolean",
8443
+ "description": "Starred taxonomy classifications can represent \"favorites\" or commonly used classifications",
8444
+ "default": false
8445
+ },
8415
8446
  "_manifest": {
8416
8447
  "type": "array",
8417
8448
  "description": "Manifest ID used to create/update the taxonomy classification",
@@ -8433,6 +8464,26 @@
8433
8464
  "example": "taxonomy-slug:classification-slug",
8434
8465
  "readOnly": true
8435
8466
  },
8467
+ "ClassificationIdOrPattern": {
8468
+ "anyOf": [
8469
+ {
8470
+ "$ref": "#/components/schemas/ClassificationId"
8471
+ },
8472
+ {
8473
+ "type": "object",
8474
+ "properties": {
8475
+ "pattern": {
8476
+ "type": "string",
8477
+ "example": "taxonomy-slug:*",
8478
+ "description": "Wildcard pattern to match classification IDs starting with the prefix before ':*'"
8479
+ }
8480
+ },
8481
+ "required": [
8482
+ "pattern"
8483
+ ]
8484
+ }
8485
+ ]
8486
+ },
8436
8487
  "ClassificationSlug": {
8437
8488
  "type": "string",
8438
8489
  "description": "URL-friendly identifier for the classification",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/entity-client",
3
- "version": "6.8.0",
3
+ "version": "6.9.0-alpha.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",