@epilot/entity-client 4.33.2 → 4.34.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/client.d.ts CHANGED
File without changes
package/dist/client.js CHANGED
File without changes
File without changes
@@ -1 +1 @@
1
- (()=>{"use strict";var e={914:function(e,t,a){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=r(a(240));t.default=n.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"}],"responses":{}}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"}],"responses":{}},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/schema":{"get":{"operationId":"getJsonSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/example":{"get":{"operationId":"getSchemaExample","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/versions":{"get":{"operationId":"getSchemaVersions","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"versions_from"},{"in":"query","name":"versions_size"},{"in":"query","name":"drafts_from"},{"in":"query","name":"drafts_size"},{"in":"query","name":"fields","required":false,"style":"form","explode":false}],"responses":{}}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints","responses":{}}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:list":{"post":{"operationId":"listEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}:validate":{"post":{"operationId":"validateEntityV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"},{"name":"strict","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}":{"get":{"operationId":"getEntityV2","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"fields","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}:restore":{"patch":{"operationId":"restoreEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}],"responses":{}},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"in":"query","name":"purge","default":false}],"responses":{}}},"/v1/entity:autocomplete":{"get":{"operationId":"autocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"slug","in":"query"},{"name":"size","in":"query"}],"responses":{}}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}],"responses":{}}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"query","name":"after"},{"in":"query","name":"before"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"removeRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"query"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"fields"}],"responses":{}}},"/v3/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV3","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseDeprecatedQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"},{"$ref":"#/components/parameters/EntityRelationsModeQueryParam"}],"responses":{}}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"responses":{}}},"/v1/entity:export":{"post":{"operationId":"exportEntities","parameters":[{"in":"query","name":"job_id"},{"in":"query","name":"is_template"},{"in":"query","name":"language"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/views":{"get":{"operationId":"listSavedViews","parameters":[{"in":"query","name":"slug","required":false},{"in":"query","name":"sort","required":false},{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"in":"query","name":"fields","required":false}],"responses":{}}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser","responses":{}}},"/v1/entity/taxonomies":{"get":{"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"}],"responses":{}},"post":{"operationId":"createTaxonomy","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"permanent"}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"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":[{"$ref":"#/components/parameters/TaxonomySlugQueryParamOptional"},{"in":"query","name":"query"},{"in":"query","name":"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"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}":{"get":{"operationId":"getTaxonomyBulkActionJobById","parameters":[{"in":"path","name":"job_id"}],"responses":{}}},"/v1/entity/taxonomies/classifications:move":{"post":{"operationId":"bulkMoveClassifications","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"}}}}')}},t={},a=function a(r){var n=t[r];if(void 0!==n)return n.exports;var s=t[r]={exports:{}};return e[r].call(s.exports,s,s.exports,a),s.exports}(914),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
1
+ (()=>{"use strict";var e={914:function(e,t,a){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=r(a(240));t.default=n.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"}],"responses":{}}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"}],"responses":{}},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/schema":{"get":{"operationId":"getJsonSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/example":{"get":{"operationId":"getSchemaExample","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/versions":{"get":{"operationId":"getSchemaVersions","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"versions_from"},{"in":"query","name":"versions_size"},{"in":"query","name":"drafts_from"},{"in":"query","name":"drafts_size"},{"in":"query","name":"fields","required":false,"style":"form","explode":false}],"responses":{}}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints","responses":{}}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:list":{"post":{"operationId":"listEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}:validate":{"post":{"operationId":"validateEntityV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"},{"name":"strict","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}":{"get":{"operationId":"getEntityV2","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"fields","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}:restore":{"patch":{"operationId":"restoreEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}],"responses":{}},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"in":"query","name":"purge"}],"responses":{}}},"/v1/entity:autocomplete":{"get":{"operationId":"autocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"slug","in":"query"},{"name":"size","in":"query"}],"responses":{}}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}],"responses":{}}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"query","name":"after"},{"in":"query","name":"before"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"removeRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"query"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"fields"}],"responses":{}}},"/v3/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV3","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseDeprecatedQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"},{"$ref":"#/components/parameters/EntityRelationsModeQueryParam"}],"responses":{}}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"responses":{}}},"/v1/entity:export":{"post":{"operationId":"exportEntities","parameters":[{"in":"query","name":"job_id"},{"in":"query","name":"is_template"},{"in":"query","name":"language"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/views":{"get":{"operationId":"listSavedViews","parameters":[{"in":"query","name":"slug","required":false},{"in":"query","name":"sort","required":false},{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"in":"query","name":"fields","required":false}],"responses":{}}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser","responses":{}}},"/v1/entity/taxonomies":{"get":{"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"}],"responses":{}},"post":{"operationId":"createTaxonomy","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"permanent"}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"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":[{"$ref":"#/components/parameters/TaxonomySlugQueryParamOptional"},{"in":"query","name":"query"},{"in":"query","name":"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"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}":{"get":{"operationId":"getTaxonomyBulkActionJobById","parameters":[{"in":"path","name":"job_id","required":true}],"responses":{}}},"/v1/entity/taxonomies/classifications:move":{"post":{"operationId":"bulkMoveClassifications","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"}}},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},a=function a(r){var n=t[r];if(void 0!==n)return n.exports;var s=t[r]={exports:{}};return e[r].call(s.exports,s,s.exports,a),s.exports}(914),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
package/dist/index.d.ts CHANGED
File without changes
package/dist/index.js CHANGED
File without changes
@@ -376,8 +376,7 @@
376
376
  },
377
377
  {
378
378
  "in": "query",
379
- "name": "purge",
380
- "default": false
379
+ "name": "purge"
381
380
  }
382
381
  ],
