@epilot/entity-client 4.32.0 → 4.33.2

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.
Files changed (5) hide show
  1. package/dist/definition.js +1 -1
  2. package/dist/openapi-runtime.json +80 -35
  3. package/dist/openapi.d.ts +201 -56
  4. package/dist/openapi.json +419 -93
  5. package/package.json +2 -2
package/dist/definition.js CHANGED
@@ -1 +1 @@
1
- (()=>{"use strict";var e={914:function(e,t,a){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=r(a(240));t.default=n.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"}],"responses":{}}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"}],"responses":{}},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/schema":{"get":{"operationId":"getJsonSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/example":{"get":{"operationId":"getSchemaExample","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/versions":{"get":{"operationId":"getSchemaVersions","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"versions_from"},{"in":"query","name":"versions_size"},{"in":"query","name":"drafts_from"},{"in":"query","name":"drafts_size"},{"in":"query","name":"fields","required":false,"style":"form","explode":false}],"responses":{}}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints","responses":{}}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:list":{"post":{"operationId":"listEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}:validate":{"post":{"operationId":"validateEntityV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"},{"name":"strict","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}":{"get":{"operationId":"getEntityV2","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"fields","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}:restore":{"patch":{"operationId":"restoreEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}],"responses":{}},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"in":"query","name":"purge","default":false}],"responses":{}}},"/v1/entity:autocomplete":{"get":{"operationId":"autocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"slug","in":"query"},{"name":"size","in":"query"}],"responses":{}}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}],"responses":{}}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"query","name":"after"},{"in":"query","name":"before"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"removeRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"query"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"fields"}],"responses":{}}},"/v3/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV3","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseDeprecatedQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"},{"$ref":"#/components/parameters/EntityRelationsModeQueryParam"}],"responses":{}}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"responses":{}}},"/v1/entity:export":{"post":{"operationId":"exportEntities","parameters":[{"in":"query","name":"job_id"},{"in":"query","name":"is_template"},{"in":"query","name":"language"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/views":{"get":{"operationId":"listSavedViews","parameters":[{"in":"query","name":"slug","required":false},{"in":"query","name":"sort","required":false},{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"in":"query","name":"fields","required":false}],"responses":{}}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser","responses":{}}},"/v1/entity/taxonomies":{"get":{"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"}],"responses":{}},"post":{"operationId":"createTaxonomy","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"permanent"}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}],"responses":{}}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"$ref":"#/components/parameters/TaxonomySlugQueryParamOptional"},{"in":"query","name":"query"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}":{"get":{"operationId":"listTaxonomyClassificationsForSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}],"responses":{}}},"/v2/entity/taxonomies/classifications/{classificationSlug}":{"get":{"operationId":"getTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"responses":{}}},"/v1/entity/schemas/attributes":{"post":{"operationId":"createSchemaAttribute","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/attributes/{composite_id}":{"get":{"operationId":"getSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/capabilities":{"post":{"operationId":"createSchemaCapability","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/capabilities/{composite_id}":{"get":{"operationId":"getSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/group":{"post":{"operationId":"createSchemaGroup","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/group/{composite_id}":{"get":{"operationId":"getSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/headline":{"post":{"operationId":"createSchemaGroupHeadline","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/headline/{composite_id}":{"get":{"operationId":"getSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}}},"components":{"parameters":{"EntityIdPathParam":{"name":"id","in":"path","required":true},"EntitySlugPathParam":{"name":"slug","in":"path","required":true},"EntitySlugPathPriceParam":{"name":"slug","in":"path","required":true},"TaxonomySlugQueryParam":{"name":"taxonomySlug","in":"query","required":true},"TaxonomySlugPathParam":{"name":"taxonomySlug","in":"path","required":true},"TaxonomySlugQueryParamOptional":{"name":"taxonomySlug","in":"query"},"TaxonomyClassificationSlugPathParam":{"name":"classificationSlug","in":"path","required":true},"SavedViewIdPathParam":{"name":"id","in":"path","required":true},"AsyncOperationQueryParam":{"name":"async","in":"query","required":false},"HydrateEntitiesQueryParam":{"name":"hydrate","in":"query"},"ActivityIdQueryParam":{"name":"activity_id","in":"query","required":false},"ActivityIdPathParam":{"name":"id","in":"path","required":true},"FromPageQueryParam":{"name":"from","in":"query"},"IncludeReverseDeprecatedQueryParam":{"name":"include_reverse","in":"query","deprecated":true},"IncludeReverseQueryParam":{"name":"include_reverse","in":"query"},"IncludeSchemasQueryParam":{"name":"include_schemas","in":"query","required":false,"style":"form","explode":false},"ExcludeSchemasQueryParam":{"name":"exclude_schemas","in":"query","required":false,"style":"form","explode":false},"EntityRelationsModeQueryParam":{"name":"mode","in":"query","required":false},"DryRunQueryParam":{"name":"dry_run","in":"query","required":false},"FillActivityQueryParam":{"name":"fill_activity","in":"query","required":false},"ValidateEntityQueryParam":{"name":"validate","in":"query"}}},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},a=function a(r){var n=t[r];if(void 0!==n)return n.exports;var s=t[r]={exports:{}};return e[r].call(s.exports,s,s.exports,a),s.exports}(914),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
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})})();
package/dist/openapi-runtime.json CHANGED
@@ -917,6 +917,56 @@
917
917
  "responses": {}
918
918
  }
919
919
  },
