@epilot/entity-client 4.25.5 → 4.26.0-rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -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"}]}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"}]},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}]}},"/v1/entity/schemas/{slug}/json/schema":{"get":{"operationId":"getJsonSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}]}},"/v1/entity/schemas/{slug}/json/example":{"get":{"operationId":"getSchemaExample","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}]}},"/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}]}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints"}},"/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"}]}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}}}},"/v1/entity:list":{"post":{"operationId":"listEntities","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"name":"strict","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}}}},"/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}]}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}]},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}]}},"/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"}]}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}]}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}]}},"/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"}]}},"/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"}]},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}}}},"/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"}]}},"/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"}]}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}]}},"/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":{}}}},"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"}]}},"/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":{}}}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}}}},"/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}]}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}]},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}]}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser"}},"/v1/entity/listTaxonomies":{"get":{"deprecated":true,"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"}]}},"/v1/entity/taxonomies":{"get":{"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"}]},"post":{"operationId":"createTaxonomy","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}]},"put":{"operationId":"updateTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"permanent"}]}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}]}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"$ref":"#/components/parameters/TaxonomySlugQueryParamOptional"},{"in":"query","name":"query"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v2/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"createTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v2/entity/taxonomies/{taxonomySlug}/classifications/{classificationSlug}":{"put":{"operationId":"updateTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"},{"in":"query","name":"permanent"}]}},"/v1/entity/schemas/attributes/{composite_id}":{"get":{"operationId":"getSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}]},"put":{"operationId":"putSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}]}},"/v1/entity/schemas/attribute/{slug}":{"post":{"operationId":"createSchemaAttribute","parameters":[{"name":"slug","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/schemas/capabilities/{composite_id}":{"get":{"operationId":"getSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}]},"put":{"operationId":"putSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}]}},"/v1/entity/schemas/capability/{slug}":{"post":{"operationId":"createSchemaCapability","parameters":[{"name":"slug","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}}}},"components":{"parameters":{"EntityIdPathParam":{"name":"id","in":"path","required":true},"EntitySlugPathParam":{"name":"slug","in":"path","required":true},"EntitySlugPathPriceParam":{"name":"slug","in":"path","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}}},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},a=function a(r){var n=t[r];if(void 0!==n)return n.exports;var o=t[r]={exports:{}};return e[r].call(o.exports,o,o.exports,a),o.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"}]}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"}]},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}]}},"/v1/entity/schemas/{slug}/json/schema":{"get":{"operationId":"getJsonSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}]}},"/v1/entity/schemas/{slug}/json/example":{"get":{"operationId":"getSchemaExample","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}]}},"/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}]}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints"}},"/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"}]}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}}}},"/v1/entity:list":{"post":{"operationId":"listEntities","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"name":"strict","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}}}},"/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}]}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}]},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}]}},"/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"}]}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}]}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}]}},"/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"}]}},"/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"}]},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"removeRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}}}},"/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"}]}},"/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"}]}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}]}},"/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":{}}}},"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"}]}},"/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":{}}}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}}}},"/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}]}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}]},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}]}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser"}},"/v1/entity/taxonomies":{"get":{"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"}]},"post":{"operationId":"createTaxonomy","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}]},"put":{"operationId":"updateTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"permanent"}]}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}]}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"$ref":"#/components/parameters/TaxonomySlugQueryParamOptional"},{"in":"query","name":"query"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v2/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"createTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v2/entity/taxonomies/{taxonomySlug}/classifications/{classificationSlug}":{"put":{"operationId":"updateTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"},{"in":"query","name":"permanent"}]}},"/v1/entity/schemas/attributes/{composite_id}":{"get":{"operationId":"getSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}]},"put":{"operationId":"putSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}]}},"/v1/entity/schemas/capabilities/{composite_id}":{"get":{"operationId":"getSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}]},"put":{"operationId":"putSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}]}},"/v1/entity/schemas/group/{composite_id}":{"get":{"operationId":"getSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}]},"put":{"operationId":"putSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}]}}},"components":{"parameters":{"EntityIdPathParam":{"name":"id","in":"path","required":true},"EntitySlugPathParam":{"name":"slug","in":"path","required":true},"EntitySlugPathPriceParam":{"name":"slug","in":"path","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}}},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},a=function a(r){var n=t[r];if(void 0!==n)return n.exports;var o=t[r]={exports:{}};return e[r].call(o.exports,o,o.exports,a),o.exports}(914),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
@@ -474,9 +474,25 @@
474
474
  },
475
475
  {
476
476
  "$ref": "#/components/parameters/AsyncOperationQueryParam"
477
+ }
478
+ ],
479
+ "requestBody": {
480
+ "content": {
481
+ "application/json": {}
482
+ }
483
+ }
484
+ },
485
+ "delete": {
486
+ "operationId": "removeRelations",
487
+ "parameters": [
488
+ {
489
+ "$ref": "#/components/parameters/EntitySlugPathParam"
477
490
  },
478
491
  {
479
- "$ref": "#/components/parameters/ActivityIdQueryParam"
492
+ "$ref": "#/components/parameters/EntityIdPathParam"
493
+ },
494
+ {
495
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
480
496
  }
481
497
  ],
482
498
  "requestBody": {
@@ -751,18 +767,6 @@
751
767
  "operationId": "listFavoriteViewsForUser"
752
768
  }
753
769
  },
754
- "/v1/entity/listTaxonomies": {
755
- "get": {
756
- "deprecated": true,
757
- "operationId": "listTaxonomies",
758
- "parameters": [
759
- {
760
- "in": "query",
761
- "name": "include_disabled"
762
- }
763
- ]
764
- }
765
- },
766
770
  "/v1/entity/taxonomies": {
767
771
  "get": {
768
772
  "operationId": "listTaxonomies",
@@ -954,23 +958,6 @@
954
958
  ]
955
959
  }
956
960
  },
