@epilot/entity-client 4.33.0 → 4.33.3
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/definition.js +1 -1
- package/dist/openapi-runtime.json +18 -19
- package/dist/openapi.d.ts +198 -47
- package/dist/openapi.json +158 -32
- 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}/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"}],"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/jobs":{"get":{"operationId":"getJobs","parameters":[{"in":"query","name":"status"}],"responses":{}}},"/v1/entity/taxonomies/classifications:move":{"post":{"operationId":"bulkMoveClassifications","parameters":[{"in":"query","name":"target_taxonomy"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/classifications:delete":{"post":{"operationId":"bulkDeleteClassifications","parameters":[{"in":"query","name":"permanent"}],"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})})();
|
|
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})})();
|
|
@@ -996,6 +996,10 @@
|
|
|
996
996
|
{
|
|
997
997
|
"in": "query",
|
|
998
998
|
"name": "query"
|
|
999
|
+
},
|
|
1000
|
+
{
|
|
1001
|
+
"in": "query",
|
|
1002
|
+
"name": "archived"
|
|
999
1003
|
}
|
|
1000
1004
|
],
|
|
1001
1005
|
"requestBody": {
|
|
@@ -1028,9 +1032,9 @@
|
|
|
1028
1032
|
"responses": {}
|
|
1029
1033
|
}
|
|
1030
1034
|
},
|
|
1031
|
-
"/v1/entity/taxonomies/jobs": {
|
|
1035
|
+
"/v1/entity/taxonomies/bulk-jobs": {
|
|
1032
1036
|
"get": {
|
|
1033
|
-
"operationId": "
|
|
1037
|
+
"operationId": "getTaxonomyBulkActionJobs",
|
|
1034
1038
|
"parameters": [
|
|
1035
1039
|
{
|
|
1036
1040
|
"in": "query",
|
|
@@ -1040,15 +1044,21 @@
|
|
|
1040
1044
|
"responses": {}
|
|
1041
1045
|
}
|
|
1042
1046
|
},
|
|
1043
|
-
"/v1/entity/taxonomies/
|
|
1044
|
-
"
|
|
1045
|
-
"operationId": "
|
|
1047
|
+
"/v1/entity/taxonomies/bulk-jobs/{job_id}": {
|
|
1048
|
+
"get": {
|
|
1049
|
+
"operationId": "getTaxonomyBulkActionJobById",
|
|
1046
1050
|
"parameters": [
|
|
1047
1051
|
{
|
|
1048
|
-
"in": "
|
|
1049
|
-
"name": "
|
|
1052
|
+
"in": "path",
|
|
1053
|
+
"name": "job_id"
|
|
1050
1054
|
}
|
|
1051
1055
|
],
|
|
1056
|
+
"responses": {}
|
|
1057
|
+
}
|
|
1058
|
+
},
|
|
1059
|
+
"/v1/entity/taxonomies/classifications:move": {
|
|
1060
|
+
"post": {
|
|
1061
|
+
"operationId": "bulkMoveClassifications",
|
|
1052
1062
|
"requestBody": {
|
|
1053
1063
|
"content": {
|
|
1054
1064
|
"application/json": {}
|
|
@@ -1060,12 +1070,6 @@
|
|
|
1060
1070
|
"/v1/entity/taxonomies/classifications:delete": {
|
|
1061
1071
|
"post": {
|
|
1062
1072
|
"operationId": "bulkDeleteClassifications",
|
|
1063
|
-
"parameters": [
|
|
1064
|
-
{
|
|
1065
|
-
"in": "query",
|
|
1066
|
-
"name": "permanent"
|
|
1067
|
-
}
|
|
1068
|
-
],
|
|
1069
1073
|
"requestBody": {
|
|
1070
1074
|
"content": {
|
|
1071
1075
|
"application/json": {}
|
|
@@ -1386,10 +1390,5 @@
|
|
|
1386
1390
|
"in": "query"
|
|
1387
1391
|
}
|
|
1388
1392
|
}
|
|
1389
|
-
}
|
|
1390
|
-
"servers": [
|
|
1391
|
-
{
|
|
1392
|
-
"url": "https://entity.sls.epilot.io"
|
|
1393
|
-
}
|
|
1394
|
-
]
|
|
1393
|
+
}
|
|
1395
1394
|
}
|
package/dist/openapi.d.ts
CHANGED
|
@@ -2488,6 +2488,11 @@ declare namespace Components {
|
|
|
2488
2488
|
* https://docs.epilot.io/docs/pricing/entities
|
|
2489
2489
|
*/
|
|
2490
2490
|
docs_url?: string; // uri
|
|
2491
|
+
/**
|
|
2492
|
+
* example:
|
|
2493
|
+
* customer_relations
|
|
2494
|
+
*/
|
|
2495
|
+
category?: "customer_relations" | "sales" | "product_hub" | "contracts" | "journeys" | "messaging" | "system";
|
|
2491
2496
|
/**
|
|
2492
2497
|
* example:
|
|
2493
2498
|
* false
|
|
@@ -2857,6 +2862,11 @@ declare namespace Components {
|
|
|
2857
2862
|
* https://docs.epilot.io/docs/pricing/entities
|
|
2858
2863
|
*/
|
|
2859
2864
|
docs_url?: string; // uri
|
|
2865
|
+
/**
|
|
2866
|
+
* example:
|
|
2867
|
+
* customer_relations
|
|
2868
|
+
*/
|
|
2869
|
+
category?: "customer_relations" | "sales" | "product_hub" | "contracts" | "journeys" | "messaging" | "system";
|
|
2860
2870
|
/**
|
|
2861
2871
|
* example:
|
|
2862
2872
|
* false
|
|
@@ -5480,8 +5490,18 @@ declare namespace Components {
|
|
|
5480
5490
|
* taxonomy-slug:classification-slug
|
|
5481
5491
|
*/
|
|
5482
5492
|
ClassificationId[];
|
|
5493
|
+
/**
|
|
5494
|
+
* Color of the classification
|
|
5495
|
+
* example:
|
|
5496
|
+
* #FF5733
|
|
5497
|
+
*/
|
|
5498
|
+
color?: string;
|
|
5483
5499
|
created_at?: string; // date-time
|
|
5484
5500
|
updated_at?: string; // date-time
|
|
5501
|
+
/**
|
|
5502
|
+
* Archived classification are not visible in the UI
|
|
5503
|
+
*/
|
|
5504
|
+
archived?: boolean;
|
|
5485
5505
|
type?: "purpose";
|
|
5486
5506
|
}
|
|
5487
5507
|
/**
|
|
@@ -7065,20 +7085,60 @@ declare namespace Components {
|
|
|
7065
7085
|
*/
|
|
7066
7086
|
enabled_locations?: TaxonomyLocationId[];
|
|
7067
7087
|
}
|
|
7088
|
+
/**
|
|
7089
|
+
* example:
|
|
7090
|
+
* {
|
|
7091
|
+
* "job_id": "123e4567-e89b-12d3-a456-426614174000",
|
|
7092
|
+
* "status": "PENDING",
|
|
7093
|
+
* "action_type": "MOVE_LABELS",
|
|
7094
|
+
* "created_by": 10598,
|
|
7095
|
+
* "created_at": "2024-01-01T00:00:00.000Z",
|
|
7096
|
+
* "updated_at": "2024-01-01T00:00:00.000Z",
|
|
7097
|
+
* "org": 66,
|
|
7098
|
+
* "progress": 0.5
|
|
7099
|
+
* }
|
|
7100
|
+
*/
|
|
7068
7101
|
export interface TaxonomyBulkJob {
|
|
7069
7102
|
job_id?: string; // uuid
|
|
7070
|
-
|
|
7071
|
-
|
|
7103
|
+
job_status?: /* The status of the bulk job */ TaxonomyBulkJobStatus;
|
|
7104
|
+
action_type?: TaxonomyBulkJobActionType;
|
|
7105
|
+
request?: {
|
|
7106
|
+
target_taxonomy?: /**
|
|
7107
|
+
* URL-friendly name for taxonomy
|
|
7108
|
+
* example:
|
|
7109
|
+
* purpose
|
|
7110
|
+
*/
|
|
7111
|
+
TaxonomySlug;
|
|
7112
|
+
classification_ids?: /**
|
|
7113
|
+
* example:
|
|
7114
|
+
* taxonomy-slug:classification-slug
|
|
7115
|
+
*/
|
|
7116
|
+
ClassificationId[];
|
|
7117
|
+
};
|
|
7118
|
+
output?: {
|
|
7119
|
+
target_entities?: EntityId /* uuid */[];
|
|
7120
|
+
affected_entities?: EntityId /* uuid */[];
|
|
7121
|
+
failures_count?: number;
|
|
7122
|
+
failed_entities?: EntityId /* uuid */[];
|
|
7123
|
+
};
|
|
7124
|
+
created_by?: string;
|
|
7125
|
+
created_at?: string; // date-time
|
|
7126
|
+
updated_at?: string; // date-time
|
|
7127
|
+
org?: string;
|
|
7128
|
+
/**
|
|
7129
|
+
* Progress of the job on a scale of 0 to 1
|
|
7130
|
+
*/
|
|
7131
|
+
progress?: number;
|
|
7072
7132
|
}
|
|
7133
|
+
export type TaxonomyBulkJobActionType = "MOVE_CLASSIFICATIONS" | "DELETE_CLASSIFICATIONS";
|
|
7073
7134
|
/**
|
|
7074
7135
|
* The status of the bulk job
|
|
7075
7136
|
*/
|
|
7076
|
-
export type TaxonomyBulkJobStatus = "PENDING" | "FAILED" | "COMPLETED";
|
|
7137
|
+
export type TaxonomyBulkJobStatus = "PENDING" | "FAILED" | "COMPLETED" | "CANCELLED";
|
|
7077
7138
|
export interface TaxonomyBulkJobTriggerResponse {
|
|
7078
7139
|
job_id?: string; // uuid
|
|
7079
7140
|
status?: /* The status of the bulk job */ TaxonomyBulkJobStatus;
|
|
7080
7141
|
}
|
|
7081
|
-
export type TaxonomyBulkJobType = "MOVE_LABELS" | "DELETE_LABELS";
|
|
7082
7142
|
export interface TaxonomyClassification {
|
|
7083
7143
|
id?: /**
|
|
7084
7144
|
* example:
|
|
@@ -7101,8 +7161,18 @@ declare namespace Components {
|
|
|
7101
7161
|
* taxonomy-slug:classification-slug
|
|
7102
7162
|
*/
|
|
7103
7163
|
ClassificationId[];
|
|
7164
|
+
/**
|
|
7165
|
+
* Color of the classification
|
|
7166
|
+
* example:
|
|
7167
|
+
* #FF5733
|
|
7168
|
+
*/
|
|
7169
|
+
color?: string;
|
|
7104
7170
|
created_at?: string; // date-time
|
|
7105
7171
|
updated_at?: string; // date-time
|
|
7172
|
+
/**
|
|
7173
|
+
* Archived classification are not visible in the UI
|
|
7174
|
+
*/
|
|
7175
|
+
archived?: boolean;
|
|
7106
7176
|
/**
|
|
7107
7177
|
* Manifest ID used to create/update the taxonomy classification
|
|
7108
7178
|
*/
|
|
@@ -7489,13 +7559,11 @@ declare namespace Paths {
|
|
|
7489
7559
|
}
|
|
7490
7560
|
}
|
|
7491
7561
|
namespace BulkDeleteClassifications {
|
|
7492
|
-
namespace Parameters {
|
|
7493
|
-
export type Permanent = boolean;
|
|
7494
|
-
}
|
|
7495
|
-
export interface QueryParameters {
|
|
7496
|
-
permanent?: Parameters.Permanent;
|
|
7497
|
-
}
|
|
7498
7562
|
export interface RequestBody {
|
|
7563
|
+
/**
|
|
7564
|
+
* Job ID for tracking the status of a bulk operation request
|
|
7565
|
+
*/
|
|
7566
|
+
job_id?: string;
|
|
7499
7567
|
classification_ids?: /**
|
|
7500
7568
|
* example:
|
|
7501
7569
|
* taxonomy-slug:classification-slug
|
|
@@ -7507,18 +7575,20 @@ declare namespace Paths {
|
|
|
7507
7575
|
}
|
|
7508
7576
|
}
|
|
7509
7577
|
namespace BulkMoveClassifications {
|
|
7510
|
-
|
|
7511
|
-
|
|
7578
|
+
export interface RequestBody {
|
|
7579
|
+
/**
|
|
7580
|
+
* Job ID for tracking the status of a bulk operation request
|
|
7581
|
+
*/
|
|
7582
|
+
job_id?: string;
|
|
7583
|
+
/**
|
|
7584
|
+
* The target taxonomy to which the classifications will be moved
|
|
7585
|
+
*/
|
|
7586
|
+
target_taxonomy?: /**
|
|
7512
7587
|
* URL-friendly name for taxonomy
|
|
7513
7588
|
* example:
|
|
7514
7589
|
* purpose
|
|
7515
7590
|
*/
|
|
7516
7591
|
Components.Schemas.TaxonomySlug;
|
|
7517
|
-
}
|
|
7518
|
-
export interface QueryParameters {
|
|
7519
|
-
target_taxonomy?: Parameters.TargetTaxonomy;
|
|
7520
|
-
}
|
|
7521
|
-
export interface RequestBody {
|
|
7522
7592
|
classification_ids?: /**
|
|
7523
7593
|
* example:
|
|
7524
7594
|
* taxonomy-slug:classification-slug
|
|
@@ -8184,17 +8254,6 @@ declare namespace Paths {
|
|
|
8184
8254
|
Components.Schemas.EntityItem;
|
|
8185
8255
|
}
|
|
8186
8256
|
}
|
|
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
8257
|
namespace GetJsonSchema {
|
|
8199
8258
|
namespace Parameters {
|
|
8200
8259
|
export type Slug = /**
|
|
@@ -8852,6 +8911,54 @@ declare namespace Paths {
|
|
|
8852
8911
|
export type $200 = Components.Schemas.Taxonomy;
|
|
8853
8912
|
}
|
|
8854
8913
|
}
|
|
8914
|
+
namespace GetTaxonomyBulkActionJobById {
|
|
8915
|
+
namespace Parameters {
|
|
8916
|
+
export type JobId = string;
|
|
8917
|
+
}
|
|
8918
|
+
export interface PathParameters {
|
|
8919
|
+
job_id?: Parameters.JobId;
|
|
8920
|
+
}
|
|
8921
|
+
namespace Responses {
|
|
8922
|
+
export type $200 = /**
|
|
8923
|
+
* example:
|
|
8924
|
+
* {
|
|
8925
|
+
* "job_id": "123e4567-e89b-12d3-a456-426614174000",
|
|
8926
|
+
* "status": "PENDING",
|
|
8927
|
+
* "action_type": "MOVE_LABELS",
|
|
8928
|
+
* "created_by": 10598,
|
|
8929
|
+
* "created_at": "2024-01-01T00:00:00.000Z",
|
|
8930
|
+
* "updated_at": "2024-01-01T00:00:00.000Z",
|
|
8931
|
+
* "org": 66,
|
|
8932
|
+
* "progress": 0.5
|
|
8933
|
+
* }
|
|
8934
|
+
*/
|
|
8935
|
+
Components.Schemas.TaxonomyBulkJob[];
|
|
8936
|
+
}
|
|
8937
|
+
}
|
|
8938
|
+
namespace GetTaxonomyBulkActionJobs {
|
|
8939
|
+
namespace Parameters {
|
|
8940
|
+
export type Status = /* The status of the bulk job */ Components.Schemas.TaxonomyBulkJobStatus;
|
|
8941
|
+
}
|
|
8942
|
+
export interface QueryParameters {
|
|
8943
|
+
status?: Parameters.Status;
|
|
8944
|
+
}
|
|
8945
|
+
namespace Responses {
|
|
8946
|
+
export type $200 = /**
|
|
8947
|
+
* example:
|
|
8948
|
+
* {
|
|
8949
|
+
* "job_id": "123e4567-e89b-12d3-a456-426614174000",
|
|
8950
|
+
* "status": "PENDING",
|
|
8951
|
+
* "action_type": "MOVE_LABELS",
|
|
8952
|
+
* "created_by": 10598,
|
|
8953
|
+
* "created_at": "2024-01-01T00:00:00.000Z",
|
|
8954
|
+
* "updated_at": "2024-01-01T00:00:00.000Z",
|
|
8955
|
+
* "org": 66,
|
|
8956
|
+
* "progress": 0.5
|
|
8957
|
+
* }
|
|
8958
|
+
*/
|
|
8959
|
+
Components.Schemas.TaxonomyBulkJob[];
|
|
8960
|
+
}
|
|
8961
|
+
}
|
|
8855
8962
|
namespace GetTaxonomyClassification {
|
|
8856
8963
|
namespace Parameters {
|
|
8857
8964
|
export type ClassificationSlug = string;
|
|
@@ -9338,6 +9445,11 @@ declare namespace Paths {
|
|
|
9338
9445
|
}
|
|
9339
9446
|
namespace TaxonomiesClassificationsSearch {
|
|
9340
9447
|
namespace Parameters {
|
|
9448
|
+
/**
|
|
9449
|
+
* example:
|
|
9450
|
+
* false
|
|
9451
|
+
*/
|
|
9452
|
+
export type Archived = boolean;
|
|
9341
9453
|
/**
|
|
9342
9454
|
* example:
|
|
9343
9455
|
* sales
|
|
@@ -9352,6 +9464,11 @@ declare namespace Paths {
|
|
|
9352
9464
|
* sales
|
|
9353
9465
|
*/
|
|
9354
9466
|
Parameters.Query;
|
|
9467
|
+
archived?: /**
|
|
9468
|
+
* example:
|
|
9469
|
+
* false
|
|
9470
|
+
*/
|
|
9471
|
+
Parameters.Archived;
|
|
9355
9472
|
}
|
|
9356
9473
|
export interface RequestBody {
|
|
9357
9474
|
classificationIds?: /**
|
|
@@ -10683,15 +10800,30 @@ export interface OperationMethods {
|
|
|
10683
10800
|
config?: AxiosRequestConfig
|
|
10684
10801
|
): OperationResponse<Paths.ListTaxonomyClassificationsForSchema.Responses.$200>
|
|
10685
10802
|
/**
|
|
10686
|
-
*
|
|
10803
|
+
* getTaxonomyBulkActionJobs - getTaxonomyBulkActionJobs
|
|
10804
|
+
*
|
|
10805
|
+
* Gets bulk actions jobs by job status:
|
|
10806
|
+
* - <undefined> = all active jobs
|
|
10807
|
+
* - PENDING = all active jobs
|
|
10808
|
+
* - FAILED = all failed jobs
|
|
10809
|
+
* - COMPLETED = all completed jobs
|
|
10687
10810
|
*
|
|
10688
|
-
* Gets bulk jobs by job status
|
|
10689
10811
|
*/
|
|
10690
|
-
'
|
|
10691
|
-
parameters?: Parameters<Paths.
|
|
10812
|
+
'getTaxonomyBulkActionJobs'(
|
|
10813
|
+
parameters?: Parameters<Paths.GetTaxonomyBulkActionJobs.QueryParameters> | null,
|
|
10692
10814
|
data?: any,
|
|
10693
10815
|
config?: AxiosRequestConfig
|
|
10694
|
-
): OperationResponse<Paths.
|
|
10816
|
+
): OperationResponse<Paths.GetTaxonomyBulkActionJobs.Responses.$200>
|
|
10817
|
+
/**
|
|
10818
|
+
* getTaxonomyBulkActionJobById - getTaxonomyBulkActionJobById
|
|
10819
|
+
*
|
|
10820
|
+
* Gets a bulk action job by job id
|
|
10821
|
+
*/
|
|
10822
|
+
'getTaxonomyBulkActionJobById'(
|
|
10823
|
+
parameters?: Parameters<Paths.GetTaxonomyBulkActionJobById.PathParameters> | null,
|
|
10824
|
+
data?: any,
|
|
10825
|
+
config?: AxiosRequestConfig
|
|
10826
|
+
): OperationResponse<Paths.GetTaxonomyBulkActionJobById.Responses.$200>
|
|
10695
10827
|
/**
|
|
10696
10828
|
* bulkMoveClassifications - bulkMoveClassifications
|
|
10697
10829
|
*
|
|
@@ -10700,19 +10832,20 @@ export interface OperationMethods {
|
|
|
10700
10832
|
*
|
|
10701
10833
|
*/
|
|
10702
10834
|
'bulkMoveClassifications'(
|
|
10703
|
-
parameters?: Parameters<
|
|
10835
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
10704
10836
|
data?: Paths.BulkMoveClassifications.RequestBody,
|
|
10705
10837
|
config?: AxiosRequestConfig
|
|
10706
10838
|
): OperationResponse<Paths.BulkMoveClassifications.Responses.$200>
|
|
10707
10839
|
/**
|
|
10708
10840
|
* bulkDeleteClassifications - bulkDeleteClassifications
|
|
10709
10841
|
*
|
|
10710
|
-
*
|
|
10711
|
-
* async operation which also deletes all references of the deleted classifications from the entities
|
|
10842
|
+
* Permanently deletes taxonomy classifications. The classifications are deleted through a bulk
|
|
10843
|
+
* async operation which also deletes all references of the deleted classifications from the entities
|
|
10844
|
+
* referencing them.
|
|
10712
10845
|
*
|
|
10713
10846
|
*/
|
|
10714
10847
|
'bulkDeleteClassifications'(
|
|
10715
|
-
parameters?: Parameters<
|
|
10848
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
10716
10849
|
data?: Paths.BulkDeleteClassifications.RequestBody,
|
|
10717
10850
|
config?: AxiosRequestConfig
|
|
10718
10851
|
): OperationResponse<Paths.BulkDeleteClassifications.Responses.$200>
|
|
@@ -11747,17 +11880,34 @@ export interface PathsDictionary {
|
|
|
11747
11880
|
config?: AxiosRequestConfig
|
|
11748
11881
|
): OperationResponse<Paths.ListTaxonomyClassificationsForSchema.Responses.$200>
|
|
11749
11882
|
}
|
|
11750
|
-
['/v1/entity/taxonomies/jobs']: {
|
|
11883
|
+
['/v1/entity/taxonomies/bulk-jobs']: {
|
|
11884
|
+
/**
|
|
11885
|
+
* getTaxonomyBulkActionJobs - getTaxonomyBulkActionJobs
|
|
11886
|
+
*
|
|
11887
|
+
* Gets bulk actions jobs by job status:
|
|
11888
|
+
* - <undefined> = all active jobs
|
|
11889
|
+
* - PENDING = all active jobs
|
|
11890
|
+
* - FAILED = all failed jobs
|
|
11891
|
+
* - COMPLETED = all completed jobs
|
|
11892
|
+
*
|
|
11893
|
+
*/
|
|
11894
|
+
'get'(
|
|
11895
|
+
parameters?: Parameters<Paths.GetTaxonomyBulkActionJobs.QueryParameters> | null,
|
|
11896
|
+
data?: any,
|
|
11897
|
+
config?: AxiosRequestConfig
|
|
11898
|
+
): OperationResponse<Paths.GetTaxonomyBulkActionJobs.Responses.$200>
|
|
11899
|
+
}
|
|
11900
|
+
['/v1/entity/taxonomies/bulk-jobs/{job_id}']: {
|
|
11751
11901
|
/**
|
|
11752
|
-
*
|
|
11902
|
+
* getTaxonomyBulkActionJobById - getTaxonomyBulkActionJobById
|
|
11753
11903
|
*
|
|
11754
|
-
* Gets bulk
|
|
11904
|
+
* Gets a bulk action job by job id
|
|
11755
11905
|
*/
|
|
11756
11906
|
'get'(
|
|
11757
|
-
parameters?: Parameters<Paths.
|
|
11907
|
+
parameters?: Parameters<Paths.GetTaxonomyBulkActionJobById.PathParameters> | null,
|
|
11758
11908
|
data?: any,
|
|
11759
11909
|
config?: AxiosRequestConfig
|
|
11760
|
-
): OperationResponse<Paths.
|
|
11910
|
+
): OperationResponse<Paths.GetTaxonomyBulkActionJobById.Responses.$200>
|
|
11761
11911
|
}
|
|
11762
11912
|
['/v1/entity/taxonomies/classifications:move']: {
|
|
11763
11913
|
/**
|
|
@@ -11768,7 +11918,7 @@ export interface PathsDictionary {
|
|
|
11768
11918
|
*
|
|
11769
11919
|
*/
|
|
11770
11920
|
'post'(
|
|
11771
|
-
parameters?: Parameters<
|
|
11921
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
11772
11922
|
data?: Paths.BulkMoveClassifications.RequestBody,
|
|
11773
11923
|
config?: AxiosRequestConfig
|
|
11774
11924
|
): OperationResponse<Paths.BulkMoveClassifications.Responses.$200>
|
|
@@ -11777,12 +11927,13 @@ export interface PathsDictionary {
|
|
|
11777
11927
|
/**
|
|
11778
11928
|
* bulkDeleteClassifications - bulkDeleteClassifications
|
|
11779
11929
|
*
|
|
11780
|
-
*
|
|
11781
|
-
* async operation which also deletes all references of the deleted classifications from the entities
|
|
11930
|
+
* Permanently deletes taxonomy classifications. The classifications are deleted through a bulk
|
|
11931
|
+
* async operation which also deletes all references of the deleted classifications from the entities
|
|
11932
|
+
* referencing them.
|
|
11782
11933
|
*
|
|
11783
11934
|
*/
|
|
11784
11935
|
'post'(
|
|
11785
|
-
parameters?: Parameters<
|
|
11936
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
11786
11937
|
data?: Paths.BulkDeleteClassifications.RequestBody,
|
|
11787
11938
|
config?: AxiosRequestConfig
|
|
11788
11939
|
): OperationResponse<Paths.BulkDeleteClassifications.Responses.$200>
|
|
@@ -12070,9 +12221,9 @@ export type SummaryField = Components.Schemas.SummaryField;
|
|
|
12070
12221
|
export type TagsAttribute = Components.Schemas.TagsAttribute;
|
|
12071
12222
|
export type Taxonomy = Components.Schemas.Taxonomy;
|
|
12072
12223
|
export type TaxonomyBulkJob = Components.Schemas.TaxonomyBulkJob;
|
|
12224
|
+
export type TaxonomyBulkJobActionType = Components.Schemas.TaxonomyBulkJobActionType;
|
|
12073
12225
|
export type TaxonomyBulkJobStatus = Components.Schemas.TaxonomyBulkJobStatus;
|
|
12074
12226
|
export type TaxonomyBulkJobTriggerResponse = Components.Schemas.TaxonomyBulkJobTriggerResponse;
|
|
12075
|
-
export type TaxonomyBulkJobType = Components.Schemas.TaxonomyBulkJobType;
|
|
12076
12227
|
export type TaxonomyClassification = Components.Schemas.TaxonomyClassification;
|
|
12077
12228
|
export type TaxonomyLocationId = Components.Schemas.TaxonomyLocationId;
|
|
12078
12229
|
export type TaxonomySlug = Components.Schemas.TaxonomySlug;
|
package/dist/openapi.json
CHANGED
|
@@ -2809,6 +2809,15 @@
|
|
|
2809
2809
|
"type": "string",
|
|
2810
2810
|
"example": "sales"
|
|
2811
2811
|
}
|
|
2812
|
+
},
|
|
2813
|
+
{
|
|
2814
|
+
"in": "query",
|
|
2815
|
+
"name": "archived",
|
|
2816
|
+
"description": "Filter by archived status",
|
|
2817
|
+
"schema": {
|
|
2818
|
+
"type": "boolean",
|
|
2819
|
+
"example": false
|
|
2820
|
+
}
|
|
2812
2821
|
}
|
|
2813
2822
|
],
|
|
2814
2823
|
"requestBody": {
|
|
@@ -2902,11 +2911,11 @@
|
|
|
2902
2911
|
}
|
|
2903
2912
|
}
|
|
2904
2913
|
},
|
|
2905
|
-
"/v1/entity/taxonomies/jobs": {
|
|
2914
|
+
"/v1/entity/taxonomies/bulk-jobs": {
|
|
2906
2915
|
"get": {
|
|
2907
|
-
"operationId": "
|
|
2908
|
-
"summary": "
|
|
2909
|
-
"description": "Gets bulk jobs by job status",
|
|
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",
|
|
2910
2919
|
"tags": [
|
|
2911
2920
|
"Taxonomy"
|
|
2912
2921
|
],
|
|
@@ -2936,23 +2945,47 @@
|
|
|
2936
2945
|
}
|
|
2937
2946
|
}
|
|
2938
2947
|
},
|
|
2939
|
-
"/v1/entity/taxonomies/
|
|
2940
|
-
"
|
|
2941
|
-
"operationId": "
|
|
2942
|
-
"summary": "
|
|
2943
|
-
"description": "
|
|
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",
|
|
2944
2953
|
"tags": [
|
|
2945
2954
|
"Taxonomy"
|
|
2946
2955
|
],
|
|
2947
2956
|
"parameters": [
|
|
2948
2957
|
{
|
|
2949
|
-
"in": "
|
|
2950
|
-
"name": "
|
|
2951
|
-
"description": "The target taxonomy to which the classifications will be moved",
|
|
2958
|
+
"in": "path",
|
|
2959
|
+
"name": "job_id",
|
|
2952
2960
|
"schema": {
|
|
2953
|
-
"
|
|
2961
|
+
"type": "string"
|
|
2962
|
+
}
|
|
2963
|
+
}
|
|
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
|
+
}
|
|
2954
2977
|
}
|
|
2955
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"
|
|
2956
2989
|
],
|
|
2957
2990
|
"requestBody": {
|
|
2958
2991
|
"content": {
|
|
@@ -2960,6 +2993,14 @@
|
|
|
2960
2993
|
"schema": {
|
|
2961
2994
|
"type": "object",
|
|
2962
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
|
+
},
|
|
2963
3004
|
"classification_ids": {
|
|
2964
3005
|
"type": "array",
|
|
2965
3006
|
"items": {
|
|
@@ -2998,27 +3039,20 @@
|
|
|
2998
3039
|
"post": {
|
|
2999
3040
|
"operationId": "bulkDeleteClassifications",
|
|
3000
3041
|
"summary": "bulkDeleteClassifications",
|
|
3001
|
-
"description": "
|
|
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",
|
|
3002
3043
|
"tags": [
|
|
3003
3044
|
"Taxonomy"
|
|
3004
3045
|
],
|
|
3005
|
-
"parameters": [
|
|
3006
|
-
{
|
|
3007
|
-
"in": "query",
|
|
3008
|
-
"name": "permanent",
|
|
3009
|
-
"schema": {
|
|
3010
|
-
"type": "boolean",
|
|
3011
|
-
"default": false
|
|
3012
|
-
},
|
|
3013
|
-
"description": "Whether to permanently delete the classifications or just archive them"
|
|
3014
|
-
}
|
|
3015
|
-
],
|
|
3016
3046
|
"requestBody": {
|
|
3017
3047
|
"content": {
|
|
3018
3048
|
"application/json": {
|
|
3019
3049
|
"schema": {
|
|
3020
3050
|
"type": "object",
|
|
3021
3051
|
"properties": {
|
|
3052
|
+
"job_id": {
|
|
3053
|
+
"description": "Job ID for tracking the status of a bulk operation request",
|
|
3054
|
+
"type": "string"
|
|
3055
|
+
},
|
|
3022
3056
|
"classification_ids": {
|
|
3023
3057
|
"type": "array",
|
|
3024
3058
|
"items": {
|
|
@@ -3697,6 +3731,19 @@
|
|
|
3697
3731
|
"format": "uri",
|
|
3698
3732
|
"example": "https://docs.epilot.io/docs/pricing/entities"
|
|
3699
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
|
+
},
|
|
3700
3747
|
"published": {
|
|
3701
3748
|
"type": "boolean",
|
|
3702
3749
|
"example": false
|
|
@@ -7293,6 +7340,11 @@
|
|
|
7293
7340
|
"$ref": "#/components/schemas/ClassificationId"
|
|
7294
7341
|
}
|
|
7295
7342
|
},
|
|
7343
|
+
"color": {
|
|
7344
|
+
"type": "string",
|
|
7345
|
+
"description": "Color of the classification",
|
|
7346
|
+
"example": "#FF5733"
|
|
7347
|
+
},
|
|
7296
7348
|
"created_at": {
|
|
7297
7349
|
"type": "string",
|
|
7298
7350
|
"format": "date-time"
|
|
@@ -7301,6 +7353,11 @@
|
|
|
7301
7353
|
"type": "string",
|
|
7302
7354
|
"format": "date-time"
|
|
7303
7355
|
},
|
|
7356
|
+
"archived": {
|
|
7357
|
+
"type": "boolean",
|
|
7358
|
+
"description": "Archived classification are not visible in the UI",
|
|
7359
|
+
"default": false
|
|
7360
|
+
},
|
|
7304
7361
|
"_manifest": {
|
|
7305
7362
|
"type": "array",
|
|
7306
7363
|
"description": "Manifest ID used to create/update the taxonomy classification",
|
|
@@ -7379,14 +7436,15 @@
|
|
|
7379
7436
|
"enum": [
|
|
7380
7437
|
"PENDING",
|
|
7381
7438
|
"FAILED",
|
|
7382
|
-
"COMPLETED"
|
|
7439
|
+
"COMPLETED",
|
|
7440
|
+
"CANCELLED"
|
|
7383
7441
|
]
|
|
7384
7442
|
},
|
|
7385
|
-
"
|
|
7443
|
+
"TaxonomyBulkJobActionType": {
|
|
7386
7444
|
"type": "string",
|
|
7387
7445
|
"enum": [
|
|
7388
|
-
"
|
|
7389
|
-
"
|
|
7446
|
+
"MOVE_CLASSIFICATIONS",
|
|
7447
|
+
"DELETE_CLASSIFICATIONS"
|
|
7390
7448
|
]
|
|
7391
7449
|
},
|
|
7392
7450
|
"TaxonomyBulkJob": {
|
|
@@ -7396,12 +7454,80 @@
|
|
|
7396
7454
|
"type": "string",
|
|
7397
7455
|
"format": "uuid"
|
|
7398
7456
|
},
|
|
7399
|
-
"
|
|
7457
|
+
"job_status": {
|
|
7400
7458
|
"$ref": "#/components/schemas/TaxonomyBulkJobStatus"
|
|
7401
7459
|
},
|
|
7402
|
-
"
|
|
7403
|
-
"$ref": "#/components/schemas/
|
|
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"
|
|
7404
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
|
|
7405
7531
|
}
|
|
7406
7532
|
},
|
|
7407
7533
|
"ESClusterAssignment": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/entity-client",
|
|
3
|
-
"version": "4.33.
|
|
3
|
+
"version": "4.33.3",
|
|
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
|
|
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",
|