920
+ "/v1/entity/taxonomies/{taxonomySlug}/classifications": {
921
+ "post": {
922
+ "operationId": "updateClassificationsForTaxonomy",
923
+ "parameters": [
924
+ {
925
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
926
+ }
927
+ ],
928
+ "requestBody": {
929
+ "content": {
930
+ "application/json": {}
931
+ }
932
+ },
933
+ "responses": {}
934
+ }
935
+ },
936
+ "/v2/entity/taxonomies/classifications/{classificationSlug}": {
937
+ "get": {
938
+ "operationId": "getTaxonomyClassification",
939
+ "parameters": [
940
+ {
941
+ "$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
942
+ }
943
+ ],
944
+ "responses": {}
945
+ },
946
+ "put": {
947
+ "operationId": "updateTaxonomyClassification",
948
+ "parameters": [
949
+ {
950
+ "$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
951
+ }
952
+ ],
953
+ "requestBody": {
954
+ "content": {
955
+ "application/json": {}
956
+ }
957
+ },
958
+ "responses": {}
959
+ },
960
+ "delete": {
961
+ "operationId": "deleteTaxonomyClassification",
962
+ "parameters": [
963
+ {
964
+ "$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
965
+ }
966
+ ],
967
+ "responses": {}
968
+ }
969
+ },
920
970
  "/v1/entity/taxonomies/{taxonomySlug}:autocomplete": {
921
971
  "get": {
922
972
  "operationId": "taxonomyAutocomplete",
@@ -946,22 +996,10 @@
946
996
  {
947
997
  "in": "query",
948
998
  "name": "query"
949
- }
950
- ],
951
- "requestBody": {
952
- "content": {
953
- "application/json": {}
954
- }
955
- },
956
- "responses": {}
957
- }
958
- },
959
- "/v1/entity/taxonomies/{taxonomySlug}/classifications": {
960
- "post": {
961
- "operationId": "updateClassificationsForTaxonomy",
962
- "parameters": [
999
+ },
963
1000
  {
964
- "$ref": "#/components/parameters/TaxonomySlugPathParam"
1001
+ "in": "query",
1002
+ "name": "archived"
965
1003
  }
966
1004
  ],
967
1005
  "requestBody": {
@@ -994,37 +1032,49 @@
994
1032
  "responses": {}
995
1033
  }
996
1034
  },
997
- "/v2/entity/taxonomies/classifications/{classificationSlug}": {
1035
+ "/v1/entity/taxonomies/bulk-jobs": {
998
1036
  "get": {
999
- "operationId": "getTaxonomyClassification",
1037
+ "operationId": "getTaxonomyBulkActionJobs",
1000
1038
  "parameters": [
1001
1039
  {
1002
- "$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
1040
+ "in": "query",
1041
+ "name": "status"
1003
1042
  }
1004
1043
  ],
1005
1044
  "responses": {}
1006
- },
1007
- "put": {
1008
- "operationId": "updateTaxonomyClassification",
1045
+ }
1046
+ },
1047
+ "/v1/entity/taxonomies/bulk-jobs/{job_id}": {
1048
+ "get": {
1049
+ "operationId": "getTaxonomyBulkActionJobById",
1009
1050
  "parameters": [
1010
1051
  {
1011
- "$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
1052
+ "in": "path",
1053
+ "name": "job_id"
1012
1054
  }
1013
1055
  ],
1056
+ "responses": {}
1057
+ }
1058
+ },
1059
+ "/v1/entity/taxonomies/classifications:move": {
1060
+ "post": {
1061
+ "operationId": "bulkMoveClassifications",
1014
1062
  "requestBody": {
1015
1063
  "content": {
1016
1064
  "application/json": {}
1017
1065
  }
1018
1066
  },
1019
1067
  "responses": {}
1020
- },
1021
- "delete": {
1022
- "operationId": "deleteTaxonomyClassification",
1023
- "parameters": [
1024
- {
1025
- "$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
1068
+ }
1069
+ },
1070
+ "/v1/entity/taxonomies/classifications:delete": {
1071
+ "post": {
1072
+ "operationId": "bulkDeleteClassifications",
1073
+ "requestBody": {
1074
+ "content": {
1075
+ "application/json": {}
1026
1076
  }
1027
- ],
1077
+ },
1028
1078
  "responses": {}
1029
1079
  }
1030
1080
  },
@@ -1340,10 +1390,5 @@
1340
1390
  "in": "query"
1341
1391
  }
1342
1392
  }
1343
- },
1344
- "servers": [
1345
- {
1346
- "url": "https://entity.sls.epilot.io"
1347
- }
1348
- ]
1393
+ }
1349
1394
  }
package/dist/openapi.d.ts CHANGED
@@ -7065,6 +7065,20 @@ declare namespace Components {
7065
7065
  */
7066
7066
  enabled_locations?: TaxonomyLocationId[];
7067
7067
  }