957
- "/v1/entity/schemas/attribute/{slug}": {
958
- "post": {
959
- "operationId": "createSchemaAttribute",
960
- "parameters": [
961
- {
962
- "name": "slug",
963
- "in": "path",
964
- "required": true
965
- }
966
- ],
967
- "requestBody": {
968
- "content": {
969
- "application/json": {}
970
- }
971
- }
972
- }
973
- },
974
961
  "/v1/entity/schemas/capabilities/{composite_id}": {
975
962
  "get": {
976
963
  "operationId": "getSchemaCapability",
@@ -1008,12 +995,22 @@
1008
995
  ]
1009
996
  }
1010
997
  },
1011
- "/v1/entity/schemas/capability/{slug}": {
1012
- "post": {
1013
- "operationId": "createSchemaCapability",
998
+ "/v1/entity/schemas/group/{composite_id}": {
999
+ "get": {
1000
+ "operationId": "getSchemaGroup",
1014
1001
  "parameters": [
1015
1002
  {
1016
- "name": "slug",
1003
+ "name": "composite_id",
1004
+ "in": "path",
1005
+ "required": true
1006
+ }
1007
+ ]
1008
+ },
1009
+ "put": {
1010
+ "operationId": "putSchemaGroup",
1011
+ "parameters": [
1012
+ {
1013
+ "name": "composite_id",
1017
1014
  "in": "path",
1018
1015
  "required": true
1019
1016
  }
@@ -1023,6 +1020,16 @@
1023
1020
  "application/json": {}
1024
1021
  }
1025
1022
  }
1023
+ },
1024
+ "delete": {
1025
+ "operationId": "deleteSchemaGroup",
1026
+ "parameters": [
1027
+ {
1028
+ "name": "composite_id",
1029
+ "in": "path",
1030
+ "required": true
1031
+ }
1032
+ ]
1026
1033
  }
1027
1034
  }
1028
1035
  },
package/dist/openapi.d.ts CHANGED
@@ -2413,17 +2413,17 @@ declare namespace Components {
2413
2413
  };
2414
2414
  capabilities: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
2415
2415
  /**
2416
- * A dictionary of Group Titles and associated settings if present.
2416
+ * A list of Group Titles and associated settings if present.
2417
2417
  * example:
2418
2418
  * [
2419
2419
  * {
2420
- * "id": "Contact Details",
2420
+ * "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
2421
2421
  * "label": "Contact Details",
2422
2422
  * "expanded": true,
2423
2423
  * "order": 1
2424
2424
  * },
2425
2425
  * {
2426
- * "id": "Address Details",
2426
+ * "id": "e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e",
2427
2427
  * "label": "Address Details",
2428
2428
  * "expanded": false,
2429
2429
  * "order": 2,
@@ -2434,39 +2434,7 @@ declare namespace Components {
2434
2434
  * }
2435
2435
  * ]
2436
2436
  */
2437
- group_settings?: {
2438
- label: string;
2439
- id: string;
2440
- expanded?: boolean;
2441
- /**
2442
- * example:
2443
- * _is_composite_price = "false"
2444
- */
2445
- render_condition?: string;
2446
- /**
2447
- * Render order of the group
2448
- */
2449
- order?: number;
2450
- /**
2451
- * This group should only be active when the feature flag is enabled
2452
- * example:
2453
- * FF_MY_FEATURE_FLAG
2454
- */
2455
- feature_flag?: string;
2456
- /**
2457
- * This group should only be active when all the settings have the correct value
2458
- */
2459
- settings_flag?: SettingFlag[];
2460
- info_tooltip_title?: {
2461
- key?: string;
2462
- default?: string;
2463
- };
2464
- _purpose?: /**
2465
- * example:
2466
- * taxonomy-slug:classification-slug
2467
- */
2468
- ClassificationId[];
2469
- }[];
2437
+ group_settings?: EntitySchemaGroup[];
2470
2438
  /**
2471
2439
  * Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
2472
2440
  * - Managed Properties: are interpreted and transformed into layout styles
@@ -2548,6 +2516,122 @@ declare namespace Components {
2548
2516
  */
2549
2517
  SearchMappings;
2550
2518
  }
2519
+ export interface EntitySchemaGroup {
2520
+ /**
2521
+ * example:
2522
+ * Contact Details
2523
+ */
2524
+ label: string;
2525
+ /**
2526
+ * example:
2527
+ * e18a532b-ae79-4d86-a6a5-e5dbfb579d14
2528
+ */
2529
+ id: string;
2530
+ /**
2531
+ * Render order of the group
2532
+ */
2533
+ order?: number;
2534
+ /**
2535
+ * Expanded by default
2536
+ */
2537
+ expanded?: boolean;
2538
+ /**
2539
+ * Only render group when render_condition resolves to true
2540
+ * example:
2541
+ * _is_composite_price = "false"
2542
+ */
2543
+ render_condition?: string;
2544
+ /**
2545
+ * Only render group when one of the purposes is enabled
2546
+ */
2547
+ _purpose?: /**
2548
+ * example:
2549
+ * taxonomy-slug:classification-slug
2550
+ */
2551
+ ClassificationId[];
2552
+ /**
2553
+ * This group should only be active when the feature flag is enabled
2554
+ * example:
2555
+ * FF_MY_FEATURE_FLAG
2556
+ */
2557
+ feature_flag?: string;
2558
+ /**
2559
+ * This group should only be active when all the settings have the correct value
2560
+ */
2561
+ settings_flag?: SettingFlag[];
2562
+ info_tooltip_title?: {
2563
+ /**
2564
+ * Translation key for info tooltip
2565
+ */
2566
+ key?: string;
2567
+ /**
2568
+ * Default string for info tooltip
2569
+ */
2570
+ default?: string;
2571
+ };
2572
+ }
2573
+ /**
2574
+ * a readonly computed ID for the group including schema slug and the group ID
2575
+ */
2576
+ export interface EntitySchemaGroupWithCompositeID {
2577
+ /**
2578
+ * example:
2579
+ * Contact Details
2580
+ */
2581
+ label: string;
2582
+ /**
2583
+ * example:
2584
+ * e18a532b-ae79-4d86-a6a5-e5dbfb579d14
2585
+ */
2586
+ id: string;
2587
+ /**
2588
+ * Render order of the group
2589
+ */
2590
+ order?: number;
2591
+ /**
2592
+ * Expanded by default
2593
+ */
2594
+ expanded?: boolean;
2595
+ /**
2596
+ * Only render group when render_condition resolves to true
2597
+ * example:
2598
+ * _is_composite_price = "false"
2599
+ */
2600
+ render_condition?: string;
2601
+ /**
2602
+ * Only render group when one of the purposes is enabled
2603
+ */
2604
+ _purpose?: /**
2605
+ * example:
2606
+ * taxonomy-slug:classification-slug
2607
+ */
2608
+ ClassificationId[];
2609
+ /**
2610
+ * This group should only be active when the feature flag is enabled
2611
+ * example:
2612
+ * FF_MY_FEATURE_FLAG
2613
+ */
2614
+ feature_flag?: string;
2615
+ /**
2616
+ * This group should only be active when all the settings have the correct value
2617
+ */
2618
+ settings_flag?: SettingFlag[];
2619
+ info_tooltip_title?: {
2620
+ /**
2621
+ * Translation key for info tooltip
2622
+ */
2623
+ key?: string;
2624
+ /**
2625
+ * Default string for info tooltip
2626
+ */
2627
+ default?: string;
2628
+ };
2629
+ /**
2630
+ * example:
2631
+ * contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14
2632
+ */
2633
+ composite_id?: string;
2634
+ }
2551
2635
  /**
2552
2636
  * The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities.
2553
2637
  */
