@epilot/entity-client 6.14.0 → 7.0.0-rc.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +1 -1
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +34 -0
- package/dist/openapi.d.ts +291 -9
- package/dist/openapi.json +205 -3
- package/package.json +4 -7
package/dist/client.d.ts
CHANGED
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={330:function(e,t,a){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=r(a(466));t.default=n.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"},{"in":"query","name":"exclude","style":"form","explode":false}],"responses":{}}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"}],"responses":{}},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/schema":{"get":{"operationId":"getJsonSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"dereference"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/example":{"get":{"operationId":"getSchemaExample","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/versions":{"get":{"operationId":"getSchemaVersions","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"versions_from"},{"in":"query","name":"versions_size"},{"in":"query","name":"drafts_from"},{"in":"query","name":"drafts_size"},{"in":"query","name":"fields","required":false,"style":"form","explode":false}],"responses":{}}},"/v1/entity/schemas/{slug}/capabilities/available":{"get":{"operationId":"listAvailableCapabilities","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints","responses":{}}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:list":{"post":{"operationId":"listEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:graph":{"post":{"operationId":"queryEntityGraph","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}:validate":{"post":{"operationId":"validateEntityV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"},{"name":"strict","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}":{"get":{"operationId":"getEntityV2","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"fields","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}:restore":{"patch":{"operationId":"restoreEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}:reindex":{"post":{"operationId":"reindexEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}],"responses":{}},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"in":"query","name":"purge"}],"responses":{}}},"/v1/entity:autocomplete":{"get":{"operationId":"autocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"slug","in":"query"},{"name":"size","in":"query"}],"responses":{}}},"/v1/entity:wipeAllEntities":{"post":{"operationId":"wipeAllEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}],"responses":{}}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"start_date"},{"in":"query","name":"end_date"},{"in":"query","name":"preset_range"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type","style":"form","explode":false},{"in":"query","name":"include_relations"},{"in":"query","name":"exclude_activity_groups"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"removeRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"query"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"fields"}],"responses":{}}},"/v3/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV3","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseDeprecatedQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"},{"$ref":"#/components/parameters/EntityRelationsModeQueryParam"},{"in":"query","name":"fields"},{"in":"query","name":"include_deleted","required":false}],"responses":{}}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"responses":{}}},"/v1/entity:export":{"post":{"operationId":"exportEntities","parameters":[{"in":"query","name":"job_id"},{"in":"query","name":"is_template"},{"in":"query","name":"language"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/views":{"get":{"operationId":"listSavedViews","parameters":[{"in":"query","name":"slug","required":false},{"in":"query","name":"sort","required":false},{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"in":"query","name":"fields","required":false}],"responses":{}}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser","responses":{}}},"/v1/entity/taxonomies":{"get":{"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"},{"in":"query","name":"type"}],"responses":{}},"post":{"operationId":"createTaxonomy","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"permanent"}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/taxonomies/classifications":{"post":{"operationId":"createTaxonomyClassification","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/taxonomies/classifications/{classificationSlug}":{"get":{"operationId":"getTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}],"responses":{}}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"in":"query","name":"taxonomySlug"},{"in":"query","name":"query"},{"in":"query","name":"archived","deprecated":true},{"in":"query","name":"include_archived"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}":{"get":{"operationId":"listTaxonomyClassificationsForSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs":{"get":{"operationId":"getTaxonomyBulkActionJobs","parameters":[{"in":"query","name":"status"},{"in":"query","name":"size"},{"in":"query","name":"created_after"},{"in":"query","name":"sort_pending_first"},{"in":"query","name":"scope"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}":{"get":{"operationId":"getTaxonomyBulkActionJobById","parameters":[{"in":"path","name":"job_id","required":true}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}/cancel":{"post":{"operationId":"cancelBulkAction","parameters":[{"name":"job_id","in":"path","required":true}],"responses":{}}},"/v1/entity/taxonomies/classifications:move":{"post":{"operationId":"bulkMoveClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/classifications:merge":{"post":{"operationId":"bulkMergeClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/classifications:delete":{"post":{"operationId":"bulkDeleteClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/attributes":{"post":{"operationId":"createSchemaAttribute","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/attributes/{composite_id}":{"get":{"operationId":"getSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/capabilities":{"post":{"operationId":"createSchemaCapability","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/capabilities/{composite_id}":{"get":{"operationId":"getSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/group":{"post":{"operationId":"createSchemaGroup","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/group/{composite_id}":{"get":{"operationId":"getSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/headline":{"post":{"operationId":"createSchemaGroupHeadline","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/headline/{composite_id}":{"get":{"operationId":"getSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}}},"components":{"parameters":{"EntityIdPathParam":{"name":"id","in":"path","required":true},"EntitySlugPathParam":{"name":"slug","in":"path","required":true},"EntitySlugPathPriceParam":{"name":"slug","in":"path","required":true},"TaxonomySlugQueryParam":{"name":"taxonomySlug","in":"query","required":true},"TaxonomySlugPathParam":{"name":"taxonomySlug","in":"path","required":true},"TaxonomySlugQueryParamOptional":{"name":"taxonomySlug","in":"query"},"TaxonomyClassificationSlugPathParam":{"name":"classificationSlug","in":"path","required":true},"SavedViewIdPathParam":{"name":"id","in":"path","required":true},"AsyncOperationQueryParam":{"name":"async","in":"query","required":false},"HydrateEntitiesQueryParam":{"name":"hydrate","in":"query"},"ActivityIdQueryParam":{"name":"activity_id","in":"query","required":false},"ActivityIdPathParam":{"name":"id","in":"path","required":true},"FromPageQueryParam":{"name":"from","in":"query"},"IncludeReverseDeprecatedQueryParam":{"name":"include_reverse","in":"query","deprecated":true},"IncludeReverseQueryParam":{"name":"include_reverse","in":"query"},"IncludeSchemasQueryParam":{"name":"include_schemas","in":"query","required":false,"style":"form","explode":false},"ExcludeSchemasQueryParam":{"name":"exclude_schemas","in":"query","required":false,"style":"form","explode":false},"EntityRelationsModeQueryParam":{"name":"mode","in":"query","required":false},"DryRunQueryParam":{"name":"dry_run","in":"query","required":false},"FillActivityQueryParam":{"name":"fill_activity","in":"query","required":false},"ValidateEntityQueryParam":{"name":"validate","in":"query"}},"responses":{"BadRequestError":{"content":{"application/json":{}}},"NotFoundError":{"content":{"application/json":{}}},"TooManyRequestsError":{"headers":{"Retry-After":{}},"content":{"application/json":{}}}}},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},a=function a(r){var n=t[r];if(void 0!==n)return n.exports;var s=t[r]={exports:{}};return e[r].call(s.exports,s,s.exports,a),s.exports}(330),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
|
|
1
|
+
(()=>{"use strict";var e={438(e,t,a){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=r(a(466));t.default=n.default},466(e){e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"},{"in":"query","name":"exclude","style":"form","explode":false},{"in":"query","name":"include","style":"form","explode":false}],"responses":{}}},"/v2/entity/schemas":{"get":{"operationId":"listSchemasV2","parameters":[{"in":"query","name":"full"},{"in":"query","name":"unpublished"},{"in":"query","name":"exclude","style":"form","explode":false},{"in":"query","name":"include","style":"form","explode":false}],"responses":{}}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"}],"responses":{}},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/schema":{"get":{"operationId":"getJsonSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"dereference"}],"responses":{}}},"/v1/entity/schemas/{slug}/json/example":{"get":{"operationId":"getSchemaExample","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/{slug}/versions":{"get":{"operationId":"getSchemaVersions","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"versions_from"},{"in":"query","name":"versions_size"},{"in":"query","name":"drafts_from"},{"in":"query","name":"drafts_size"},{"in":"query","name":"fields","required":false,"style":"form","explode":false}],"responses":{}}},"/v1/entity/schemas/{slug}/capabilities/available":{"get":{"operationId":"listAvailableCapabilities","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}],"responses":{}}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints","responses":{}}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:list":{"post":{"operationId":"listEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:graph":{"post":{"operationId":"queryEntityGraph","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}:validate":{"post":{"operationId":"validateEntityV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"},{"name":"strict","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}":{"get":{"operationId":"getEntityV2","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"fields","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}:restore":{"patch":{"operationId":"restoreEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}:reindex":{"post":{"operationId":"reindexEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}],"responses":{}},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ValidateEntityQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"in":"query","name":"purge"}],"responses":{}}},"/v1/entity:autocomplete":{"get":{"operationId":"autocomplete","parameters":[{"name":"input","in":"query"},{"name":"attribute","in":"query","required":true},{"name":"slug","in":"query"},{"name":"size","in":"query"}],"responses":{}}},"/v1/entity:wipeAllEntities":{"post":{"operationId":"wipeAllEntities","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}],"responses":{}}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}],"responses":{}}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"query","name":"after"},{"in":"query","name":"before"},{"in":"query","name":"start_date"},{"in":"query","name":"end_date"},{"in":"query","name":"preset_range"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type","style":"form","explode":false},{"in":"query","name":"include_relations"},{"in":"query","name":"exclude_activity_groups"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"removeRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV2","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"in":"query","name":"query"},{"$ref":"#/components/parameters/IncludeReverseQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"fields"}],"responses":{}}},"/v3/entity/{slug}/{id}/relations":{"get":{"operationId":"getRelationsV3","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"},{"$ref":"#/components/parameters/IncludeReverseDeprecatedQueryParam"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size","required":false},{"$ref":"#/components/parameters/IncludeSchemasQueryParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"},{"$ref":"#/components/parameters/EntityRelationsModeQueryParam"},{"in":"query","name":"fields"},{"in":"query","name":"include_deleted","required":false}],"responses":{}}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}],"responses":{}}},"/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}":{"put":{"operationId":"updateRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteRelation","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"path","name":"attribute","required":true},{"in":"path","name":"entity_id","required":true},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"responses":{}}},"/v1/entity:export":{"post":{"operationId":"exportEntities","parameters":[{"in":"query","name":"job_id"},{"in":"query","name":"is_template"},{"in":"query","name":"language"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/views":{"get":{"operationId":"listSavedViews","parameters":[{"in":"query","name":"slug","required":false},{"in":"query","name":"sort","required":false},{"in":"query","name":"from","required":false},{"in":"query","name":"size","required":false},{"in":"query","name":"fields","required":false}],"responses":{}}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"patch":{"operationId":"patchSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"responses":{}}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser","responses":{}}},"/v1/entity/taxonomies":{"get":{"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"},{"in":"query","name":"type"}],"responses":{}},"post":{"operationId":"createTaxonomy","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"permanent"}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/taxonomies/classifications":{"post":{"operationId":"createTaxonomyClassification","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/entity/taxonomies/classifications/{classificationSlug}":{"get":{"operationId":"getTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"responses":{}},"put":{"operationId":"updateTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"responses":{}}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}],"responses":{}}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"in":"query","name":"taxonomySlug"},{"in":"query","name":"query"},{"in":"query","name":"archived","deprecated":true},{"in":"query","name":"include_archived"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}":{"get":{"operationId":"listTaxonomyClassificationsForSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs":{"get":{"operationId":"getTaxonomyBulkActionJobs","parameters":[{"in":"query","name":"status"},{"in":"query","name":"size"},{"in":"query","name":"created_after"},{"in":"query","name":"sort_pending_first"},{"in":"query","name":"scope"}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}":{"get":{"operationId":"getTaxonomyBulkActionJobById","parameters":[{"in":"path","name":"job_id","required":true}],"responses":{}}},"/v1/entity/taxonomies/bulk-jobs/{job_id}/cancel":{"post":{"operationId":"cancelBulkAction","parameters":[{"name":"job_id","in":"path","required":true}],"responses":{}}},"/v1/entity/taxonomies/classifications:move":{"post":{"operationId":"bulkMoveClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/classifications:merge":{"post":{"operationId":"bulkMergeClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/taxonomies/classifications:delete":{"post":{"operationId":"bulkDeleteClassifications","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/attributes":{"post":{"operationId":"createSchemaAttribute","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/attributes/{composite_id}":{"get":{"operationId":"getSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/capabilities":{"post":{"operationId":"createSchemaCapability","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/capabilities/{composite_id}":{"get":{"operationId":"getSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/group":{"post":{"operationId":"createSchemaGroup","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/group/{composite_id}":{"get":{"operationId":"getSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroup","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}},"/v1/entity/schemas/headline":{"post":{"operationId":"createSchemaGroupHeadline","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/schemas/headline/{composite_id}":{"get":{"operationId":"getSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}},"put":{"operationId":"putSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSchemaGroupHeadline","parameters":[{"name":"composite_id","in":"path","required":true}],"responses":{}}}},"components":{"parameters":{"EntityIdPathParam":{"name":"id","in":"path","required":true},"EntitySlugPathParam":{"name":"slug","in":"path","required":true},"EntitySlugPathPriceParam":{"name":"slug","in":"path","required":true},"TaxonomySlugQueryParam":{"name":"taxonomySlug","in":"query","required":true},"TaxonomySlugPathParam":{"name":"taxonomySlug","in":"path","required":true},"TaxonomySlugQueryParamOptional":{"name":"taxonomySlug","in":"query"},"TaxonomyClassificationSlugPathParam":{"name":"classificationSlug","in":"path","required":true},"SavedViewIdPathParam":{"name":"id","in":"path","required":true},"AsyncOperationQueryParam":{"name":"async","in":"query","required":false},"HydrateEntitiesQueryParam":{"name":"hydrate","in":"query"},"ActivityIdQueryParam":{"name":"activity_id","in":"query","required":false},"ActivityIdPathParam":{"name":"id","in":"path","required":true},"FromPageQueryParam":{"name":"from","in":"query"},"IncludeReverseDeprecatedQueryParam":{"name":"include_reverse","in":"query","deprecated":true},"IncludeReverseQueryParam":{"name":"include_reverse","in":"query"},"IncludeSchemasQueryParam":{"name":"include_schemas","in":"query","required":false,"style":"form","explode":false},"ExcludeSchemasQueryParam":{"name":"exclude_schemas","in":"query","required":false,"style":"form","explode":false},"EntityRelationsModeQueryParam":{"name":"mode","in":"query","required":false},"DryRunQueryParam":{"name":"dry_run","in":"query","required":false},"FillActivityQueryParam":{"name":"fill_activity","in":"query","required":false},"ValidateEntityQueryParam":{"name":"validate","in":"query"}},"responses":{"BadRequestError":{"content":{"application/json":{}}},"NotFoundError":{"content":{"application/json":{}}},"TooManyRequestsError":{"headers":{"Retry-After":{}},"content":{"application/json":{}}}}},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},a=function a(r){var n=t[r];if(void 0!==n)return n.exports;var s=t[r]={exports:{}};return e[r].call(s.exports,s,s.exports,a),s.exports}(438),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
|
|
@@ -18,6 +18,40 @@
|
|
|
18
18
|
"name": "exclude",
|
|
19
19
|
"style": "form",
|
|
20
20
|
"explode": false
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
"in": "query",
|
|
24
|
+
"name": "include",
|
|
25
|
+
"style": "form",
|
|
26
|
+
"explode": false
|
|
27
|
+
}
|
|
28
|
+
],
|
|
29
|
+
"responses": {}
|
|
30
|
+
}
|
|
31
|
+
},
|
|
32
|
+
"/v2/entity/schemas": {
|
|
33
|
+
"get": {
|
|
34
|
+
"operationId": "listSchemasV2",
|
|
35
|
+
"parameters": [
|
|
36
|
+
{
|
|
37
|
+
"in": "query",
|
|
38
|
+
"name": "full"
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
"in": "query",
|
|
42
|
+
"name": "unpublished"
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"in": "query",
|
|
46
|
+
"name": "exclude",
|
|
47
|
+
"style": "form",
|
|
48
|
+
"explode": false
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"in": "query",
|
|
52
|
+
"name": "include",
|
|
53
|
+
"style": "form",
|
|
54
|
+
"explode": false
|
|
21
55
|
}
|
|
22
56
|
],
|
|
23
57
|
"responses": {}
|
package/dist/openapi.d.ts
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
/* eslint-disable */
|
|
2
|
-
|
|
3
1
|
import type {
|
|
4
2
|
OpenAPIClient,
|
|
5
3
|
Parameters,
|
|
@@ -710,7 +708,7 @@ declare namespace Components {
|
|
|
710
708
|
*/
|
|
711
709
|
DefaultAddressFields;
|
|
712
710
|
}
|
|
713
|
-
export type Attribute = /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Address attribute */ AddressAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Tags */ TagsAttribute | /* Message emil address */ MessageEmailAddressAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute | /* Shared Partner Organisations */ PartnerOrganisationAttribute | /* Portal access configuration */ PortalAccessAttribute | /* Phone number */ PhoneAttribute | /* Email address */ EmailAttribute | /* Payment method */ PaymentAttribute | /* Price component */ PriceComponentAttribute;
|
|
711
|
+
export type Attribute = /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Address attribute */ AddressAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Tags */ TagsAttribute | /* Message emil address */ MessageEmailAddressAttribute | /* Numeric input */ NumberAttribute | /* Dynamic data table with configurable columns. Data is stored as an array of objects where each object represents a row. */ TableAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute | /* Shared Partner Organisations */ PartnerOrganisationAttribute | /* Portal access configuration */ PortalAccessAttribute | /* Phone number */ PhoneAttribute | /* Email address */ EmailAttribute | /* Payment method */ PaymentAttribute | /* Price component */ PriceComponentAttribute;
|
|
714
712
|
/**
|
|
715
713
|
* a readonly computed ID for the attribute including schema slug and the attribute ID
|
|
716
714
|
*/
|
|
@@ -726,7 +724,7 @@ declare namespace Components {
|
|
|
726
724
|
* contact
|
|
727
725
|
*/
|
|
728
726
|
schema?: string;
|
|
729
|
-
} & (/* a readonly computed ID for the attribute including schema slug and the attribute ID */ /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Address attribute */ AddressAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Tags */ TagsAttribute | /* Message emil address */ MessageEmailAddressAttribute | /* Numeric input */ NumberAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute | /* Shared Partner Organisations */ PartnerOrganisationAttribute | /* Portal access configuration */ PortalAccessAttribute | /* Phone number */ PhoneAttribute | /* Email address */ EmailAttribute | /* Payment method */ PaymentAttribute | /* Price component */ PriceComponentAttribute);
|
|
727
|
+
} & (/* a readonly computed ID for the attribute including schema slug and the attribute ID */ /* Textarea or text input */ TextAttribute | /* Link with title and href */ LinkAttribute | /* Date or Datetime picker */ DateAttribute | /* Country picker */ CountryAttribute | /* Yes / No Toggle */ BooleanAttribute | /* Dropdown select */ SelectAttribute | /* Multi Choice Selection */ MultiSelectAttribute | /* Status select */ StatusAttribute | /* Sequence of unique identifiers */ SequenceAttribute | /* Entity Relationship */ RelationAttribute | /* User Relationship */ UserRelationAttribute | /* Address attribute */ AddressAttribute | /* Reference to an address attribute of another entity */ AddressRelationAttribute | /* Reference to a payment method attribute of another entity */ PaymentMethodRelationAttribute | /* Currency input */ CurrencyAttribute | /* Tags */ TagsAttribute | /* Message emil address */ MessageEmailAddressAttribute | /* Numeric input */ NumberAttribute | /* Dynamic data table with configurable columns. Data is stored as an array of objects where each object represents a row. */ TableAttribute | /* Consent Management */ ConsentAttribute | /* No UI representation */ InternalAttribute | /* Type of attribute to render N number of ordered fields */ OrderedListAttribute | /* File or Image Attachment */ FileAttribute | /* An attribute that is computed from the entity data. For more details on how to use them, check the docs [here](https://e-pilot.atlassian.net/wiki/spaces/EO/pages/5642977476/How+To+Computed+Schema+Attributes) */ ComputedAttribute | /* Partner Status */ PartnerStatusAttribute | /* Email address for send invitation */ InvitationEmailAttribute | /* Automation entity */ AutomationAttribute | /* Epilot internal user info */ InternalUserAttribute | /* Entity Taxonomy */ PurposeAttribute | /* Shared Partner Organisations */ PartnerOrganisationAttribute | /* Portal access configuration */ PortalAccessAttribute | /* Phone number */ PhoneAttribute | /* Email address */ EmailAttribute | /* Payment method */ PaymentAttribute | /* Price component */ PriceComponentAttribute);
|
|
730
728
|
/**
|
|
731
729
|
* Automation entity
|
|
732
730
|
*/
|
|
@@ -2613,6 +2611,18 @@ declare namespace Components {
|
|
|
2613
2611
|
* This capability should only be active when all the settings have the correct value
|
|
2614
2612
|
*/
|
|
2615
2613
|
settings_flag?: SettingFlag[];
|
|
2614
|
+
/**
|
|
2615
|
+
* Schema-specific configuration for the capability
|
|
2616
|
+
*/
|
|
2617
|
+
schemas?: {
|
|
2618
|
+
[name: string]: any;
|
|
2619
|
+
/**
|
|
2620
|
+
* Entity schema slug
|
|
2621
|
+
* example:
|
|
2622
|
+
* contact
|
|
2623
|
+
*/
|
|
2624
|
+
schema: string;
|
|
2625
|
+
}[];
|
|
2616
2626
|
}
|
|
2617
2627
|
/**
|
|
2618
2628
|
* a readonly computed ID for the entity capability including schema slug and the capability ID
|
|
@@ -2746,6 +2756,18 @@ declare namespace Components {
|
|
|
2746
2756
|
* This capability should only be active when all the settings have the correct value
|
|
2747
2757
|
*/
|
|
2748
2758
|
settings_flag?: SettingFlag[];
|
|
2759
|
+
/**
|
|
2760
|
+
* Schema-specific configuration for the capability
|
|
2761
|
+
*/
|
|
2762
|
+
schemas?: {
|
|
2763
|
+
[name: string]: any;
|
|
2764
|
+
/**
|
|
2765
|
+
* Entity schema slug
|
|
2766
|
+
* example:
|
|
2767
|
+
* contact
|
|
2768
|
+
*/
|
|
2769
|
+
schema: string;
|
|
2770
|
+
}[];
|
|
2749
2771
|
/**
|
|
2750
2772
|
* example:
|
|
2751
2773
|
* contact:97644baa-083f-4e49-9188-fcff2ecaad7d
|
|
@@ -3443,6 +3465,22 @@ declare namespace Components {
|
|
|
3443
3465
|
_manifest?: string /* uuid */[] | null;
|
|
3444
3466
|
};
|
|
3445
3467
|
};
|
|
3468
|
+
/**
|
|
3469
|
+
* Internal property for workflow origin tracking and infinite loop prevention.
|
|
3470
|
+
* Populated when an entity update originates from a workflow execution.
|
|
3471
|
+
* This allows downstream automation services to prevent circular triggering.
|
|
3472
|
+
*
|
|
3473
|
+
*/
|
|
3474
|
+
_workflow_origin?: {
|
|
3475
|
+
/**
|
|
3476
|
+
* The ID of the workflow execution that triggered this entity update
|
|
3477
|
+
*/
|
|
3478
|
+
workflow_exec_id?: string;
|
|
3479
|
+
/**
|
|
3480
|
+
* The flow template ID - used to detect and prevent circular triggering
|
|
3481
|
+
*/
|
|
3482
|
+
flow_template_id?: string;
|
|
3483
|
+
};
|
|
3446
3484
|
}
|
|
3447
3485
|
/**
|
|
3448
3486
|
* The user / organization owning this entity.
|
|
@@ -3846,6 +3884,10 @@ declare namespace Components {
|
|
|
3846
3884
|
id?: string;
|
|
3847
3885
|
type?: string;
|
|
3848
3886
|
};
|
|
3887
|
+
/**
|
|
3888
|
+
* Indicates this is a truncated summary schema (attributes trimmed to summary_attributes only, no capabilities or group_settings)
|
|
3889
|
+
*/
|
|
3890
|
+
_summary?: boolean;
|
|
3849
3891
|
slug: /**
|
|
3850
3892
|
* URL-friendly identifier for the entity schema
|
|
3851
3893
|
* example:
|
|
@@ -9474,6 +9516,194 @@ declare namespace Components {
|
|
|
9474
9516
|
*/
|
|
9475
9517
|
display_as?: string;
|
|
9476
9518
|
}
|
|
9519
|
+
/**
|
|
9520
|
+
* Dynamic data table with configurable columns. Data is stored as an array of objects where each object represents a row.
|
|
9521
|
+
*/
|
|
9522
|
+
export interface TableAttribute {
|
|
9523
|
+
/**
|
|
9524
|
+
* ID for the entity attribute
|
|
9525
|
+
* example:
|
|
9526
|
+
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
9527
|
+
*/
|
|
9528
|
+
id?: string;
|
|
9529
|
+
name: string;
|
|
9530
|
+
label: string;
|
|
9531
|
+
placeholder?: string;
|
|
9532
|
+
/**
|
|
9533
|
+
* Do not render attribute in entity views
|
|
9534
|
+
*/
|
|
9535
|
+
hidden?: boolean;
|
|
9536
|
+
/**
|
|
9537
|
+
* Render as a column in table views. When defined, overrides `hidden`
|
|
9538
|
+
*/
|
|
9539
|
+
show_in_table?: boolean;
|
|
9540
|
+
/**
|
|
9541
|
+
* Allow sorting by this attribute in table views if `show_in_table` is true
|
|
9542
|
+
*/
|
|
9543
|
+
sortable?: boolean;
|
|
9544
|
+
required?: boolean;
|
|
9545
|
+
readonly?: boolean;
|
|
9546
|
+
deprecated?: boolean;
|
|
9547
|
+
default_value?: any;
|
|
9548
|
+
/**
|
|
9549
|
+
* Which group the attribute should appear in. Accepts group ID or group name
|
|
9550
|
+
*/
|
|
9551
|
+
group?: string;
|
|
9552
|
+
/**
|
|
9553
|
+
* Attribute sort order (ascending) in group
|
|
9554
|
+
* example:
|
|
9555
|
+
* 0
|
|
9556
|
+
*/
|
|
9557
|
+
order?: number;
|
|
9558
|
+
/**
|
|
9559
|
+
* example:
|
|
9560
|
+
* full_width
|
|
9561
|
+
*/
|
|
9562
|
+
layout?: string;
|
|
9563
|
+
/**
|
|
9564
|
+
* When set to true, will hide the label of the field.
|
|
9565
|
+
*/
|
|
9566
|
+
hide_label?: boolean;
|
|
9567
|
+
/**
|
|
9568
|
+
* Code name of the icon to used to represent this attribute.
|
|
9569
|
+
* The value must be a valid @epilot/base-elements Icon name
|
|
9570
|
+
*
|
|
9571
|
+
*/
|
|
9572
|
+
icon?: string;
|
|
9573
|
+
/**
|
|
9574
|
+
* Defines the conditional rendering expression for showing this field.
|
|
9575
|
+
* When a valid expression is parsed, their evaluation defines the visibility of this attribute.
|
|
9576
|
+
* Note: Empty or invalid expression have no effect on the field visibility.
|
|
9577
|
+
*
|
|
9578
|
+
*/
|
|
9579
|
+
render_condition?: string;
|
|
9580
|
+
_purpose?: /**
|
|
9581
|
+
* example:
|
|
9582
|
+
* taxonomy-slug:classification-slug
|
|
9583
|
+
*/
|
|
9584
|
+
ClassificationId[];
|
|
9585
|
+
/**
|
|
9586
|
+
* Manifest ID used to create/update the schema attribute
|
|
9587
|
+
*/
|
|
9588
|
+
_manifest?: string /* uuid */[] | null;
|
|
9589
|
+
/**
|
|
9590
|
+
* A set of constraints applicable to the attribute.
|
|
9591
|
+
* These constraints should and will be enforced by the attribute renderer.
|
|
9592
|
+
*
|
|
9593
|
+
* example:
|
|
9594
|
+
* {
|
|
9595
|
+
* "disablePast": true
|
|
9596
|
+
* }
|
|
9597
|
+
*/
|
|
9598
|
+
constraints?: {
|
|
9599
|
+
[key: string]: any;
|
|
9600
|
+
};
|
|
9601
|
+
/**
|
|
9602
|
+
* This attribute should only be active when the feature flag is enabled
|
|
9603
|
+
* example:
|
|
9604
|
+
* FF_MY_FEATURE_FLAG
|
|
9605
|
+
*/
|
|
9606
|
+
feature_flag?: string;
|
|
9607
|
+
/**
|
|
9608
|
+
* This attribute should only be active when one of the provided settings have the correct value
|
|
9609
|
+
*/
|
|
9610
|
+
settings_flag?: SettingFlag[];
|
|
9611
|
+
value_formatter?: string;
|
|
9612
|
+
preview_value_formatter?: string;
|
|
9613
|
+
/**
|
|
9614
|
+
* Setting to `true` disables editing the attribute on the entity builder UI
|
|
9615
|
+
*/
|
|
9616
|
+
entity_builder_disable_edit?: boolean;
|
|
9617
|
+
/**
|
|
9618
|
+
* Setting to `true` prevents the attribute from being modified / deleted
|
|
9619
|
+
*/
|
|
9620
|
+
protected?: boolean;
|
|
9621
|
+
/**
|
|
9622
|
+
* A set of configurations meant to document and assist the user in filling the attribute.
|
|
9623
|
+
*/
|
|
9624
|
+
info_helpers?: {
|
|
9625
|
+
/**
|
|
9626
|
+
* The text to be displayed in the attribute hint helper.
|
|
9627
|
+
* When specified it overrides the `hint_text_key` configuration.
|
|
9628
|
+
*
|
|
9629
|
+
*/
|
|
9630
|
+
hint_text?: string;
|
|
9631
|
+
/**
|
|
9632
|
+
* The key of the hint text to be displayed in the attribute hint helper.
|
|
9633
|
+
* The key should be a valid i18n key.
|
|
9634
|
+
*
|
|
9635
|
+
*/
|
|
9636
|
+
hint_text_key?: string;
|
|
9637
|
+
/**
|
|
9638
|
+
* The name of the custom component to be used as the hint helper.
|
|
9639
|
+
* The component should be registered in the `@epilot360/entity-ui` on the index of the components directory.
|
|
9640
|
+
* When specified it overrides the `hint_text` or `hint_text_key` configuration.
|
|
9641
|
+
*
|
|
9642
|
+
*/
|
|
9643
|
+
hint_custom_component?: string;
|
|
9644
|
+
/**
|
|
9645
|
+
* The placement of the hint tooltip.
|
|
9646
|
+
* The value should be a valid `@mui/core` tooltip placement.
|
|
9647
|
+
*
|
|
9648
|
+
* example:
|
|
9649
|
+
* top
|
|
9650
|
+
*/
|
|
9651
|
+
hint_tooltip_placement?: string;
|
|
9652
|
+
};
|
|
9653
|
+
/**
|
|
9654
|
+
* When set to true, this attribute will always be searchable regardless of
|
|
9655
|
+
* the ELASTIC_MAX_SEARCH_FIELDS limit. Use this for critical search fields
|
|
9656
|
+
* that must always be included in search operations.
|
|
9657
|
+
*
|
|
9658
|
+
*/
|
|
9659
|
+
explicit_searchable?: boolean;
|
|
9660
|
+
/**
|
|
9661
|
+
* When set to true, this attribute will be excluded from search fields.
|
|
9662
|
+
* Use this for fields that should not be matched during entity search operations,
|
|
9663
|
+
* such as internal hashes or identifiers that might accidentally match search terms.
|
|
9664
|
+
*
|
|
9665
|
+
*/
|
|
9666
|
+
exclude_from_search?: boolean;
|
|
9667
|
+
/**
|
|
9668
|
+
* The attribute is a repeatable
|
|
9669
|
+
*/
|
|
9670
|
+
repeatable?: boolean;
|
|
9671
|
+
has_primary?: boolean;
|
|
9672
|
+
type: "table";
|
|
9673
|
+
/**
|
|
9674
|
+
* Column definitions for the table
|
|
9675
|
+
*/
|
|
9676
|
+
columns?: {
|
|
9677
|
+
/**
|
|
9678
|
+
* The column identifier (used as object key in row data)
|
|
9679
|
+
*/
|
|
9680
|
+
name: string;
|
|
9681
|
+
/**
|
|
9682
|
+
* Display label for the column header
|
|
9683
|
+
*/
|
|
9684
|
+
label: string;
|
|
9685
|
+
/**
|
|
9686
|
+
* The data type for cells in this column
|
|
9687
|
+
*/
|
|
9688
|
+
type?: "string" | "number" | "date" | "boolean";
|
|
9689
|
+
/**
|
|
9690
|
+
* Optional column width (e.g., "100px", "20%")
|
|
9691
|
+
*/
|
|
9692
|
+
width?: string;
|
|
9693
|
+
/**
|
|
9694
|
+
* Whether this column is required for each row
|
|
9695
|
+
*/
|
|
9696
|
+
required?: boolean;
|
|
9697
|
+
}[];
|
|
9698
|
+
/**
|
|
9699
|
+
* Minimum number of rows required
|
|
9700
|
+
*/
|
|
9701
|
+
min_rows?: number;
|
|
9702
|
+
/**
|
|
9703
|
+
* Maximum number of rows allowed
|
|
9704
|
+
*/
|
|
9705
|
+
max_rows?: number;
|
|
9706
|
+
}
|
|
9477
9707
|
/**
|
|
9478
9708
|
* Tags
|
|
9479
9709
|
*/
|
|
@@ -12171,7 +12401,7 @@ declare namespace Paths {
|
|
|
12171
12401
|
/**
|
|
12172
12402
|
* ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).
|
|
12173
12403
|
* example:
|
|
12174
|
-
* 2023-01-01T00:00:
|
|
12404
|
+
* 2023-01-01T00:00:00Z
|
|
12175
12405
|
*/
|
|
12176
12406
|
export type CreatedAfter = string; // date-time
|
|
12177
12407
|
/**
|
|
@@ -12197,7 +12427,7 @@ declare namespace Paths {
|
|
|
12197
12427
|
created_after?: /**
|
|
12198
12428
|
* ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).
|
|
12199
12429
|
* example:
|
|
12200
|
-
* 2023-01-01T00:00:
|
|
12430
|
+
* 2023-01-01T00:00:00Z
|
|
12201
12431
|
*/
|
|
12202
12432
|
Parameters.CreatedAfter /* date-time */;
|
|
12203
12433
|
sort_pending_first?: /* When true, sorts PENDING status jobs to the top of the results. */ Parameters.SortPendingFirst;
|
|
@@ -12357,11 +12587,32 @@ declare namespace Paths {
|
|
|
12357
12587
|
namespace ListSchemas {
|
|
12358
12588
|
namespace Parameters {
|
|
12359
12589
|
export type Exclude = string[];
|
|
12590
|
+
export type Include = string[];
|
|
12360
12591
|
export type Unpublished = boolean;
|
|
12361
12592
|
}
|
|
12362
12593
|
export interface QueryParameters {
|
|
12363
12594
|
unpublished?: Parameters.Unpublished;
|
|
12364
12595
|
exclude?: Parameters.Exclude;
|
|
12596
|
+
include?: Parameters.Include;
|
|
12597
|
+
}
|
|
12598
|
+
namespace Responses {
|
|
12599
|
+
export interface $200 {
|
|
12600
|
+
results?: /* The "type" of an Entity. Describes the shape. Includes Entity Attributes, Relations and Capabilities. */ Components.Schemas.EntitySchemaItem[];
|
|
12601
|
+
}
|
|
12602
|
+
}
|
|
12603
|
+
}
|
|
12604
|
+
namespace ListSchemasV2 {
|
|
12605
|
+
namespace Parameters {
|
|
12606
|
+
export type Exclude = string[];
|
|
12607
|
+
export type Full = boolean;
|
|
12608
|
+
export type Include = string[];
|
|
12609
|
+
export type Unpublished = boolean;
|
|
12610
|
+
}
|
|
12611
|
+
export interface QueryParameters {
|
|
12612
|
+
full?: Parameters.Full;
|
|
12613
|
+
unpublished?: Parameters.Unpublished;
|
|
12614
|
+
exclude?: Parameters.Exclude;
|
|
12615
|
+
include?: Parameters.Include;
|
|
12365
12616
|
}
|
|
12366
12617
|
namespace Responses {
|
|
12367
12618
|
export interface $200 {
|
|
@@ -13005,9 +13256,11 @@ declare namespace Paths {
|
|
|
13005
13256
|
export interface $200 {
|
|
13006
13257
|
created?: Components.Schemas.TaxonomyClassification[];
|
|
13007
13258
|
updated?: Components.Schemas.TaxonomyClassification[];
|
|
13008
|
-
deleted?:
|
|
13009
|
-
|
|
13010
|
-
|
|
13259
|
+
deleted?: /**
|
|
13260
|
+
* example:
|
|
13261
|
+
* taxonomy-slug:classification-slug
|
|
13262
|
+
*/
|
|
13263
|
+
Components.Schemas.ClassificationId[];
|
|
13011
13264
|
}
|
|
13012
13265
|
export type $404 = /**
|
|
13013
13266
|
* A generic error returned by the API
|
|
@@ -13577,6 +13830,19 @@ export interface OperationMethods {
|
|
|
13577
13830
|
data?: any,
|
|
13578
13831
|
config?: AxiosRequestConfig
|
|
13579
13832
|
): OperationResponse<Paths.ListSchemas.Responses.$200>
|
|
13833
|
+
/**
|
|
13834
|
+
* listSchemasV2 - listSchemasV2
|
|
13835
|
+
*
|
|
13836
|
+
* Get the latest versions of all schemas.
|
|
13837
|
+
* Returns summary schemas by default (only summary attributes, no capabilities).
|
|
13838
|
+
* Use ?full=true for complete schemas.
|
|
13839
|
+
*
|
|
13840
|
+
*/
|
|
13841
|
+
'listSchemasV2'(
|
|
13842
|
+
parameters?: Parameters<Paths.ListSchemasV2.QueryParameters> | null,
|
|
13843
|
+
data?: any,
|
|
13844
|
+
config?: AxiosRequestConfig
|
|
13845
|
+
): OperationResponse<Paths.ListSchemasV2.Responses.$200>
|
|
13580
13846
|
/**
|
|
13581
13847
|
* getSchema - getSchema
|
|
13582
13848
|
*
|
|
@@ -14680,6 +14946,21 @@ export interface PathsDictionary {
|
|
|
14680
14946
|
config?: AxiosRequestConfig
|
|
14681
14947
|
): OperationResponse<Paths.ListSchemas.Responses.$200>
|
|
14682
14948
|
}
|
|
14949
|
+
['/v2/entity/schemas']: {
|
|
14950
|
+
/**
|
|
14951
|
+
* listSchemasV2 - listSchemasV2
|
|
14952
|
+
*
|
|
14953
|
+
* Get the latest versions of all schemas.
|
|
14954
|
+
* Returns summary schemas by default (only summary attributes, no capabilities).
|
|
14955
|
+
* Use ?full=true for complete schemas.
|
|
14956
|
+
*
|
|
14957
|
+
*/
|
|
14958
|
+
'get'(
|
|
14959
|
+
parameters?: Parameters<Paths.ListSchemasV2.QueryParameters> | null,
|
|
14960
|
+
data?: any,
|
|
14961
|
+
config?: AxiosRequestConfig
|
|
14962
|
+
): OperationResponse<Paths.ListSchemasV2.Responses.$200>
|
|
14963
|
+
}
|
|
14683
14964
|
['/v1/entity/schemas/{slug}']: {
|
|
14684
14965
|
/**
|
|
14685
14966
|
* getSchema - getSchema
|
|
@@ -16004,6 +16285,7 @@ export type SettingFlag = Components.Schemas.SettingFlag;
|
|
|
16004
16285
|
export type StatusAttribute = Components.Schemas.StatusAttribute;
|
|
16005
16286
|
export type SummaryAttribute = Components.Schemas.SummaryAttribute;
|
|
16006
16287
|
export type SummaryField = Components.Schemas.SummaryField;
|
|
16288
|
+
export type TableAttribute = Components.Schemas.TableAttribute;
|
|
16007
16289
|
export type TagsAttribute = Components.Schemas.TagsAttribute;
|
|
16008
16290
|
export type Taxonomy = Components.Schemas.Taxonomy;
|
|
16009
16291
|
export type TaxonomyBulkJob = Components.Schemas.TaxonomyBulkJob;
|
package/dist/openapi.json
CHANGED
|
@@ -83,6 +83,95 @@
|
|
|
83
83
|
},
|
|
84
84
|
"style": "form",
|
|
85
85
|
"explode": false
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
"in": "query",
|
|
89
|
+
"name": "include",
|
|
90
|
+
"description": "List of schema slugs to include in the results. When provided, only these schemas are returned. Accepts a comma-separated list of slugs.",
|
|
91
|
+
"schema": {
|
|
92
|
+
"type": "array",
|
|
93
|
+
"items": {
|
|
94
|
+
"type": "string"
|
|
95
|
+
}
|
|
96
|
+
},
|
|
97
|
+
"style": "form",
|
|
98
|
+
"explode": false
|
|
99
|
+
}
|
|
100
|
+
],
|
|
101
|
+
"tags": [
|
|
102
|
+
"Schemas"
|
|
103
|
+
],
|
|
104
|
+
"responses": {
|
|
105
|
+
"200": {
|
|
106
|
+
"description": "Success",
|
|
107
|
+
"content": {
|
|
108
|
+
"application/json": {
|
|
109
|
+
"schema": {
|
|
110
|
+
"type": "object",
|
|
111
|
+
"properties": {
|
|
112
|
+
"results": {
|
|
113
|
+
"type": "array",
|
|
114
|
+
"items": {
|
|
115
|
+
"$ref": "#/components/schemas/EntitySchemaItem"
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
},
|
|
126
|
+
"/v2/entity/schemas": {
|
|
127
|
+
"get": {
|
|
128
|
+
"operationId": "listSchemasV2",
|
|
129
|
+
"summary": "listSchemasV2",
|
|
130
|
+
"description": "Get the latest versions of all schemas.\nReturns summary schemas by default (only summary attributes, no capabilities).\nUse ?full=true for complete schemas.\n",
|
|
131
|
+
"parameters": [
|
|
132
|
+
{
|
|
133
|
+
"in": "query",
|
|
134
|
+
"name": "full",
|
|
135
|
+
"description": "Return full schemas including all attributes and capabilities",
|
|
136
|
+
"schema": {
|
|
137
|
+
"type": "boolean",
|
|
138
|
+
"default": false
|
|
139
|
+
}
|
|
140
|
+
},
|
|
141
|
+
{
|
|
142
|
+
"in": "query",
|
|
143
|
+
"name": "unpublished",
|
|
144
|
+
"description": "Return unpublished draft schemas",
|
|
145
|
+
"schema": {
|
|
146
|
+
"type": "boolean",
|
|
147
|
+
"default": false
|
|
148
|
+
}
|
|
149
|
+
},
|
|
150
|
+
{
|
|
151
|
+
"in": "query",
|
|
152
|
+
"name": "exclude",
|
|
153
|
+
"description": "List of schema slugs to exclude from the results. Accepts a comma-separated list of slugs to exclude from the results.",
|
|
154
|
+
"schema": {
|
|
155
|
+
"type": "array",
|
|
156
|
+
"items": {
|
|
157
|
+
"type": "string"
|
|
158
|
+
}
|
|
159
|
+
},
|
|
160
|
+
"style": "form",
|
|
161
|
+
"explode": false
|
|
162
|
+
},
|
|
163
|
+
{
|
|
164
|
+
"in": "query",
|
|
165
|
+
"name": "include",
|
|
166
|
+
"description": "List of schema slugs to include in the results. When provided, only these schemas are returned. Accepts a comma-separated list of slugs.",
|
|
167
|
+
"schema": {
|
|
168
|
+
"type": "array",
|
|
169
|
+
"items": {
|
|
170
|
+
"type": "string"
|
|
171
|
+
}
|
|
172
|
+
},
|
|
173
|
+
"style": "form",
|
|
174
|
+
"explode": false
|
|
86
175
|
}
|
|
87
176
|
],
|
|
88
177
|
"tags": [
|
|
@@ -3074,7 +3163,7 @@
|
|
|
3074
3163
|
}
|
|
3075
3164
|
},
|
|
3076
3165
|
"deleted": {
|
|
3077
|
-
"type": "
|
|
3166
|
+
"type": "array",
|
|
3078
3167
|
"items": {
|
|
3079
3168
|
"$ref": "#/components/schemas/ClassificationId"
|
|
3080
3169
|
}
|
|
@@ -3468,7 +3557,7 @@
|
|
|
3468
3557
|
"description": "ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).",
|
|
3469
3558
|
"type": "string",
|
|
3470
3559
|
"format": "date-time",
|
|
3471
|
-
"example": "2023-01-01T00:00:
|
|
3560
|
+
"example": "2023-01-01T00:00:00Z"
|
|
3472
3561
|
}
|
|
3473
3562
|
},
|
|
3474
3563
|
{
|
|
@@ -4743,6 +4832,10 @@
|
|
|
4743
4832
|
"type": "string"
|
|
4744
4833
|
}
|
|
4745
4834
|
}
|
|
4835
|
+
},
|
|
4836
|
+
"_summary": {
|
|
4837
|
+
"description": "Indicates this is a truncated summary schema (attributes trimmed to summary_attributes only, no capabilities or group_settings)",
|
|
4838
|
+
"type": "boolean"
|
|
4746
4839
|
}
|
|
4747
4840
|
}
|
|
4748
4841
|
},
|
|
@@ -5004,6 +5097,9 @@
|
|
|
5004
5097
|
{
|
|
5005
5098
|
"$ref": "#/components/schemas/NumberAttribute"
|
|
5006
5099
|
},
|
|
5100
|
+
{
|
|
5101
|
+
"$ref": "#/components/schemas/TableAttribute"
|
|
5102
|
+
},
|
|
5007
5103
|
{
|
|
5008
5104
|
"$ref": "#/components/schemas/ConsentAttribute"
|
|
5009
5105
|
},
|
|
@@ -6244,6 +6340,77 @@
|
|
|
6244
6340
|
}
|
|
6245
6341
|
]
|
|
6246
6342
|
},
|
|
6343
|
+
"TableAttribute": {
|
|
6344
|
+
"allOf": [
|
|
6345
|
+
{
|
|
6346
|
+
"$ref": "#/components/schemas/BaseAttribute"
|
|
6347
|
+
},
|
|
6348
|
+
{
|
|
6349
|
+
"type": "object",
|
|
6350
|
+
"description": "Dynamic data table with configurable columns. Data is stored as an array of objects where each object represents a row.",
|
|
6351
|
+
"properties": {
|
|
6352
|
+
"type": {
|
|
6353
|
+
"type": "string",
|
|
6354
|
+
"enum": [
|
|
6355
|
+
"table"
|
|
6356
|
+
]
|
|
6357
|
+
},
|
|
6358
|
+
"columns": {
|
|
6359
|
+
"type": "array",
|
|
6360
|
+
"description": "Column definitions for the table",
|
|
6361
|
+
"items": {
|
|
6362
|
+
"type": "object",
|
|
6363
|
+
"properties": {
|
|
6364
|
+
"name": {
|
|
6365
|
+
"type": "string",
|
|
6366
|
+
"description": "The column identifier (used as object key in row data)"
|
|
6367
|
+
},
|
|
6368
|
+
"label": {
|
|
6369
|
+
"type": "string",
|
|
6370
|
+
"description": "Display label for the column header"
|
|
6371
|
+
},
|
|
6372
|
+
"type": {
|
|
6373
|
+
"type": "string",
|
|
6374
|
+
"description": "The data type for cells in this column",
|
|
6375
|
+
"enum": [
|
|
6376
|
+
"string",
|
|
6377
|
+
"number",
|
|
6378
|
+
"date",
|
|
6379
|
+
"boolean"
|
|
6380
|
+
],
|
|
6381
|
+
"default": "string"
|
|
6382
|
+
},
|
|
6383
|
+
"width": {
|
|
6384
|
+
"type": "string",
|
|
6385
|
+
"description": "Optional column width (e.g., \"100px\", \"20%\")"
|
|
6386
|
+
},
|
|
6387
|
+
"required": {
|
|
6388
|
+
"type": "boolean",
|
|
6389
|
+
"description": "Whether this column is required for each row",
|
|
6390
|
+
"default": false
|
|
6391
|
+
}
|
|
6392
|
+
},
|
|
6393
|
+
"required": [
|
|
6394
|
+
"name",
|
|
6395
|
+
"label"
|
|
6396
|
+
]
|
|
6397
|
+
}
|
|
6398
|
+
},
|
|
6399
|
+
"min_rows": {
|
|
6400
|
+
"type": "integer",
|
|
6401
|
+
"description": "Minimum number of rows required",
|
|
6402
|
+
"minimum": 0,
|
|
6403
|
+
"default": 0
|
|
6404
|
+
},
|
|
6405
|
+
"max_rows": {
|
|
6406
|
+
"type": "integer",
|
|
6407
|
+
"description": "Maximum number of rows allowed",
|
|
6408
|
+
"minimum": 1
|
|
6409
|
+
}
|
|
6410
|
+
}
|
|
6411
|
+
}
|
|
6412
|
+
]
|
|
6413
|
+
},
|
|
6247
6414
|
"ConsentAttribute": {
|
|
6248
6415
|
"allOf": [
|
|
6249
6416
|
{
|
|
@@ -6746,6 +6913,24 @@
|
|
|
6746
6913
|
"items": {
|
|
6747
6914
|
"$ref": "#/components/schemas/SettingFlag"
|
|
6748
6915
|
}
|
|
6916
|
+
},
|
|
6917
|
+
"schemas": {
|
|
6918
|
+
"type": "array",
|
|
6919
|
+
"description": "Schema-specific configuration for the capability",
|
|
6920
|
+
"items": {
|
|
6921
|
+
"type": "object",
|
|
6922
|
+
"additionalProperties": true,
|
|
6923
|
+
"required": [
|
|
6924
|
+
"schema"
|
|
6925
|
+
],
|
|
6926
|
+
"properties": {
|
|
6927
|
+
"schema": {
|
|
6928
|
+
"type": "string",
|
|
6929
|
+
"description": "Entity schema slug",
|
|
6930
|
+
"example": "contact"
|
|
6931
|
+
}
|
|
6932
|
+
}
|
|
6933
|
+
}
|
|
6749
6934
|
}
|
|
6750
6935
|
},
|
|
6751
6936
|
"required": [
|
|
@@ -7070,10 +7255,13 @@
|
|
|
7070
7255
|
}
|
|
7071
7256
|
},
|
|
7072
7257
|
"NullableEntity": {
|
|
7073
|
-
"nullable": true,
|
|
7074
7258
|
"allOf": [
|
|
7075
7259
|
{
|
|
7076
7260
|
"$ref": "#/components/schemas/Entity"
|
|
7261
|
+
},
|
|
7262
|
+
{
|
|
7263
|
+
"type": "object",
|
|
7264
|
+
"nullable": true
|
|
7077
7265
|
}
|
|
7078
7266
|
]
|
|
7079
7267
|
},
|
|
@@ -8467,6 +8655,20 @@
|
|
|
8467
8655
|
]
|
|
8468
8656
|
}
|
|
8469
8657
|
}
|
|
8658
|
+
},
|
|
8659
|
+
"_workflow_origin": {
|
|
8660
|
+
"type": "object",
|
|
8661
|
+
"description": "Internal property for workflow origin tracking and infinite loop prevention.\nPopulated when an entity update originates from a workflow execution.\nThis allows downstream automation services to prevent circular triggering.\n",
|
|
8662
|
+
"properties": {
|
|
8663
|
+
"workflow_exec_id": {
|
|
8664
|
+
"type": "string",
|
|
8665
|
+
"description": "The ID of the workflow execution that triggered this entity update"
|
|
8666
|
+
},
|
|
8667
|
+
"flow_template_id": {
|
|
8668
|
+
"type": "string",
|
|
8669
|
+
"description": "The flow template ID - used to detect and prevent circular triggering"
|
|
8670
|
+
}
|
|
8671
|
+
}
|
|
8470
8672
|
}
|
|
8471
8673
|
},
|
|
8472
8674
|
"required": [
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/entity-client",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "7.0.0-rc.1",
|
|
4
4
|
"description": "JavaScript client library for the epilot Core Entity API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -22,17 +22,17 @@
|
|
|
22
22
|
"entity"
|
|
23
23
|
],
|
|
24
24
|
"scripts": {
|
|
25
|
-
"test": "
|
|
25
|
+
"test": "vitest",
|
|
26
26
|
"typescript": "tsc",
|
|
27
27
|
"bundle-definition": "webpack",
|
|
28
28
|
"prepublishOnly": "npm run typegen && npm run build",
|
|
29
29
|
"openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/entity.yaml",
|
|
30
|
-
"typegen": "openapi typegen src/openapi.json --client
|
|
30
|
+
"typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
|
|
31
31
|
"build": "tsc && npm run build:patch && npm run bundle-definition",
|
|
32
32
|
"build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
|
|
33
33
|
"build:watch": "npm run build && tsc -w",
|
|
34
34
|
"release-alpha": "npm version prerelease --preid alpha",
|
|
35
|
-
"lint": "
|
|
35
|
+
"lint": "biome check src"
|
|
36
36
|
},
|
|
37
37
|
"files": [
|
|
38
38
|
"*.js",
|
|
@@ -60,13 +60,10 @@
|
|
|
60
60
|
"util": "^0.12.3"
|
|
61
61
|
},
|
|
62
62
|
"devDependencies": {
|
|
63
|
-
"@types/jest": "^26.0.20",
|
|
64
63
|
"axios": "^1.11.0",
|
|
65
64
|
"copy-webpack-plugin": "^7.0.0",
|
|
66
|
-
"jest": "^29.6.2",
|
|
67
65
|
"json-loader": "^0.5.7",
|
|
68
66
|
"openapicmd": "^2.7.0",
|
|
69
|
-
"ts-jest": "^29.4.1",
|
|
70
67
|
"ts-loader": "^8.0.14",
|
|
71
68
|
"ts-node": "^10.9.1",
|
|
72
69
|
"typescript": "^4.1.3",
|