7068
+ export interface TaxonomyBulkJob {
7069
+ job_id?: string; // uuid
7070
+ status?: /* The status of the bulk job */ TaxonomyBulkJobStatus;
7071
+ type?: TaxonomyBulkJobType;
7072
+ }
7073
+ /**
7074
+ * The status of the bulk job
7075
+ */
7076
+ export type TaxonomyBulkJobStatus = "PENDING" | "FAILED" | "COMPLETED";
7077
+ export interface TaxonomyBulkJobTriggerResponse {
7078
+ job_id?: string; // uuid
7079
+ status?: /* The status of the bulk job */ TaxonomyBulkJobStatus;
7080
+ }
7081
+ export type TaxonomyBulkJobType = "MOVE_LABELS" | "DELETE_LABELS";
7068
7082
  export interface TaxonomyClassification {
7069
7083
  id?: /**
7070
7084
  * example:
@@ -7237,6 +7251,7 @@ declare namespace Components {
7237
7251
  };
7238
7252
  type?: "string";
7239
7253
  multiline?: boolean;
7254
+ rich_text?: boolean;
7240
7255
  }
7241
7256
  /**
7242
7257
  * User Relationship
@@ -7473,6 +7488,47 @@ declare namespace Paths {
7473
7488
  }
7474
7489
  }
7475
7490
  }
7491
+ namespace BulkDeleteClassifications {
7492
+ namespace Parameters {
7493
+ export type Permanent = boolean;
7494
+ }
7495
+ export interface QueryParameters {
7496
+ permanent?: Parameters.Permanent;
7497
+ }
7498
+ export interface RequestBody {
7499
+ classification_ids?: /**
7500
+ * example:
7501
+ * taxonomy-slug:classification-slug
7502
+ */
7503
+ Components.Schemas.ClassificationId[];
7504
+ }
7505
+ namespace Responses {
7506
+ export type $200 = Components.Schemas.TaxonomyBulkJobTriggerResponse;
7507
+ }
7508
+ }
7509
+ namespace BulkMoveClassifications {
7510
+ namespace Parameters {
7511
+ export type TargetTaxonomy = /**
7512
+ * URL-friendly name for taxonomy
7513
+ * example:
7514
+ * purpose
7515
+ */
7516
+ Components.Schemas.TaxonomySlug;
7517
+ }
7518
+ export interface QueryParameters {
7519
+ target_taxonomy?: Parameters.TargetTaxonomy;
7520
+ }
7521
+ export interface RequestBody {
7522
+ classification_ids?: /**
7523
+ * example:
7524
+ * taxonomy-slug:classification-slug
7525
+ */
7526
+ Components.Schemas.ClassificationId[];
7527
+ }
7528
+ namespace Responses {
7529
+ export type $200 = Components.Schemas.TaxonomyBulkJobTriggerResponse;
7530
+ }
7531
+ }
7476
7532
  namespace CreateActivity {
7477
7533
  namespace Parameters {
7478
7534
  export type Entities = Components.Schemas.EntityId /* uuid */[];
@@ -8128,6 +8184,17 @@ declare namespace Paths {
8128
8184
  Components.Schemas.EntityItem;
8129
8185
  }
8130
8186
  }
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
+ }
8131
8198
  namespace GetJsonSchema {
8132
8199
  namespace Parameters {
8133
8200
  export type Slug = /**
@@ -10545,6 +10612,46 @@ export interface OperationMethods {
10545
10612
  data?: any,
10546
10613
  config?: AxiosRequestConfig
10547
10614
  ): OperationResponse<Paths.DeleteTaxonomy.Responses.$204>
10615
+ /**
10616
+ * updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
10617
+ *
10618
+ * Update the classifications for a taxonomy
10619
+ */
10620
+ 'updateClassificationsForTaxonomy'(
10621
+ parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
10622
+ data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
10623
+ config?: AxiosRequestConfig
10624
+ ): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
10625
+ /**
10626
+ * getTaxonomyClassification - getTaxonomyClassification
10627
+ *
10628
+ * Get a classification for a taxonomy
10629
+ */
10630
+ 'getTaxonomyClassification'(
10631
+ parameters?: Parameters<Paths.GetTaxonomyClassification.PathParameters> | null,
10632
+ data?: any,
10633
+ config?: AxiosRequestConfig
10634
+ ): OperationResponse<Paths.GetTaxonomyClassification.Responses.$200>
10635
+ /**
10636
+ * updateTaxonomyClassification - updateTaxonomyClassification
10637
+ *
10638
+ * Update a classification for a taxonomy
10639
+ */
10640
+ 'updateTaxonomyClassification'(
10641
+ parameters?: Parameters<Paths.UpdateTaxonomyClassification.PathParameters> | null,
10642
+ data?: Paths.UpdateTaxonomyClassification.RequestBody,
10643
+ config?: AxiosRequestConfig
10644
+ ): OperationResponse<Paths.UpdateTaxonomyClassification.Responses.$200>
10645
+ /**
10646
+ * deleteTaxonomyClassification - deleteTaxonomyClassification
10647
+ *
10648
+ * Delete a classification for a taxonomy
10649
+ */
10650
+ 'deleteTaxonomyClassification'(
10651
+ parameters?: Parameters<Paths.DeleteTaxonomyClassification.PathParameters> | null,
10652
+ data?: any,
10653
+ config?: AxiosRequestConfig
10654
+ ): OperationResponse<Paths.DeleteTaxonomyClassification.Responses.$200>
10548
10655
  /**
10549
10656
  * taxonomyAutocomplete - taxonomyAutocomplete
10550
10657
  *
@@ -10565,16 +10672,6 @@ export interface OperationMethods {
10565
10672
  data?: Paths.TaxonomiesClassificationsSearch.RequestBody,
10566
10673
  config?: AxiosRequestConfig
10567
10674
  ): OperationResponse<Paths.TaxonomiesClassificationsSearch.Responses.$200>
10568
- /**
10569
- * updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
10570
- *
10571
- * Update the classifications for a taxonomy
10572
- */
10573
- 'updateClassificationsForTaxonomy'(
10574
- parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
10575
- data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
10576
- config?: AxiosRequestConfig
10577
- ): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
10578
10675
  /**
10579
10676
  * listTaxonomyClassificationsForSchema - listTaxonomyClassificationsForSchema
10580
10677
  *
@@ -10586,35 +10683,39 @@ export interface OperationMethods {
10586
10683
  config?: AxiosRequestConfig
10587
10684
  ): OperationResponse<Paths.ListTaxonomyClassificationsForSchema.Responses.$200>
10588
10685
  /**
10589
- * getTaxonomyClassification - getTaxonomyClassification
10686
+ * getJobs - getJobs
10590
10687
  *
10591
- * Get a classification for a taxonomy
10688
+ * Gets bulk jobs by job status
10592
10689
  */
10593
- 'getTaxonomyClassification'(
10594
- parameters?: Parameters<Paths.GetTaxonomyClassification.PathParameters> | null,
10690
+ 'getJobs'(
10691
+ parameters?: Parameters<Paths.GetJobs.QueryParameters> | null,
10595
10692
  data?: any,
10596
10693
  config?: AxiosRequestConfig
10597
- ): OperationResponse<Paths.GetTaxonomyClassification.Responses.$200>
10694
+ ): OperationResponse<Paths.GetJobs.Responses.$200>
10598
10695
  /**
10599
- * updateTaxonomyClassification - updateTaxonomyClassification
10696
+ * bulkMoveClassifications - bulkMoveClassifications
10697
+ *
10698
+ * Moves classifications from one taxonomy to another, through a bulk async operation which
10699
+ * also updates all references from the old classification to the new one under the target taxonomy.
10600
10700
  *
10601
- * Update a classification for a taxonomy
10602
10701
  */
10603
- 'updateTaxonomyClassification'(
10604
- parameters?: Parameters<Paths.UpdateTaxonomyClassification.PathParameters> | null,
10605
- data?: Paths.UpdateTaxonomyClassification.RequestBody,
10702
+ 'bulkMoveClassifications'(
10703
+ parameters?: Parameters<Paths.BulkMoveClassifications.QueryParameters> | null,
10704
+ data?: Paths.BulkMoveClassifications.RequestBody,
10606
10705
  config?: AxiosRequestConfig
10607
- ): OperationResponse<Paths.UpdateTaxonomyClassification.Responses.$200>
10706
+ ): OperationResponse<Paths.BulkMoveClassifications.Responses.$200>
10608
10707
  /**
10609
- * deleteTaxonomyClassification - deleteTaxonomyClassification
10708
+ * bulkDeleteClassifications - bulkDeleteClassifications
10709
+ *
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.
10610
10712
  *
10611
- * Delete a classification for a taxonomy
10612
10713
  */
10613
- 'deleteTaxonomyClassification'(
10614
- parameters?: Parameters<Paths.DeleteTaxonomyClassification.PathParameters> | null,
10615
- data?: any,
10714
+ 'bulkDeleteClassifications'(
10715
+ parameters?: Parameters<Paths.BulkDeleteClassifications.QueryParameters> | null,
10716
+ data?: Paths.BulkDeleteClassifications.RequestBody,
10616
10717
  config?: AxiosRequestConfig
10617
- ): OperationResponse<Paths.DeleteTaxonomyClassification.Responses.$200>
10718
+ ): OperationResponse<Paths.BulkDeleteClassifications.Responses.$200>
10618
10719
  /**
10619
10720
  * createSchemaAttribute - createSchemaAttribute
10620
10721
  *
@@ -11566,6 +11667,50 @@ export interface PathsDictionary {
11566
11667
  config?: AxiosRequestConfig
11567
11668
  ): OperationResponse<Paths.DeleteTaxonomy.Responses.$204>
11568
11669
  }
11670
+ ['/v1/entity/taxonomies/{taxonomySlug}/classifications']: {
11671
+ /**
11672
+ * updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
11673
+ *
11674
+ * Update the classifications for a taxonomy
11675
+ */
11676
+ 'post'(
11677
+ parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
11678
+ data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
11679
+ config?: AxiosRequestConfig
11680
+ ): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
11681
+ }
11682
+ ['/v2/entity/taxonomies/classifications/{classificationSlug}']: {
11683
+ /**
11684
+ * getTaxonomyClassification - getTaxonomyClassification
11685
+ *
11686
+ * Get a classification for a taxonomy
11687
+ */
11688
+ 'get'(
11689
+ parameters?: Parameters<Paths.GetTaxonomyClassification.PathParameters> | null,
11690
+ data?: any,
11691
+ config?: AxiosRequestConfig
11692
+ ): OperationResponse<Paths.GetTaxonomyClassification.Responses.$200>
11693
+ /**
11694
+ * updateTaxonomyClassification - updateTaxonomyClassification
11695
+ *
11696
+ * Update a classification for a taxonomy
11697
+ */
11698
+ 'put'(
11699
+ parameters?: Parameters<Paths.UpdateTaxonomyClassification.PathParameters> | null,
11700
+ data?: Paths.UpdateTaxonomyClassification.RequestBody,
11701
+ config?: AxiosRequestConfig
11702
+ ): OperationResponse<Paths.UpdateTaxonomyClassification.Responses.$200>
11703
+ /**
11704
+ * deleteTaxonomyClassification - deleteTaxonomyClassification
11705
+ *
11706
+ * Delete a classification for a taxonomy
11707
+ */
11708
+ 'delete'(
11709
+ parameters?: Parameters<Paths.DeleteTaxonomyClassification.PathParameters> | null,
11710
+ data?: any,
11711
+ config?: AxiosRequestConfig
11712
+ ): OperationResponse<Paths.DeleteTaxonomyClassification.Responses.$200>
11713
+ }
11569
11714
  ['/v1/entity/taxonomies/{taxonomySlug}:autocomplete']: {
11570
11715
  /**
11571
11716
  * taxonomyAutocomplete - taxonomyAutocomplete
@@ -11590,18 +11735,6 @@ export interface PathsDictionary {
11590
11735
  config?: AxiosRequestConfig
11591
11736
  ): OperationResponse<Paths.TaxonomiesClassificationsSearch.Responses.$200>
11592
11737
  }
11593
- ['/v1/entity/taxonomies/{taxonomySlug}/classifications']: {
11594
- /**
11595
- * updateClassificationsForTaxonomy - updateClassificationsForTaxonomy
11596
- *
11597
- * Update the classifications for a taxonomy
11598
- */
11599
- 'post'(
11600
- parameters?: Parameters<Paths.UpdateClassificationsForTaxonomy.PathParameters> | null,
11601
- data?: Paths.UpdateClassificationsForTaxonomy.RequestBody,
11602
- config?: AxiosRequestConfig
11603
- ): OperationResponse<Paths.UpdateClassificationsForTaxonomy.Responses.$200>
11604
- }
11605
11738
  ['/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}']: {
11606
11739
  /**
11607
11740
  * listTaxonomyClassificationsForSchema - listTaxonomyClassificationsForSchema
@@ -11614,37 +11747,45 @@ export interface PathsDictionary {
11614
11747
  config?: AxiosRequestConfig
11615
11748
  ): OperationResponse<Paths.ListTaxonomyClassificationsForSchema.Responses.$200>
11616
11749
  }
11617
- ['/v2/entity/taxonomies/classifications/{classificationSlug}']: {
11750
+ ['/v1/entity/taxonomies/jobs']: {
11618
11751
  /**
11619
- * getTaxonomyClassification - getTaxonomyClassification
11752
+ * getJobs - getJobs
11620
11753
  *
11621
- * Get a classification for a taxonomy
11754
+ * Gets bulk jobs by job status
11622
11755
  */
11623
11756
  'get'(
11624
- parameters?: Parameters<Paths.GetTaxonomyClassification.PathParameters> | null,
11757
+ parameters?: Parameters<Paths.GetJobs.QueryParameters> | null,
11625
11758
  data?: any,
11626
11759
  config?: AxiosRequestConfig
11627
- ): OperationResponse<Paths.GetTaxonomyClassification.Responses.$200>
11760
+ ): OperationResponse<Paths.GetJobs.Responses.$200>
11761
+ }
11762
+ ['/v1/entity/taxonomies/classifications:move']: {
11628
11763
  /**
11629
- * updateTaxonomyClassification - updateTaxonomyClassification
11764
+ * bulkMoveClassifications - bulkMoveClassifications
11765
+ *
11766
+ * Moves classifications from one taxonomy to another, through a bulk async operation which
11767
+ * also updates all references from the old classification to the new one under the target taxonomy.
11630
11768
  *
11631
- * Update a classification for a taxonomy
11632
11769
  */
11633
- 'put'(
11634
- parameters?: Parameters<Paths.UpdateTaxonomyClassification.PathParameters> | null,
11635
- data?: Paths.UpdateTaxonomyClassification.RequestBody,
11770
+ 'post'(
11771
+ parameters?: Parameters<Paths.BulkMoveClassifications.QueryParameters> | null,
11772
+ data?: Paths.BulkMoveClassifications.RequestBody,
11636
11773
  config?: AxiosRequestConfig
11637
- ): OperationResponse<Paths.UpdateTaxonomyClassification.Responses.$200>
11774
+ ): OperationResponse<Paths.BulkMoveClassifications.Responses.$200>
11775
+ }
11776
+ ['/v1/entity/taxonomies/classifications:delete']: {
11638
11777
  /**
11639
- * deleteTaxonomyClassification - deleteTaxonomyClassification
11778
+ * bulkDeleteClassifications - bulkDeleteClassifications
11779
+ *
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.
11640
11782
  *
11641
- * Delete a classification for a taxonomy
11642
11783
  */
11643
- 'delete'(
11644
- parameters?: Parameters<Paths.DeleteTaxonomyClassification.PathParameters> | null,
11645
- data?: any,
11784
+ 'post'(
11785
+ parameters?: Parameters<Paths.BulkDeleteClassifications.QueryParameters> | null,
11786
+ data?: Paths.BulkDeleteClassifications.RequestBody,
11646
11787
  config?: AxiosRequestConfig
11647
- ): OperationResponse<Paths.DeleteTaxonomyClassification.Responses.$200>
11788
+ ): OperationResponse<Paths.BulkDeleteClassifications.Responses.$200>
11648
11789
  }