@@ -2672,17 +2756,17 @@ declare namespace Components {
2672
2756
  };
2673
2757
  capabilities: /* Capabilities the Entity has. Turn features on/off for entities. */ EntityCapability[];
2674
2758
  /**
2675
- * A dictionary of Group Titles and associated settings if present.
2759
+ * A list of Group Titles and associated settings if present.
2676
2760
  * example:
2677
2761
  * [
2678
2762
  * {
2679
- * "id": "Contact Details",
2763
+ * "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
2680
2764
  * "label": "Contact Details",
2681
2765
  * "expanded": true,
2682
2766
  * "order": 1
2683
2767
  * },
2684
2768
  * {
2685
- * "id": "Address Details",
2769
+ * "id": "e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e",
2686
2770
  * "label": "Address Details",
2687
2771
  * "expanded": false,
2688
2772
  * "order": 2,
@@ -2693,39 +2777,7 @@ declare namespace Components {
2693
2777
  * }
2694
2778
  * ]
2695
2779
  */
2696
- group_settings?: {
2697
- label: string;
2698
- id: string;
2699
- expanded?: boolean;
2700
- /**
2701
- * example:
2702
- * _is_composite_price = "false"
2703
- */
2704
- render_condition?: string;
2705
- /**
2706
- * Render order of the group
2707
- */
2708
- order?: number;
2709
- /**
2710
- * This group should only be active when the feature flag is enabled
2711
- * example:
2712
- * FF_MY_FEATURE_FLAG
2713
- */
2714
- feature_flag?: string;
2715
- /**
2716
- * This group should only be active when all the settings have the correct value
2717
- */
2718
- settings_flag?: SettingFlag[];
2719
- info_tooltip_title?: {
2720
- key?: string;
2721
- default?: string;
2722
- };
2723
- _purpose?: /**
2724
- * example:
2725
- * taxonomy-slug:classification-slug
2726
- */
2727
- ClassificationId[];
2728
- }[];
2780
+ group_settings?: EntitySchemaGroup[];
2729
2781
  /**
2730
2782
  * Custom grid definitions for the layout. These settings are composed by managed and un-managed properties:
2731
2783
  * - Managed Properties: are interpreted and transformed into layout styles
@@ -6688,12 +6740,6 @@ declare namespace Components {
6688
6740
  declare namespace Paths {
6689
6741
  namespace AddRelations {
6690
6742
  namespace Parameters {
6691
- export type ActivityId = /**
6692
- * See https://github.com/ulid/spec
6693
- * example:
6694
- * 01F130Q52Q6MWSNS8N2AVXV4JN
6695
- */
6696
- Components.Schemas.ActivityId /* ulid */;
6697
6743
  export type Async = boolean;
6698
6744
  export type Id = Components.Schemas.EntityId /* uuid */;
6699
6745
  export type Slug = /**
@@ -6709,7 +6755,6 @@ declare namespace Paths {
6709
6755
  }
6710
6756
  export interface QueryParameters {
6711
6757
  async?: Parameters.Async;
6712
- activity_id?: Parameters.ActivityId;
6713
6758
  }
6714
6759
  export type RequestBody = Components.Schemas.RelationItem[];
6715
6760
  namespace Responses {
@@ -6901,46 +6946,6 @@ declare namespace Paths {
6901
6946
  export type $201 = /* A saved entity view */ Components.Schemas.SavedViewItem;
6902
6947
  }
6903
6948
  }
6904
- namespace CreateSchemaAttribute {
6905
- namespace Parameters {
6906
- /**
6907
- * example:
6908
- * contact
6909
- */
6910
- export type Slug = string;
6911
- }
6912
- export interface PathParameters {
6913
- slug: /**
6914
- * example:
6915
- * contact
6916
- */
6917
- Parameters.Slug;
6918
- }
6919
- export type RequestBody = Components.Schemas.Attribute;
6920
- namespace Responses {
6921
- export type $200 = /* a readonly computed ID for the attribute including schema slug and the attribute ID */ Components.Schemas.AttributeWithCompositeID;
6922
- }
6923
- }
6924
- namespace CreateSchemaCapability {
6925
- namespace Parameters {
6926
- /**
6927
- * example:
6928
- * contact
6929
- */
6930
- export type Slug = string;
6931
- }
6932
- export interface PathParameters {
6933
- slug: /**
6934
- * example:
6935
- * contact
6936
- */
6937
- Parameters.Slug;
6938
- }
6939
- export type RequestBody = /* Capabilities the Entity has. Turn features on/off for entities. */ Components.Schemas.EntityCapability;
6940
- namespace Responses {
6941
- export type $200 = /* a readonly computed ID for the entity capability including schema slug and the capability ID */ Components.Schemas.EntityCapabilityWithCompositeID;
6942
- }
6943
- }
6944
6949
  namespace CreateTaxonomy {
6945
6950
  /**
6946
6951
  * example:
@@ -7133,6 +7138,25 @@ declare namespace Paths {
7133
7138
  export type $200 = /* a readonly computed ID for the entity capability including schema slug and the capability ID */ Components.Schemas.EntityCapabilityWithCompositeID;
7134
7139
  }