383
382
  "responses": {}
@@ -1050,7 +1049,8 @@
1050
1049
  "parameters": [
1051
1050
  {
1052
1051
  "in": "path",
1053
- "name": "job_id"
1052
+ "name": "job_id",
1053
+ "required": true
1054
1054
  }
1055
1055
  ],
1056
1056
  "responses": {}
@@ -1390,5 +1390,10 @@
1390
1390
  "in": "query"
1391
1391
  }
1392
1392
  }
1393
- }
1393
+ },
1394
+ "servers": [
1395
+ {
1396
+ "url": "https://entity.sls.epilot.io"
1397
+ }
1398
+ ]
1394
1399
  }
package/dist/openapi.d.ts CHANGED
@@ -21,7 +21,7 @@ declare namespace Components {
21
21
  * example:
22
22
  * 01F130Q52Q6MWSNS8N2AVXV4JN
23
23
  */
24
- Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("");
24
+ Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("" | null);
25
25
  export type AsyncOperationQueryParam = boolean;
26
26
  export type DryRunQueryParam = boolean;
27
27
  export type EntityIdPathParam = Schemas.EntityId /* uuid */;
@@ -239,6 +239,146 @@ declare namespace Components {
239
239
  operations_total?: number;
240
240
  operations?: EntityOperation[];
241
241
  }
242
+ /**
243
+ * Address attribute
244
+ */
245
+ export interface AddressAttribute {
246
+ /**
247
+ * ID for the entity attribute
248
+ * example:
249
+ * d5839b94-ba20-4225-a78e-76951d352bd6
250
+ */
251
+ id?: string;
252
+ name: string;
253
+ label: string;
254
+ placeholder?: string;
255
+ /**
256
+ * Do not render attribute in entity views
257
+ */
258
+ hidden?: boolean;
259
+ /**
260
+ * Render as a column in table views. When defined, overrides `hidden`
261
+ */
262
+ show_in_table?: boolean;
263
+ /**
264
+ * Allow sorting by this attribute in table views if `show_in_table` is true
265
+ */
266
+ sortable?: boolean;
267
+ required?: boolean;
268
+ readonly?: boolean;
269
+ deprecated?: boolean;
270
+ default_value?: any;
271
+ /**
272
+ * Which group the attribute should appear in. Accepts group ID or group name
273
+ */
274
+ group?: string;
275
+ /**
276
+ * Attribute sort order (ascending) in group
277
+ * example:
278
+ * 0
279
+ */
280
+ order?: number;
281
+ /**
282
+ * example:
283
+ * full_width
284
+ */
285
+ layout?: string;
286
+ /**
287
+ * When set to true, will hide the label of the field.
288
+ */
289
+ hide_label?: boolean;
290
+ /**
291
+ * Code name of the icon to used to represent this attribute.
292
+ * The value must be a valid @epilot/base-elements Icon name
293
+ *
294
+ */
295
+ icon?: string;
296
+ /**
297
+ * Defines the conditional rendering expression for showing this field.
298
+ * When a valid expression is parsed, their evaluation defines the visibility of this attribute.
299
+ * Note: Empty or invalid expression have no effect on the field visibility.
300
+ *
301
+ */
302
+ render_condition?: string;
303
+ _purpose?: /**
304
+ * example:
305
+ * taxonomy-slug:classification-slug
306
+ */
307
+ ClassificationId[];
308
+ /**
309
+ * Manifest ID used to create/update the schema attribute
310
+ */
311
+ _manifest?: string /* uuid */[] | null;
312
+ /**
313
+ * A set of constraints applicable to the attribute.
314
+ * These constraints should and will be enforced by the attribute renderer.
315
+ *
316
+ * example:
317
+ * {
318
+ * "disablePast": true
319
+ * }
320
+ */
321
+ constraints?: {
322
+ [key: string]: any;
323
+ };
324
+ /**
325
+ * This attribute should only be active when the feature flag is enabled
326
+ * example:
327
+ * FF_MY_FEATURE_FLAG
328
+ */
329
+ feature_flag?: string;
330
+ /**
331
+ * This attribute should only be active when one of the provided settings have the correct value
332
+ */
333
+ settings_flag?: SettingFlag[];
334
+ value_formatter?: string;
335
+ preview_value_formatter?: string;
336
+ /**
337
+ * Setting to `true` disables editing the attribute on the entity builder UI
338
+ */
339
+ entity_builder_disable_edit?: boolean;
340
+ /**
341
+ * Setting to `true` prevents the attribute from being modified / deleted
342
+ */
343
+ protected?: boolean;
344
+ /**
345
+ * A set of configurations meant to document and assist the user in filling the attribute.
346
+ */
347
+ info_helpers?: {
348
+ /**
349
+ * The text to be displayed in the attribute hint helper.
350
+ * When specified it overrides the `hint_text_key` configuration.
351
+ *
352
+ */
353
+ hint_text?: string;
354
+ /**
355
+ * The key of the hint text to be displayed in the attribute hint helper.
356
+ * The key should be a valid i18n key.
357
+ *
358
+ */
359
+ hint_text_key?: string;
360
+ /**
361
+ * The name of the custom component to be used as the hint helper.
362
+ * The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
363
+ * When specified it overrides the `hint_text` or `hint_text_key` configuration.
364
+ *
365
+ */
366
+ hint_custom_component?: string;
367
+ /**
368
+ * The placement of the hint tooltip.
369
+ * The value should be a valid `@mui/core` tooltip placement.
370
+ *
371
+ * example:
372
+ * top
373
+ */
374
+ hint_tooltip_placement?: string;
375
+ };
376
+ type?: "address";
377
+ /**
378
+ * Default fields visible on addresses
379
+ */
380
+ default_address_fields?: ("postal_code" | "city" | "street" | "street_number" | "plot_area" | "plot_of_land" | "suburb" | "country" | "additional_info" | "coordinates" | "start_date" | "end_date")[];
381
+ }
242
382
  /**
243
383
  * Reference to an address attribute of another entity
244
384
  */
@@ -376,7 +516,7 @@ declare namespace Components {
376
516
  type?: "relation_address";
377
517
  has_primary?: boolean;
378
518
  }
379
- 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 | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Repeatable (add N number of fields) */ RepeatableAttribute | /* Tags */ TagsAttribute | /* 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;
519
+ 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 | /* Repeatable (add N number of fields) */ RepeatableAttribute | /* Tags */ TagsAttribute | /* 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;
380
520
  /**
381
521
  * a readonly computed ID for the attribute including schema slug and the attribute ID
382
522
  */
@@ -392,7 +532,7 @@ declare namespace Components {
392
532
  * contact
393
533
  */
394
534
  schema?: string;
395
- } & (/* 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 | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Repeatable (add N number of fields) */ RepeatableAttribute | /* Tags */ TagsAttribute | /* 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);
535
+ } & (/* 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 | /* Repeatable (add N number of fields) */ RepeatableAttribute | /* Tags */ TagsAttribute | /* 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);
396
536
  /**
397
537
  * Automation entity
398
538
  */
@@ -2488,6 +2628,11 @@ declare namespace Components {
2488
2628
  * https://docs.epilot.io/docs/pricing/entities
2489
2629
  */
2490
2630
  docs_url?: string; // uri
2631
+ /**
2632
+ * example:
2633
+ * customer_relations
2634
+ */
2635
+ category?: "customer_relations" | "sales" | "product_hub" | "contracts" | "journeys" | "messaging" | "system";
2491
2636
  /**
2492
2637
  * example:
2493
2638
  * false
@@ -2857,6 +3002,11 @@ declare namespace Components {
2857
3002
  * https://docs.epilot.io/docs/pricing/entities
2858
3003
  */
2859
3004
  docs_url?: string; // uri
3005
+ /**
3006
+ * example:
3007
+ * customer_relations
3008
+ */
3009
+ category?: "customer_relations" | "sales" | "product_hub" | "contracts" | "journeys" | "messaging" | "system";
2860
3010
  /**
2861
3011
  * example:
2862
3012
  * false
@@ -5480,8 +5630,18 @@ declare namespace Components {
5480
5630
  * taxonomy-slug:classification-slug
5481
5631
  */
5482
5632
  ClassificationId[];
5633
+ /**
5634
+ * Color of the classification
5635
+ * example:
5636
+ * #FF5733
5637
+ */
5638
+ color?: string;
5483
5639
  created_at?: string; // date-time
5484
5640
  updated_at?: string; // date-time
5641
+ /**
5642
+ * Archived classification are not visible in the UI
5643
+ */
5644
+ archived?: boolean;
5485
5645
  type?: "purpose";
5486
5646
  }
5487
5647
  /**
@@ -7065,20 +7225,60 @@ declare namespace Components {
7065
7225
  */
7066
7226
  enabled_locations?: TaxonomyLocationId[];
7067
7227
  }
7228
+ /**
7229
+ * example:
7230
+ * {
7231
+ * "job_id": "123e4567-e89b-12d3-a456-426614174000",
7232
+ * "status": "PENDING",
7233
+ * "action_type": "MOVE_LABELS",
7234
+ * "created_by": 10598,
7235
+ * "created_at": "2024-01-01T00:00:00.000Z",
7236
+ * "updated_at": "2024-01-01T00:00:00.000Z",
7237
+ * "org": 66,
7238
+ * "progress": 0.5
7239
+ * }
7240
+ */
7068
7241
  export interface TaxonomyBulkJob {
7069
7242
  job_id?: string; // uuid
7070
- status?: /* The status of the bulk job */ TaxonomyBulkJobStatus;
7071
- type?: TaxonomyBulkJobType;
7243
+ job_status?: /* The status of the bulk job */ TaxonomyBulkJobStatus;
7244
+ action_type?: TaxonomyBulkJobActionType;
7245
+ request?: {
7246
+ target_taxonomy?: /**
7247
+ * URL-friendly name for taxonomy
7248
+ * example:
7249
+ * purpose
7250
+ */
7251
+ TaxonomySlug;
7252
+ classification_ids?: /**
7253
+ * example:
7254
+ * taxonomy-slug:classification-slug
7255
+ */
7256
+ ClassificationId[];
7257
+ };
7258
+ output?: {
7259
+ target_entities?: EntityId /* uuid */[];
7260
+ affected_entities?: EntityId /* uuid */[];
7261
+ failures_count?: number;
7262
+ failed_entities?: EntityId /* uuid */[];
7263
+ };
7264
+ created_by?: string;
7265
+ created_at?: string; // date-time
7266
+ updated_at?: string; // date-time
7267
+ org?: string;
7268
+ /**
7269
+ * Progress of the job on a scale of 0 to 1
7270
+ */
7271
+ progress?: number;
7072
7272
  }
7273
+ export type TaxonomyBulkJobActionType = "MOVE_CLASSIFICATIONS" | "DELETE_CLASSIFICATIONS";
7073
7274
  /**
7074
7275
  * The status of the bulk job
7075
7276
  */
7076
- export type TaxonomyBulkJobStatus = "PENDING" | "FAILED" | "COMPLETED";
7277
+ export type TaxonomyBulkJobStatus = "PENDING" | "FAILED" | "COMPLETED" | "CANCELLED";
7077
7278
  export interface TaxonomyBulkJobTriggerResponse {
7078
7279
  job_id?: string; // uuid
7079
7280
  status?: /* The status of the bulk job */ TaxonomyBulkJobStatus;
7080
7281
  }
7081
- export type TaxonomyBulkJobType = "MOVE_LABELS" | "DELETE_LABELS";
7082
7282
  export interface TaxonomyClassification {
7083
7283
  id?: /**
7084
7284
  * example:
@@ -7101,8 +7301,18 @@ declare namespace Components {
7101
7301
  * taxonomy-slug:classification-slug
7102
7302
  */
7103
7303
  ClassificationId[];
7304
+ /**
7305
+ * Color of the classification
7306
+ * example:
7307
+ * #FF5733
7308
+ */
7309
+ color?: string;
7104
7310
  created_at?: string; // date-time
7105
7311
  updated_at?: string; // date-time
7312
+ /**
7313
+ * Archived classification are not visible in the UI
7314
+ */
7315
+ archived?: boolean;
7106
7316
  /**
7107
7317
  * Manifest ID used to create/update the taxonomy classification
7108
7318
  */
@@ -7400,7 +7610,7 @@ declare namespace Paths {
7400
7610
  * example:
7401
7611
  * 01F130Q52Q6MWSNS8N2AVXV4JN
7402
7612
  */
7403
- Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("");
7613
+ Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("" | null);
7404
7614
  export type Async = boolean;
7405
7615
  export type Id = Components.Schemas.EntityId /* uuid */;
7406
7616
  export type Slug = /**
@@ -7489,13 +7699,11 @@ declare namespace Paths {
7489
7699
  }
7490
7700
  }
7491
7701
  namespace BulkDeleteClassifications {
7492
- namespace Parameters {
7493
- export type Permanent = boolean;
7494
- }
7495
- export interface QueryParameters {
7496
- permanent?: Parameters.Permanent;
7497
- }
7498
7702
  export interface RequestBody {
7703
+ /**
7704
+ * Job ID for tracking the status of a bulk operation request
7705
+ */
7706
+ job_id?: string;
7499
7707
  classification_ids?: /**
7500
7708
  * example:
7501
7709
  * taxonomy-slug:classification-slug
@@ -7507,18 +7715,20 @@ declare namespace Paths {
7507
7715
  }
7508
7716
  }
7509
7717
  namespace BulkMoveClassifications {
7510
- namespace Parameters {
7511
- export type TargetTaxonomy = /**
7718
+ export interface RequestBody {
7719
+ /**
7720
+ * Job ID for tracking the status of a bulk operation request
7721
+ */
7722
+ job_id?: string;
7723
+ /**
7724
+ * The target taxonomy to which the classifications will be moved
7725
+ */
7726
+ target_taxonomy?: /**
7512
7727
  * URL-friendly name for taxonomy
7513
7728
  * example:
7514
7729
  * purpose
7515
7730
  */
7516
7731
  Components.Schemas.TaxonomySlug;
7517
- }
7518
- export interface QueryParameters {
7519
- target_taxonomy?: Parameters.TargetTaxonomy;
7520
- }
7521
- export interface RequestBody {
7522
7732
  classification_ids?: /**
7523
7733
  * example:
7524
7734
  * taxonomy-slug:classification-slug
@@ -7548,7 +7758,7 @@ declare namespace Paths {
7548
7758
  * example:
7549
7759
  * 01F130Q52Q6MWSNS8N2AVXV4JN
7550
7760
  */
7551
- Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("");
7761
+ Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("" | null);
7552
7762
  export type Async = boolean;
7553
7763
  export type FillActivity = boolean;
7554
7764
  export type Slug = /**
@@ -7700,7 +7910,7 @@ declare namespace Paths {
7700
7910
  * example:
7701
7911
  * 01F130Q52Q6MWSNS8N2AVXV4JN
7702
7912
  */
7703
- Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("");
7913
+ Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("" | null);
7704
7914
  export type Id = Components.Schemas.EntityId /* uuid */;
7705
7915
  export type Purge = boolean;
7706
7916
  export type Slug = /**
@@ -7730,7 +7940,7 @@ declare namespace Paths {
7730
7940
  * example:
7731
7941
  * 01F130Q52Q6MWSNS8N2AVXV4JN
7732
7942
  */
7733
- Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("");
7943
+ Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("" | null);
7734
7944
  export type Async = boolean;
7735
7945
  export type Attribute = string;
7736
7946
  export type EntityId = string;
@@ -8184,17 +8394,6 @@ declare namespace Paths {
8184
8394
  Components.Schemas.EntityItem;
8185
8395
  }
8186
8396
  }
8187
- namespace GetJobs {
8188
- namespace Parameters {
8189
- export type Status = /* The status of the bulk job */ Components.Schemas.TaxonomyBulkJobStatus;
8190
- }
8191
- export interface QueryParameters {
8192
- status?: Parameters.Status;
8193
- }
8194
- namespace Responses {
8195
- export type $200 = Components.Schemas.TaxonomyBulkJob[];
8196
- }
8197
- }
8198
8397
  namespace GetJsonSchema {
8199
8398
  namespace Parameters {
8200
8399
  export type Slug = /**
@@ -8314,7 +8513,8 @@ declare namespace Paths {
8314
8513
  * "enum": [
8315
8514
  * "Dr.",
8316
8515
  * "Prof.",
8317
- * "Prof. Dr."
8516
+ * "Prof. Dr.",
8517
+ * null
8318
8518
  * ]
8319
8519
  * },
8320
8520
  * "salutation": {
@@ -8330,7 +8530,8 @@ declare namespace Paths {
8330
8530
  * "Family",
8331
8531
  * "Ownership",
8332
8532
  * "Assembly",
8333
- * "Other"
8533
+ * "Other",
8534
+ * null
8334
8535
  * ]
8335
8536
  * },
8336
8537
  * "first_name": {
@@ -8407,7 +8608,8 @@ declare namespace Paths {
8407
8608
  * "enum": [
8408
8609
  * "DE",
8409
8610
  * "AT",
8410
- * "CH"
8611
+ * "CH",
8612
+ * null
8411
8613
  * ]
8412
8614
  * },
8413
8615
  * "additional_info": {
@@ -8852,6 +9054,54 @@ declare namespace Paths {
8852
9054
  export type $200 = Components.Schemas.Taxonomy;
8853
9055
  }
8854
9056
  }
9057
+ namespace GetTaxonomyBulkActionJobById {
9058
+ namespace Parameters {
9059
+ export type JobId = string;
9060
+ }
9061
+ export interface PathParameters {
9062
+ job_id: Parameters.JobId;
9063
+ }
9064
+ namespace Responses {
9065
+ export type $200 = /**
9066
+ * example:
9067
+ * {
9068
+ * "job_id": "123e4567-e89b-12d3-a456-426614174000",
9069
+ * "status": "PENDING",
9070
+ * "action_type": "MOVE_LABELS",
9071
+ * "created_by": 10598,
9072
+ * "created_at": "2024-01-01T00:00:00.000Z",
9073
+ * "updated_at": "2024-01-01T00:00:00.000Z",
9074
+ * "org": 66,
9075
+ * "progress": 0.5
9076
+ * }
9077
+ */
9078
+ Components.Schemas.TaxonomyBulkJob[];
9079
+ }
9080
+ }
9081
+ namespace GetTaxonomyBulkActionJobs {
9082
+ namespace Parameters {
9083
+ export type Status = /* The status of the bulk job */ Components.Schemas.TaxonomyBulkJobStatus;
9084
+ }
9085
+ export interface QueryParameters {
9086
+ status?: Parameters.Status;
9087
+ }
9088
+ namespace Responses {
9089
+ export type $200 = /**
9090
+ * example:
9091
+ * {
9092
+ * "job_id": "123e4567-e89b-12d3-a456-426614174000",
9093
+ * "status": "PENDING",
9094
+ * "action_type": "MOVE_LABELS",
9095
+ * "created_by": 10598,
9096
+ * "created_at": "2024-01-01T00:00:00.000Z",
9097
+ * "updated_at": "2024-01-01T00:00:00.000Z",
9098
+ * "org": 66,
9099
+ * "progress": 0.5
9100
+ * }
9101
+ */
9102
+ Components.Schemas.TaxonomyBulkJob[];
9103
+ }
9104
+ }
8855
9105
  namespace GetTaxonomyClassification {
8856
9106
  namespace Parameters {
8857
9107
  export type ClassificationSlug = string;
@@ -9003,7 +9253,7 @@ declare namespace Paths {
9003
9253
  * example:
9004
9254
  * 01F130Q52Q6MWSNS8N2AVXV4JN
9005
9255
  */
9006
- Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("");
9256
+ Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("" | null);
9007
9257
  export type Async = boolean;
9008
9258
  export type DryRun = boolean;
9009
9259
  export type FillActivity = boolean;
@@ -9224,7 +9474,7 @@ declare namespace Paths {
9224
9474
  * example:
9225
9475
  * 01F130Q52Q6MWSNS8N2AVXV4JN
9226
9476
  */
9227
- Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("");
9477
+ Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("" | null);
9228
9478
  export type Async = boolean;
9229
9479
  export type Id = Components.Schemas.EntityId /* uuid */;
9230
9480
  export type Slug = /**
@@ -9255,7 +9505,7 @@ declare namespace Paths {
9255
9505
  * example:
9256
9506
  * 01F130Q52Q6MWSNS8N2AVXV4JN
9257
9507
  */
9258
- Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("");
9508
+ Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("" | null);
9259
9509
  export type Id = Components.Schemas.EntityId /* uuid */;
9260
9510
  export type Slug = /**
9261
9511
  * URL-friendly identifier for the entity schema
@@ -9338,6 +9588,11 @@ declare namespace Paths {
9338
9588
  }
9339
9589
  namespace TaxonomiesClassificationsSearch {
9340
9590
  namespace Parameters {
9591
+ /**
9592
+ * example:
9593
+ * false
9594
+ */
9595
+ export type Archived = boolean;
9341
9596
  /**
9342
9597
  * example:
9343
9598
  * sales
@@ -9352,6 +9607,11 @@ declare namespace Paths {
9352
9607
  * sales
9353
9608
  */
9354
9609
  Parameters.Query;
9610
+ archived?: /**
9611
+ * example:
9612
+ * false
9613
+ */
9614
+ Parameters.Archived;
9355
9615
  }
9356
9616
  export interface RequestBody {
9357
9617
  classificationIds?: /**
@@ -9410,7 +9670,7 @@ declare namespace Paths {
9410
9670
  * example:
9411
9671
  * 01F130Q52Q6MWSNS8N2AVXV4JN
9412
9672
  */
9413
- Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("");
9673
+ Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("" | null);
9414
9674
  export type Async = boolean;
9415
9675
  export type FillActivity = boolean;
9416
9676
  export type Id = Components.Schemas.EntityId /* uuid */;
@@ -9526,7 +9786,7 @@ declare namespace Paths {
9526
9786
  * example:
9527
9787
  * 01F130Q52Q6MWSNS8N2AVXV4JN
9528
9788
  */
9529
- Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("");
9789
+ Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("" | null);
9530
9790
  export type Async = boolean;
9531
9791
  export type Attribute = string;
9532
9792
  export type EntityId = string;
@@ -9600,7 +9860,7 @@ declare namespace Paths {
9600
9860
  * example:
9601
9861
  * 01F130Q52Q6MWSNS8N2AVXV4JN
9602
9862
  */
9603
- Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("");
9863
+ Components.Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("" | null);
9604
9864
  export type Async = boolean;
9605
9865
  export type DryRun = boolean;
9606
9866
  export type FillActivity = boolean;
@@ -10683,15 +10943,30 @@ export interface OperationMethods {
10683
10943
  config?: AxiosRequestConfig
10684
10944
  ): OperationResponse<Paths.ListTaxonomyClassificationsForSchema.Responses.$200>
10685
10945
  /**
10686
- * getJobs - getJobs
10946
+ * getTaxonomyBulkActionJobs - getTaxonomyBulkActionJobs
10947
+ *
10948
+ * Gets bulk actions jobs by job status:
10949
+ * - <undefined> = all active jobs
10950
+ * - PENDING = all active jobs
10951
+ * - FAILED = all failed jobs
10952
+ * - COMPLETED = all completed jobs
10687
10953
  *
10688
- * Gets bulk jobs by job status
10689
10954
  */
10690
- 'getJobs'(
10691
- parameters?: Parameters<Paths.GetJobs.QueryParameters> | null,
10955
+ 'getTaxonomyBulkActionJobs'(
10956
+ parameters?: Parameters<Paths.GetTaxonomyBulkActionJobs.QueryParameters> | null,
10692
10957
  data?: any,
10693
10958
  config?: AxiosRequestConfig
10694
- ): OperationResponse<Paths.GetJobs.Responses.$200>
10959
+ ): OperationResponse<Paths.GetTaxonomyBulkActionJobs.Responses.$200>
10960
+ /**
10961
+ * getTaxonomyBulkActionJobById - getTaxonomyBulkActionJobById
10962
+ *
10963
+ * Gets a bulk action job by job id
10964
+ */
10965
+ 'getTaxonomyBulkActionJobById'(
10966
+ parameters?: Parameters<Paths.GetTaxonomyBulkActionJobById.PathParameters> | null,
10967
+ data?: any,
10968
+ config?: AxiosRequestConfig
10969
+ ): OperationResponse<Paths.GetTaxonomyBulkActionJobById.Responses.$200>
10695
10970
  /**
10696
10971
  * bulkMoveClassifications - bulkMoveClassifications
10697
10972
  *
@@ -10700,19 +10975,20 @@ export interface OperationMethods {
10700
10975
  *
10701
10976
  */
10702
10977
  'bulkMoveClassifications'(
10703
- parameters?: Parameters<Paths.BulkMoveClassifications.QueryParameters> | null,
10978
+ parameters?: Parameters<UnknownParamsObject> | null,
10704
10979
  data?: Paths.BulkMoveClassifications.RequestBody,
10705
10980
  config?: AxiosRequestConfig
10706
10981
  ): OperationResponse<Paths.BulkMoveClassifications.Responses.$200>
10707
10982
  /**
10708
10983
  * bulkDeleteClassifications - bulkDeleteClassifications
10709
10984
  *
10710
- * Archives or permanently deletes taxonomy classifications. When permanent is true, the classifications are deleted through a bulk
10711
- * async operation which also deletes all references of the deleted classifications from the entities referencing them.
10985
+ * Permanently deletes taxonomy classifications. The classifications are deleted through a bulk
10986
+ * async operation which also deletes all references of the deleted classifications from the entities
10987
+ * referencing them.
10712
10988
  *
10713
10989
  */
10714
10990
  'bulkDeleteClassifications'(
10715
- parameters?: Parameters<Paths.BulkDeleteClassifications.QueryParameters> | null,
10991
+ parameters?: Parameters<UnknownParamsObject> | null,
10716
10992
  data?: Paths.BulkDeleteClassifications.RequestBody,
10717
10993
  config?: AxiosRequestConfig
10718
10994
  ): OperationResponse<Paths.BulkDeleteClassifications.Responses.$200>
@@ -11747,17 +12023,34 @@ export interface PathsDictionary {
11747
12023
  config?: AxiosRequestConfig
11748
12024
  ): OperationResponse<Paths.ListTaxonomyClassificationsForSchema.Responses.$200>
11749
12025
  }
11750
- ['/v1/entity/taxonomies/jobs']: {
12026
+ ['/v1/entity/taxonomies/bulk-jobs']: {
11751
12027
  /**
11752
- * getJobs - getJobs
12028
+ * getTaxonomyBulkActionJobs - getTaxonomyBulkActionJobs
12029
+ *
12030
+ * Gets bulk actions jobs by job status:
12031
+ * - <undefined> = all active jobs
12032
+ * - PENDING = all active jobs
12033
+ * - FAILED = all failed jobs
12034
+ * - COMPLETED = all completed jobs
11753
12035
  *
11754
- * Gets bulk jobs by job status
11755
12036
  */
11756
12037
  'get'(
11757
- parameters?: Parameters<Paths.GetJobs.QueryParameters> | null,
12038
+ parameters?: Parameters<Paths.GetTaxonomyBulkActionJobs.QueryParameters> | null,
11758
12039
  data?: any,
11759
12040
  config?: AxiosRequestConfig
11760
- ): OperationResponse<Paths.GetJobs.Responses.$200>
12041
+ ): OperationResponse<Paths.GetTaxonomyBulkActionJobs.Responses.$200>
12042
+ }
12043
+ ['/v1/entity/taxonomies/bulk-jobs/{job_id}']: {
12044
+ /**
12045
+ * getTaxonomyBulkActionJobById - getTaxonomyBulkActionJobById
12046
+ *
12047
+ * Gets a bulk action job by job id
12048
+ */
12049
+ 'get'(
12050
+ parameters?: Parameters<Paths.GetTaxonomyBulkActionJobById.PathParameters> | null,
12051
+ data?: any,
12052
+ config?: AxiosRequestConfig
12053
+ ): OperationResponse<Paths.GetTaxonomyBulkActionJobById.Responses.$200>
11761
12054
  }
11762
12055
  ['/v1/entity/taxonomies/classifications:move']: {
11763
12056
  /**
@@ -11768,7 +12061,7 @@ export interface PathsDictionary {
11768
12061
  *
11769
12062
  */
11770
12063
  'post'(
11771
- parameters?: Parameters<Paths.BulkMoveClassifications.QueryParameters> | null,
12064
+ parameters?: Parameters<UnknownParamsObject> | null,
11772
12065
  data?: Paths.BulkMoveClassifications.RequestBody,
11773
12066
  config?: AxiosRequestConfig
11774
12067
  ): OperationResponse<Paths.BulkMoveClassifications.Responses.$200>
@@ -11777,12 +12070,13 @@ export interface PathsDictionary {
11777
12070
  /**
11778
12071
  * bulkDeleteClassifications - bulkDeleteClassifications
11779
12072
  *
11780
- * Archives or permanently deletes taxonomy classifications. When permanent is true, the classifications are deleted through a bulk
11781
- * async operation which also deletes all references of the deleted classifications from the entities referencing them.
12073
+ * Permanently deletes taxonomy classifications. The classifications are deleted through a bulk
12074
+ * async operation which also deletes all references of the deleted classifications from the entities
12075
+ * referencing them.
11782
12076
  *
11783
12077
  */
11784
12078
  'post'(
11785
- parameters?: Parameters<Paths.BulkDeleteClassifications.QueryParameters> | null,
12079
+ parameters?: Parameters<UnknownParamsObject> | null,
11786
12080
  data?: Paths.BulkDeleteClassifications.RequestBody,
11787
12081
  config?: AxiosRequestConfig
11788
12082
  ): OperationResponse<Paths.BulkDeleteClassifications.Responses.$200>
@@ -11971,6 +12265,7 @@ export type Activity = Components.Schemas.Activity;
11971
12265
  export type ActivityCallerContext = Components.Schemas.ActivityCallerContext;
11972
12266
  export type ActivityId = Components.Schemas.ActivityId;
11973
12267
  export type ActivityItem = Components.Schemas.ActivityItem;
12268
+ export type AddressAttribute = Components.Schemas.AddressAttribute;
11974
12269
  export type AddressRelationAttribute = Components.Schemas.AddressRelationAttribute;
11975
12270
  export type Attribute = Components.Schemas.Attribute;
11976
12271
  export type AttributeWithCompositeID = Components.Schemas.AttributeWithCompositeID;
@@ -12070,9 +12365,9 @@ export type SummaryField = Components.Schemas.SummaryField;
12070
12365
  export type TagsAttribute = Components.Schemas.TagsAttribute;
12071
12366
  export type Taxonomy = Components.Schemas.Taxonomy;
12072
12367
  export type TaxonomyBulkJob = Components.Schemas.TaxonomyBulkJob;
12368
+ export type TaxonomyBulkJobActionType = Components.Schemas.TaxonomyBulkJobActionType;
12073
12369
  export type TaxonomyBulkJobStatus = Components.Schemas.TaxonomyBulkJobStatus;
12074
12370
  export type TaxonomyBulkJobTriggerResponse = Components.Schemas.TaxonomyBulkJobTriggerResponse;
12075
- export type TaxonomyBulkJobType = Components.Schemas.TaxonomyBulkJobType;
12076
12371
  export type TaxonomyClassification = Components.Schemas.TaxonomyClassification;
12077
12372
  export type TaxonomyLocationId = Components.Schemas.TaxonomyLocationId;
12078
12373
  export type TaxonomySlug = Components.Schemas.TaxonomySlug;
package/dist/openapi.json CHANGED
@@ -307,7 +307,8 @@
307
307
  "enum": [
308
308
  "Dr.",
309
309
  "Prof.",
310
- "Prof. Dr."
310
+ "Prof. Dr.",
311
+ null
311
312
  ]
312
313
  },
313
314
  "salutation": {
@@ -323,7 +324,8 @@
323
324
  "Family",
324
325
  "Ownership",
325
326
  "Assembly",
326
- "Other"
327
+ "Other",
328
+ null
327
329
  ]
328
330
  },
329
331
  "first_name": {
@@ -400,7 +402,8 @@
400
402
  "enum": [
401
403
  "DE",
402
404
  "AT",
403
- "CH"
405
+ "CH",
406
+ null
404
407
  ]
405
408
  },
406
409
  "additional_info": {
@@ -1315,9 +1318,9 @@
1315
1318
  "in": "query",
1316
1319
  "name": "purge",
1317
1320
  "description": "Permanently deletes the entity when set to `true`",
1318
- "default": false,
1319
1321
  "schema": {
1320
- "type": "boolean"
1322
+ "type": "boolean",
1323
+ "default": false
1321
1324
  }
1322
1325
  }
1323
1326
  ],
@@ -2957,6 +2960,7 @@
2957
2960
  {
2958
2961
  "in": "path",
2959
2962
  "name": "job_id",
2963
+ "required": true,
2960
2964
  "schema": {
2961
2965
  "type": "string"
2962
2966
  }
@@ -4245,6 +4249,9 @@
4245
4249
  {
4246
4250
  "$ref": "#/components/schemas/UserRelationAttribute"
4247
4251
  },
4252
+ {
4253
+ "$ref": "#/components/schemas/AddressAttribute"
4254
+ },
4248
4255
  {
4249
4256
  "$ref": "#/components/schemas/AddressRelationAttribute"
4250
4257
  },
@@ -5139,6 +5146,52 @@
5139
5146
  }
5140
5147
  ]
5141
5148
  },
5149
+ "AddressAttribute": {
5150
+ "allOf": [
5151
+ {
5152
+ "$ref": "#/components/schemas/BaseAttribute"
5153
+ },
5154
+ {
5155
+ "type": "object",
5156
+ "description": "Address attribute",
5157
+ "properties": {
5158
+ "type": {
5159
+ "type": "string",
5160
+ "enum": [
5161
+ "address"
5162
+ ]
5163
+ },
5164
+ "default_address_fields": {
5165
+ "description": "Default fields visible on addresses",
5166
+ "default": [
5167
+ "postal_code",
5168
+ "city",
5169
+ "street",
5170
+ "street_number"
5171
+ ],
5172
+ "type": "array",
5173
+ "items": {
5174
+ "type": "string",
5175
+ "enum": [
5176
+ "postal_code",
5177
+ "city",
5178
+ "street",
5179
+ "street_number",
5180
+ "plot_area",
5181
+ "plot_of_land",
5182
+ "suburb",
5183
+ "country",
5184
+ "additional_info",
5185
+ "coordinates",
5186
+ "start_date",
5187
+ "end_date"
5188
+ ]
5189
+ }
5190
+ }
5191
+ }
5192
+ }
5193
+ ]
5194
+ },
5142
5195
  "AddressRelationAttribute": {
5143
5196
  "allOf": [
5144
5197
  {
@@ -7668,7 +7721,8 @@
7668
7721
  "type": "string",
7669
7722
  "nullable": true,
7670
7723
  "enum": [
7671
- ""
7724
+ "",
7725
+ null
7672
7726
  ]
7673
7727
  }
7674
7728
  ]
@@ -8439,9 +8493,6 @@
8439
8493
  }
8440
8494
  },
8441
8495
  "servers": [
8442
- {
8443
- "url": "https://entity.sls.epilot.io"
8444
- },
8445
8496
  {
8446
8497
  "url": "https://entity.sls.epilot.io"
8447
8498
  }
File without changes
File without changes
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/entity-client",
3
- "version": "4.33.2",
3
+ "version": "4.34.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",
@@ -24,7 +24,7 @@
24
24
  "test": "jest",
25
25
  "typescript": "tsc",
26
26
  "bundle-definition": "webpack",
27
- "openapi": "node ../../scripts/update-openapi.js ./src/openapi.yml",
27
+ "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/entity.yaml",
28
28
  "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
29
29
  "build": "tsc && npm run build:patch && npm run bundle-definition",
30
30
  "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",