@epilot/entity-client 6.6.1 → 6.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +75 -0
- package/dist/openapi.d.ts +310 -0
- package/dist/openapi.json +304 -1
- package/package.json +18 -17
- package/LICENSE +0 -21
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={390: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"}],"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/{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"},{"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"}],"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":{"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}(390),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
|
|
1
|
+
(()=>{"use strict";var e={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"}],"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/{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"},{"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"}],"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":{}}},"/v1/entity/{id}/collections":{"get":{"operationId":"getFileCollections","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"}],"responses":{}},"post":{"operationId":"createFileCollection","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{id}/collections/{collection_id}":{"get":{"operationId":"getFileCollection","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/CollectionIdPathParam"}],"responses":{}},"put":{"operationId":"updateFileCollection","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/CollectionIdPathParam"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteFileCollection","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/CollectionIdPathParam"}],"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"},"CollectionIdPathParam":{"name":"collection_id","in":"path","required":true}},"responses":{"NotFoundError":{"content":{"application/json":{}}},"TooManyRequestsError":{"headers":{"Retry-After":{}},"content":{"application/json":{}}}}},"servers":[{"url":"https://entity.sls.epilot.io"}]}')},757: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}},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}(757),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
|
|
@@ -1421,6 +1421,76 @@
|
|
|
1421
1421
|
],
|
|
1422
1422
|
"responses": {}
|
|
1423
1423
|
}
|
|
1424
|
+
},
|
|
1425
|
+
"/v1/entity/{id}/collections": {
|
|
1426
|
+
"get": {
|
|
1427
|
+
"operationId": "getFileCollections",
|
|
1428
|
+
"parameters": [
|
|
1429
|
+
{
|
|
1430
|
+
"$ref": "#/components/parameters/EntityIdPathParam"
|
|
1431
|
+
}
|
|
1432
|
+
],
|
|
1433
|
+
"responses": {}
|
|
1434
|
+
},
|
|
1435
|
+
"post": {
|
|
1436
|
+
"operationId": "createFileCollection",
|
|
1437
|
+
"parameters": [
|
|
1438
|
+
{
|
|
1439
|
+
"$ref": "#/components/parameters/EntityIdPathParam"
|
|
1440
|
+
}
|
|
1441
|
+
],
|
|
1442
|
+
"requestBody": {
|
|
1443
|
+
"required": true,
|
|
1444
|
+
"content": {
|
|
1445
|
+
"application/json": {}
|
|
1446
|
+
}
|
|
1447
|
+
},
|
|
1448
|
+
"responses": {}
|
|
1449
|
+
}
|
|
1450
|
+
},
|
|
1451
|
+
"/v1/entity/{id}/collections/{collection_id}": {
|
|
1452
|
+
"get": {
|
|
1453
|
+
"operationId": "getFileCollection",
|
|
1454
|
+
"parameters": [
|
|
1455
|
+
{
|
|
1456
|
+
"$ref": "#/components/parameters/EntityIdPathParam"
|
|
1457
|
+
},
|
|
1458
|
+
{
|
|
1459
|
+
"$ref": "#/components/parameters/CollectionIdPathParam"
|
|
1460
|
+
}
|
|
1461
|
+
],
|
|
1462
|
+
"responses": {}
|
|
1463
|
+
},
|
|
1464
|
+
"put": {
|
|
1465
|
+
"operationId": "updateFileCollection",
|
|
1466
|
+
"parameters": [
|
|
1467
|
+
{
|
|
1468
|
+
"$ref": "#/components/parameters/EntityIdPathParam"
|
|
1469
|
+
},
|
|
1470
|
+
{
|
|
1471
|
+
"$ref": "#/components/parameters/CollectionIdPathParam"
|
|
1472
|
+
}
|
|
1473
|
+
],
|
|
1474
|
+
"requestBody": {
|
|
1475
|
+
"required": true,
|
|
1476
|
+
"content": {
|
|
1477
|
+
"application/json": {}
|
|
1478
|
+
}
|
|
1479
|
+
},
|
|
1480
|
+
"responses": {}
|
|
1481
|
+
},
|
|
1482
|
+
"delete": {
|
|
1483
|
+
"operationId": "deleteFileCollection",
|
|
1484
|
+
"parameters": [
|
|
1485
|
+
{
|
|
1486
|
+
"$ref": "#/components/parameters/EntityIdPathParam"
|
|
1487
|
+
},
|
|
1488
|
+
{
|
|
1489
|
+
"$ref": "#/components/parameters/CollectionIdPathParam"
|
|
1490
|
+
}
|
|
1491
|
+
],
|
|
1492
|
+
"responses": {}
|
|
1493
|
+
}
|
|
1424
1494
|
}
|
|
1425
1495
|
},
|
|
1426
1496
|
"components": {
|
|
@@ -1528,6 +1598,11 @@
|
|
|
1528
1598
|
"ValidateEntityQueryParam": {
|
|
1529
1599
|
"name": "validate",
|
|
1530
1600
|
"in": "query"
|
|
1601
|
+
},
|
|
1602
|
+
"CollectionIdPathParam": {
|
|
1603
|
+
"name": "collection_id",
|
|
1604
|
+
"in": "path",
|
|
1605
|
+
"required": true
|
|
1531
1606
|
}
|
|
1532
1607
|
},
|
|
1533
1608
|
"responses": {
|
package/dist/openapi.d.ts
CHANGED
|
@@ -23,6 +23,7 @@ declare namespace Components {
|
|
|
23
23
|
*/
|
|
24
24
|
Schemas.ActivityId /* ulid ^01[0-9a-zA-Z]{24}$ */ | ("" | null);
|
|
25
25
|
export type AsyncOperationQueryParam = boolean;
|
|
26
|
+
export type CollectionIdPathParam = string; // uuid
|
|
26
27
|
export type DryRunQueryParam = boolean;
|
|
27
28
|
export type EntityIdPathParam = Schemas.EntityId /* uuid */;
|
|
28
29
|
export type EntityRelationsModeQueryParam = "direct" | "reverse" | "both";
|
|
@@ -75,6 +76,7 @@ declare namespace Components {
|
|
|
75
76
|
TaxonomyClassificationSlugPathParam?: Parameters.TaxonomyClassificationSlugPathParam;
|
|
76
77
|
SavedViewIdPathParam?: Parameters.SavedViewIdPathParam;
|
|
77
78
|
ActivityIdPathParam?: Parameters.ActivityIdPathParam;
|
|
79
|
+
CollectionIdPathParam?: Parameters.CollectionIdPathParam /* uuid */;
|
|
78
80
|
}
|
|
79
81
|
export interface QueryParameters {
|
|
80
82
|
TaxonomySlugQueryParam?: Parameters.TaxonomySlugQueryParam;
|
|
@@ -4279,6 +4281,95 @@ declare namespace Components {
|
|
|
4279
4281
|
enable_description?: boolean;
|
|
4280
4282
|
default_access_control?: "public-read" | "private";
|
|
4281
4283
|
}
|
|
4284
|
+
export interface FileCollectionAttributes {
|
|
4285
|
+
/**
|
|
4286
|
+
* Name of the file collection
|
|
4287
|
+
*/
|
|
4288
|
+
name?: string;
|
|
4289
|
+
/**
|
|
4290
|
+
* Whether the collection is starred
|
|
4291
|
+
*/
|
|
4292
|
+
starred?: boolean;
|
|
4293
|
+
/**
|
|
4294
|
+
* Array of file IDs in this collection
|
|
4295
|
+
*/
|
|
4296
|
+
files?: string /* uuid */[];
|
|
4297
|
+
}
|
|
4298
|
+
/**
|
|
4299
|
+
* Request body for creating a file collection
|
|
4300
|
+
*/
|
|
4301
|
+
export interface FileCollectionCreateRequest {
|
|
4302
|
+
/**
|
|
4303
|
+
* Name of the file collection
|
|
4304
|
+
*/
|
|
4305
|
+
name: string;
|
|
4306
|
+
/**
|
|
4307
|
+
* Whether the collection is starred
|
|
4308
|
+
*/
|
|
4309
|
+
starred: boolean;
|
|
4310
|
+
/**
|
|
4311
|
+
* Array of file IDs in this collection
|
|
4312
|
+
*/
|
|
4313
|
+
files: string /* uuid */[];
|
|
4314
|
+
}
|
|
4315
|
+
/**
|
|
4316
|
+
* Generated uuid for a file collection
|
|
4317
|
+
*/
|
|
4318
|
+
export type FileCollectionId = string; // uuid
|
|
4319
|
+
/**
|
|
4320
|
+
* A file collection with identifiers and timestamps
|
|
4321
|
+
*/
|
|
4322
|
+
export interface FileCollectionItem {
|
|
4323
|
+
id: /* Generated uuid for a file collection */ FileCollectionId /* uuid */;
|
|
4324
|
+
/**
|
|
4325
|
+
* Organization ID
|
|
4326
|
+
* example:
|
|
4327
|
+
* 123
|
|
4328
|
+
*/
|
|
4329
|
+
orgId: string;
|
|
4330
|
+
entityId: EntityId /* uuid */;
|
|
4331
|
+
/**
|
|
4332
|
+
* Logical type for this item (e.g. "collection")
|
|
4333
|
+
* example:
|
|
4334
|
+
* collection
|
|
4335
|
+
*/
|
|
4336
|
+
type: string;
|
|
4337
|
+
/**
|
|
4338
|
+
* example:
|
|
4339
|
+
* MyCollectionOfImportantFiles
|
|
4340
|
+
*/
|
|
4341
|
+
name: string;
|
|
4342
|
+
entity_id: EntityId /* uuid */;
|
|
4343
|
+
/**
|
|
4344
|
+
* example:
|
|
4345
|
+
* false
|
|
4346
|
+
*/
|
|
4347
|
+
starred: boolean;
|
|
4348
|
+
/**
|
|
4349
|
+
* Array of file IDs in this collection
|
|
4350
|
+
* example:
|
|
4351
|
+
* [
|
|
4352
|
+
* "123e4567-e89b-12d3-a456-426614174000"
|
|
4353
|
+
* ]
|
|
4354
|
+
*/
|
|
4355
|
+
files: string /* uuid */[];
|
|
4356
|
+
/**
|
|
4357
|
+
* User ID who created the collection
|
|
4358
|
+
* example:
|
|
4359
|
+
* 17622
|
|
4360
|
+
*/
|
|
4361
|
+
created_by: string;
|
|
4362
|
+
/**
|
|
4363
|
+
* example:
|
|
4364
|
+
* 2025-08-20T12:01:00Z
|
|
4365
|
+
*/
|
|
4366
|
+
created_at: string; // date-time
|
|
4367
|
+
/**
|
|
4368
|
+
* example:
|
|
4369
|
+
* 2025-08-20T12:01:00Z
|
|
4370
|
+
*/
|
|
4371
|
+
updated_at: string; // date-time
|
|
4372
|
+
}
|
|
4282
4373
|
export interface GenerateEntityTableAIFiltersRequest {
|
|
4283
4374
|
/**
|
|
4284
4375
|
* The prompt to generate the filters
|
|
@@ -9240,6 +9331,27 @@ declare namespace Paths {
|
|
|
9240
9331
|
Components.Responses.TooManyRequestsError;
|
|
9241
9332
|
}
|
|
9242
9333
|
}
|
|
9334
|
+
namespace CreateFileCollection {
|
|
9335
|
+
namespace Parameters {
|
|
9336
|
+
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
9337
|
+
}
|
|
9338
|
+
export interface PathParameters {
|
|
9339
|
+
id: Parameters.Id;
|
|
9340
|
+
}
|
|
9341
|
+
export type RequestBody = /* Request body for creating a file collection */ Components.Schemas.FileCollectionCreateRequest;
|
|
9342
|
+
namespace Responses {
|
|
9343
|
+
export type $201 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem;
|
|
9344
|
+
export type $404 = /**
|
|
9345
|
+
* A generic error returned by the API
|
|
9346
|
+
* example:
|
|
9347
|
+
* {
|
|
9348
|
+
* "status": 404,
|
|
9349
|
+
* "error": "Not Found"
|
|
9350
|
+
* }
|
|
9351
|
+
*/
|
|
9352
|
+
Components.Responses.NotFoundError;
|
|
9353
|
+
}
|
|
9354
|
+
}
|
|
9243
9355
|
namespace CreateSavedView {
|
|
9244
9356
|
export type RequestBody = /* A saved entity view */ Components.Schemas.SavedView;
|
|
9245
9357
|
namespace Responses {
|
|
@@ -9386,6 +9498,29 @@ declare namespace Paths {
|
|
|
9386
9498
|
Components.Responses.TooManyRequestsError;
|
|
9387
9499
|
}
|
|
9388
9500
|
}
|
|
9501
|
+
namespace DeleteFileCollection {
|
|
9502
|
+
namespace Parameters {
|
|
9503
|
+
export type CollectionId = string; // uuid
|
|
9504
|
+
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
9505
|
+
}
|
|
9506
|
+
export interface PathParameters {
|
|
9507
|
+
id: Parameters.Id;
|
|
9508
|
+
collection_id: Parameters.CollectionId /* uuid */;
|
|
9509
|
+
}
|
|
9510
|
+
namespace Responses {
|
|
9511
|
+
export interface $200 {
|
|
9512
|
+
}
|
|
9513
|
+
export type $404 = /**
|
|
9514
|
+
* A generic error returned by the API
|
|
9515
|
+
* example:
|
|
9516
|
+
* {
|
|
9517
|
+
* "status": 404,
|
|
9518
|
+
* "error": "Not Found"
|
|
9519
|
+
* }
|
|
9520
|
+
*/
|
|
9521
|
+
Components.Responses.NotFoundError;
|
|
9522
|
+
}
|
|
9523
|
+
}
|
|
9389
9524
|
namespace DeleteRelation {
|
|
9390
9525
|
namespace Parameters {
|
|
9391
9526
|
export type ActivityId = /**
|
|
@@ -10008,6 +10143,50 @@ declare namespace Paths {
|
|
|
10008
10143
|
Components.Responses.NotFoundError;
|
|
10009
10144
|
}
|
|
10010
10145
|
}
|
|
10146
|
+
namespace GetFileCollection {
|
|
10147
|
+
namespace Parameters {
|
|
10148
|
+
export type CollectionId = string; // uuid
|
|
10149
|
+
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
10150
|
+
}
|
|
10151
|
+
export interface PathParameters {
|
|
10152
|
+
id: Parameters.Id;
|
|
10153
|
+
collection_id: Parameters.CollectionId /* uuid */;
|
|
10154
|
+
}
|
|
10155
|
+
namespace Responses {
|
|
10156
|
+
export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem;
|
|
10157
|
+
export type $404 = /**
|
|
10158
|
+
* A generic error returned by the API
|
|
10159
|
+
* example:
|
|
10160
|
+
* {
|
|
10161
|
+
* "status": 404,
|
|
10162
|
+
* "error": "Not Found"
|
|
10163
|
+
* }
|
|
10164
|
+
*/
|
|
10165
|
+
Components.Responses.NotFoundError;
|
|
10166
|
+
}
|
|
10167
|
+
}
|
|
10168
|
+
namespace GetFileCollections {
|
|
10169
|
+
namespace Parameters {
|
|
10170
|
+
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
10171
|
+
}
|
|
10172
|
+
export interface PathParameters {
|
|
10173
|
+
id: Parameters.Id;
|
|
10174
|
+
}
|
|
10175
|
+
namespace Responses {
|
|
10176
|
+
export interface $200 {
|
|
10177
|
+
results?: /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem[];
|
|
10178
|
+
}
|
|
10179
|
+
export type $404 = /**
|
|
10180
|
+
* A generic error returned by the API
|
|
10181
|
+
* example:
|
|
10182
|
+
* {
|
|
10183
|
+
* "status": 404,
|
|
10184
|
+
* "error": "Not Found"
|
|
10185
|
+
* }
|
|
10186
|
+
*/
|
|
10187
|
+
Components.Responses.NotFoundError;
|
|
10188
|
+
}
|
|
10189
|
+
}
|
|
10011
10190
|
namespace GetJsonSchema {
|
|
10012
10191
|
namespace Parameters {
|
|
10013
10192
|
export type Dereference = boolean;
|
|
@@ -11787,6 +11966,29 @@ declare namespace Paths {
|
|
|
11787
11966
|
export type $422 = /* Validation result for a failed validation */ Components.Schemas.EntityValidationV2ResultError;
|
|
11788
11967
|
}
|
|
11789
11968
|
}
|
|
11969
|
+
namespace UpdateFileCollection {
|
|
11970
|
+
namespace Parameters {
|
|
11971
|
+
export type CollectionId = string; // uuid
|
|
11972
|
+
export type Id = Components.Schemas.EntityId /* uuid */;
|
|
11973
|
+
}
|
|
11974
|
+
export interface PathParameters {
|
|
11975
|
+
id: Parameters.Id;
|
|
11976
|
+
collection_id: Parameters.CollectionId /* uuid */;
|
|
11977
|
+
}
|
|
11978
|
+
export type RequestBody = Components.Schemas.FileCollectionAttributes;
|
|
11979
|
+
namespace Responses {
|
|
11980
|
+
export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem;
|
|
11981
|
+
export type $404 = /**
|
|
11982
|
+
* A generic error returned by the API
|
|
11983
|
+
* example:
|
|
11984
|
+
* {
|
|
11985
|
+
* "status": 404,
|
|
11986
|
+
* "error": "Not Found"
|
|
11987
|
+
* }
|
|
11988
|
+
*/
|
|
11989
|
+
Components.Responses.NotFoundError;
|
|
11990
|
+
}
|
|
11991
|
+
}
|
|
11790
11992
|
namespace UpdateRelation {
|
|
11791
11993
|
namespace Parameters {
|
|
11792
11994
|
export type ActivityId = /**
|
|
@@ -13291,6 +13493,56 @@ export interface OperationMethods {
|
|
|
13291
13493
|
data?: any,
|
|
13292
13494
|
config?: AxiosRequestConfig
|
|
13293
13495
|
): OperationResponse<Paths.DeleteSchemaGroupHeadline.Responses.$200>
|
|
13496
|
+
/**
|
|
13497
|
+
* getFileCollections - getFileCollections
|
|
13498
|
+
*
|
|
13499
|
+
* Gets a list of collections that exist for an entity
|
|
13500
|
+
*/
|
|
13501
|
+
'getFileCollections'(
|
|
13502
|
+
parameters?: Parameters<Paths.GetFileCollections.PathParameters> | null,
|
|
13503
|
+
data?: any,
|
|
13504
|
+
config?: AxiosRequestConfig
|
|
13505
|
+
): OperationResponse<Paths.GetFileCollections.Responses.$200>
|
|
13506
|
+
/**
|
|
13507
|
+
* createFileCollection - createFileCollection
|
|
13508
|
+
*
|
|
13509
|
+
* Creates a new file collection for the specified entity
|
|
13510
|
+
*/
|
|
13511
|
+
'createFileCollection'(
|
|
13512
|
+
parameters?: Parameters<Paths.CreateFileCollection.PathParameters> | null,
|
|
13513
|
+
data?: Paths.CreateFileCollection.RequestBody,
|
|
13514
|
+
config?: AxiosRequestConfig
|
|
13515
|
+
): OperationResponse<Paths.CreateFileCollection.Responses.$201>
|
|
13516
|
+
/**
|
|
13517
|
+
* getFileCollection - getFileCollection
|
|
13518
|
+
*
|
|
13519
|
+
* Gets a specific file collection by ID
|
|
13520
|
+
*/
|
|
13521
|
+
'getFileCollection'(
|
|
13522
|
+
parameters?: Parameters<Paths.GetFileCollection.PathParameters> | null,
|
|
13523
|
+
data?: any,
|
|
13524
|
+
config?: AxiosRequestConfig
|
|
13525
|
+
): OperationResponse<Paths.GetFileCollection.Responses.$200>
|
|
13526
|
+
/**
|
|
13527
|
+
* updateFileCollection - updateFileCollection
|
|
13528
|
+
*
|
|
13529
|
+
* Updates a specific file collection by ID
|
|
13530
|
+
*/
|
|
13531
|
+
'updateFileCollection'(
|
|
13532
|
+
parameters?: Parameters<Paths.UpdateFileCollection.PathParameters> | null,
|
|
13533
|
+
data?: Paths.UpdateFileCollection.RequestBody,
|
|
13534
|
+
config?: AxiosRequestConfig
|
|
13535
|
+
): OperationResponse<Paths.UpdateFileCollection.Responses.$200>
|
|
13536
|
+
/**
|
|
13537
|
+
* deleteFileCollection - deleteFileCollection
|
|
13538
|
+
*
|
|
13539
|
+
* Deletes a specific file collection by ID
|
|
13540
|
+
*/
|
|
13541
|
+
'deleteFileCollection'(
|
|
13542
|
+
parameters?: Parameters<Paths.DeleteFileCollection.PathParameters> | null,
|
|
13543
|
+
data?: any,
|
|
13544
|
+
config?: AxiosRequestConfig
|
|
13545
|
+
): OperationResponse<Paths.DeleteFileCollection.Responses.$200>
|
|
13294
13546
|
}
|
|
13295
13547
|
|
|
13296
13548
|
export interface PathsDictionary {
|
|
@@ -14488,6 +14740,60 @@ export interface PathsDictionary {
|
|
|
14488
14740
|
config?: AxiosRequestConfig
|
|
14489
14741
|
): OperationResponse<Paths.DeleteSchemaGroupHeadline.Responses.$200>
|
|
14490
14742
|
}
|
|
14743
|
+
['/v1/entity/{id}/collections']: {
|
|
14744
|
+
/**
|
|
14745
|
+
* getFileCollections - getFileCollections
|
|
14746
|
+
*
|
|
14747
|
+
* Gets a list of collections that exist for an entity
|
|
14748
|
+
*/
|
|
14749
|
+
'get'(
|
|
14750
|
+
parameters?: Parameters<Paths.GetFileCollections.PathParameters> | null,
|
|
14751
|
+
data?: any,
|
|
14752
|
+
config?: AxiosRequestConfig
|
|
14753
|
+
): OperationResponse<Paths.GetFileCollections.Responses.$200>
|
|
14754
|
+
/**
|
|
14755
|
+
* createFileCollection - createFileCollection
|
|
14756
|
+
*
|
|
14757
|
+
* Creates a new file collection for the specified entity
|
|
14758
|
+
*/
|
|
14759
|
+
'post'(
|
|
14760
|
+
parameters?: Parameters<Paths.CreateFileCollection.PathParameters> | null,
|
|
14761
|
+
data?: Paths.CreateFileCollection.RequestBody,
|
|
14762
|
+
config?: AxiosRequestConfig
|
|
14763
|
+
): OperationResponse<Paths.CreateFileCollection.Responses.$201>
|
|
14764
|
+
}
|
|
14765
|
+
['/v1/entity/{id}/collections/{collection_id}']: {
|
|
14766
|
+
/**
|
|
14767
|
+
* getFileCollection - getFileCollection
|
|
14768
|
+
*
|
|
14769
|
+
* Gets a specific file collection by ID
|
|
14770
|
+
*/
|
|
14771
|
+
'get'(
|
|
14772
|
+
parameters?: Parameters<Paths.GetFileCollection.PathParameters> | null,
|
|
14773
|
+
data?: any,
|
|
14774
|
+
config?: AxiosRequestConfig
|
|
14775
|
+
): OperationResponse<Paths.GetFileCollection.Responses.$200>
|
|
14776
|
+
/**
|
|
14777
|
+
* updateFileCollection - updateFileCollection
|
|
14778
|
+
*
|
|
14779
|
+
* Updates a specific file collection by ID
|
|
14780
|
+
*/
|
|
14781
|
+
'put'(
|
|
14782
|
+
parameters?: Parameters<Paths.UpdateFileCollection.PathParameters> | null,
|
|
14783
|
+
data?: Paths.UpdateFileCollection.RequestBody,
|
|
14784
|
+
config?: AxiosRequestConfig
|
|
14785
|
+
): OperationResponse<Paths.UpdateFileCollection.Responses.$200>
|
|
14786
|
+
/**
|
|
14787
|
+
* deleteFileCollection - deleteFileCollection
|
|
14788
|
+
*
|
|
14789
|
+
* Deletes a specific file collection by ID
|
|
14790
|
+
*/
|
|
14791
|
+
'delete'(
|
|
14792
|
+
parameters?: Parameters<Paths.DeleteFileCollection.PathParameters> | null,
|
|
14793
|
+
data?: any,
|
|
14794
|
+
config?: AxiosRequestConfig
|
|
14795
|
+
): OperationResponse<Paths.DeleteFileCollection.Responses.$200>
|
|
14796
|
+
}
|
|
14491
14797
|
}
|
|
14492
14798
|
|
|
14493
14799
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
@@ -14556,6 +14862,10 @@ export type ErrorObject = Components.Schemas.ErrorObject;
|
|
|
14556
14862
|
export type ExportJobId = Components.Schemas.ExportJobId;
|
|
14557
14863
|
export type FieldsParam = Components.Schemas.FieldsParam;
|
|
14558
14864
|
export type FileAttribute = Components.Schemas.FileAttribute;
|
|
14865
|
+
export type FileCollectionAttributes = Components.Schemas.FileCollectionAttributes;
|
|
14866
|
+
export type FileCollectionCreateRequest = Components.Schemas.FileCollectionCreateRequest;
|
|
14867
|
+
export type FileCollectionId = Components.Schemas.FileCollectionId;
|
|
14868
|
+
export type FileCollectionItem = Components.Schemas.FileCollectionItem;
|
|
14559
14869
|
export type GenerateEntityTableAIFiltersRequest = Components.Schemas.GenerateEntityTableAIFiltersRequest;
|
|
14560
14870
|
export type GenerateEntityTableAIFiltersResponse = Components.Schemas.GenerateEntityTableAIFiltersResponse;
|
|
14561
14871
|
export type GetRelatedEntitiesCount = Components.Schemas.GetRelatedEntitiesCount;
|
package/dist/openapi.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"openapi": "3.0.2",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Entity API",
|
|
5
|
-
"version": "1.
|
|
5
|
+
"version": "1.2.0",
|
|
6
6
|
"description": "Flexible data layer for epilot Entities.\n\nUse this API configure and access your business objects like Contacts, Opportunities and Products.\n\n[Feature Documentation](https://docs.epilot.io/docs/entities/flexible-entities)\n"
|
|
7
7
|
},
|
|
8
8
|
"tags": [
|
|
@@ -45,6 +45,10 @@
|
|
|
45
45
|
{
|
|
46
46
|
"name": "Public",
|
|
47
47
|
"description": "Public"
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"name": "File Collections",
|
|
51
|
+
"description": "Collections of files associated with the entity"
|
|
48
52
|
}
|
|
49
53
|
],
|
|
50
54
|
"security": [
|
|
@@ -4311,6 +4315,180 @@
|
|
|
4311
4315
|
}
|
|
4312
4316
|
}
|
|
4313
4317
|
}
|
|
4318
|
+
},
|
|
4319
|
+
"/v1/entity/{id}/collections": {
|
|
4320
|
+
"get": {
|
|
4321
|
+
"operationId": "getFileCollections",
|
|
4322
|
+
"summary": "getFileCollections",
|
|
4323
|
+
"description": "Gets a list of collections that exist for an entity",
|
|
4324
|
+
"tags": [
|
|
4325
|
+
"File Collections"
|
|
4326
|
+
],
|
|
4327
|
+
"parameters": [
|
|
4328
|
+
{
|
|
4329
|
+
"$ref": "#/components/parameters/EntityIdPathParam"
|
|
4330
|
+
}
|
|
4331
|
+
],
|
|
4332
|
+
"responses": {
|
|
4333
|
+
"200": {
|
|
4334
|
+
"description": "List of collections the entity is part of",
|
|
4335
|
+
"content": {
|
|
4336
|
+
"application/json": {
|
|
4337
|
+
"schema": {
|
|
4338
|
+
"type": "object",
|
|
4339
|
+
"properties": {
|
|
4340
|
+
"results": {
|
|
4341
|
+
"type": "array",
|
|
4342
|
+
"items": {
|
|
4343
|
+
"$ref": "#/components/schemas/FileCollectionItem"
|
|
4344
|
+
}
|
|
4345
|
+
}
|
|
4346
|
+
}
|
|
4347
|
+
}
|
|
4348
|
+
}
|
|
4349
|
+
}
|
|
4350
|
+
},
|
|
4351
|
+
"404": {
|
|
4352
|
+
"$ref": "#/components/responses/NotFoundError"
|
|
4353
|
+
}
|
|
4354
|
+
}
|
|
4355
|
+
},
|
|
4356
|
+
"post": {
|
|
4357
|
+
"operationId": "createFileCollection",
|
|
4358
|
+
"summary": "createFileCollection",
|
|
4359
|
+
"description": "Creates a new file collection for the specified entity",
|
|
4360
|
+
"tags": [
|
|
4361
|
+
"File Collections"
|
|
4362
|
+
],
|
|
4363
|
+
"parameters": [
|
|
4364
|
+
{
|
|
4365
|
+
"$ref": "#/components/parameters/EntityIdPathParam"
|
|
4366
|
+
}
|
|
4367
|
+
],
|
|
4368
|
+
"requestBody": {
|
|
4369
|
+
"required": true,
|
|
4370
|
+
"content": {
|
|
4371
|
+
"application/json": {
|
|
4372
|
+
"schema": {
|
|
4373
|
+
"$ref": "#/components/schemas/FileCollectionCreateRequest"
|
|
4374
|
+
}
|
|
4375
|
+
}
|
|
4376
|
+
}
|
|
4377
|
+
},
|
|
4378
|
+
"responses": {
|
|
4379
|
+
"201": {
|
|
4380
|
+
"description": "File collection created successfully",
|
|
4381
|
+
"content": {
|
|
4382
|
+
"application/json": {
|
|
4383
|
+
"schema": {
|
|
4384
|
+
"$ref": "#/components/schemas/FileCollectionItem"
|
|
4385
|
+
}
|
|
4386
|
+
}
|
|
4387
|
+
}
|
|
4388
|
+
},
|
|
4389
|
+
"404": {
|
|
4390
|
+
"$ref": "#/components/responses/NotFoundError"
|
|
4391
|
+
}
|
|
4392
|
+
}
|
|
4393
|
+
}
|
|
4394
|
+
},
|
|
4395
|
+
"/v1/entity/{id}/collections/{collection_id}": {
|
|
4396
|
+
"get": {
|
|
4397
|
+
"operationId": "getFileCollection",
|
|
4398
|
+
"summary": "getFileCollection",
|
|
4399
|
+
"description": "Gets a specific file collection by ID",
|
|
4400
|
+
"tags": [
|
|
4401
|
+
"File Collections"
|
|
4402
|
+
],
|
|
4403
|
+
"parameters": [
|
|
4404
|
+
{
|
|
4405
|
+
"$ref": "#/components/parameters/EntityIdPathParam"
|
|
4406
|
+
},
|
|
4407
|
+
{
|
|
4408
|
+
"$ref": "#/components/parameters/CollectionIdPathParam"
|
|
4409
|
+
}
|
|
4410
|
+
],
|
|
4411
|
+
"responses": {
|
|
4412
|
+
"200": {
|
|
4413
|
+
"description": "File collection found",
|
|
4414
|
+
"content": {
|
|
4415
|
+
"application/json": {
|
|
4416
|
+
"schema": {
|
|
4417
|
+
"$ref": "#/components/schemas/FileCollectionItem"
|
|
4418
|
+
}
|
|
4419
|
+
}
|
|
4420
|
+
}
|
|
4421
|
+
},
|
|
4422
|
+
"404": {
|
|
4423
|
+
"$ref": "#/components/responses/NotFoundError"
|
|
4424
|
+
}
|
|
4425
|
+
}
|
|
4426
|
+
},
|
|
4427
|
+
"put": {
|
|
4428
|
+
"operationId": "updateFileCollection",
|
|
4429
|
+
"summary": "updateFileCollection",
|
|
4430
|
+
"description": "Updates a specific file collection by ID",
|
|
4431
|
+
"tags": [
|
|
4432
|
+
"File Collections"
|
|
4433
|
+
],
|
|
4434
|
+
"parameters": [
|
|
4435
|
+
{
|
|
4436
|
+
"$ref": "#/components/parameters/EntityIdPathParam"
|
|
4437
|
+
},
|
|
4438
|
+
{
|
|
4439
|
+
"$ref": "#/components/parameters/CollectionIdPathParam"
|
|
4440
|
+
}
|
|
4441
|
+
],
|
|
4442
|
+
"requestBody": {
|
|
4443
|
+
"required": true,
|
|
4444
|
+
"content": {
|
|
4445
|
+
"application/json": {
|
|
4446
|
+
"schema": {
|
|
4447
|
+
"$ref": "#/components/schemas/FileCollectionAttributes"
|
|
4448
|
+
}
|
|
4449
|
+
}
|
|
4450
|
+
}
|
|
4451
|
+
},
|
|
4452
|
+
"responses": {
|
|
4453
|
+
"200": {
|
|
4454
|
+
"description": "File collection updated successfully",
|
|
4455
|
+
"content": {
|
|
4456
|
+
"application/json": {
|
|
4457
|
+
"schema": {
|
|
4458
|
+
"$ref": "#/components/schemas/FileCollectionItem"
|
|
4459
|
+
}
|
|
4460
|
+
}
|
|
4461
|
+
}
|
|
4462
|
+
},
|
|
4463
|
+
"404": {
|
|
4464
|
+
"$ref": "#/components/responses/NotFoundError"
|
|
4465
|
+
}
|
|
4466
|
+
}
|
|
4467
|
+
},
|
|
4468
|
+
"delete": {
|
|
4469
|
+
"operationId": "deleteFileCollection",
|
|
4470
|
+
"summary": "deleteFileCollection",
|
|
4471
|
+
"description": "Deletes a specific file collection by ID",
|
|
4472
|
+
"tags": [
|
|
4473
|
+
"File Collections"
|
|
4474
|
+
],
|
|
4475
|
+
"parameters": [
|
|
4476
|
+
{
|
|
4477
|
+
"$ref": "#/components/parameters/EntityIdPathParam"
|
|
4478
|
+
},
|
|
4479
|
+
{
|
|
4480
|
+
"$ref": "#/components/parameters/CollectionIdPathParam"
|
|
4481
|
+
}
|
|
4482
|
+
],
|
|
4483
|
+
"responses": {
|
|
4484
|
+
"200": {
|
|
4485
|
+
"description": "File collection deleted successfully"
|
|
4486
|
+
},
|
|
4487
|
+
"404": {
|
|
4488
|
+
"$ref": "#/components/responses/NotFoundError"
|
|
4489
|
+
}
|
|
4490
|
+
}
|
|
4491
|
+
}
|
|
4314
4492
|
}
|
|
4315
4493
|
},
|
|
4316
4494
|
"components": {
|
|
@@ -8612,6 +8790,121 @@
|
|
|
8612
8790
|
"example": "Bad Request"
|
|
8613
8791
|
}
|
|
8614
8792
|
}
|
|
8793
|
+
},
|
|
8794
|
+
"FileCollectionId": {
|
|
8795
|
+
"description": "Generated uuid for a file collection",
|
|
8796
|
+
"type": "string",
|
|
8797
|
+
"format": "uuid"
|
|
8798
|
+
},
|
|
8799
|
+
"FileCollectionItem": {
|
|
8800
|
+
"description": "A file collection with identifiers and timestamps",
|
|
8801
|
+
"type": "object",
|
|
8802
|
+
"properties": {
|
|
8803
|
+
"id": {
|
|
8804
|
+
"$ref": "#/components/schemas/FileCollectionId"
|
|
8805
|
+
},
|
|
8806
|
+
"orgId": {
|
|
8807
|
+
"type": "string",
|
|
8808
|
+
"description": "Organization ID",
|
|
8809
|
+
"example": "123"
|
|
8810
|
+
},
|
|
8811
|
+
"entityId": {
|
|
8812
|
+
"$ref": "#/components/schemas/EntityId"
|
|
8813
|
+
},
|
|
8814
|
+
"type": {
|
|
8815
|
+
"type": "string",
|
|
8816
|
+
"description": "Logical type for this item (e.g. \"collection\")",
|
|
8817
|
+
"example": "collection"
|
|
8818
|
+
},
|
|
8819
|
+
"name": {
|
|
8820
|
+
"type": "string",
|
|
8821
|
+
"example": "MyCollectionOfImportantFiles"
|
|
8822
|
+
},
|
|
8823
|
+
"entity_id": {
|
|
8824
|
+
"$ref": "#/components/schemas/EntityId"
|
|
8825
|
+
},
|
|
8826
|
+
"starred": {
|
|
8827
|
+
"type": "boolean",
|
|
8828
|
+
"example": false
|
|
8829
|
+
},
|
|
8830
|
+
"files": {
|
|
8831
|
+
"type": "array",
|
|
8832
|
+
"description": "Array of file IDs in this collection",
|
|
8833
|
+
"items": {
|
|
8834
|
+
"type": "string",
|
|
8835
|
+
"format": "uuid"
|
|
8836
|
+
},
|
|
8837
|
+
"example": [
|
|
8838
|
+
"123e4567-e89b-12d3-a456-426614174000"
|
|
8839
|
+
]
|
|
8840
|
+
},
|
|
8841
|
+
"created_by": {
|
|
8842
|
+
"type": "string",
|
|
8843
|
+
"description": "User ID who created the collection",
|
|
8844
|
+
"example": "17622"
|
|
8845
|
+
},
|
|
8846
|
+
"created_at": {
|
|
8847
|
+
"type": "string",
|
|
8848
|
+
"format": "date-time",
|
|
8849
|
+
"example": "2025-08-20T12:01:00Z"
|
|
8850
|
+
},
|
|
8851
|
+
"updated_at": {
|
|
8852
|
+
"type": "string",
|
|
8853
|
+
"format": "date-time",
|
|
8854
|
+
"example": "2025-08-20T12:01:00Z"
|
|
8855
|
+
}
|
|
8856
|
+
},
|
|
8857
|
+
"required": [
|
|
8858
|
+
"id",
|
|
8859
|
+
"orgId",
|
|
8860
|
+
"entityId",
|
|
8861
|
+
"type",
|
|
8862
|
+
"name",
|
|
8863
|
+
"entity_id",
|
|
8864
|
+
"starred",
|
|
8865
|
+
"files",
|
|
8866
|
+
"created_by",
|
|
8867
|
+
"created_at",
|
|
8868
|
+
"updated_at"
|
|
8869
|
+
]
|
|
8870
|
+
},
|
|
8871
|
+
"FileCollectionAttributes": {
|
|
8872
|
+
"type": "object",
|
|
8873
|
+
"properties": {
|
|
8874
|
+
"name": {
|
|
8875
|
+
"type": "string",
|
|
8876
|
+
"description": "Name of the file collection"
|
|
8877
|
+
},
|
|
8878
|
+
"starred": {
|
|
8879
|
+
"type": "boolean",
|
|
8880
|
+
"description": "Whether the collection is starred"
|
|
8881
|
+
},
|
|
8882
|
+
"files": {
|
|
8883
|
+
"type": "array",
|
|
8884
|
+
"description": "Array of file IDs in this collection",
|
|
8885
|
+
"items": {
|
|
8886
|
+
"type": "string",
|
|
8887
|
+
"format": "uuid"
|
|
8888
|
+
}
|
|
8889
|
+
}
|
|
8890
|
+
},
|
|
8891
|
+
"additionalProperties": false
|
|
8892
|
+
},
|
|
8893
|
+
"FileCollectionCreateRequest": {
|
|
8894
|
+
"description": "Request body for creating a file collection",
|
|
8895
|
+
"allOf": [
|
|
8896
|
+
{
|
|
8897
|
+
"$ref": "#/components/schemas/FileCollectionAttributes"
|
|
8898
|
+
},
|
|
8899
|
+
{
|
|
8900
|
+
"type": "object",
|
|
8901
|
+
"required": [
|
|
8902
|
+
"name",
|
|
8903
|
+
"starred",
|
|
8904
|
+
"files"
|
|
8905
|
+
]
|
|
8906
|
+
}
|
|
8907
|
+
]
|
|
8615
8908
|
}
|
|
8616
8909
|
},
|
|
8617
8910
|
"parameters": {
|
|
@@ -8848,6 +9141,16 @@
|
|
|
8848
9141
|
"default": false,
|
|
8849
9142
|
"type": "boolean"
|
|
8850
9143
|
}
|
|
9144
|
+
},
|
|
9145
|
+
"CollectionIdPathParam": {
|
|
9146
|
+
"name": "collection_id",
|
|
9147
|
+
"description": "Collection Id",
|
|
9148
|
+
"in": "path",
|
|
9149
|
+
"required": true,
|
|
9150
|
+
"schema": {
|
|
9151
|
+
"type": "string",
|
|
9152
|
+
"format": "uuid"
|
|
9153
|
+
}
|
|
8851
9154
|
}
|
|
8852
9155
|
},
|
|
8853
9156
|
"examples": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/entity-client",
|
|
3
|
-
"version": "6.
|
|
3
|
+
"version": "6.7.0",
|
|
4
4
|
"description": "JavaScript client library for the epilot Core Entity API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -21,6 +21,19 @@
|
|
|
21
21
|
"sdk",
|
|
22
22
|
"entity"
|
|
23
23
|
],
|
|
24
|
+
"scripts": {
|
|
25
|
+
"test": "jest",
|
|
26
|
+
"typescript": "tsc",
|
|
27
|
+
"bundle-definition": "webpack",
|
|
28
|
+
"prepublishOnly": "npm run typegen && npm run build",
|
|
29
|
+
"openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/entity.yaml",
|
|
30
|
+
"typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
|
|
31
|
+
"build": "tsc && npm run build:patch && npm run bundle-definition",
|
|
32
|
+
"build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
|
|
33
|
+
"build:watch": "npm run build && tsc -w",
|
|
34
|
+
"release-alpha": "npm version prerelease --preid alpha",
|
|
35
|
+
"lint": "pnpm exec eslint src"
|
|
36
|
+
},
|
|
24
37
|
"files": [
|
|
25
38
|
"*.js",
|
|
26
39
|
"*.d.ts",
|
|
@@ -50,27 +63,15 @@
|
|
|
50
63
|
"@types/jest": "^26.0.20",
|
|
51
64
|
"axios": "^1.11.0",
|
|
52
65
|
"copy-webpack-plugin": "^7.0.0",
|
|
53
|
-
"jest": "^
|
|
66
|
+
"jest": "^29.6.2",
|
|
54
67
|
"json-loader": "^0.5.7",
|
|
55
68
|
"openapicmd": "^2.7.0",
|
|
56
|
-
"ts-jest": "^
|
|
69
|
+
"ts-jest": "^29.4.1",
|
|
57
70
|
"ts-loader": "^8.0.14",
|
|
58
71
|
"ts-node": "^10.9.1",
|
|
59
72
|
"typescript": "^4.1.3",
|
|
60
73
|
"webpack": "^5.18.0",
|
|
61
74
|
"webpack-cli": "^4.4.0"
|
|
62
75
|
},
|
|
63
|
-
"gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
|
|
64
|
-
|
|
65
|
-
"test": "jest",
|
|
66
|
-
"typescript": "tsc",
|
|
67
|
-
"bundle-definition": "webpack",
|
|
68
|
-
"openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/entity.yaml",
|
|
69
|
-
"typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
|
|
70
|
-
"build": "tsc && npm run build:patch && npm run bundle-definition",
|
|
71
|
-
"build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
|
|
72
|
-
"build:watch": "npm run build && tsc -w",
|
|
73
|
-
"release-alpha": "npm version prerelease --preid alpha",
|
|
74
|
-
"lint": "pnpm exec eslint src"
|
|
75
|
-
}
|
|
76
|
-
}
|
|
76
|
+
"gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
|
|
77
|
+
}
|
package/LICENSE
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
The MIT License (MIT)
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2025 epilot GmbH
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in
|
|
13
|
-
all copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
-
THE SOFTWARE.
|