7135
7140
  }
7141
+ namespace DeleteSchemaGroup {
7142
+ namespace Parameters {
7143
+ /**
7144
+ * example:
7145
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
7146
+ */
7147
+ export type CompositeId = string; // ^.+:.+$
7148
+ }
7149
+ export interface PathParameters {
7150
+ composite_id: /**
7151
+ * example:
7152
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
7153
+ */
7154
+ Parameters.CompositeId /* ^.+:.+$ */;
7155
+ }
7156
+ namespace Responses {
7157
+ export type $200 = /* a readonly computed ID for the group including schema slug and the group ID */ Components.Schemas.EntitySchemaGroupWithCompositeID;
7158
+ }
7159
+ }
7136
7160
  namespace DeleteTaxonomy {
7137
7161
  namespace Parameters {
7138
7162
  export type Permanent = boolean;
@@ -8002,6 +8026,25 @@ declare namespace Paths {
8002
8026
  }
8003
8027
  }
8004
8028
  }
8029
+ namespace GetSchemaGroup {
8030
+ namespace Parameters {
8031
+ /**
8032
+ * example:
8033
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
8034
+ */
8035
+ export type CompositeId = string; // ^.+:.+$
8036
+ }
8037
+ export interface PathParameters {
8038
+ composite_id: /**
8039
+ * example:
8040
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
8041
+ */
8042
+ Parameters.CompositeId /* ^.+:.+$ */;
8043
+ }
8044
+ namespace Responses {
8045
+ export type $200 = /* a readonly computed ID for the group including schema slug and the group ID */ Components.Schemas.EntitySchemaGroupWithCompositeID;
8046
+ }
8047
+ }
8005
8048
  namespace GetSchemaVersions {
8006
8049
  namespace Parameters {
8007
8050
  export type DraftsFrom = number;
@@ -8360,6 +8403,50 @@ declare namespace Paths {
8360
8403
  export type $200 = /* a readonly computed ID for the entity capability including schema slug and the capability ID */ Components.Schemas.EntityCapabilityWithCompositeID;
8361
8404
  }
8362
8405
  }
8406
+ namespace PutSchemaGroup {
8407
+ namespace Parameters {
8408
+ /**
8409
+ * example:
8410
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
8411
+ */
8412
+ export type CompositeId = string; // ^.+:.+$
8413
+ }
8414
+ export interface PathParameters {
8415
+ composite_id: /**
8416
+ * example:
8417
+ * contact:97644baa-083f-4e49-9188-fcff2ecaad7d
8418
+ */
8419
+ Parameters.CompositeId /* ^.+:.+$ */;
8420
+ }
8421
+ export type RequestBody = /* a readonly computed ID for the group including schema slug and the group ID */ Components.Schemas.EntitySchemaGroupWithCompositeID;
8422
+ namespace Responses {
8423
+ export type $200 = /* a readonly computed ID for the group including schema slug and the group ID */ Components.Schemas.EntitySchemaGroupWithCompositeID;
8424
+ }
8425
+ }
8426
+ namespace RemoveRelations {
8427
+ namespace Parameters {
8428
+ export type Async = boolean;
8429
+ export type Id = Components.Schemas.EntityId /* uuid */;
8430
+ export type Slug = /**
8431
+ * URL-friendly identifier for the entity schema
8432
+ * example:
8433
+ * contact
8434
+ */
8435
+ Components.Schemas.EntitySlug;
8436
+ }
8437
+ export interface PathParameters {
8438
+ slug: Parameters.Slug;
8439
+ id: Parameters.Id;
8440
+ }
8441
+ export interface QueryParameters {
8442
+ async?: Parameters.Async;
8443
+ }
8444
+ export type RequestBody = Components.Schemas.RelationItem[];
8445
+ namespace Responses {
8446
+ export interface $204 {
8447
+ }
8448
+ }
8449
+ }
8363
8450
  namespace SearchEntities {
8364
8451
  export type RequestBody = Components.Schemas.EntitySearchParams;
8365
8452
  namespace Responses {
@@ -9367,6 +9454,16 @@ export interface OperationMethods {
9367
9454
  data?: Paths.AddRelations.RequestBody,
9368
9455
  config?: AxiosRequestConfig
9369
9456
  ): OperationResponse<Paths.AddRelations.Responses.$200>
9457
+ /**
9458
+ * removeRelations - removeRelations
9459
+ *
9460
+ * Disassociate one or more entities to parent entity by removing items to a relation attribute
9461
+ */
9462
+ 'removeRelations'(
9463
+ parameters?: Parameters<Paths.RemoveRelations.PathParameters & Paths.RemoveRelations.QueryParameters> | null,
9464
+ data?: Paths.RemoveRelations.RequestBody,
9465
+ config?: AxiosRequestConfig
9466
+ ): OperationResponse<Paths.RemoveRelations.Responses.$204>
9370
9467
  /**
9371
9468
  * getRelationsV2 - getRelationsV2
9372
9469
  *
@@ -9511,16 +9608,6 @@ export interface OperationMethods {
9511
9608
  data?: any,
9512
9609
  config?: AxiosRequestConfig
9513
9610
  ): OperationResponse<Paths.ListFavoriteViewsForUser.Responses.$200>
9514
- /**
9515
- * listTaxonomies - listTaxonomies
9516
- *
9517
- * List taxonomies in an organisation
9518
- */
9519
- 'listTaxonomies'(
9520
- parameters?: Parameters<Paths.ListTaxonomies.QueryParameters> | null,
9521
- data?: any,
9522
- config?: AxiosRequestConfig
9523
- ): OperationResponse<Paths.ListTaxonomies.Responses.$200>
9524
9611
  /**
9525
9612
  * listTaxonomies - listTaxonomies
9526
9613
  *
@@ -9661,16 +9748,6 @@ export interface OperationMethods {
9661
9748
  data?: any,
9662
9749
  config?: AxiosRequestConfig
9663
9750
  ): OperationResponse<Paths.DeleteSchemaAttribute.Responses.$200>
9664
- /**
9665
- * createSchemaAttribute - createSchemaAttribute
9666
- *
9667
- * Adds an attribute to the schema
9668
- */
9669
- 'createSchemaAttribute'(
9670
- parameters?: Parameters<Paths.CreateSchemaAttribute.PathParameters> | null,
9671
- data?: Paths.CreateSchemaAttribute.RequestBody,
9672
- config?: AxiosRequestConfig
9673
- ): OperationResponse<Paths.CreateSchemaAttribute.Responses.$200>
9674
9751
  /**
9675
9752
  * getSchemaCapability - getSchemaCapability
9676
9753
  *
@@ -9702,15 +9779,35 @@ export interface OperationMethods {
9702
9779
  config?: AxiosRequestConfig
9703
9780
  ): OperationResponse<Paths.DeleteSchemaCapability.Responses.$200>
9704
9781
  /**
9705
- * createSchemaCapability - createSchemaCapability
9782
+ * getSchemaGroup - getSchemaGroup
9706
9783
  *
9707
- * Adds a capability to the schema
9784
+ * Get a schema group from given group composite ID
9708
9785
  */
9709
- 'createSchemaCapability'(
9710
- parameters?: Parameters<Paths.CreateSchemaCapability.PathParameters> | null,
9711
- data?: Paths.CreateSchemaCapability.RequestBody,
9786
+ 'getSchemaGroup'(
9787
+ parameters?: Parameters<Paths.GetSchemaGroup.PathParameters> | null,
9788
+ data?: any,
9789
+ config?: AxiosRequestConfig
9790
+ ): OperationResponse<Paths.GetSchemaGroup.Responses.$200>
9791
+ /**
9792
+ * putSchemaGroup - putSchemaGroup
9793
+ *
9794
+ * Adds or updates an capability in the schema
9795
+ */
9796
+ 'putSchemaGroup'(
9797
+ parameters?: Parameters<Paths.PutSchemaGroup.PathParameters> | null,
9798
+ data?: Paths.PutSchemaGroup.RequestBody,
9799
+ config?: AxiosRequestConfig
9800
+ ): OperationResponse<Paths.PutSchemaGroup.Responses.$200>
9801
+ /**
9802
+ * deleteSchemaGroup - deleteSchemaGroup
9803
+ *
9804
+ * Deletes a Capability from a schema
9805
+ */
9806
+ 'deleteSchemaGroup'(
9807
+ parameters?: Parameters<Paths.DeleteSchemaGroup.PathParameters> | null,
9808
+ data?: any,
9712
9809
  config?: AxiosRequestConfig
9713
- ): OperationResponse<Paths.CreateSchemaCapability.Responses.$200>
9810
+ ): OperationResponse<Paths.DeleteSchemaGroup.Responses.$200>
9714
9811
  }
9715
9812
 
9716
9813
  export interface PathsDictionary {
@@ -10248,6 +10345,16 @@ export interface PathsDictionary {
10248
10345
  data?: Paths.AddRelations.RequestBody,
10249
10346
  config?: AxiosRequestConfig
10250
10347
  ): OperationResponse<Paths.AddRelations.Responses.$200>
10348
+ /**
10349
+ * removeRelations - removeRelations
10350
+ *
10351
+ * Disassociate one or more entities to parent entity by removing items to a relation attribute
10352
+ */
10353
+ 'delete'(
10354
+ parameters?: Parameters<Paths.RemoveRelations.PathParameters & Paths.RemoveRelations.QueryParameters> | null,
10355
+ data?: Paths.RemoveRelations.RequestBody,
10356
+ config?: AxiosRequestConfig
10357
+ ): OperationResponse<Paths.RemoveRelations.Responses.$204>
10251
10358
  }
10252
10359
  ['/v2/entity/{slug}/{id}/relations']: {
10253
10360
  /**
@@ -10413,18 +10520,6 @@ export interface PathsDictionary {
10413
10520
  config?: AxiosRequestConfig
10414
10521
  ): OperationResponse<Paths.ListFavoriteViewsForUser.Responses.$200>
10415
10522
  }
10416
- ['/v1/entity/listTaxonomies']: {
10417
- /**
10418
- * listTaxonomies - listTaxonomies
10419
- *
10420
- * List taxonomies in an organisation
10421
- */
10422
- 'get'(
10423
- parameters?: Parameters<Paths.ListTaxonomies.QueryParameters> | null,
10424
- data?: any,
10425
- config?: AxiosRequestConfig
10426
- ): OperationResponse<Paths.ListTaxonomies.Responses.$200>
10427
- }
10428
10523
  ['/v1/entity/taxonomies']: {
10429
10524
  /**
10430
10525
  * listTaxonomies - listTaxonomies
@@ -10581,18 +10676,6 @@ export interface PathsDictionary {
10581
10676
  config?: AxiosRequestConfig
10582
10677
  ): OperationResponse<Paths.DeleteSchemaAttribute.Responses.$200>
10583
10678
  }
10584
- ['/v1/entity/schemas/attribute/{slug}']: {
10585
- /**
10586
- * createSchemaAttribute - createSchemaAttribute
10587
- *
10588
- * Adds an attribute to the schema
10589
- */
10590
- 'post'(
10591
- parameters?: Parameters<Paths.CreateSchemaAttribute.PathParameters> | null,
10592
- data?: Paths.CreateSchemaAttribute.RequestBody,
10593
- config?: AxiosRequestConfig
10594
- ): OperationResponse<Paths.CreateSchemaAttribute.Responses.$200>
10595
- }
10596
10679
  ['/v1/entity/schemas/capabilities/{composite_id}']: {
10597
10680
  /**
10598
10681
  * getSchemaCapability - getSchemaCapability
@@ -10625,17 +10708,37 @@ export interface PathsDictionary {
10625
10708
  config?: AxiosRequestConfig
10626
10709
  ): OperationResponse<Paths.DeleteSchemaCapability.Responses.$200>
10627
10710
  }
10628
- ['/v1/entity/schemas/capability/{slug}']: {
10711
+ ['/v1/entity/schemas/group/{composite_id}']: {
10629
10712
  /**
10630
- * createSchemaCapability - createSchemaCapability
10713
+ * getSchemaGroup - getSchemaGroup
10631
10714
  *
10632
- * Adds a capability to the schema
10715
+ * Get a schema group from given group composite ID
10633
10716
  */
10634
- 'post'(
10635
- parameters?: Parameters<Paths.CreateSchemaCapability.PathParameters> | null,
10636
- data?: Paths.CreateSchemaCapability.RequestBody,
10717
+ 'get'(
10718
+ parameters?: Parameters<Paths.GetSchemaGroup.PathParameters> | null,
10719
+ data?: any,
10720
+ config?: AxiosRequestConfig
10721
+ ): OperationResponse<Paths.GetSchemaGroup.Responses.$200>
10722
+ /**
10723
+ * putSchemaGroup - putSchemaGroup
10724
+ *
10725
+ * Adds or updates an capability in the schema
10726
+ */
10727
+ 'put'(
10728
+ parameters?: Parameters<Paths.PutSchemaGroup.PathParameters> | null,
10729
+ data?: Paths.PutSchemaGroup.RequestBody,
10730
+ config?: AxiosRequestConfig
10731
+ ): OperationResponse<Paths.PutSchemaGroup.Responses.$200>
10732
+ /**
10733
+ * deleteSchemaGroup - deleteSchemaGroup
10734
+ *
10735
+ * Deletes a Capability from a schema
10736
+ */
10737
+ 'delete'(
10738
+ parameters?: Parameters<Paths.DeleteSchemaGroup.PathParameters> | null,
10739
+ data?: any,
10637
10740
  config?: AxiosRequestConfig
10638
- ): OperationResponse<Paths.CreateSchemaCapability.Responses.$200>
10741
+ ): OperationResponse<Paths.DeleteSchemaGroup.Responses.$200>
10639
10742
  }
10640
10743
  }
10641
10744
 
package/dist/openapi.json CHANGED
@@ -1611,9 +1611,6 @@
1611
1611
  },
