@epilot/entity-client 4.25.3 → 4.25.5
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/LICENSE +21 -0
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +25 -0
- package/dist/openapi.d.ts +402 -37
- package/dist/openapi.json +363 -9
- package/package.json +2 -2
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2022 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.
|
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={914:function(e,t,a){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=r(a(240));t.default=n.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"}]}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"}]},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}]}},"/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}]}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints"}},"/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"}]}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}}}},"/v1/entity:list":{"post":{"operationId":"listEntities","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}}}},"/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}]}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}]},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}]}},"/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"}]}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}]}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}]}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"query","name":"after"},{"in":"query","name":"before"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}]}},"/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"}]},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}}}},"/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"}]}},"/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"}]}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}]}},"/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":{}}}},"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"}]}},"/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":{}}}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}}}},"/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}]}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}]},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}]}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser"}},"/v1/entity/listTaxonomies":{"get":{"deprecated":true,"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"}]}},"/v1/entity/taxonomies":{"get":{"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"}]},"post":{"operationId":"createTaxonomy","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}]},"put":{"operationId":"updateTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"permanent"}]}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}]}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"$ref":"#/components/parameters/TaxonomySlugQueryParamOptional"},{"in":"query","name":"query"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v2/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"createTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v2/entity/taxonomies/{taxonomySlug}/classifications/{classificationSlug}":{"put":{"operationId":"updateTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"},{"in":"query","name":"permanent"}]}},"/v1/entity/schemas/attributes/{composite_id}":{"get":{"operationId":"getSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}]},"put":{"operationId":"putSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}]}},"/v1/entity/schemas/attribute/{slug}":{"post":{"operationId":"createSchemaAttribute","parameters":[{"name":"slug","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/schemas/capabilities/{composite_id}":{"get":{"operationId":"getSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}]},"put":{"operationId":"putSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}]}},"/v1/entity/schemas/capability/{slug}":{"post":{"operationId":"createSchemaCapability","parameters":[{"name":"slug","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}}}},"components":{"parameters":{"EntityIdPathParam":{"name":"id","in":"path","required":true},"EntitySlugPathParam":{"name":"slug","in":"path","required":true},"EntitySlugPathPriceParam":{"name":"slug","in":"path","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}}},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},a=function a(r){var n=t[r];if(void 0!==n)return n.exports;var o=t[r]={exports:{}};return e[r].call(o.exports,o,o.exports,a),o.exports}(914),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
|
|
1
|
+
(()=>{"use strict";var e={914:function(e,t,a){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=r(a(240));t.default=n.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v1/entity/schemas":{"get":{"operationId":"listSchemas","parameters":[{"in":"query","name":"unpublished"}]}},"/v1/entity/schemas/{slug}":{"get":{"operationId":"getSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"id"}]},"put":{"operationId":"putSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"in":"query","name":"draft"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}]}},"/v1/entity/schemas/{slug}/json/schema":{"get":{"operationId":"getJsonSchema","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}]}},"/v1/entity/schemas/{slug}/json/example":{"get":{"operationId":"getSchemaExample","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"}]}},"/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}]}},"/v1/entity/schemas/blueprints":{"get":{"operationId":"listSchemaBlueprints"}},"/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"}]}},"/v1/entity:search":{"post":{"operationId":"searchEntities","requestBody":{"content":{"application/json":{}}}}},"/v1/entity:list":{"post":{"operationId":"listEntities","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}":{"post":{"operationId":"createEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}:validate":{"post":{"operationId":"validateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathPriceParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/{slug}:upsert":{"patch":{"operationId":"upsertEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"name":"strict","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}}}},"/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}]}},"/v1/entity/{slug}/{id}":{"get":{"operationId":"getEntity","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/HydrateEntitiesQueryParam"}]},"put":{"operationId":"updateEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}}},"patch":{"operationId":"patchEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/DryRunQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}},"required":true}},"delete":{"operationId":"deleteEntity","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}]}},"/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"}]}},"/v1/entity/activity":{"post":{"operationId":"createActivity","parameters":[{"in":"query","name":"entities","style":"form","explode":false}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/activity/{id}":{"get":{"operationId":"getActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"operations_size"},{"in":"query","name":"operations_from"}]}},"/v1/entity/activity/{id}:attach":{"post":{"operationId":"attachActivity","parameters":[{"$ref":"#/components/parameters/ActivityIdPathParam"},{"in":"query","name":"entities","style":"form","explode":false}]}},"/v1/entity/{slug}/{id}/activity":{"get":{"operationId":"getEntityActivityFeed","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"in":"query","name":"after"},{"in":"query","name":"before"},{"$ref":"#/components/parameters/FromPageQueryParam"},{"in":"query","name":"size"},{"in":"query","name":"type"},{"in":"query","name":"include_relations"}]}},"/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"}]},"post":{"operationId":"addRelations","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/ActivityIdQueryParam"}],"requestBody":{"content":{"application/json":{}}}}},"/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"}]}},"/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"}]}},"/v2/entity/{slug}/{id}/relations/count":{"get":{"operationId":"getRelatedEntitiesCount","parameters":[{"$ref":"#/components/parameters/EntitySlugPathParam"},{"$ref":"#/components/parameters/EntityIdPathParam"},{"$ref":"#/components/parameters/ExcludeSchemasQueryParam"}]}},"/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":{}}}},"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"}]}},"/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":{}}}}},"/v1/entity:import":{"post":{"operationId":"importEntities","parameters":[{"in":"query","name":"job_id"}],"requestBody":{"content":{"application/json":{}}}}},"/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}]}},"/v1/entity/view":{"post":{"operationId":"createSavedView","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/view/{id}":{"get":{"operationId":"getSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}]},"put":{"operationId":"updateSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSavedView","parameters":[{"$ref":"#/components/parameters/SavedViewIdPathParam"}]}},"/v1/entity/views/favorites":{"get":{"operationId":"listFavoriteViewsForUser"}},"/v1/entity/listTaxonomies":{"get":{"deprecated":true,"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"}]}},"/v1/entity/taxonomies":{"get":{"operationId":"listTaxonomies","parameters":[{"in":"query","name":"include_disabled"}]},"post":{"operationId":"createTaxonomy","requestBody":{"content":{"application/json":{}}}}},"/v1/entity/taxonomies/{taxonomySlug}":{"get":{"operationId":"getTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}]},"put":{"operationId":"updateTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"permanent"}]}},"/v1/entity/taxonomies/{taxonomySlug}:autocomplete":{"get":{"operationId":"taxonomyAutocomplete","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"in":"query","name":"query"},{"in":"query","name":"size"}]}},"/v1/entity/taxonomies/classifications:search":{"post":{"operationId":"taxonomiesClassificationsSearch","parameters":[{"$ref":"#/components/parameters/TaxonomySlugQueryParamOptional"},{"in":"query","name":"query"}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"updateClassificationsForTaxonomy","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v2/entity/taxonomies/{taxonomySlug}/classifications":{"post":{"operationId":"createTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"}],"requestBody":{"content":{"application/json":{}}}}},"/v2/entity/taxonomies/{taxonomySlug}/classifications/{classificationSlug}":{"put":{"operationId":"updateTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteTaxonomyClassification","parameters":[{"$ref":"#/components/parameters/TaxonomySlugPathParam"},{"$ref":"#/components/parameters/TaxonomyClassificationSlugPathParam"},{"in":"query","name":"permanent"}]}},"/v1/entity/schemas/attributes/{composite_id}":{"get":{"operationId":"getSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}]},"put":{"operationId":"putSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchemaAttribute","parameters":[{"name":"composite_id","in":"path","required":true}]}},"/v1/entity/schemas/attribute/{slug}":{"post":{"operationId":"createSchemaAttribute","parameters":[{"name":"slug","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}}},"/v1/entity/schemas/capabilities/{composite_id}":{"get":{"operationId":"getSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}]},"put":{"operationId":"putSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSchemaCapability","parameters":[{"name":"composite_id","in":"path","required":true}]}},"/v1/entity/schemas/capability/{slug}":{"post":{"operationId":"createSchemaCapability","parameters":[{"name":"slug","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}}}},"components":{"parameters":{"EntityIdPathParam":{"name":"id","in":"path","required":true},"EntitySlugPathParam":{"name":"slug","in":"path","required":true},"EntitySlugPathPriceParam":{"name":"slug","in":"path","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}}},"servers":[{"url":"https://entity.sls.epilot.io"}]}')}},t={},a=function a(r){var n=t[r];if(void 0!==n)return n.exports;var o=t[r]={exports:{}};return e[r].call(o.exports,o,o.exports,a),o.exports}(914),r=exports;for(var n in a)r[n]=a[n];a.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
|
|
@@ -55,6 +55,26 @@
|
|
|
55
55
|
]
|
|
56
56
|
}
|
|
57
57
|
},
|
|
58
|
+
"/v1/entity/schemas/{slug}/json/schema": {
|
|
59
|
+
"get": {
|
|
60
|
+
"operationId": "getJsonSchema",
|
|
61
|
+
"parameters": [
|
|
62
|
+
{
|
|
63
|
+
"$ref": "#/components/parameters/EntitySlugPathParam"
|
|
64
|
+
}
|
|
65
|
+
]
|
|
66
|
+
}
|
|
67
|
+
},
|
|
68
|
+
"/v1/entity/schemas/{slug}/json/example": {
|
|
69
|
+
"get": {
|
|
70
|
+
"operationId": "getSchemaExample",
|
|
71
|
+
"parameters": [
|
|
72
|
+
{
|
|
73
|
+
"$ref": "#/components/parameters/EntitySlugPathParam"
|
|
74
|
+
}
|
|
75
|
+
]
|
|
76
|
+
}
|
|
77
|
+
},
|
|
58
78
|
"/v1/entity/schemas/{slug}/versions": {
|
|
59
79
|
"get": {
|
|
60
80
|
"operationId": "getSchemaVersions",
|
|
@@ -185,6 +205,11 @@
|
|
|
185
205
|
},
|
|
186
206
|
{
|
|
187
207
|
"$ref": "#/components/parameters/AsyncOperationQueryParam"
|
|
208
|
+
},
|
|
209
|
+
{
|
|
210
|
+
"name": "strict",
|
|
211
|
+
"in": "query",
|
|
212
|
+
"required": false
|
|
188
213
|
}
|
|
189
214
|
],
|
|
190
215
|
"requestBody": {
|
package/dist/openapi.d.ts
CHANGED
|
@@ -229,7 +229,7 @@ declare namespace Components {
|
|
|
229
229
|
* example:
|
|
230
230
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
231
231
|
*/
|
|
232
|
-
id
|
|
232
|
+
id?: string;
|
|
233
233
|
name: string;
|
|
234
234
|
label: string;
|
|
235
235
|
placeholder?: string;
|
|
@@ -373,7 +373,7 @@ declare namespace Components {
|
|
|
373
373
|
* example:
|
|
374
374
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
375
375
|
*/
|
|
376
|
-
id
|
|
376
|
+
id?: string;
|
|
377
377
|
name: string;
|
|
378
378
|
label: string;
|
|
379
379
|
placeholder?: string;
|
|
@@ -541,7 +541,7 @@ declare namespace Components {
|
|
|
541
541
|
* example:
|
|
542
542
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
543
543
|
*/
|
|
544
|
-
id
|
|
544
|
+
id?: string;
|
|
545
545
|
name: string;
|
|
546
546
|
label: string;
|
|
547
547
|
placeholder?: string;
|
|
@@ -737,7 +737,7 @@ declare namespace Components {
|
|
|
737
737
|
* example:
|
|
738
738
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
739
739
|
*/
|
|
740
|
-
id
|
|
740
|
+
id?: string;
|
|
741
741
|
name: string;
|
|
742
742
|
label: string;
|
|
743
743
|
placeholder?: string;
|
|
@@ -883,7 +883,7 @@ declare namespace Components {
|
|
|
883
883
|
* example:
|
|
884
884
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
885
885
|
*/
|
|
886
|
-
id
|
|
886
|
+
id?: string;
|
|
887
887
|
name: string;
|
|
888
888
|
label: string;
|
|
889
889
|
placeholder?: string;
|
|
@@ -1015,7 +1015,7 @@ declare namespace Components {
|
|
|
1015
1015
|
* example:
|
|
1016
1016
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
1017
1017
|
*/
|
|
1018
|
-
id
|
|
1018
|
+
id?: string;
|
|
1019
1019
|
name: string;
|
|
1020
1020
|
label: string;
|
|
1021
1021
|
placeholder?: string;
|
|
@@ -1149,7 +1149,7 @@ declare namespace Components {
|
|
|
1149
1149
|
* example:
|
|
1150
1150
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
1151
1151
|
*/
|
|
1152
|
-
id
|
|
1152
|
+
id?: string;
|
|
1153
1153
|
name: string;
|
|
1154
1154
|
label: string;
|
|
1155
1155
|
placeholder?: string;
|
|
@@ -1281,7 +1281,7 @@ declare namespace Components {
|
|
|
1281
1281
|
* example:
|
|
1282
1282
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
1283
1283
|
*/
|
|
1284
|
-
id
|
|
1284
|
+
id?: string;
|
|
1285
1285
|
name: string;
|
|
1286
1286
|
label: string;
|
|
1287
1287
|
placeholder?: string;
|
|
@@ -1423,7 +1423,7 @@ declare namespace Components {
|
|
|
1423
1423
|
* example:
|
|
1424
1424
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
1425
1425
|
*/
|
|
1426
|
-
id
|
|
1426
|
+
id?: string;
|
|
1427
1427
|
name: string;
|
|
1428
1428
|
label: string;
|
|
1429
1429
|
placeholder?: string;
|
|
@@ -1654,7 +1654,7 @@ declare namespace Components {
|
|
|
1654
1654
|
* example:
|
|
1655
1655
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
1656
1656
|
*/
|
|
1657
|
-
id
|
|
1657
|
+
id?: string;
|
|
1658
1658
|
/**
|
|
1659
1659
|
* Unique name for the capability
|
|
1660
1660
|
* example:
|
|
@@ -1769,7 +1769,7 @@ declare namespace Components {
|
|
|
1769
1769
|
* example:
|
|
1770
1770
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
1771
1771
|
*/
|
|
1772
|
-
id
|
|
1772
|
+
id?: string;
|
|
1773
1773
|
/**
|
|
1774
1774
|
* Unique name for the capability
|
|
1775
1775
|
* example:
|
|
@@ -3081,7 +3081,7 @@ declare namespace Components {
|
|
|
3081
3081
|
* example:
|
|
3082
3082
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
3083
3083
|
*/
|
|
3084
|
-
id
|
|
3084
|
+
id?: string;
|
|
3085
3085
|
name: string;
|
|
3086
3086
|
label: string;
|
|
3087
3087
|
placeholder?: string;
|
|
@@ -3344,7 +3344,7 @@ declare namespace Components {
|
|
|
3344
3344
|
* example:
|
|
3345
3345
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
3346
3346
|
*/
|
|
3347
|
-
id
|
|
3347
|
+
id?: string;
|
|
3348
3348
|
name: string;
|
|
3349
3349
|
label: string;
|
|
3350
3350
|
placeholder?: string;
|
|
@@ -3476,7 +3476,7 @@ declare namespace Components {
|
|
|
3476
3476
|
* example:
|
|
3477
3477
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
3478
3478
|
*/
|
|
3479
|
-
id
|
|
3479
|
+
id?: string;
|
|
3480
3480
|
name: string;
|
|
3481
3481
|
label: string;
|
|
3482
3482
|
placeholder?: string;
|
|
@@ -3608,7 +3608,7 @@ declare namespace Components {
|
|
|
3608
3608
|
* example:
|
|
3609
3609
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
3610
3610
|
*/
|
|
3611
|
-
id
|
|
3611
|
+
id?: string;
|
|
3612
3612
|
name: string;
|
|
3613
3613
|
label: string;
|
|
3614
3614
|
placeholder?: string;
|
|
@@ -3748,7 +3748,7 @@ declare namespace Components {
|
|
|
3748
3748
|
* example:
|
|
3749
3749
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
3750
3750
|
*/
|
|
3751
|
-
id
|
|
3751
|
+
id?: string;
|
|
3752
3752
|
name: string;
|
|
3753
3753
|
label: string;
|
|
3754
3754
|
placeholder?: string;
|
|
@@ -3888,7 +3888,7 @@ declare namespace Components {
|
|
|
3888
3888
|
* example:
|
|
3889
3889
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
3890
3890
|
*/
|
|
3891
|
-
id
|
|
3891
|
+
id?: string;
|
|
3892
3892
|
name: string;
|
|
3893
3893
|
label: string;
|
|
3894
3894
|
placeholder?: string;
|
|
@@ -4036,7 +4036,7 @@ declare namespace Components {
|
|
|
4036
4036
|
* example:
|
|
4037
4037
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
4038
4038
|
*/
|
|
4039
|
-
id
|
|
4039
|
+
id?: string;
|
|
4040
4040
|
name: string;
|
|
4041
4041
|
label: string;
|
|
4042
4042
|
placeholder?: string;
|
|
@@ -4173,7 +4173,7 @@ declare namespace Components {
|
|
|
4173
4173
|
* example:
|
|
4174
4174
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
4175
4175
|
*/
|
|
4176
|
-
id
|
|
4176
|
+
id?: string;
|
|
4177
4177
|
name: string;
|
|
4178
4178
|
label: string;
|
|
4179
4179
|
placeholder?: string;
|
|
@@ -4305,7 +4305,7 @@ declare namespace Components {
|
|
|
4305
4305
|
* example:
|
|
4306
4306
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
4307
4307
|
*/
|
|
4308
|
-
id
|
|
4308
|
+
id?: string;
|
|
4309
4309
|
name: string;
|
|
4310
4310
|
label: string;
|
|
4311
4311
|
placeholder?: string;
|
|
@@ -4437,7 +4437,7 @@ declare namespace Components {
|
|
|
4437
4437
|
* example:
|
|
4438
4438
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
4439
4439
|
*/
|
|
4440
|
-
id
|
|
4440
|
+
id?: string;
|
|
4441
4441
|
name: string;
|
|
4442
4442
|
label: string;
|
|
4443
4443
|
placeholder?: string;
|
|
@@ -4569,7 +4569,7 @@ declare namespace Components {
|
|
|
4569
4569
|
* example:
|
|
4570
4570
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
4571
4571
|
*/
|
|
4572
|
-
id
|
|
4572
|
+
id?: string;
|
|
4573
4573
|
name: string;
|
|
4574
4574
|
label: string;
|
|
4575
4575
|
placeholder?: string;
|
|
@@ -4702,7 +4702,7 @@ declare namespace Components {
|
|
|
4702
4702
|
* example:
|
|
4703
4703
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
4704
4704
|
*/
|
|
4705
|
-
id
|
|
4705
|
+
id?: /**
|
|
4706
4706
|
* example:
|
|
4707
4707
|
* taxonomy-slug:classification-slug
|
|
4708
4708
|
*/
|
|
@@ -4870,7 +4870,7 @@ declare namespace Components {
|
|
|
4870
4870
|
* example:
|
|
4871
4871
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
4872
4872
|
*/
|
|
4873
|
-
id
|
|
4873
|
+
id?: string;
|
|
4874
4874
|
name: string;
|
|
4875
4875
|
label: string;
|
|
4876
4876
|
placeholder?: string;
|
|
@@ -5239,7 +5239,7 @@ declare namespace Components {
|
|
|
5239
5239
|
* example:
|
|
5240
5240
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
5241
5241
|
*/
|
|
5242
|
-
id
|
|
5242
|
+
id?: string;
|
|
5243
5243
|
name: string;
|
|
5244
5244
|
label: string;
|
|
5245
5245
|
placeholder?: string;
|
|
@@ -5704,7 +5704,7 @@ declare namespace Components {
|
|
|
5704
5704
|
* example:
|
|
5705
5705
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
5706
5706
|
*/
|
|
5707
|
-
id
|
|
5707
|
+
id?: string;
|
|
5708
5708
|
name: string;
|
|
5709
5709
|
label: string;
|
|
5710
5710
|
placeholder?: string;
|
|
@@ -5844,7 +5844,7 @@ declare namespace Components {
|
|
|
5844
5844
|
* example:
|
|
5845
5845
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
5846
5846
|
*/
|
|
5847
|
-
id
|
|
5847
|
+
id?: string;
|
|
5848
5848
|
name: string;
|
|
5849
5849
|
label: string;
|
|
5850
5850
|
placeholder?: string;
|
|
@@ -5993,7 +5993,7 @@ declare namespace Components {
|
|
|
5993
5993
|
* example:
|
|
5994
5994
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
5995
5995
|
*/
|
|
5996
|
-
id
|
|
5996
|
+
id?: string;
|
|
5997
5997
|
name: string;
|
|
5998
5998
|
label: string;
|
|
5999
5999
|
placeholder?: string;
|
|
@@ -6195,7 +6195,7 @@ declare namespace Components {
|
|
|
6195
6195
|
* example:
|
|
6196
6196
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
6197
6197
|
*/
|
|
6198
|
-
id
|
|
6198
|
+
id?: string;
|
|
6199
6199
|
name: string;
|
|
6200
6200
|
label: string;
|
|
6201
6201
|
placeholder?: string;
|
|
@@ -6384,7 +6384,7 @@ declare namespace Components {
|
|
|
6384
6384
|
/**
|
|
6385
6385
|
* List of locations where the taxonomy is enabled to be used. If empty, it's enabled for all locations.
|
|
6386
6386
|
*/
|
|
6387
|
-
enabled_locations?: ("email-templates" | "emails" | "contacts" | "orders" | "contracts" | "meters" | "accounts" | "products" | "prices" | "opportunities" | "all_entities")[];
|
|
6387
|
+
enabled_locations?: ("email-templates" | "emails" | "contacts" | "orders" | "contracts" | "meters" | "accounts" | "products" | "prices" | "opportunities" | "all_entities" | "files")[];
|
|
6388
6388
|
}
|
|
6389
6389
|
export interface TaxonomyClassification {
|
|
6390
6390
|
id?: /**
|
|
@@ -6426,7 +6426,7 @@ declare namespace Components {
|
|
|
6426
6426
|
* example:
|
|
6427
6427
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
6428
6428
|
*/
|
|
6429
|
-
id
|
|
6429
|
+
id?: string;
|
|
6430
6430
|
name: string;
|
|
6431
6431
|
label: string;
|
|
6432
6432
|
placeholder?: string;
|
|
@@ -6559,7 +6559,7 @@ declare namespace Components {
|
|
|
6559
6559
|
* example:
|
|
6560
6560
|
* d5839b94-ba20-4225-a78e-76951d352bd6
|
|
6561
6561
|
*/
|
|
6562
|
-
id
|
|
6562
|
+
id?: string;
|
|
6563
6563
|
name: string;
|
|
6564
6564
|
label: string;
|
|
6565
6565
|
placeholder?: string;
|
|
@@ -7091,7 +7091,7 @@ declare namespace Paths {
|
|
|
7091
7091
|
slug: Parameters.Slug;
|
|
7092
7092
|
}
|
|
7093
7093
|
namespace Responses {
|
|
7094
|
-
export interface $
|
|
7094
|
+
export interface $200 {
|
|
7095
7095
|
}
|
|
7096
7096
|
}
|
|
7097
7097
|
}
|
|
@@ -7450,6 +7450,310 @@ declare namespace Paths {
|
|
|
7450
7450
|
Components.Schemas.EntityItem;
|
|
7451
7451
|
}
|
|
7452
7452
|
}
|
|
7453
|
+
namespace GetJsonSchema {
|
|
7454
|
+
namespace Parameters {
|
|
7455
|
+
export type Slug = /**
|
|
7456
|
+
* URL-friendly identifier for the entity schema
|
|
7457
|
+
* example:
|
|
7458
|
+
* contact
|
|
7459
|
+
*/
|
|
7460
|
+
Components.Schemas.EntitySlug;
|
|
7461
|
+
}
|
|
7462
|
+
export interface PathParameters {
|
|
7463
|
+
slug: Parameters.Slug;
|
|
7464
|
+
}
|
|
7465
|
+
namespace Responses {
|
|
7466
|
+
/**
|
|
7467
|
+
* example:
|
|
7468
|
+
* {
|
|
7469
|
+
* "$schema": "http://json-schema.org/draft/2020-12/schema",
|
|
7470
|
+
* "type": "object",
|
|
7471
|
+
* "properties": {
|
|
7472
|
+
* "_id": {
|
|
7473
|
+
* "type": "string",
|
|
7474
|
+
* "format": "uuid",
|
|
7475
|
+
* "example": "123e4567-e89b-12d3-a456-426614174000"
|
|
7476
|
+
* },
|
|
7477
|
+
* "_org": {
|
|
7478
|
+
* "type": "string",
|
|
7479
|
+
* "description": "Organization Id the entity belongs to",
|
|
7480
|
+
* "readOnly": true
|
|
7481
|
+
* },
|
|
7482
|
+
* "_owners": {
|
|
7483
|
+
* "type": "array",
|
|
7484
|
+
* "readOnly": true,
|
|
7485
|
+
* "items": {
|
|
7486
|
+
* "description": "The user / organization owning this entity.\n\nNote: Owner implicitly has access to the entity regardless of ACLs.\n",
|
|
7487
|
+
* "type": "object",
|
|
7488
|
+
* "properties": {
|
|
7489
|
+
* "org_id": {
|
|
7490
|
+
* "type": "string",
|
|
7491
|
+
* "example": "123"
|
|
7492
|
+
* },
|
|
7493
|
+
* "user_id": {
|
|
7494
|
+
* "type": "string",
|
|
7495
|
+
* "example": "123"
|
|
7496
|
+
* }
|
|
7497
|
+
* },
|
|
7498
|
+
* "required": [
|
|
7499
|
+
* "org_id"
|
|
7500
|
+
* ]
|
|
7501
|
+
* }
|
|
7502
|
+
* },
|
|
7503
|
+
* "_schema": {
|
|
7504
|
+
* "readOnly": true,
|
|
7505
|
+
* "type": "string"
|
|
7506
|
+
* },
|
|
7507
|
+
* "_title": {
|
|
7508
|
+
* "readOnly": true,
|
|
7509
|
+
* "type": "string"
|
|
7510
|
+
* },
|
|
7511
|
+
* "_tags": {
|
|
7512
|
+
* "type": "array",
|
|
7513
|
+
* "nullable": true,
|
|
7514
|
+
* "items": {
|
|
7515
|
+
* "type": "string"
|
|
7516
|
+
* }
|
|
7517
|
+
* },
|
|
7518
|
+
* "_created_at": {
|
|
7519
|
+
* "readOnly": true,
|
|
7520
|
+
* "type": "string",
|
|
7521
|
+
* "format": "date-time"
|
|
7522
|
+
* },
|
|
7523
|
+
* "_updated_at": {
|
|
7524
|
+
* "readOnly": true,
|
|
7525
|
+
* "type": "string",
|
|
7526
|
+
* "format": "date-time"
|
|
7527
|
+
* },
|
|
7528
|
+
* "_acl": {
|
|
7529
|
+
* "readOnly": true,
|
|
7530
|
+
* "type": "object",
|
|
7531
|
+
* "description": "Access control list (ACL) for an entity. Defines sharing access to external orgs or users.",
|
|
7532
|
+
* "additionalProperties": true,
|
|
7533
|
+
* "properties": {
|
|
7534
|
+
* "view": {
|
|
7535
|
+
* "type": "array",
|
|
7536
|
+
* "items": {
|
|
7537
|
+
* "type": "string",
|
|
7538
|
+
* "example": "org:456"
|
|
7539
|
+
* }
|
|
7540
|
+
* },
|
|
7541
|
+
* "edit": {
|
|
7542
|
+
* "type": "array",
|
|
7543
|
+
* "items": {
|
|
7544
|
+
* "type": "string",
|
|
7545
|
+
* "example": "org:456"
|
|
7546
|
+
* }
|
|
7547
|
+
* },
|
|
7548
|
+
* "delete": {
|
|
7549
|
+
* "type": "array",
|
|
7550
|
+
* "items": {
|
|
7551
|
+
* "type": "string",
|
|
7552
|
+
* "example": "org:456"
|
|
7553
|
+
* }
|
|
7554
|
+
* }
|
|
7555
|
+
* }
|
|
7556
|
+
* },
|
|
7557
|
+
* "title": {
|
|
7558
|
+
* "type": "string",
|
|
7559
|
+
* "nullable": true,
|
|
7560
|
+
* "enum": [
|
|
7561
|
+
* "Dr.",
|
|
7562
|
+
* "Prof.",
|
|
7563
|
+
* "Prof. Dr."
|
|
7564
|
+
* ]
|
|
7565
|
+
* },
|
|
7566
|
+
* "salutation": {
|
|
7567
|
+
* "type": "string",
|
|
7568
|
+
* "nullable": true,
|
|
7569
|
+
* "enum": [
|
|
7570
|
+
* "Mr.",
|
|
7571
|
+
* "Ms. / Mrs.",
|
|
7572
|
+
* "Company",
|
|
7573
|
+
* "Contact Person",
|
|
7574
|
+
* "Company/Contact Person",
|
|
7575
|
+
* "Spouse",
|
|
7576
|
+
* "Family",
|
|
7577
|
+
* "Ownership",
|
|
7578
|
+
* "Assembly",
|
|
7579
|
+
* "Other"
|
|
7580
|
+
* ]
|
|
7581
|
+
* },
|
|
7582
|
+
* "first_name": {
|
|
7583
|
+
* "type": "string"
|
|
7584
|
+
* },
|
|
7585
|
+
* "last_name": {
|
|
7586
|
+
* "type": "string"
|
|
7587
|
+
* },
|
|
7588
|
+
* "customer_number": {
|
|
7589
|
+
* "type": "string",
|
|
7590
|
+
* "nullable": true
|
|
7591
|
+
* },
|
|
7592
|
+
* "birthdate": {
|
|
7593
|
+
* "type": "string",
|
|
7594
|
+
* "format": "date",
|
|
7595
|
+
* "nullable": true
|
|
7596
|
+
* },
|
|
7597
|
+
* "account": {
|
|
7598
|
+
* "type": "object",
|
|
7599
|
+
* "nullable": true,
|
|
7600
|
+
* "properties": {
|
|
7601
|
+
* "$relation": {
|
|
7602
|
+
* "type": "array",
|
|
7603
|
+
* "items": {
|
|
7604
|
+
* "type": "object",
|
|
7605
|
+
* "properties": {
|
|
7606
|
+
* "entity_id": {
|
|
7607
|
+
* "type": "string",
|
|
7608
|
+
* "format": "uuid",
|
|
7609
|
+
* "example": "123e4567-e89b-12d3-a456-426614174000"
|
|
7610
|
+
* },
|
|
7611
|
+
* "_tags": {
|
|
7612
|
+
* "type": "array",
|
|
7613
|
+
* "nullable": true,
|
|
7614
|
+
* "items": {
|
|
7615
|
+
* "type": "string"
|
|
7616
|
+
* }
|
|
7617
|
+
* }
|
|
7618
|
+
* },
|
|
7619
|
+
* "required": [
|
|
7620
|
+
* "entity_id"
|
|
7621
|
+
* ]
|
|
7622
|
+
* }
|
|
7623
|
+
* }
|
|
7624
|
+
* },
|
|
7625
|
+
* "additionalProperties": true
|
|
7626
|
+
* },
|
|
7627
|
+
* "address": {
|
|
7628
|
+
* "type": "array",
|
|
7629
|
+
* "nullable": true,
|
|
7630
|
+
* "description": "Addresses as a list of object, the element with index 0 is treated as the primary one.\n",
|
|
7631
|
+
* "items": {
|
|
7632
|
+
* "type": "object",
|
|
7633
|
+
* "properties": {
|
|
7634
|
+
* "street": {
|
|
7635
|
+
* "type": "string",
|
|
7636
|
+
* "nullable": true
|
|
7637
|
+
* },
|
|
7638
|
+
* "street_number": {
|
|
7639
|
+
* "type": "string",
|
|
7640
|
+
* "nullable": true
|
|
7641
|
+
* },
|
|
7642
|
+
* "postal_code": {
|
|
7643
|
+
* "type": "string",
|
|
7644
|
+
* "nullable": true
|
|
7645
|
+
* },
|
|
7646
|
+
* "city": {
|
|
7647
|
+
* "type": "string",
|
|
7648
|
+
* "nullable": true
|
|
7649
|
+
* },
|
|
7650
|
+
* "country": {
|
|
7651
|
+
* "type": "string",
|
|
7652
|
+
* "nullable": true,
|
|
7653
|
+
* "enum": [
|
|
7654
|
+
* "DE",
|
|
7655
|
+
* "AT",
|
|
7656
|
+
* "CH"
|
|
7657
|
+
* ]
|
|
7658
|
+
* },
|
|
7659
|
+
* "additional_info": {
|
|
7660
|
+
* "type": "string",
|
|
7661
|
+
* "nullable": true
|
|
7662
|
+
* },
|
|
7663
|
+
* "_tags": {
|
|
7664
|
+
* "type": "array",
|
|
7665
|
+
* "nullable": true,
|
|
7666
|
+
* "items": {
|
|
7667
|
+
* "type": "string"
|
|
7668
|
+
* }
|
|
7669
|
+
* },
|
|
7670
|
+
* "_id": {
|
|
7671
|
+
* "type": "string",
|
|
7672
|
+
* "example": "xHcOoJCa07eysJ1GaQeSb"
|
|
7673
|
+
* }
|
|
7674
|
+
* },
|
|
7675
|
+
* "required": [
|
|
7676
|
+
* "street",
|
|
7677
|
+
* "street_number",
|
|
7678
|
+
* "postal_code",
|
|
7679
|
+
* "city",
|
|
7680
|
+
* "country"
|
|
7681
|
+
* ]
|
|
7682
|
+
* }
|
|
7683
|
+
* },
|
|
7684
|
+
* "email": {
|
|
7685
|
+
* "type": "array",
|
|
7686
|
+
* "nullable": true,
|
|
7687
|
+
* "description": "Email addresses as a list of object, the element with index 0 is treated as the primary one.\n",
|
|
7688
|
+
* "items": {
|
|
7689
|
+
* "type": "object",
|
|
7690
|
+
* "properties": {
|
|
7691
|
+
* "_id": {
|
|
7692
|
+
* "type": "string",
|
|
7693
|
+
* "example": "xHcOoJCa07eysJ1GaQeSb"
|
|
7694
|
+
* },
|
|
7695
|
+
* "_tags": {
|
|
7696
|
+
* "type": "array",
|
|
7697
|
+
* "nullable": true,
|
|
7698
|
+
* "items": {
|
|
7699
|
+
* "type": "string"
|
|
7700
|
+
* }
|
|
7701
|
+
* },
|
|
7702
|
+
* "email": {
|
|
7703
|
+
* "type": "string"
|
|
7704
|
+
* }
|
|
7705
|
+
* },
|
|
7706
|
+
* "required": [
|
|
7707
|
+
* "email"
|
|
7708
|
+
* ]
|
|
7709
|
+
* }
|
|
7710
|
+
* },
|
|
7711
|
+
* "phone": {
|
|
7712
|
+
* "type": "array",
|
|
7713
|
+
* "description": "Phone numbers as a list of object, the element with index 0 is treated as the primary one.\n",
|
|
7714
|
+
* "items": {
|
|
7715
|
+
* "type": "object",
|
|
7716
|
+
* "properties": {
|
|
7717
|
+
* "_id": {
|
|
7718
|
+
* "type": "string",
|
|
7719
|
+
* "example": "xHcOoJCa07eysJ1GaQeSb"
|
|
7720
|
+
* },
|
|
7721
|
+
* "_tags": {
|
|
7722
|
+
* "type": "array",
|
|
7723
|
+
* "nullable": true,
|
|
7724
|
+
* "items": {
|
|
7725
|
+
* "type": "string"
|
|
7726
|
+
* }
|
|
7727
|
+
* },
|
|
7728
|
+
* "phone": {
|
|
7729
|
+
* "type": "string"
|
|
7730
|
+
* }
|
|
7731
|
+
* },
|
|
7732
|
+
* "required": [
|
|
7733
|
+
* "phone"
|
|
7734
|
+
* ]
|
|
7735
|
+
* }
|
|
7736
|
+
* }
|
|
7737
|
+
* },
|
|
7738
|
+
* "required": [
|
|
7739
|
+
* "first_name",
|
|
7740
|
+
* "last_name",
|
|
7741
|
+
* "_id",
|
|
7742
|
+
* "_org",
|
|
7743
|
+
* "_owners",
|
|
7744
|
+
* "_schema",
|
|
7745
|
+
* "_title",
|
|
7746
|
+
* "_tags",
|
|
7747
|
+
* "_created_at",
|
|
7748
|
+
* "_updated_at",
|
|
7749
|
+
* "_acl"
|
|
7750
|
+
* ]
|
|
7751
|
+
* }
|
|
7752
|
+
*/
|
|
7753
|
+
export interface $200 {
|
|
7754
|
+
}
|
|
7755
|
+
}
|
|
7756
|
+
}
|
|
7453
7757
|
namespace GetRelatedEntitiesCount {
|
|
7454
7758
|
namespace Parameters {
|
|
7455
7759
|
export type ExcludeSchemas = /**
|
|
@@ -7681,6 +7985,23 @@ declare namespace Paths {
|
|
|
7681
7985
|
export type $200 = /* a readonly computed ID for the entity capability including schema slug and the capability ID */ Components.Schemas.EntityCapabilityWithCompositeID;
|
|
7682
7986
|
}
|
|
7683
7987
|
}
|
|
7988
|
+
namespace GetSchemaExample {
|
|
7989
|
+
namespace Parameters {
|
|
7990
|
+
export type Slug = /**
|
|
7991
|
+
* URL-friendly identifier for the entity schema
|
|
7992
|
+
* example:
|
|
7993
|
+
* contact
|
|
7994
|
+
*/
|
|
7995
|
+
Components.Schemas.EntitySlug;
|
|
7996
|
+
}
|
|
7997
|
+
export interface PathParameters {
|
|
7998
|
+
slug: Parameters.Slug;
|
|
7999
|
+
}
|
|
8000
|
+
namespace Responses {
|
|
8001
|
+
export interface $200 {
|
|
8002
|
+
}
|
|
8003
|
+
}
|
|
8004
|
+
}
|
|
7684
8005
|
namespace GetSchemaVersions {
|
|
7685
8006
|
namespace Parameters {
|
|
7686
8007
|
export type DraftsFrom = number;
|
|
@@ -8349,6 +8670,7 @@ declare namespace Paths {
|
|
|
8349
8670
|
* contact
|
|
8350
8671
|
*/
|
|
8351
8672
|
Components.Schemas.EntitySlug;
|
|
8673
|
+
export type Strict = boolean;
|
|
8352
8674
|
}
|
|
8353
8675
|
export interface PathParameters {
|
|
8354
8676
|
slug: Parameters.Slug;
|
|
@@ -8357,6 +8679,7 @@ declare namespace Paths {
|
|
|
8357
8679
|
activity_id?: Parameters.ActivityId;
|
|
8358
8680
|
dry_run?: Parameters.DryRun;
|
|
8359
8681
|
async?: Parameters.Async;
|
|
8682
|
+
strict?: Parameters.Strict;
|
|
8360
8683
|
}
|
|
8361
8684
|
export interface RequestBody {
|
|
8362
8685
|
/**
|
|
@@ -8588,7 +8911,27 @@ export interface OperationMethods {
|
|
|
8588
8911
|
parameters?: Parameters<Paths.DeleteSchema.PathParameters> | null,
|
|
8589
8912
|
data?: any,
|
|
8590
8913
|
config?: AxiosRequestConfig
|
|
8591
|
-
): OperationResponse<Paths.DeleteSchema.Responses.$
|
|
8914
|
+
): OperationResponse<Paths.DeleteSchema.Responses.$200>
|
|
8915
|
+
/**
|
|
8916
|
+
* getJsonSchema - getJsonSchema
|
|
8917
|
+
*
|
|
8918
|
+
* Get formal JSON schema definition draft 2020-12 for the given epilot schema
|
|
8919
|
+
*/
|
|
8920
|
+
'getJsonSchema'(
|
|
8921
|
+
parameters?: Parameters<Paths.GetJsonSchema.PathParameters> | null,
|
|
8922
|
+
data?: any,
|
|
8923
|
+
config?: AxiosRequestConfig
|
|
8924
|
+
): OperationResponse<Paths.GetJsonSchema.Responses.$200>
|
|
8925
|
+
/**
|
|
8926
|
+
* getSchemaExample - getSchemaExample
|
|
8927
|
+
*
|
|
8928
|
+
* Get a full example entity for the given schema
|
|
8929
|
+
*/
|
|
8930
|
+
'getSchemaExample'(
|
|
8931
|
+
parameters?: Parameters<Paths.GetSchemaExample.PathParameters> | null,
|
|
8932
|
+
data?: any,
|
|
8933
|
+
config?: AxiosRequestConfig
|
|
8934
|
+
): OperationResponse<Paths.GetSchemaExample.Responses.$200>
|
|
8592
8935
|
/**
|
|
8593
8936
|
* getSchemaVersions - getSchemaVersions
|
|
8594
8937
|
*
|
|
@@ -8759,7 +9102,6 @@ export interface OperationMethods {
|
|
|
8759
9102
|
*
|
|
8760
9103
|
* - If no entities are matched, a new entity is created.
|
|
8761
9104
|
* - If exactly one entity is matched, a `PATCH`-style update is applied to the existing entity.
|
|
8762
|
-
* - If more than one entity is matched a `409` Error is returned
|
|
8763
9105
|
*
|
|
8764
9106
|
* ## Activity
|
|
8765
9107
|
*
|
|
@@ -9414,7 +9756,31 @@ export interface PathsDictionary {
|
|
|
9414
9756
|
parameters?: Parameters<Paths.DeleteSchema.PathParameters> | null,
|
|
9415
9757
|
data?: any,
|
|
9416
9758
|
config?: AxiosRequestConfig
|
|
9417
|
-
): OperationResponse<Paths.DeleteSchema.Responses.$
|
|
9759
|
+
): OperationResponse<Paths.DeleteSchema.Responses.$200>
|
|
9760
|
+
}
|
|
9761
|
+
['/v1/entity/schemas/{slug}/json/schema']: {
|
|
9762
|
+
/**
|
|
9763
|
+
* getJsonSchema - getJsonSchema
|
|
9764
|
+
*
|
|
9765
|
+
* Get formal JSON schema definition draft 2020-12 for the given epilot schema
|
|
9766
|
+
*/
|
|
9767
|
+
'get'(
|
|
9768
|
+
parameters?: Parameters<Paths.GetJsonSchema.PathParameters> | null,
|
|
9769
|
+
data?: any,
|
|
9770
|
+
config?: AxiosRequestConfig
|
|
9771
|
+
): OperationResponse<Paths.GetJsonSchema.Responses.$200>
|
|
9772
|
+
}
|
|
9773
|
+
['/v1/entity/schemas/{slug}/json/example']: {
|
|
9774
|
+
/**
|
|
9775
|
+
* getSchemaExample - getSchemaExample
|
|
9776
|
+
*
|
|
9777
|
+
* Get a full example entity for the given schema
|
|
9778
|
+
*/
|
|
9779
|
+
'get'(
|
|
9780
|
+
parameters?: Parameters<Paths.GetSchemaExample.PathParameters> | null,
|
|
9781
|
+
data?: any,
|
|
9782
|
+
config?: AxiosRequestConfig
|
|
9783
|
+
): OperationResponse<Paths.GetSchemaExample.Responses.$200>
|
|
9418
9784
|
}
|
|
9419
9785
|
['/v1/entity/schemas/{slug}/versions']: {
|
|
9420
9786
|
/**
|
|
@@ -9601,7 +9967,6 @@ export interface PathsDictionary {
|
|
|
9601
9967
|
*
|
|
9602
9968
|
* - If no entities are matched, a new entity is created.
|
|
9603
9969
|
* - If exactly one entity is matched, a `PATCH`-style update is applied to the existing entity.
|
|
9604
|
-
* - If more than one entity is matched a `409` Error is returned
|
|
9605
9970
|
*
|
|
9606
9971
|
* ## Activity
|
|
9607
9972
|
*
|
package/dist/openapi.json
CHANGED
|
@@ -177,12 +177,355 @@
|
|
|
177
177
|
}
|
|
178
178
|
],
|
|
179
179
|
"responses": {
|
|
180
|
-
"
|
|
180
|
+
"200": {
|
|
181
181
|
"description": "Success"
|
|
182
182
|
}
|
|
183
183
|
}
|
|
184
184
|
}
|
|
185
185
|
},
|
|
186
|
+
"/v1/entity/schemas/{slug}/json/schema": {
|
|
187
|
+
"get": {
|
|
188
|
+
"operationId": "getJsonSchema",
|
|
189
|
+
"summary": "getJsonSchema",
|
|
190
|
+
"description": "Get formal JSON schema definition draft 2020-12 for the given epilot schema",
|
|
191
|
+
"tags": [
|
|
192
|
+
"Schemas"
|
|
193
|
+
],
|
|
194
|
+
"parameters": [
|
|
195
|
+
{
|
|
196
|
+
"$ref": "#/components/parameters/EntitySlugPathParam"
|
|
197
|
+
}
|
|
198
|
+
],
|
|
199
|
+
"responses": {
|
|
200
|
+
"200": {
|
|
201
|
+
"description": "Success",
|
|
202
|
+
"content": {
|
|
203
|
+
"application/json": {
|
|
204
|
+
"schema": {
|
|
205
|
+
"type": "object",
|
|
206
|
+
"example": {
|
|
207
|
+
"$schema": "http://json-schema.org/draft/2020-12/schema",
|
|
208
|
+
"type": "object",
|
|
209
|
+
"properties": {
|
|
210
|
+
"_id": {
|
|
211
|
+
"type": "string",
|
|
212
|
+
"format": "uuid",
|
|
213
|
+
"example": "123e4567-e89b-12d3-a456-426614174000"
|
|
214
|
+
},
|
|
215
|
+
"_org": {
|
|
216
|
+
"type": "string",
|
|
217
|
+
"description": "Organization Id the entity belongs to",
|
|
218
|
+
"readOnly": true
|
|
219
|
+
},
|
|
220
|
+
"_owners": {
|
|
221
|
+
"type": "array",
|
|
222
|
+
"readOnly": true,
|
|
223
|
+
"items": {
|
|
224
|
+
"description": "The user / organization owning this entity.\n\nNote: Owner implicitly has access to the entity regardless of ACLs.\n",
|
|
225
|
+
"type": "object",
|
|
226
|
+
"properties": {
|
|
227
|
+
"org_id": {
|
|
228
|
+
"type": "string",
|
|
229
|
+
"example": "123"
|
|
230
|
+
},
|
|
231
|
+
"user_id": {
|
|
232
|
+
"type": "string",
|
|
233
|
+
"example": "123"
|
|
234
|
+
}
|
|
235
|
+
},
|
|
236
|
+
"required": [
|
|
237
|
+
"org_id"
|
|
238
|
+
]
|
|
239
|
+
}
|
|
240
|
+
},
|
|
241
|
+
"_schema": {
|
|
242
|
+
"readOnly": true,
|
|
243
|
+
"type": "string"
|
|
244
|
+
},
|
|
245
|
+
"_title": {
|
|
246
|
+
"readOnly": true,
|
|
247
|
+
"type": "string"
|
|
248
|
+
},
|
|
249
|
+
"_tags": {
|
|
250
|
+
"type": "array",
|
|
251
|
+
"nullable": true,
|
|
252
|
+
"items": {
|
|
253
|
+
"type": "string"
|
|
254
|
+
}
|
|
255
|
+
},
|
|
256
|
+
"_created_at": {
|
|
257
|
+
"readOnly": true,
|
|
258
|
+
"type": "string",
|
|
259
|
+
"format": "date-time"
|
|
260
|
+
},
|
|
261
|
+
"_updated_at": {
|
|
262
|
+
"readOnly": true,
|
|
263
|
+
"type": "string",
|
|
264
|
+
"format": "date-time"
|
|
265
|
+
},
|
|
266
|
+
"_acl": {
|
|
267
|
+
"readOnly": true,
|
|
268
|
+
"type": "object",
|
|
269
|
+
"description": "Access control list (ACL) for an entity. Defines sharing access to external orgs or users.",
|
|
270
|
+
"additionalProperties": true,
|
|
271
|
+
"properties": {
|
|
272
|
+
"view": {
|
|
273
|
+
"type": "array",
|
|
274
|
+
"items": {
|
|
275
|
+
"type": "string",
|
|
276
|
+
"example": "org:456"
|
|
277
|
+
}
|
|
278
|
+
},
|
|
279
|
+
"edit": {
|
|
280
|
+
"type": "array",
|
|
281
|
+
"items": {
|
|
282
|
+
"type": "string",
|
|
283
|
+
"example": "org:456"
|
|
284
|
+
}
|
|
285
|
+
},
|
|
286
|
+
"delete": {
|
|
287
|
+
"type": "array",
|
|
288
|
+
"items": {
|
|
289
|
+
"type": "string",
|
|
290
|
+
"example": "org:456"
|
|
291
|
+
}
|
|
292
|
+
}
|
|
293
|
+
}
|
|
294
|
+
},
|
|
295
|
+
"title": {
|
|
296
|
+
"type": "string",
|
|
297
|
+
"nullable": true,
|
|
298
|
+
"enum": [
|
|
299
|
+
"Dr.",
|
|
300
|
+
"Prof.",
|
|
301
|
+
"Prof. Dr."
|
|
302
|
+
]
|
|
303
|
+
},
|
|
304
|
+
"salutation": {
|
|
305
|
+
"type": "string",
|
|
306
|
+
"nullable": true,
|
|
307
|
+
"enum": [
|
|
308
|
+
"Mr.",
|
|
309
|
+
"Ms. / Mrs.",
|
|
310
|
+
"Company",
|
|
311
|
+
"Contact Person",
|
|
312
|
+
"Company/Contact Person",
|
|
313
|
+
"Spouse",
|
|
314
|
+
"Family",
|
|
315
|
+
"Ownership",
|
|
316
|
+
"Assembly",
|
|
317
|
+
"Other"
|
|
318
|
+
]
|
|
319
|
+
},
|
|
320
|
+
"first_name": {
|
|
321
|
+
"type": "string"
|
|
322
|
+
},
|
|
323
|
+
"last_name": {
|
|
324
|
+
"type": "string"
|
|
325
|
+
},
|
|
326
|
+
"customer_number": {
|
|
327
|
+
"type": "string",
|
|
328
|
+
"nullable": true
|
|
329
|
+
},
|
|
330
|
+
"birthdate": {
|
|
331
|
+
"type": "string",
|
|
332
|
+
"format": "date",
|
|
333
|
+
"nullable": true
|
|
334
|
+
},
|
|
335
|
+
"account": {
|
|
336
|
+
"type": "object",
|
|
337
|
+
"nullable": true,
|
|
338
|
+
"properties": {
|
|
339
|
+
"$relation": {
|
|
340
|
+
"type": "array",
|
|
341
|
+
"items": {
|
|
342
|
+
"type": "object",
|
|
343
|
+
"properties": {
|
|
344
|
+
"entity_id": {
|
|
345
|
+
"type": "string",
|
|
346
|
+
"format": "uuid",
|
|
347
|
+
"example": "123e4567-e89b-12d3-a456-426614174000"
|
|
348
|
+
},
|
|
349
|
+
"_tags": {
|
|
350
|
+
"type": "array",
|
|
351
|
+
"nullable": true,
|
|
352
|
+
"items": {
|
|
353
|
+
"type": "string"
|
|
354
|
+
}
|
|
355
|
+
}
|
|
356
|
+
},
|
|
357
|
+
"required": [
|
|
358
|
+
"entity_id"
|
|
359
|
+
]
|
|
360
|
+
}
|
|
361
|
+
}
|
|
362
|
+
},
|
|
363
|
+
"additionalProperties": true
|
|
364
|
+
},
|
|
365
|
+
"address": {
|
|
366
|
+
"type": "array",
|
|
367
|
+
"nullable": true,
|
|
368
|
+
"description": "Addresses as a list of object, the element with index 0 is treated as the primary one.\n",
|
|
369
|
+
"items": {
|
|
370
|
+
"type": "object",
|
|
371
|
+
"properties": {
|
|
372
|
+
"street": {
|
|
373
|
+
"type": "string",
|
|
374
|
+
"nullable": true
|
|
375
|
+
},
|
|
376
|
+
"street_number": {
|
|
377
|
+
"type": "string",
|
|
378
|
+
"nullable": true
|
|
379
|
+
},
|
|
380
|
+
"postal_code": {
|
|
381
|
+
"type": "string",
|
|
382
|
+
"nullable": true
|
|
383
|
+
},
|
|
384
|
+
"city": {
|
|
385
|
+
"type": "string",
|
|
386
|
+
"nullable": true
|
|
387
|
+
},
|
|
388
|
+
"country": {
|
|
389
|
+
"type": "string",
|
|
390
|
+
"nullable": true,
|
|
391
|
+
"enum": [
|
|
392
|
+
"DE",
|
|
393
|
+
"AT",
|
|
394
|
+
"CH"
|
|
395
|
+
]
|
|
396
|
+
},
|
|
397
|
+
"additional_info": {
|
|
398
|
+
"type": "string",
|
|
399
|
+
"nullable": true
|
|
400
|
+
},
|
|
401
|
+
"_tags": {
|
|
402
|
+
"type": "array",
|
|
403
|
+
"nullable": true,
|
|
404
|
+
"items": {
|
|
405
|
+
"type": "string"
|
|
406
|
+
}
|
|
407
|
+
},
|
|
408
|
+
"_id": {
|
|
409
|
+
"type": "string",
|
|
410
|
+
"example": "xHcOoJCa07eysJ1GaQeSb"
|
|
411
|
+
}
|
|
412
|
+
},
|
|
413
|
+
"required": [
|
|
414
|
+
"street",
|
|
415
|
+
"street_number",
|
|
416
|
+
"postal_code",
|
|
417
|
+
"city",
|
|
418
|
+
"country"
|
|
419
|
+
]
|
|
420
|
+
}
|
|
421
|
+
},
|
|
422
|
+
"email": {
|
|
423
|
+
"type": "array",
|
|
424
|
+
"nullable": true,
|
|
425
|
+
"description": "Email addresses as a list of object, the element with index 0 is treated as the primary one.\n",
|
|
426
|
+
"items": {
|
|
427
|
+
"type": "object",
|
|
428
|
+
"properties": {
|
|
429
|
+
"_id": {
|
|
430
|
+
"type": "string",
|
|
431
|
+
"example": "xHcOoJCa07eysJ1GaQeSb"
|
|
432
|
+
},
|
|
433
|
+
"_tags": {
|
|
434
|
+
"type": "array",
|
|
435
|
+
"nullable": true,
|
|
436
|
+
"items": {
|
|
437
|
+
"type": "string"
|
|
438
|
+
}
|
|
439
|
+
},
|
|
440
|
+
"email": {
|
|
441
|
+
"type": "string"
|
|
442
|
+
}
|
|
443
|
+
},
|
|
444
|
+
"required": [
|
|
445
|
+
"email"
|
|
446
|
+
]
|
|
447
|
+
}
|
|
448
|
+
},
|
|
449
|
+
"phone": {
|
|
450
|
+
"type": "array",
|
|
451
|
+
"description": "Phone numbers as a list of object, the element with index 0 is treated as the primary one.\n",
|
|
452
|
+
"items": {
|
|
453
|
+
"type": "object",
|
|
454
|
+
"properties": {
|
|
455
|
+
"_id": {
|
|
456
|
+
"type": "string",
|
|
457
|
+
"example": "xHcOoJCa07eysJ1GaQeSb"
|
|
458
|
+
},
|
|
459
|
+
"_tags": {
|
|
460
|
+
"type": "array",
|
|
461
|
+
"nullable": true,
|
|
462
|
+
"items": {
|
|
463
|
+
"type": "string"
|
|
464
|
+
}
|
|
465
|
+
},
|
|
466
|
+
"phone": {
|
|
467
|
+
"type": "string"
|
|
468
|
+
}
|
|
469
|
+
},
|
|
470
|
+
"required": [
|
|
471
|
+
"phone"
|
|
472
|
+
]
|
|
473
|
+
}
|
|
474
|
+
}
|
|
475
|
+
},
|
|
476
|
+
"required": [
|
|
477
|
+
"first_name",
|
|
478
|
+
"last_name",
|
|
479
|
+
"_id",
|
|
480
|
+
"_org",
|
|
481
|
+
"_owners",
|
|
482
|
+
"_schema",
|
|
483
|
+
"_title",
|
|
484
|
+
"_tags",
|
|
485
|
+
"_created_at",
|
|
486
|
+
"_updated_at",
|
|
487
|
+
"_acl"
|
|
488
|
+
]
|
|
489
|
+
}
|
|
490
|
+
}
|
|
491
|
+
}
|
|
492
|
+
}
|
|
493
|
+
}
|
|
494
|
+
}
|
|
495
|
+
}
|
|
496
|
+
},
|
|
497
|
+
"/v1/entity/schemas/{slug}/json/example": {
|
|
498
|
+
"get": {
|
|
499
|
+
"operationId": "getSchemaExample",
|
|
500
|
+
"summary": "getSchemaExample",
|
|
501
|
+
"description": "Get a full example entity for the given schema",
|
|
502
|
+
"tags": [
|
|
503
|
+
"Schemas"
|
|
504
|
+
],
|
|
505
|
+
"parameters": [
|
|
506
|
+
{
|
|
507
|
+
"$ref": "#/components/parameters/EntitySlugPathParam"
|
|
508
|
+
}
|
|
509
|
+
],
|
|
510
|
+
"responses": {
|
|
511
|
+
"200": {
|
|
512
|
+
"description": "Success",
|
|
513
|
+
"content": {
|
|
514
|
+
"application/json": {
|
|
515
|
+
"schema": {
|
|
516
|
+
"type": "object"
|
|
517
|
+
},
|
|
518
|
+
"examples": {
|
|
519
|
+
"contact": {
|
|
520
|
+
"$ref": "#/components/examples/ContactEntity"
|
|
521
|
+
}
|
|
522
|
+
}
|
|
523
|
+
}
|
|
524
|
+
}
|
|
525
|
+
}
|
|
526
|
+
}
|
|
527
|
+
}
|
|
528
|
+
},
|
|
186
529
|
"/v1/entity/schemas/{slug}/versions": {
|
|
187
530
|
"get": {
|
|
188
531
|
"operationId": "getSchemaVersions",
|
|
@@ -559,7 +902,7 @@
|
|
|
559
902
|
"patch": {
|
|
560
903
|
"operationId": "upsertEntity",
|
|
561
904
|
"summary": "upsertEntity",
|
|
562
|
-
"description": "Create or update an entity using `unique_key`\n\n- If no entities are matched, a new entity is created.\n- If exactly one entity is matched, a `PATCH`-style update is applied to the existing entity.\n
|
|
905
|
+
"description": "Create or update an entity using `unique_key`\n\n- If no entities are matched, a new entity is created.\n- If exactly one entity is matched, a `PATCH`-style update is applied to the existing entity.\n\n## Activity\n\nIf no `activity_id` query parameter is provided, implicitly creates Activity of type `EntityCreated` or `EntityUpdated`\n",
|
|
563
906
|
"tags": [
|
|
564
907
|
"Entities"
|
|
565
908
|
],
|
|
@@ -575,6 +918,16 @@
|
|
|
575
918
|
},
|
|
576
919
|
{
|
|
577
920
|
"$ref": "#/components/parameters/AsyncOperationQueryParam"
|
|
921
|
+
},
|
|
922
|
+
{
|
|
923
|
+
"name": "strict",
|
|
924
|
+
"description": "Strict mode = return 409 if more than one entity is matched",
|
|
925
|
+
"in": "query",
|
|
926
|
+
"required": false,
|
|
927
|
+
"schema": {
|
|
928
|
+
"type": "boolean",
|
|
929
|
+
"default": false
|
|
930
|
+
}
|
|
578
931
|
}
|
|
579
932
|
],
|
|
580
933
|
"requestBody": {
|
|
@@ -3363,7 +3716,6 @@
|
|
|
3363
3716
|
}
|
|
3364
3717
|
},
|
|
3365
3718
|
"required": [
|
|
3366
|
-
"id",
|
|
3367
3719
|
"name",
|
|
3368
3720
|
"label"
|
|
3369
3721
|
]
|
|
@@ -4520,7 +4872,6 @@
|
|
|
4520
4872
|
}
|
|
4521
4873
|
},
|
|
4522
4874
|
"required": [
|
|
4523
|
-
"id",
|
|
4524
4875
|
"name"
|
|
4525
4876
|
]
|
|
4526
4877
|
},
|
|
@@ -4713,14 +5064,17 @@
|
|
|
4713
5064
|
"additionalProperties": true,
|
|
4714
5065
|
"properties": {
|
|
4715
5066
|
"_id": {
|
|
5067
|
+
"readOnly": true,
|
|
4716
5068
|
"$ref": "#/components/schemas/EntityId"
|
|
4717
5069
|
},
|
|
4718
5070
|
"_org": {
|
|
4719
5071
|
"type": "string",
|
|
5072
|
+
"readOnly": true,
|
|
4720
5073
|
"description": "Organization Id the entity belongs to"
|
|
4721
5074
|
},
|
|
4722
5075
|
"_owners": {
|
|
4723
5076
|
"type": "array",
|
|
5077
|
+
"readOnly": true,
|
|
4724
5078
|
"items": {
|
|
4725
5079
|
"$ref": "#/components/schemas/EntityOwner"
|
|
4726
5080
|
}
|
|
@@ -4743,14 +5097,17 @@
|
|
|
4743
5097
|
"_created_at": {
|
|
4744
5098
|
"type": "string",
|
|
4745
5099
|
"format": "date-time",
|
|
4746
|
-
"nullable": true
|
|
5100
|
+
"nullable": true,
|
|
5101
|
+
"readOnly": true
|
|
4747
5102
|
},
|
|
4748
5103
|
"_updated_at": {
|
|
4749
5104
|
"type": "string",
|
|
4750
5105
|
"format": "date-time",
|
|
4751
|
-
"nullable": true
|
|
5106
|
+
"nullable": true,
|
|
5107
|
+
"readOnly": true
|
|
4752
5108
|
},
|
|
4753
5109
|
"_acl": {
|
|
5110
|
+
"readOnly": true,
|
|
4754
5111
|
"$ref": "#/components/schemas/EntityAcl"
|
|
4755
5112
|
}
|
|
4756
5113
|
},
|
|
@@ -6849,9 +7206,6 @@
|
|
|
6849
7206
|
}
|
|
6850
7207
|
},
|
|
6851
7208
|
"servers": [
|
|
6852
|
-
{
|
|
6853
|
-
"url": "https://entity.sls.epilot.io"
|
|
6854
|
-
},
|
|
6855
7209
|
{
|
|
6856
7210
|
"url": "https://entity.sls.epilot.io"
|
|
6857
7211
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/entity-client",
|
|
3
|
-
"version": "4.25.
|
|
3
|
+
"version": "4.25.5",
|
|
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",
|
|
@@ -71,5 +71,5 @@
|
|
|
71
71
|
"webpack": "^5.18.0",
|
|
72
72
|
"webpack-cli": "^4.4.0"
|
|
73
73
|
},
|
|
74
|
-
"gitHead": "
|
|
74
|
+
"gitHead": "6ccd0b02c2516775f32e10bd9b870f8dab6b749b"
|
|
75
75
|
}
|