@epilot/entity-client 4.24.0 → 4.25.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 +10 -0
- package/dist/openapi.d.ts +388 -8
- package/dist/openapi.json +358 -20
- package/package/dist/client.d.ts +3 -0
- package/package/dist/client.js +37 -0
- package/package/dist/definition.d.ts +3 -0
- package/package/dist/definition.js +1 -0
- package/package/dist/index.js +19 -0
- package/{src → package/dist}/openapi.d.ts +71 -0
- package/{src → package/dist}/openapi.json +85 -3
- package/package/dist/schema-model.d.ts +11 -0
- package/package/dist/schema-model.js +13 -0
- package/package.json +1 -1
- package/dist/client.js.map +0 -1
- package/dist/definition.js.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/schema-model.js.map +0 -1
- package/jest.config.ts +0 -16
- package/package-lock.json +0 -17779
- package/src/client.test.ts +0 -25
- package/src/client.ts +0 -26
- package/src/definition.ts +0 -5
- package/src/schema-model.ts +0 -13
- package/webpack.config.js +0 -31
- /package/{src/index.ts → package/dist/index.d.ts} +0 -0
- /package/{src → package/dist}/openapi-runtime.json +0 -0
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/{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/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}]}}},"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}/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/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}]}}},"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})})();
|
|
@@ -124,6 +124,16 @@
|
|
|
124
124
|
}
|
|
125
125
|
}
|
|
126
126
|
},
|
|
127
|
+
"/v1/entity:list": {
|
|
128
|
+
"post": {
|
|
129
|
+
"operationId": "listEntities",
|
|
130
|
+
"requestBody": {
|
|
131
|
+
"content": {
|
|
132
|
+
"application/json": {}
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
},
|
|
127
137
|
"/v1/entity/{slug}": {
|
|
128
138
|
"post": {
|
|
129
139
|
"operationId": "createEntity",
|
package/dist/openapi.d.ts
CHANGED
|
@@ -1948,6 +1948,77 @@ declare namespace Components {
|
|
|
1948
1948
|
_updated_at: string | null; // date-time
|
|
1949
1949
|
_acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ EntityAcl;
|
|
1950
1950
|
}
|
|
1951
|
+
export interface EntityListParams {
|
|
1952
|
+
filter: /**
|
|
1953
|
+
* A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
|
|
1954
|
+
* example:
|
|
1955
|
+
* [
|
|
1956
|
+
* {
|
|
1957
|
+
* "term": {
|
|
1958
|
+
* "_schema": "contact"
|
|
1959
|
+
* }
|
|
1960
|
+
* },
|
|
1961
|
+
* {
|
|
1962
|
+
* "terms": {
|
|
1963
|
+
* "status": [
|
|
1964
|
+
* "active"
|
|
1965
|
+
* ]
|
|
1966
|
+
* }
|
|
1967
|
+
* }
|
|
1968
|
+
* ]
|
|
1969
|
+
*/
|
|
1970
|
+
SearchFilter;
|
|
1971
|
+
/**
|
|
1972
|
+
* Allow running the listing without any schema filter. This is disabled by default to prevent security and performance issues if done by an accident.
|
|
1973
|
+
*/
|
|
1974
|
+
allow_targeting_all_schemas?: boolean;
|
|
1975
|
+
/**
|
|
1976
|
+
* example:
|
|
1977
|
+
* _created_at:desc
|
|
1978
|
+
*/
|
|
1979
|
+
sort?: string;
|
|
1980
|
+
from?: number;
|
|
1981
|
+
/**
|
|
1982
|
+
* Max search size is 1000 with higher values defaulting to 1000
|
|
1983
|
+
*/
|
|
1984
|
+
size?: number;
|
|
1985
|
+
/**
|
|
1986
|
+
* When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.
|
|
1987
|
+
*/
|
|
1988
|
+
hydrate?: boolean;
|
|
1989
|
+
fields?: /**
|
|
1990
|
+
* List of entity fields to include or exclude in the response
|
|
1991
|
+
*
|
|
1992
|
+
* Use ! to exclude fields, e.g. `!_id` to exclude the `_id` field.
|
|
1993
|
+
*
|
|
1994
|
+
* Globbing and globstart (**) is supported for nested fields.
|
|
1995
|
+
*
|
|
1996
|
+
* example:
|
|
1997
|
+
* [
|
|
1998
|
+
* "_id",
|
|
1999
|
+
* "_title",
|
|
2000
|
+
* "first_name",
|
|
2001
|
+
* "account",
|
|
2002
|
+
* "!account.*._files",
|
|
2003
|
+
* "**._product"
|
|
2004
|
+
* ]
|
|
2005
|
+
*/
|
|
2006
|
+
FieldsParam;
|
|
2007
|
+
/**
|
|
2008
|
+
* Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics.
|
|
2009
|
+
* example:
|
|
2010
|
+
* {
|
|
2011
|
+
* "contact-count-per-tag": {
|
|
2012
|
+
* "terms": {
|
|
2013
|
+
* "field": "_tags.keyword"
|
|
2014
|
+
* }
|
|
2015
|
+
* }
|
|
2016
|
+
* }
|
|
2017
|
+
*/
|
|
2018
|
+
aggs?: {
|
|
2019
|
+
[key: string]: any;
|
|
2020
|
+
};
|
|
2021
|
+
}
|
|
1951
2022
|
export interface EntityOperation {
|
|
1952
2023
|
entity: EntityId /* uuid */;
|
|
1953
2024
|
/**
|
|
@@ -2670,13 +2741,65 @@ declare namespace Components {
|
|
|
2670
2741
|
*/
|
|
2671
2742
|
SearchMappings;
|
|
2672
2743
|
}
|
|
2744
|
+
export interface EntitySearchOptions {
|
|
2745
|
+
/**
|
|
2746
|
+
* example:
|
|
2747
|
+
* _created_at:desc
|
|
2748
|
+
*/
|
|
2749
|
+
sort?: string;
|
|
2750
|
+
from?: number;
|
|
2751
|
+
/**
|
|
2752
|
+
* Max search size is 1000 with higher values defaulting to 1000
|
|
2753
|
+
*/
|
|
2754
|
+
size?: number;
|
|
2755
|
+
/**
|
|
2756
|
+
* When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.
|
|
2757
|
+
*/
|
|
2758
|
+
hydrate?: boolean;
|
|
2759
|
+
fields?: /**
|
|
2760
|
+
* List of entity fields to include or exclude in the response
|
|
2761
|
+
*
|
|
2762
|
+
* Use ! to exclude fields, e.g. `!_id` to exclude the `_id` field.
|
|
2763
|
+
*
|
|
2764
|
+
* Globbing and globstart (**) is supported for nested fields.
|
|
2765
|
+
*
|
|
2766
|
+
* example:
|
|
2767
|
+
* [
|
|
2768
|
+
* "_id",
|
|
2769
|
+
* "_title",
|
|
2770
|
+
* "first_name",
|
|
2771
|
+
* "account",
|
|
2772
|
+
* "!account.*._files",
|
|
2773
|
+
* "**._product"
|
|
2774
|
+
* ]
|
|
2775
|
+
*/
|
|
2776
|
+
FieldsParam;
|
|
2777
|
+
/**
|
|
2778
|
+
* Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics.
|
|
2779
|
+
* example:
|
|
2780
|
+
* {
|
|
2781
|
+
* "contact-count-per-tag": {
|
|
2782
|
+
* "terms": {
|
|
2783
|
+
* "field": "_tags.keyword"
|
|
2784
|
+
* }
|
|
2785
|
+
* }
|
|
2786
|
+
* }
|
|
2787
|
+
*/
|
|
2788
|
+
aggs?: {
|
|
2789
|
+
[key: string]: any;
|
|
2790
|
+
};
|
|
2791
|
+
}
|
|
2673
2792
|
export interface EntitySearchParams {
|
|
2674
2793
|
/**
|
|
2675
|
-
* Lucene queries supported with ElasticSearch
|
|
2794
|
+
* Lucene [queries supported with ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax)
|
|
2676
2795
|
* example:
|
|
2677
2796
|
* _schema:contact AND status:active
|
|
2678
2797
|
*/
|
|
2679
2798
|
q: string;
|
|
2799
|
+
/**
|
|
2800
|
+
* Adds a `_score` number field to results that can be used to rank by match score
|
|
2801
|
+
*/
|
|
2802
|
+
include_scores?: boolean;
|
|
2680
2803
|
/**
|
|
2681
2804
|
* example:
|
|
2682
2805
|
* _created_at:desc
|
|
@@ -2709,10 +2832,6 @@ declare namespace Components {
|
|
|
2709
2832
|
* ]
|
|
2710
2833
|
*/
|
|
2711
2834
|
FieldsParam;
|
|
2712
|
-
/**
|
|
2713
|
-
* Adds a `_score` number field to results that can be used to rank by match score
|
|
2714
|
-
*/
|
|
2715
|
-
include_scores?: boolean;
|
|
2716
2835
|
/**
|
|
2717
2836
|
* Aggregation supported by ElasticSearch allows summarizing data as metrics, statistics, or other analytics.
|
|
2718
2837
|
* example:
|
|
@@ -3077,6 +3196,73 @@ declare namespace Components {
|
|
|
3077
3196
|
hits?: number;
|
|
3078
3197
|
relations?: GetRelationsResp;
|
|
3079
3198
|
}
|
|
3199
|
+
/**
|
|
3200
|
+
* Entity with relation data resolved into the attribute values
|
|
3201
|
+
* example:
|
|
3202
|
+
* {
|
|
3203
|
+
* "_relations": [
|
|
3204
|
+
* {
|
|
3205
|
+
* "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
|
|
3206
|
+
* }
|
|
3207
|
+
* ],
|
|
3208
|
+
* "status": "active",
|
|
3209
|
+
* "customer_number": "abc123",
|
|
3210
|
+
* "email": [
|
|
3211
|
+
* {
|
|
3212
|
+
* "label": "work",
|
|
3213
|
+
* "email": "user@example.com"
|
|
3214
|
+
* }
|
|
3215
|
+
* ],
|
|
3216
|
+
* "phone": [
|
|
3217
|
+
* {
|
|
3218
|
+
* "label": "work",
|
|
3219
|
+
* "phone": "+49123456789"
|
|
3220
|
+
* }
|
|
3221
|
+
* ],
|
|
3222
|
+
* "first_name": "First Name",
|
|
3223
|
+
* "middle_name": "Middle Name",
|
|
3224
|
+
* "last_name": "Last Name",
|
|
3225
|
+
* "date_of_birth": "2019-08-24",
|
|
3226
|
+
* "title": "Mr.",
|
|
3227
|
+
* "account": [
|
|
3228
|
+
* {
|
|
3229
|
+
* "status": "active",
|
|
3230
|
+
* "name": "Company name",
|
|
3231
|
+
* "company_email": [
|
|
3232
|
+
* {
|
|
3233
|
+
* "label": "Company email",
|
|
3234
|
+
* "email": "company@example.com"
|
|
3235
|
+
* }
|
|
3236
|
+
* ],
|
|
3237
|
+
* "company_phone": [
|
|
3238
|
+
* {
|
|
3239
|
+
* "label": "Support phone",
|
|
3240
|
+
* "phone": "+49123456789"
|
|
3241
|
+
* }
|
|
3242
|
+
* ],
|
|
3243
|
+
* "company_website": "https://example.com",
|
|
3244
|
+
* "tax_id": "DE123456789",
|
|
3245
|
+
* "tax_exemption": "2019-08-24",
|
|
3246
|
+
* "contacts": {
|
|
3247
|
+
* "$relation": [
|
|
3248
|
+
* {
|
|
3249
|
+
* "_tags": [
|
|
3250
|
+
* "CEO"
|
|
3251
|
+
* ],
|
|
3252
|
+
* "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
|
|
3253
|
+
* }
|
|
3254
|
+
* ]
|
|
3255
|
+
* }
|
|
3256
|
+
* }
|
|
3257
|
+
* ]
|
|
3258
|
+
* }
|
|
3259
|
+
*/
|
|
3260
|
+
export interface HydratedEntity {
|
|
3261
|
+
[name: string]: any;
|
|
3262
|
+
_relations: {
|
|
3263
|
+
entity_id: EntityId /* uuid */;
|
|
3264
|
+
}[];
|
|
3265
|
+
}
|
|
3080
3266
|
/**
|
|
3081
3267
|
* No UI representation
|
|
3082
3268
|
*/
|
|
@@ -5180,6 +5366,166 @@ declare namespace Components {
|
|
|
5180
5366
|
* Generated uuid for schema
|
|
5181
5367
|
*/
|
|
5182
5368
|
export type SchemaId = string; // uuid
|
|
5369
|
+
/**
|
|
5370
|
+
* A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
|
|
5371
|
+
* example:
|
|
5372
|
+
* [
|
|
5373
|
+
* {
|
|
5374
|
+
* "term": {
|
|
5375
|
+
* "_schema": "contact"
|
|
5376
|
+
* }
|
|
5377
|
+
* },
|
|
5378
|
+
* {
|
|
5379
|
+
* "terms": {
|
|
5380
|
+
* "status": [
|
|
5381
|
+
* "active"
|
|
5382
|
+
* ]
|
|
5383
|
+
* }
|
|
5384
|
+
* }
|
|
5385
|
+
* ]
|
|
5386
|
+
*/
|
|
5387
|
+
export type SearchFilter = {
|
|
5388
|
+
/**
|
|
5389
|
+
* Returns documents that contain an exact term in a provided field.
|
|
5390
|
+
*
|
|
5391
|
+
* To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
|
|
5392
|
+
*
|
|
5393
|
+
* You likely DO NOT want to use this filter on text fields and want to target its .keyword instead.
|
|
5394
|
+
*
|
|
5395
|
+
* example:
|
|
5396
|
+
* {
|
|
5397
|
+
* "_schema": "contact"
|
|
5398
|
+
* }
|
|
5399
|
+
*/
|
|
5400
|
+
term?: {
|
|
5401
|
+
[name: string]: /* A filter field value. */ SearchFilterValue;
|
|
5402
|
+
};
|
|
5403
|
+
/**
|
|
5404
|
+
* Returns documents that contain one of the exact terms in a provided field. See term filter for more info.
|
|
5405
|
+
* example:
|
|
5406
|
+
* {
|
|
5407
|
+
* "status": [
|
|
5408
|
+
* "active"
|
|
5409
|
+
* ]
|
|
5410
|
+
* }
|
|
5411
|
+
*/
|
|
5412
|
+
terms?: {
|
|
5413
|
+
[name: string]: /* A filter field value. */ SearchFilterValue[];
|
|
5414
|
+
};
|
|
5415
|
+
/**
|
|
5416
|
+
* Returns documents based on their IDs.
|
|
5417
|
+
* example:
|
|
5418
|
+
* {
|
|
5419
|
+
* "values": [
|
|
5420
|
+
* "550e8400-e29b-41d4-a716-446655440000"
|
|
5421
|
+
* ]
|
|
5422
|
+
* }
|
|
5423
|
+
*/
|
|
5424
|
+
ids?: {
|
|
5425
|
+
values?: string[];
|
|
5426
|
+
};
|
|
5427
|
+
/**
|
|
5428
|
+
* Returns documents with fields that have terms within a certain range.
|
|
5429
|
+
* example:
|
|
5430
|
+
* {
|
|
5431
|
+
* "_created_at": {
|
|
5432
|
+
* "gte": "2021-01-01T00:00:00.000Z",
|
|
5433
|
+
* "lte": "2021-01-31T23:59:59.999Z"
|
|
5434
|
+
* }
|
|
5435
|
+
* }
|
|
5436
|
+
*/
|
|
5437
|
+
range?: {
|
|
5438
|
+
[name: string]: {
|
|
5439
|
+
gt?: /* A filter field value. */ SearchFilterValue;
|
|
5440
|
+
gte?: /* A filter field value. */ SearchFilterValue;
|
|
5441
|
+
lt?: /* A filter field value. */ SearchFilterValue;
|
|
5442
|
+
lte?: /* A filter field value. */ SearchFilterValue;
|
|
5443
|
+
/**
|
|
5444
|
+
* The date format used to parse date values.
|
|
5445
|
+
*/
|
|
5446
|
+
format?: string;
|
|
5447
|
+
/**
|
|
5448
|
+
* Indicates how the range query matches values for range fields.
|
|
5449
|
+
*/
|
|
5450
|
+
relation?: "INTERSECTS" | "CONTAINS" | "WITHIN";
|
|
5451
|
+
/**
|
|
5452
|
+
* Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query to UTC.
|
|
5453
|
+
*/
|
|
5454
|
+
time_zone?: string;
|
|
5455
|
+
};
|
|
5456
|
+
};
|
|
5457
|
+
/**
|
|
5458
|
+
* Returns documents that have a value in the specified field.
|
|
5459
|
+
* example:
|
|
5460
|
+
* {
|
|
5461
|
+
* "field": "_tags"
|
|
5462
|
+
* }
|
|
5463
|
+
*/
|
|
5464
|
+
exists?: {
|
|
5465
|
+
field: string;
|
|
5466
|
+
};
|
|
5467
|
+
$and?: /**
|
|
5468
|
+
* A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
|
|
5469
|
+
* example:
|
|
5470
|
+
* [
|
|
5471
|
+
* {
|
|
5472
|
+
* "term": {
|
|
5473
|
+
* "_schema": "contact"
|
|
5474
|
+
* }
|
|
5475
|
+
* },
|
|
5476
|
+
* {
|
|
5477
|
+
* "terms": {
|
|
5478
|
+
* "status": [
|
|
5479
|
+
* "active"
|
|
5480
|
+
* ]
|
|
5481
|
+
* }
|
|
5482
|
+
* }
|
|
5483
|
+
* ]
|
|
5484
|
+
*/
|
|
5485
|
+
SearchFilter;
|
|
5486
|
+
$or?: /**
|
|
5487
|
+
* A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
|
|
5488
|
+
* example:
|
|
5489
|
+
* [
|
|
5490
|
+
* {
|
|
5491
|
+
* "term": {
|
|
5492
|
+
* "_schema": "contact"
|
|
5493
|
+
* }
|
|
5494
|
+
* },
|
|
5495
|
+
* {
|
|
5496
|
+
* "terms": {
|
|
5497
|
+
* "status": [
|
|
5498
|
+
* "active"
|
|
5499
|
+
* ]
|
|
5500
|
+
* }
|
|
5501
|
+
* }
|
|
5502
|
+
* ]
|
|
5503
|
+
*/
|
|
5504
|
+
SearchFilter;
|
|
5505
|
+
$not?: /**
|
|
5506
|
+
* A subset of simplified Elasticsearch query clauses. The default operator is a logical AND. Use nested $and, $or, $not to combine filters using different logical operators.
|
|
5507
|
+
* example:
|
|
5508
|
+
* [
|
|
5509
|
+
* {
|
|
5510
|
+
* "term": {
|
|
5511
|
+
* "_schema": "contact"
|
|
5512
|
+
* }
|
|
5513
|
+
* },
|
|
5514
|
+
* {
|
|
5515
|
+
* "terms": {
|
|
5516
|
+
* "status": [
|
|
5517
|
+
* "active"
|
|
5518
|
+
* ]
|
|
5519
|
+
* }
|
|
5520
|
+
* }
|
|
5521
|
+
* ]
|
|
5522
|
+
*/
|
|
5523
|
+
SearchFilter;
|
|
5524
|
+
}[];
|
|
5525
|
+
/**
|
|
5526
|
+
* A filter field value.
|
|
5527
|
+
*/
|
|
5528
|
+
export type SearchFilterValue = /* A filter field value. */ (string | null) | number | boolean;
|
|
5183
5529
|
/**
|
|
5184
5530
|
* Advanced: explicit Elasticsearch index mapping definitions for entity data
|
|
5185
5531
|
*
|
|
@@ -7176,6 +7522,12 @@ declare namespace Paths {
|
|
|
7176
7522
|
}
|
|
7177
7523
|
}
|
|
7178
7524
|
}
|
|
7525
|
+
namespace ListEntities {
|
|
7526
|
+
export type RequestBody = Components.Schemas.EntityListParams;
|
|
7527
|
+
namespace Responses {
|
|
7528
|
+
export type $200 = Components.Schemas.EntitySearchResults;
|
|
7529
|
+
}
|
|
7530
|
+
}
|
|
7179
7531
|
namespace ListFavoriteViewsForUser {
|
|
7180
7532
|
namespace Responses {
|
|
7181
7533
|
export interface $200 {
|
|
@@ -7672,7 +8024,7 @@ declare namespace Paths {
|
|
|
7672
8024
|
export interface PathParameters {
|
|
7673
8025
|
id: Parameters.Id;
|
|
7674
8026
|
}
|
|
7675
|
-
export type RequestBody = /* A saved entity view */ Components.Schemas.
|
|
8027
|
+
export type RequestBody = /* A saved entity view */ Components.Schemas.SavedViewItem;
|
|
7676
8028
|
namespace Responses {
|
|
7677
8029
|
export type $200 = /* A saved entity view */ Components.Schemas.SavedViewItem;
|
|
7678
8030
|
}
|
|
@@ -8035,7 +8387,7 @@ export interface OperationMethods {
|
|
|
8035
8387
|
/**
|
|
8036
8388
|
* searchEntities - searchEntities
|
|
8037
8389
|
*
|
|
8038
|
-
* Search for entities. Supports ordering and pagination. Lucene query syntax supported for complex querying.
|
|
8390
|
+
* Search for entities. Supports ordering and pagination. [Lucene query syntax](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax) supported for complex querying.
|
|
8039
8391
|
*
|
|
8040
8392
|
* Passing comma-separated `x-epilot-org-id` is supported for cross-org entity search.
|
|
8041
8393
|
*
|
|
@@ -8107,6 +8459,19 @@ export interface OperationMethods {
|
|
|
8107
8459
|
data?: Paths.SearchEntities.RequestBody,
|
|
8108
8460
|
config?: AxiosRequestConfig
|
|
8109
8461
|
): OperationResponse<Paths.SearchEntities.Responses.$200>
|
|
8462
|
+
/**
|
|
8463
|
+
* listEntities - listEntities
|
|
8464
|
+
*
|
|
8465
|
+
* List entities that meet the specified conditions.
|
|
8466
|
+
*
|
|
8467
|
+
* Supports the same options as entity search but utilizes filtering using a subset of [Elastic Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) and does not perform scoring.
|
|
8468
|
+
*
|
|
8469
|
+
*/
|
|
8470
|
+
'listEntities'(
|
|
8471
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
8472
|
+
data?: Paths.ListEntities.RequestBody,
|
|
8473
|
+
config?: AxiosRequestConfig
|
|
8474
|
+
): OperationResponse<Paths.ListEntities.Responses.$200>
|
|
8110
8475
|
/**
|
|
8111
8476
|
* createEntity - createEntity
|
|
8112
8477
|
*
|
|
@@ -8836,7 +9201,7 @@ export interface PathsDictionary {
|
|
|
8836
9201
|
/**
|
|
8837
9202
|
* searchEntities - searchEntities
|
|
8838
9203
|
*
|
|
8839
|
-
* Search for entities. Supports ordering and pagination. Lucene query syntax supported for complex querying.
|
|
9204
|
+
* Search for entities. Supports ordering and pagination. [Lucene query syntax](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax) supported for complex querying.
|
|
8840
9205
|
*
|
|
8841
9206
|
* Passing comma-separated `x-epilot-org-id` is supported for cross-org entity search.
|
|
8842
9207
|
*
|
|
@@ -8909,6 +9274,21 @@ export interface PathsDictionary {
|
|
|
8909
9274
|
config?: AxiosRequestConfig
|
|
8910
9275
|
): OperationResponse<Paths.SearchEntities.Responses.$200>
|
|
8911
9276
|
}
|
|
9277
|
+
['/v1/entity:list']: {
|
|
9278
|
+
/**
|
|
9279
|
+
* listEntities - listEntities
|
|
9280
|
+
*
|
|
9281
|
+
* List entities that meet the specified conditions.
|
|
9282
|
+
*
|
|
9283
|
+
* Supports the same options as entity search but utilizes filtering using a subset of [Elastic Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) and does not perform scoring.
|
|
9284
|
+
*
|
|
9285
|
+
*/
|
|
9286
|
+
'post'(
|
|
9287
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
9288
|
+
data?: Paths.ListEntities.RequestBody,
|
|
9289
|
+
config?: AxiosRequestConfig
|
|
9290
|
+
): OperationResponse<Paths.ListEntities.Responses.$200>
|
|
9291
|
+
}
|
|
8912
9292
|
['/v1/entity/{slug}']: {
|
|
8913
9293
|
/**
|
|
8914
9294
|
* createEntity - createEntity
|