1612
1612
  {
1613
1613
  "$ref": "#/components/parameters/AsyncOperationQueryParam"
1614
- },
1615
- {
1616
- "$ref": "#/components/parameters/ActivityIdQueryParam"
1617
1614
  }
1618
1615
  ],
1619
1616
  "requestBody": {
@@ -1657,6 +1654,59 @@
1657
1654
  }
1658
1655
  }
1659
1656
  }
1657
+ },
1658
+ "delete": {
1659
+ "operationId": "removeRelations",
1660
+ "summary": "removeRelations",
1661
+ "description": "Disassociate one or more entities to parent entity by removing items to a relation attribute",
1662
+ "tags": [
1663
+ "Relations"
1664
+ ],
1665
+ "parameters": [
1666
+ {
1667
+ "$ref": "#/components/parameters/EntitySlugPathParam"
1668
+ },
1669
+ {
1670
+ "$ref": "#/components/parameters/EntityIdPathParam"
1671
+ },
1672
+ {
1673
+ "$ref": "#/components/parameters/AsyncOperationQueryParam"
1674
+ }
1675
+ ],
1676
+ "requestBody": {
1677
+ "content": {
1678
+ "application/json": {
1679
+ "schema": {
1680
+ "type": "array",
1681
+ "items": {
1682
+ "$ref": "#/components/schemas/RelationItem"
1683
+ }
1684
+ },
1685
+ "example": [
1686
+ {
1687
+ "attribute": "contacts",
1688
+ "entity_id": "e8878f62-2d3d-4c86-bfe7-01a4180ff048",
1689
+ "_tags": [
1690
+ "billing"
1691
+ ]
1692
+ },
1693
+ {
1694
+ "attribute": "contacts",
1695
+ "entity_id": "ee8a2af9-fb36-4981-b848-4e65275851af"
1696
+ },
1697
+ {
1698
+ "attribute": "opportunities",
1699
+ "entity_id": "30990430-a53d-41a2-83db-2de072dc4dd4"
1700
+ }
1701
+ ]
1702
+ }
1703
+ }
1704
+ },
1705
+ "responses": {
1706
+ "204": {
1707
+ "description": "Relations deleted with success."
1708
+ }
1709
+ }
1660
1710
  }