11649
11790
  ['/v1/entity/schemas/attributes']: {
11650
11791
  /**
@@ -11928,6 +12069,10 @@ export type SummaryAttribute = Components.Schemas.SummaryAttribute;
11928
12069
  export type SummaryField = Components.Schemas.SummaryField;
11929
12070
  export type TagsAttribute = Components.Schemas.TagsAttribute;
11930
12071
  export type Taxonomy = Components.Schemas.Taxonomy;
12072
+ export type TaxonomyBulkJob = Components.Schemas.TaxonomyBulkJob;
12073
+ export type TaxonomyBulkJobStatus = Components.Schemas.TaxonomyBulkJobStatus;
12074
+ export type TaxonomyBulkJobTriggerResponse = Components.Schemas.TaxonomyBulkJobTriggerResponse;
12075
+ export type TaxonomyBulkJobType = Components.Schemas.TaxonomyBulkJobType;
11931
12076
  export type TaxonomyClassification = Components.Schemas.TaxonomyClassification;
11932
12077
  export type TaxonomyLocationId = Components.Schemas.TaxonomyLocationId;
11933
12078
  export type TaxonomySlug = Components.Schemas.TaxonomySlug;
package/dist/openapi.json CHANGED
@@ -23,8 +23,8 @@
23
23
  "description": "Entity Events"
24
24
  },
25
25
  {
26
- "name": "Export",
27
- "description": "Export and Import entities via files"
26
+ "name": "Import-Export",
27
+ "description": "Import and Export entities via portable files (CSV)"
28
28
  },
29
29
  {
30
30
  "name": "Saved Views",
@@ -2139,7 +2139,7 @@
2139
2139
  "summary": "exportEntities",
2140
2140
  "description": "Export entity data in a CSV-format. The export will export data as close as possible to what is visible on Entity UI tables.\nThe values exported as in some cases, transformed to human-readable values.\n\nTo force the export of raw values, use the `#` prefix in front of your field name when specifying the field on the `fields` param.\n",
2141
2141
  "tags": [
2142
- "Export"
2142
+ "Import-Export"
2143
2143
  ],
2144
2144
  "parameters": [
2145
2145
  {
@@ -2189,7 +2189,7 @@
2189
2189
  "summary": "Import Entities",
2190
2190
  "description": "This endpoint enables the import of entities into the platform.\nThe entities should be provided in a CSV format inside an S3 bucket.\nThis API will return the `job_id`` which can be used to fetch the status of the import process.\n",
2191
2191
  "tags": [
2192
- "Entity Import"
2192
+ "Import-Export"
2193
2193
  ],
2194
2194
  "parameters": [
2195
2195
  {
@@ -2590,6 +2590,154 @@
2590
2590
  }
2591
2591
  }
2592
2592
  },
2593
+ "/v1/entity/taxonomies/{taxonomySlug}/classifications": {
2594
+ "post": {
2595
+ "operationId": "updateClassificationsForTaxonomy",
2596
+ "summary": "updateClassificationsForTaxonomy",
2597
+ "description": "Update the classifications for a taxonomy",
2598
+ "tags": [
2599
+ "Taxonomy"
2600
+ ],
2601
+ "parameters": [
2602
+ {
2603
+ "$ref": "#/components/parameters/TaxonomySlugPathParam"
2604
+ }
2605
+ ],
2606
+ "requestBody": {
2607
+ "content": {
2608
+ "application/json": {
2609
+ "schema": {
2610
+ "$ref": "#/components/schemas/ClassificationsUpdate"
2611
+ }
2612
+ }
2613
+ }
2614
+ },
2615
+ "responses": {
2616
+ "200": {
2617
+ "description": "Taxonomies classifications",
2618
+ "content": {
2619
+ "application/json": {
2620
+ "schema": {
2621
+ "type": "object",
2622
+ "properties": {
2623
+ "created": {
2624
+ "type": "array",
2625
+ "items": {
2626
+ "$ref": "#/components/schemas/TaxonomyClassification"
2627
+ }
2628
+ },
2629
+ "updated": {
2630
+ "type": "array",
2631
+ "items": {
2632
+ "$ref": "#/components/schemas/TaxonomyClassification"
2633
+ }
2634
+ },
2635
+ "deleted": {
2636
+ "type": "object",
2637
+ "items": {
2638
+ "$ref": "#/components/schemas/ClassificationId"
2639
+ }
2640
+ }
2641
+ }
2642
+ }
2643
+ }
2644
+ }
2645
+ }
2646
+ }
2647
+ }
2648
+ },
2649
+ "/v2/entity/taxonomies/classifications/{classificationSlug}": {
2650
+ "get": {
2651
+ "operationId": "getTaxonomyClassification",
2652
+ "summary": "getTaxonomyClassification",
2653
+ "description": "Get a classification for a taxonomy",
2654
+ "tags": [
2655
+ "Taxonomy"
2656
+ ],
2657
+ "parameters": [
2658
+ {
2659
+ "$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
2660
+ }
2661
+ ],
2662
+ "responses": {
2663
+ "200": {
2664
+ "description": "Taxonomy classification",
2665
+ "content": {
2666
+ "application/json": {
2667
+ "schema": {
2668
+ "$ref": "#/components/schemas/TaxonomyClassification"
2669
+ }
2670
+ }
2671
+ }
2672
+ },
2673
+ "404": {
2674
+ "description": "Taxonomy classification not found"
2675
+ }
2676
+ }
2677
+ },
2678
+ "put": {
2679
+ "operationId": "updateTaxonomyClassification",
2680
+ "summary": "updateTaxonomyClassification",
2681
+ "description": "Update a classification for a taxonomy",
2682
+ "tags": [
2683
+ "Taxonomy"
2684
+ ],
2685
+ "parameters": [
2686
+ {
2687
+ "$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
2688
+ }
2689
+ ],
2690
+ "requestBody": {
2691
+ "content": {
2692
+ "application/json": {
2693
+ "schema": {
2694
+ "$ref": "#/components/schemas/TaxonomyClassification"
2695
+ }
2696
+ }
2697
+ }
2698
+ },
2699
+ "responses": {
2700
+ "200": {
2701
+ "description": "Taxonomy classification updated",
2702
+ "content": {
2703
+ "application/json": {
2704
+ "schema": {
2705
+ "$ref": "#/components/schemas/TaxonomyClassification"
2706
+ }
2707
+ }
2708
+ }
2709
+ },
2710
+ "404": {
2711
+ "description": "Taxonomy classification not found"
2712
+ }
2713
+ }
2714
+ },
2715
+ "delete": {
2716
+ "operationId": "deleteTaxonomyClassification",
2717
+ "summary": "deleteTaxonomyClassification",
2718
+ "description": "Delete a classification for a taxonomy",
2719
+ "tags": [
2720
+ "Taxonomy"
2721
+ ],
2722
+ "parameters": [
2723
+ {
2724
+ "$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
2725
+ }
2726
+ ],
2727
+ "responses": {
2728
+ "200": {
2729
+ "description": "Taxonomy classification deleted",
2730
+ "content": {
2731
+ "application/json": {
2732
+ "schema": {
2733
+ "$ref": "#/components/schemas/TaxonomyClassification"
2734
+ }
2735
+ }
2736
+ }
2737
+ }
2738
+ }
2739
+ }
2740
+ },
2593
2741
  "/v1/entity/taxonomies/{taxonomySlug}:autocomplete": {
2594
2742
  "get": {
2595
2743
  "operationId": "taxonomyAutocomplete",
@@ -2661,6 +2809,15 @@
2661
2809
  "type": "string",
2662
2810
  "example": "sales"
2663
2811
  }
2812
+ },
2813
+ {
2814
+ "in": "query",
2815
+ "name": "archived",
2816
+ "description": "Filter by archived status",
2817
+ "schema": {
2818
+ "type": "boolean",
2819
+ "example": false
2820
+ }
2664
2821
  }
2665
2822
  ],
2666
2823
  "requestBody": {
@@ -2702,62 +2859,6 @@
2702
2859
  }
2703
2860
  }
2704
2861
  },
2705
- "/v1/entity/taxonomies/{taxonomySlug}/classifications": {
2706
- "post": {
2707
- "operationId": "updateClassificationsForTaxonomy",
2708
- "summary": "updateClassificationsForTaxonomy",
2709
- "description": "Update the classifications for a taxonomy",
2710
- "tags": [
2711
- "Taxonomy"
2712
- ],
2713
- "parameters": [
2714
- {
2715
- "$ref": "#/components/parameters/TaxonomySlugPathParam"
2716
- }
2717
- ],
2718
- "requestBody": {
2719
- "content": {
2720
- "application/json": {
2721
- "schema": {
2722
- "$ref": "#/components/schemas/ClassificationsUpdate"
2723
- }
2724
- }
2725
- }
2726
- },
2727
- "responses": {
2728
- "200": {
2729
- "description": "Taxonomies classifications",
2730
- "content": {
2731
- "application/json": {
2732
- "schema": {
2733
- "type": "object",
2734
- "properties": {
2735
- "created": {
2736
- "type": "array",
2737
- "items": {
2738
- "$ref": "#/components/schemas/TaxonomyClassification"
2739
- }
2740
- },
2741
- "updated": {
2742
- "type": "array",
2743
- "items": {
2744
- "$ref": "#/components/schemas/TaxonomyClassification"
2745
- }
2746
- },
2747
- "deleted": {
2748
- "type": "object",
2749
- "items": {
2750
- "$ref": "#/components/schemas/ClassificationId"
2751
- }
2752
- }
2753
- }
2754
- }
2755
- }
2756
- }
2757
- }
2758
- }
2759
- }
2760
- },
2761
2862
  "/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}": {
2762
2863
  "get": {
2763
2864
  "operationId": "listTaxonomyClassificationsForSchema",
@@ -2810,91 +2911,175 @@
2810
2911
  }
2811
2912
  }
2812
2913
  },
2813
- "/v2/entity/taxonomies/classifications/{classificationSlug}": {
2914
+ "/v1/entity/taxonomies/bulk-jobs": {
2814
2915
  "get": {
2815
- "operationId": "getTaxonomyClassification",
2816
- "summary": "getTaxonomyClassification",
2817
- "description": "Get a classification for a taxonomy",
2916
+ "operationId": "getTaxonomyBulkActionJobs",
2917
+ "summary": "getTaxonomyBulkActionJobs",
2918
+ "description": "Gets bulk actions jobs by job status:\n- <undefined> = all active jobs\n- PENDING = all active jobs\n- FAILED = all failed jobs\n- COMPLETED = all completed jobs\n",
2818
2919
  "tags": [
2819
2920
  "Taxonomy"
2820
2921
  ],
2821
2922
  "parameters": [
2822
2923
  {
2823
- "$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
2924
+ "in": "query",
2925
+ "name": "status",
2926
+ "schema": {
2927
+ "$ref": "#/components/schemas/TaxonomyBulkJobStatus"
2928
+ }
2824
2929
  }
2825
2930
  ],
2826
2931
  "responses": {
2827
2932
  "200": {
2828
- "description": "Taxonomy classification",
2933
+ "description": "Returns the jobs matching the given query or the active jobs if no status is provided",
2829
2934
  "content": {
2830
2935
  "application/json": {
2831
2936
  "schema": {
2832
- "$ref": "#/components/schemas/TaxonomyClassification"
2937
+ "type": "array",
2938
+ "items": {
2939
+ "$ref": "#/components/schemas/TaxonomyBulkJob"
2940
+ }
2833
2941
  }
2834
2942
  }
2835
2943
  }
2836
- },
2837
- "404": {
2838
- "description": "Taxonomy classification not found"
2839
2944
  }
2840
2945
  }
2841
- },
2842
- "put": {
2843
- "operationId": "updateTaxonomyClassification",
2844
- "summary": "updateTaxonomyClassification",
2845
- "description": "Update a classification for a taxonomy",
2946
+ }
2947
+ },
2948
+ "/v1/entity/taxonomies/bulk-jobs/{job_id}": {
2949
+ "get": {
2950
+ "operationId": "getTaxonomyBulkActionJobById",
2951
+ "summary": "getTaxonomyBulkActionJobById",
2952
+ "description": "Gets a bulk action job by job id",
2846
2953
  "tags": [
2847
2954
  "Taxonomy"
2848
2955
  ],
2849
2956
  "parameters": [
2850
2957
  {
2851
- "$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
2958
+ "in": "path",
2959
+ "name": "job_id",
2960
+ "schema": {
2961
+ "type": "string"
2962
+ }
2852
2963
  }
2853
2964
  ],
2965
+ "responses": {
2966
+ "200": {
2967
+ "description": "Returns the job matching the given job id",
2968
+ "content": {
2969
+ "application/json": {
2970
+ "schema": {
2971
+ "type": "array",
2972
+ "items": {
2973
+ "$ref": "#/components/schemas/TaxonomyBulkJob"
2974
+ }
2975
+ }
2976
+ }
2977
+ }
2978
+ }
2979
+ }
2980
+ }
2981
+ },
2982
+ "/v1/entity/taxonomies/classifications:move": {
2983
+ "post": {
2984
+ "operationId": "bulkMoveClassifications",
2985
+ "summary": "bulkMoveClassifications",
2986
+ "description": "Moves classifications from one taxonomy to another, through a bulk async operation which\nalso updates all references from the old classification to the new one under the target taxonomy.\n",
2987
+ "tags": [
2988
+ "Taxonomy"
2989
+ ],
2854
2990
  "requestBody": {
2855
2991
  "content": {
2856
2992
  "application/json": {
2857
2993
  "schema": {
2858
- "$ref": "#/components/schemas/TaxonomyClassification"
2994
+ "type": "object",
2995
+ "properties": {
2996
+ "job_id": {
2997
+ "description": "Job ID for tracking the status of a bulk operation request",
2998
+ "type": "string"
2999
+ },
3000
+ "target_taxonomy": {
3001
+ "description": "The target taxonomy to which the classifications will be moved",
3002
+ "$ref": "#/components/schemas/TaxonomySlug"
3003
+ },
3004
+ "classification_ids": {
3005
+ "type": "array",
3006
+ "items": {
3007
+ "$ref": "#/components/schemas/ClassificationId"
3008
+ }
3009
+ }
3010
+ }
3011
+ },
3012
+ "example": {
3013
+ "classification_ids": [
3014
+ "taxonomy-slug:classification-slug"
3015
+ ]
2859
3016
  }
2860
3017
  }
2861
3018
  }
2862
3019
  },
2863
3020
  "responses": {
2864
3021
  "200": {
2865
- "description": "Taxonomy classification updated",
3022
+ "description": "Returns the job id for the async job and current status",
2866
3023
  "content": {
2867
3024
  "application/json": {
2868
3025
  "schema": {
2869
- "$ref": "#/components/schemas/TaxonomyClassification"
3026
+ "$ref": "#/components/schemas/TaxonomyBulkJobTriggerResponse"
3027
+ },
3028
+ "example": {
3029
+ "job_id": "123",
3030
+ "status": "PENDING"
2870
3031
  }
2871
3032
  }
2872
3033
  }
2873
- },
2874
- "404": {
2875
- "description": "Taxonomy classification not found"
2876
3034
  }
2877
3035
  }
2878
- },
2879
- "delete": {
2880
- "operationId": "deleteTaxonomyClassification",
2881
- "summary": "deleteTaxonomyClassification",
2882
- "description": "Delete a classification for a taxonomy",
3036
+ }
3037
+ },
3038
+ "/v1/entity/taxonomies/classifications:delete": {
3039
+ "post": {
3040
+ "operationId": "bulkDeleteClassifications",
3041
+ "summary": "bulkDeleteClassifications",
3042
+ "description": "Permanently deletes taxonomy classifications. The classifications are deleted through a bulk \nasync operation which also deletes all references of the deleted classifications from the entities \nreferencing them.\n",
2883
3043
  "tags": [
2884
3044
  "Taxonomy"
2885
3045
  ],
2886
- "parameters": [
2887
- {
2888
- "$ref": "#/components/parameters/TaxonomyClassificationSlugPathParam"
3046
+ "requestBody": {
3047
+ "content": {
3048
+ "application/json": {
3049
+ "schema": {
3050
+ "type": "object",
3051
+ "properties": {
3052
+ "job_id": {
3053
+ "description": "Job ID for tracking the status of a bulk operation request",
3054
+ "type": "string"
3055
+ },
3056
+ "classification_ids": {
3057
+ "type": "array",
3058
+ "items": {
3059
+ "$ref": "#/components/schemas/ClassificationId"
3060
+ }
3061
+ }
3062
+ }
3063
+ },
3064
+ "example": {
3065
+ "classification_ids": [
3066
+ "taxonomy-slug:classification-slug"
3067
+ ]
3068
+ }
3069
+ }
2889
3070
  }
2890
- ],
3071
+ },
2891
3072
  "responses": {
2892
3073
  "200": {
2893
- "description": "Taxonomy classification deleted",
3074
+ "description": "Returns the job id for the async job and current status",
2894
3075
  "content": {
2895
3076
  "application/json": {
2896
3077
  "schema": {
2897
- "$ref": "#/components/schemas/TaxonomyClassification"
3078
+ "$ref": "#/components/schemas/TaxonomyBulkJobTriggerResponse"
3079
+ },
3080
+ "example": {
3081
+ "job_id": "123",
3082
+ "status": "PENDING"
2898
3083
  }
2899
3084
  }
2900
3085
  }
@@ -3546,6 +3731,19 @@
3546
3731
  "format": "uri",
3547
3732
  "example": "https://docs.epilot.io/docs/pricing/entities"
3548
3733
  },
3734
+ "category": {
3735
+ "type": "string",
3736
+ "example": "customer_relations",
3737
+ "enum": [
3738
+ "customer_relations",
3739
+ "sales",
3740
+ "product_hub",
3741
+ "contracts",
3742
+ "journeys",
3743
+ "messaging",
3744
+ "system"
3745
+ ]
3746
+ },
3549
3747
  "published": {
3550
3748
  "type": "boolean",
3551
3749
  "example": false
@@ -4288,6 +4486,9 @@
4288
4486
  },
4289
4487
  "multiline": {
4290
4488
  "type": "boolean"
4489
+ },
4490
+ "rich_text": {
4491
+ "type": "boolean"
4291
4492
  }
4292
4493
  }
4293
4494
  }
@@ -7139,6 +7340,11 @@
7139
7340
  "$ref": "#/components/schemas/ClassificationId"
7140
7341
  }
7141
7342
  },
7343
+ "color": {
7344
+ "type": "string",
7345
+ "description": "Color of the classification",
7346
+ "example": "#FF5733"
7347
+ },
7142
7348
  "created_at": {
7143
7349
  "type": "string",
7144
7350
  "format": "date-time"
@@ -7147,6 +7353,11 @@
7147
7353
  "type": "string",
7148
7354
  "format": "date-time"
7149
7355
  },
7356
+ "archived": {
7357
+ "type": "boolean",
7358
+ "description": "Archived classification are not visible in the UI",
7359
+ "default": false
7360
+ },
7150
7361
  "_manifest": {
7151
7362
  "type": "array",
7152
7363
  "description": "Manifest ID used to create/update the taxonomy classification",
@@ -7207,6 +7418,118 @@
7207
7418
  }
7208
7419
  }
7209
7420
  },
7421
+ "TaxonomyBulkJobTriggerResponse": {
7422
+ "type": "object",
7423
+ "properties": {
7424
+ "job_id": {
7425
+ "type": "string",
7426
+ "format": "uuid"
7427
+ },
7428
+ "status": {
7429
+ "$ref": "#/components/schemas/TaxonomyBulkJobStatus"
7430
+ }
7431
+ }
7432
+ },
7433
+ "TaxonomyBulkJobStatus": {
7434
+ "type": "string",
7435
+ "description": "The status of the bulk job",
7436
+ "enum": [
7437
+ "PENDING",
7438
+ "FAILED",
7439
+ "COMPLETED",
7440
+ "CANCELLED"
7441
+ ]
7442
+ },
7443
+ "TaxonomyBulkJobActionType": {
7444
+ "type": "string",
7445
+ "enum": [
7446
+ "MOVE_CLASSIFICATIONS",
7447
+ "DELETE_CLASSIFICATIONS"
7448
+ ]
7449
+ },
7450
+ "TaxonomyBulkJob": {
7451
+ "type": "object",
7452
+ "properties": {
7453
+ "job_id": {
7454
+ "type": "string",
7455
+ "format": "uuid"
7456
+ },
7457
+ "job_status": {
7458
+ "$ref": "#/components/schemas/TaxonomyBulkJobStatus"
7459
+ },
7460
+ "action_type": {
7461
+ "$ref": "#/components/schemas/TaxonomyBulkJobActionType"
7462
+ },
7463
+ "request": {
7464
+ "type": "object",
7465
+ "properties": {
7466
+ "target_taxonomy": {
7467
+ "$ref": "#/components/schemas/TaxonomySlug"
7468
+ },
7469
+ "classification_ids": {
7470
+ "type": "array",
7471
+ "items": {
7472
+ "$ref": "#/components/schemas/ClassificationId"
7473
+ }
7474
+ }
7475
+ }
7476
+ },
7477
+ "output": {
7478
+ "type": "object",
7479
+ "properties": {
7480
+ "target_entities": {
7481
+ "type": "array",
7482
+ "items": {
7483
+ "$ref": "#/components/schemas/EntityId"
7484
+ }
7485
+ },
7486
+ "affected_entities": {
7487
+ "type": "array",
7488
+ "items": {
7489
+ "$ref": "#/components/schemas/EntityId"
7490
+ }
7491
+ },
7492
+ "failures_count": {
7493
+ "type": "number"
7494
+ },
7495
+ "failed_entities": {
7496
+ "type": "array",
7497
+ "items": {
7498
+ "$ref": "#/components/schemas/EntityId"
7499
+ }
7500
+ }
7501
+ }
7502
+ },
7503
+ "created_by": {
7504
+ "type": "string"
7505
+ },
7506
+ "created_at": {
7507
+ "type": "string",
7508
+ "format": "date-time"
7509
+ },
7510
+ "updated_at": {
7511
+ "type": "string",
7512
+ "format": "date-time"
7513
+ },
7514
+ "org": {
7515
+ "type": "string"
7516
+ },
7517
+ "progress": {
7518
+ "description": "Progress of the job on a scale of 0 to 1",
7519
+ "type": "number"
7520
+ }
7521
+ },
7522
+ "example": {
7523
+ "job_id": "123e4567-e89b-12d3-a456-426614174000",
7524
+ "status": "PENDING",
7525
+ "action_type": "MOVE_LABELS",
7526
+ "created_by": 10598,
7527
+ "created_at": "2024-01-01T00:00:00.000Z",
7528
+ "updated_at": "2024-01-01T00:00:00.000Z",
7529
+ "org": 66,
7530
+ "progress": 0.5
7531
+ }
7532
+ },
7210
7533
  "ESClusterAssignment": {
7211
7534
  "type": "object",
7212
7535
  "properties": {
@@ -8116,6 +8439,9 @@
8116
8439
  }
8117
8440
  },
8118
8441
  "servers": [
8442
+ {
8443
+ "url": "https://entity.sls.epilot.io"
8444
+ },
8119
8445
  {
8120
8446
  "url": "https://entity.sls.epilot.io"
8121
8447
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/entity-client",
3
- "version": "4.32.0",
3
+ "version": "4.33.2",
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 https://docs.api.epilot.io/entity.yaml",
27
+ "openapi": "node ../../scripts/update-openapi.js ./src/openapi.yml",
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",