1661
1711
  },
1662
1712
  "/v2/entity/{slug}/{id}/relations": {
@@ -2238,48 +2288,6 @@
2238
2288
  }
2239
2289
  }
2240
2290
  },
2241
- "/v1/entity/listTaxonomies": {
2242
- "get": {
2243
- "deprecated": true,
2244
- "operationId": "listTaxonomies",
2245
- "summary": "listTaxonomies",
2246
- "description": "List taxonomies in an organisation",
2247
- "tags": [
2248
- "Taxonomy"
2249
- ],
2250
- "parameters": [
2251
- {
2252
- "in": "query",
2253
- "name": "include_disabled",
2254
- "description": "Include disabled taxonomies",
2255
- "schema": {
2256
- "type": "boolean",
2257
- "default": false
2258
- }
2259
- }
2260
- ],
2261
- "responses": {
2262
- "200": {
2263
- "description": "Returns list of taxonomies in an organisation",
2264
- "content": {
2265
- "application/json": {
2266
- "schema": {
2267
- "type": "object",
2268
- "properties": {
2269
- "results": {
2270
- "type": "array",
2271
- "items": {
2272
- "$ref": "#/components/schemas/Taxonomy"
2273
- }
2274
- }
2275
- }
2276
- }
2277
- }
2278
- }
2279
- }
2280
- }
2281
- }
2282
- },
2283
2291
  "/v1/entity/taxonomies": {
2284
2292
  "get": {
2285
2293
  "operationId": "listTaxonomies",
@@ -2898,49 +2906,6 @@
2898
2906
  }
2899
2907
  }
2900
2908
  },
2901
- "/v1/entity/schemas/attribute/{slug}": {
2902
- "post": {
2903
- "operationId": "createSchemaAttribute",
2904
- "summary": "createSchemaAttribute",
2905
- "description": "Adds an attribute to the schema",
2906
- "tags": [
2907
- "Schemas"
2908
- ],
2909
- "parameters": [
2910
- {
2911
- "name": "slug",
2912
- "description": "Schema Slug",
2913
- "in": "path",
2914
- "required": true,
2915
- "schema": {
2916
- "type": "string",
2917
- "example": "contact"
2918
- }
2919
- }
2920
- ],
2921
- "requestBody": {
2922
- "content": {
2923
- "application/json": {
2924
- "schema": {
2925
- "$ref": "#/components/schemas/Attribute"
2926
- }
2927
- }
2928
- }
2929
- },
2930
- "responses": {
2931
- "200": {
2932
- "description": "Success",
2933
- "content": {
2934
- "application/json": {
2935
- "schema": {
2936
- "$ref": "#/components/schemas/AttributeWithCompositeID"
2937
- }
2938
- }
2939
- }
2940
- }
2941
- }
2942
- }
2943
- },
2944
2909
  "/v1/entity/schemas/capabilities/{composite_id}": {
2945
2910
  "get": {
2946
2911
  "operationId": "getSchemaCapability",
@@ -3051,23 +3016,57 @@
3051
3016
  }
3052
3017
  }
3053
3018
  },
3054
- "/v1/entity/schemas/capability/{slug}": {
3055
- "post": {
3056
- "operationId": "createSchemaCapability",
3057
- "summary": "createSchemaCapability",
3058
- "description": "Adds a capability to the schema",
3019
+ "/v1/entity/schemas/group/{composite_id}": {
3020
+ "get": {
3021
+ "operationId": "getSchemaGroup",
3022
+ "summary": "getSchemaGroup",
3023
+ "description": "Get a schema group from given group composite ID",
3059
3024
  "tags": [
3060
3025
  "Schemas"
3061
3026
  ],
3062
3027
  "parameters": [
3063
3028
  {
3064
- "name": "slug",
3065
- "description": "Schema Slug",
3029
+ "name": "composite_id",
3030
+ "description": "Schema Slug and the Group ID",
3031
+ "in": "path",
3032
+ "required": true,
3033
+ "schema": {
3034
+ "type": "string",
3035
+ "pattern": "^.+:.+$",
3036
+ "example": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d"
3037
+ }
3038
+ }
3039
+ ],
3040
+ "responses": {
3041
+ "200": {
3042
+ "description": "Success",
3043
+ "content": {
3044
+ "application/json": {
3045
+ "schema": {
3046
+ "$ref": "#/components/schemas/EntitySchemaGroupWithCompositeID"
3047
+ }
3048
+ }
3049
+ }
3050
+ }
3051
+ }
3052
+ },
3053
+ "put": {
3054
+ "operationId": "putSchemaGroup",
3055
+ "summary": "putSchemaGroup",
3056
+ "description": "Adds or updates an capability in the schema",
3057
+ "tags": [
3058
+ "Schemas"
3059
+ ],
3060
+ "parameters": [
3061
+ {
3062
+ "name": "composite_id",
3063
+ "description": "Schema Slug and the Group ID",
3066
3064
  "in": "path",
3067
3065
  "required": true,
3068
3066
  "schema": {
3069
3067
  "type": "string",
3070
- "example": "contact"
3068
+ "pattern": "^.+:.+$",
3069
+ "example": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d"
3071
3070
  }
3072
3071
  }
3073
3072
  ],
@@ -3075,7 +3074,7 @@
3075
3074
  "content": {
3076
3075
  "application/json": {
3077
3076
  "schema": {
3078
- "$ref": "#/components/schemas/EntityCapability"
3077
+ "$ref": "#/components/schemas/EntitySchemaGroupWithCompositeID"
3079
3078
  }
3080
3079
  }
3081
3080
  }
@@ -3086,7 +3085,40 @@
3086
3085
  "content": {
3087
3086
  "application/json": {
3088
3087
  "schema": {
3089
- "$ref": "#/components/schemas/EntityCapabilityWithCompositeID"
3088
+ "$ref": "#/components/schemas/EntitySchemaGroupWithCompositeID"
3089
+ }
3090
+ }
3091
+ }
3092
+ }
3093
+ }
3094
+ },
3095
+ "delete": {
3096
+ "operationId": "deleteSchemaGroup",
3097
+ "summary": "deleteSchemaGroup",
3098
+ "description": "Deletes a Capability from a schema",
3099
+ "tags": [
3100
+ "Schemas"
3101
+ ],
3102
+ "parameters": [
3103
+ {
3104
+ "name": "composite_id",
3105
+ "description": "Schema Slug and the Group ID",
3106
+ "in": "path",
3107
+ "required": true,
3108
+ "schema": {
3109
+ "type": "string",
3110
+ "pattern": "^.+:.+$",
3111
+ "example": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d"
3112
+ }
3113
+ }
3114
+ ],
3115
+ "responses": {
3116
+ "200": {
3117
+ "description": "Success",
3118
+ "content": {
3119
+ "application/json": {
3120
+ "schema": {
3121
+ "$ref": "#/components/schemas/EntitySchemaGroupWithCompositeID"
3090
3122
  }
3091
3123
  }
3092
3124
  }
@@ -3283,72 +3315,19 @@
3283
3315
  },
3284
3316
  "group_settings": {
3285
3317
  "type": "array",
3286
- "description": "A dictionary of Group Titles and associated settings if present.",
3318
+ "description": "A list of Group Titles and associated settings if present.",
3287
3319
  "items": {
3288
- "type": "object",
3289
- "properties": {
3290
- "label": {
3291
- "type": "string"
3292
- },
3293
- "id": {
3294
- "type": "string"
3295
- },
3296
- "expanded": {
3297
- "type": "boolean"
3298
- },
3299
- "render_condition": {
3300
- "type": "string",
3301
- "example": "_is_composite_price = \"false\""
3302
- },
3303
- "order": {
3304
- "description": "Render order of the group",
3305
- "type": "integer",
3306
- "default": 0
3307
- },
3308
- "feature_flag": {
3309
- "type": "string",
3310
- "example": "FF_MY_FEATURE_FLAG",
3311
- "description": "This group should only be active when the feature flag is enabled"
3312
- },
3313
- "settings_flag": {
3314
- "type": "array",
3315
- "description": "This group should only be active when all the settings have the correct value",
3316
- "items": {
3317
- "$ref": "#/components/schemas/SettingFlag"
3318
- }
3319
- },
3320
- "info_tooltip_title": {
3321
- "type": "object",
3322
- "properties": {
3323
- "key": {
3324
- "type": "string"
3325
- },
3326
- "default": {
3327
- "type": "string"
3328
- }
3329
- }
3330
- },
3331
- "_purpose": {
3332
- "type": "array",
3333
- "items": {
3334
- "$ref": "#/components/schemas/ClassificationId"
3335
- }
3336
- }
3337
- },
3338
- "required": [
3339
- "label",
3340
- "id"
3341
- ]
3320
+ "$ref": "#/components/schemas/EntitySchemaGroup"
3342
3321
  },
3343
3322
  "example": [
3344
3323
  {
3345
- "id": "Contact Details",
3324
+ "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
3346
3325
  "label": "Contact Details",
3347
3326
  "expanded": true,
3348
3327
  "order": 1
3349
3328
  },
3350
3329
  {
3351
- "id": "Address Details",
3330
+ "id": "e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e",
3352
3331
  "label": "Address Details",
3353
3332
  "expanded": false,
3354
3333
  "order": 2,
@@ -3475,6 +3454,88 @@
3475
3454
  }
3476
3455
  ]
3477
3456
  },
3457
+ "EntitySchemaGroup": {
3458
+ "type": "object",
3459
+ "properties": {
3460
+ "label": {
3461
+ "type": "string",
3462
+ "example": "Contact Details"
3463
+ },
3464
+ "id": {
3465
+ "type": "string",
3466
+ "example": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14"
3467
+ },
3468
+ "order": {
3469
+ "description": "Render order of the group",
3470
+ "type": "integer",
3471
+ "default": 0
3472
+ },
3473
+ "expanded": {
3474
+ "description": "Expanded by default",
3475
+ "type": "boolean",
3476
+ "default": false
3477
+ },
3478
+ "render_condition": {
3479
+ "description": "Only render group when render_condition resolves to true",
3480
+ "type": "string",
3481
+ "example": "_is_composite_price = \"false\""
3482
+ },
3483
+ "_purpose": {
3484
+ "description": "Only render group when one of the purposes is enabled",
3485
+ "type": "array",
3486
+ "items": {
3487
+ "$ref": "#/components/schemas/ClassificationId"
3488
+ }
3489
+ },
3490
+ "feature_flag": {
3491
+ "type": "string",
3492
+ "example": "FF_MY_FEATURE_FLAG",
3493
+ "description": "This group should only be active when the feature flag is enabled"
3494
+ },
3495
+ "settings_flag": {
3496
+ "type": "array",
3497
+ "description": "This group should only be active when all the settings have the correct value",
3498
+ "items": {
3499
+ "$ref": "#/components/schemas/SettingFlag"
3500
+ }
3501
+ },
3502
+ "info_tooltip_title": {
3503
+ "type": "object",
3504
+ "properties": {
3505
+ "key": {
3506
+ "description": "Translation key for info tooltip",
3507
+ "type": "string"
3508
+ },
3509
+ "default": {
3510
+ "description": "Default string for info tooltip",
3511
+ "type": "string"
3512
+ }
3513
+ }
3514
+ }
3515
+ },
3516
+ "required": [
3517
+ "label",
3518
+ "id"
3519
+ ]
3520
+ },
3521
+ "EntitySchemaGroupWithCompositeID": {
3522
+ "allOf": [
3523
+ {
3524
+ "$ref": "#/components/schemas/EntitySchemaGroup"
3525
+ },
3526
+ {
3527
+ "type": "object",
3528
+ "description": "a readonly computed ID for the group including schema slug and the group ID",
3529
+ "properties": {
3530
+ "composite_id": {
3531
+ "type": "string",
3532
+ "readOnly": true,
3533
+ "example": "contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14"
3534
+ }
3535
+ }
3536
+ }
3537
+ ]
3538
+ },
3478
3539
  "Attribute": {
3479
3540
  "anyOf": [
3480
3541
  {
@@ -6202,7 +6263,7 @@
6202
6263
  "example": "Purposes"
6203
6264
  },
6204
6265
  "kind": {
6205
- "readonly": true,
6266
+ "readOnly": true,
6206
6267
  "type": "string",
6207
6268
  "enum": [
6208
6269
  "system",
@@ -6222,23 +6283,23 @@
6222
6283
  "example": "#FF5733"
6223
6284
  },
6224
6285
  "created_at": {
6225
- "readonly": true,
6286
+ "readOnly": true,
6226
6287
  "type": "string",
6227
6288
  "format": "date-time"
6228
6289
  },
6229
6290
  "updated_at": {
6230
- "readonly": true,
6291
+ "readOnly": true,
6231
6292
  "type": "string",
6232
6293
  "format": "date-time"
6233
6294
  },
6234
6295
  "deleted_at": {
6235
- "readonly": true,
6296
+ "readOnly": true,
6236
6297
  "type": "string",
6237
6298
  "format": "date-time",
6238
6299
  "description": "Date when the taxonomy was soft-deleted (enabled: false)"
6239
6300
  },
6240
6301
  "created_by": {
6241
- "readonly": true,
6302
+ "readOnly": true,
6242
6303
  "type": "string",
6243
6304
  "description": "User ID of the creator",
6244
6305
  "example": "10598"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/entity-client",
3
- "version": "4.25.5",
3
+ "version": "4.26.0-rc.1",
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",
@@ -71,5 +71,5 @@
71
71
  "webpack": "^5.18.0",
72
72
  "webpack-cli": "^4.4.0"
73
73
  },
74
- "gitHead": "6ccd0b02c2516775f32e10bd9b870f8dab6b749b"
74
+ "gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
75
75
  }
package/LICENSE DELETED
@@ -1,21 +0,0 @@
1
- The MIT License (MIT)
2
-
3
- Copyright (c) 2022 epilot GmbH
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in
13
- all copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
- THE SOFTWARE.