@epilot/sdk 2.3.10 → 2.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/entity-runtime.json +1 -1
- package/definitions/entity.json +391 -4
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +8 -8
- package/dist/apis/entity.d.cts +2 -2
- package/dist/apis/entity.d.ts +2 -2
- package/dist/apis/entity.js +2 -2
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/bin/cli.js +1 -1
- package/dist/chunk-M6Z6ES3I.js +14 -0
- package/dist/{chunk-W7YCS4FU.js → chunk-O2AUZKUD.js} +2 -2
- package/dist/{chunk-MDLNRFJV.cjs → chunk-OK74PNHY.cjs} +2 -2
- package/dist/chunk-UBQCDPW6.cjs +14 -0
- package/dist/entity-H6ESUH3Y.js +7 -0
- package/dist/entity-ZVDKWQSF.cjs +7 -0
- package/dist/entity-runtime-3J5EDLXP.cjs +5 -0
- package/dist/{entity-runtime-D4DV5XRM.js → entity-runtime-LNAZILIN.js} +1 -1
- package/dist/{entity.d-ByufVI16.d.cts → entity.d-BHR9dEon.d.cts} +2020 -15
- package/dist/{entity.d-ByufVI16.d.ts → entity.d-BHR9dEon.d.ts} +2020 -15
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/dist/{js-yaml-DLCVPJ7G.js → js-yaml-UPZKYVRY.js} +15 -17
- package/docs/entity.md +1156 -40
- package/package.json +1 -1
- package/dist/chunk-F7W62NKV.js +0 -14
- package/dist/chunk-QA2OYK7N.cjs +0 -14
- package/dist/entity-CK76MXVN.js +0 -7
- package/dist/entity-TFMH5VTZ.cjs +0 -7
- package/dist/entity-runtime-DUJTRYLQ.cjs +0 -5
|
@@ -1 +1 @@
|
|
|
1
|
-
{"s":"https://entity.sls.epilot.io","o":[["listSchemas","get","/v1/entity/schemas",[["unpublished","q"],["latest","q"],["exclude","q",false,"form",false],["include","q",false,"form",false]]],["listSchemasV2","get","/v2/entity/schemas",[["full","q"],["unpublished","q"],["latest","q"],["exclude","q",false,"form",false],["include","q",false,"form",false]]],["getSchema","get","/v1/entity/schemas/{slug}",[["EntitySlugPathParam"],["id","q"],["latest","q"]]],["putSchema","put","/v1/entity/schemas/{slug}",[["EntitySlugPathParam"],["draft","q"]],1],["deleteSchema","delete","/v1/entity/schemas/{slug}",[["EntitySlugPathParam"]]],["getJsonSchema","get","/v1/entity/schemas/{slug}/json/schema",[["EntitySlugPathParam"],["dereference","q"]]],["getSchemaExample","get","/v1/entity/schemas/{slug}/json/example",[["EntitySlugPathParam"]]],["getSchemaVersions","get","/v1/entity/schemas/{slug}/versions",[["EntitySlugPathParam"],["versions_from","q"],["versions_size","q"],["drafts_from","q"],["drafts_size","q"],["fields","q",false,"form",false]]],["freezeSchema","post","/v1/entity/schemas/{slug}/freeze",[["EntitySlugPathParam"]],1],["unfreezeSchema","post","/v1/entity/schemas/{slug}/unfreeze",[["EntitySlugPathParam"]]],["listAvailableCapabilities","get","/v1/entity/schemas/{slug}/capabilities/available",[["EntitySlugPathParam"]]],["listSchemaBlueprints","get","/v1/entity/schemas/blueprints"],["searchEntities","post","/v1/entity:search",null,1],["listEntities","post","/v1/entity:list",null,1],["queryEntityGraph","post","/v1/entity:graph",null,1],["createEntity","post","/v1/entity/{slug}",[["EntitySlugPathParam"],["ActivityIdQueryParam"],["FillActivityQueryParam"],["AsyncOperationQueryParam"],["ValidateEntityQueryParam"]],1],["validateEntity","post","/v1/entity/{slug}:validate",[["EntitySlugPathPriceParam"]],1],["validateEntityV2","post","/v2/entity/{slug}:validate",[["EntitySlugPathPriceParam"]],1],["upsertEntity","patch","/v1/entity/{slug}:upsert",[["EntitySlugPathParam"],["ActivityIdQueryParam"],["FillActivityQueryParam"],["DryRunQueryParam"],["AsyncOperationQueryParam"],["ValidateEntityQueryParam"],["strict","q"]],1],["getEntityV2","get","/v2/entity/{slug}/{id}",[["EntityIdPathParam"],["EntitySlugPathParam"],["HydrateEntitiesQueryParam"],["fields","q",false,"form",false]]],["restoreEntity","patch","/v1/entity/{slug}/{id}:restore",[["EntityIdPathParam"],["EntitySlugPathParam"],["ActivityIdQueryParam"]],1],["reindexEntity","post","/v1/entity/{slug}/{id}:reindex",[["EntityIdPathParam"],["EntitySlugPathParam"]],1],["getEntity","get","/v1/entity/{slug}/{id}",[["EntityIdPathParam"],["EntitySlugPathParam"],["HydrateEntitiesQueryParam"]]],["updateEntity","put","/v1/entity/{slug}/{id}",[["EntitySlugPathParam"],["EntityIdPathParam"],["ActivityIdQueryParam"],["FillActivityQueryParam"],["AsyncOperationQueryParam"],["ValidateEntityQueryParam"]],1],["patchEntity","patch","/v1/entity/{slug}/{id}",[["EntitySlugPathParam"],["EntityIdPathParam"],["ActivityIdQueryParam"],["FillActivityQueryParam"],["DryRunQueryParam"],["AsyncOperationQueryParam"],["ValidateEntityQueryParam"]],1],["deleteEntity","delete","/v1/entity/{slug}/{id}",[["EntitySlugPathParam"],["EntityIdPathParam"],["ActivityIdQueryParam"],["purge","q"]]],["autocomplete","get","/v1/entity:autocomplete",[["input","q"],["attribute","q",true],["slug","q"],["size","q"]]],["wipeAllEntities","post","/v1/entity:wipeAllEntities",null,1],["createActivity","post","/v1/entity/activity",[["entities","q",false,"form",false]],1],["getActivity","get","/v1/entity/activity/{id}",[["ActivityIdPathParam"],["operations_size","q"],["operations_from","q"]]],["attachActivity","post","/v1/entity/activity/{id}:attach",[["ActivityIdPathParam"],["entities","q",false,"form",false]]],["getEntityActivityFeed","get","/v1/entity/{slug}/{id}/activity",[["EntitySlugPathParam"],["EntityIdPathParam"],["after","q"],["before","q"],["start_date","q"],["end_date","q"],["preset_range","q"],["FromPageQueryParam"],["size","q"],["type","q",false,"form",false],["include_relations","q"],["exclude_activity_groups","q"]]],["getRelations","get","/v1/entity/{slug}/{id}/relations",[["EntitySlugPathParam"],["EntityIdPathParam"],["HydrateEntitiesQueryParam"],["IncludeReverseQueryParam"],["FromPageQueryParam"],["size","q"],["IncludeSchemasQueryParam"],["ExcludeSchemasQueryParam"]]],["addRelations","post","/v1/entity/{slug}/{id}/relations",[["EntitySlugPathParam"],["EntityIdPathParam"],["AsyncOperationQueryParam"],["ActivityIdQueryParam"]],1],["removeRelations","delete","/v1/entity/{slug}/{id}/relations",[["EntitySlugPathParam"],["EntityIdPathParam"],["AsyncOperationQueryParam"],["ActivityIdQueryParam"]],1],["getRelationsV2","get","/v2/entity/{slug}/{id}/relations",[["EntitySlugPathParam"],["EntityIdPathParam"],["HydrateEntitiesQueryParam"],["query","q"],["IncludeReverseQueryParam"],["FromPageQueryParam"],["size","q"],["fields","q"]]],["getRelationsV3","get","/v3/entity/{slug}/{id}/relations",[["EntitySlugPathParam"],["EntityIdPathParam"],["HydrateEntitiesQueryParam"],["IncludeReverseDeprecatedQueryParam"],["FromPageQueryParam"],["size","q"],["IncludeSchemasQueryParam"],["ExcludeSchemasQueryParam"],["EntityRelationsModeQueryParam"],["fields","q"],["include_deleted","q"]]],["getRelatedEntitiesCount","get","/v2/entity/{slug}/{id}/relations/count",[["EntitySlugPathParam"],["EntityIdPathParam"],["ExcludeSchemasQueryParam"]]],["updateRelation","put","/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}",[["EntitySlugPathParam"],["EntityIdPathParam"],["attribute","p",true],["entity_id","p",true],["AsyncOperationQueryParam"],["ActivityIdQueryParam"]],1],["deleteRelation","delete","/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}",[["EntitySlugPathParam"],["EntityIdPathParam"],["attribute","p",true],["entity_id","p",true],["AsyncOperationQueryParam"],["ActivityIdQueryParam"]]],["exportEntities","post","/v1/entity:export",[["job_id","q"],["is_template","q"],["language","q"]],1],["importEntities","post","/v1/entity:import",[["job_id","q"]],1],["listSavedViews","get","/v1/entity/views",[["slug","q"],["sort","q"],["from","q"],["size","q"],["fields","q"]]],["createSavedView","post","/v1/entity/view",null,1],["getSavedView","get","/v1/entity/view/{id}",[["SavedViewIdPathParam"]]],["updateSavedView","put","/v1/entity/view/{id}",[["SavedViewIdPathParam"]],1],["patchSavedView","patch","/v1/entity/view/{id}",[["SavedViewIdPathParam"]],1],["deleteSavedView","delete","/v1/entity/view/{id}",[["SavedViewIdPathParam"]]],["listFavoriteViewsForUser","get","/v1/entity/views/favorites"],["listTaxonomies","get","/v1/entity/taxonomies",[["include_disabled","q"],["type","q"]]],["createTaxonomy","post","/v1/entity/taxonomies",null,1],["getTaxonomy","get","/v1/entity/taxonomies/{taxonomySlug}",[["TaxonomySlugPathParam"]]],["updateTaxonomy","put","/v1/entity/taxonomies/{taxonomySlug}",[["TaxonomySlugPathParam"]],1],["deleteTaxonomy","delete","/v1/entity/taxonomies/{taxonomySlug}",[["TaxonomySlugPathParam"],["permanent","q"]]],["updateClassificationsForTaxonomy","post","/v1/entity/taxonomies/{taxonomySlug}/classifications",[["TaxonomySlugPathParam"]],1],["createTaxonomyClassification","post","/v2/entity/taxonomies/classifications",null,1],["getTaxonomyClassification","get","/v2/entity/taxonomies/classifications/{classificationSlug}",[["TaxonomyClassificationSlugPathParam"]]],["updateTaxonomyClassification","put","/v2/entity/taxonomies/classifications/{classificationSlug}",[["TaxonomyClassificationSlugPathParam"]],1],["deleteTaxonomyClassification","delete","/v2/entity/taxonomies/classifications/{classificationSlug}",[["TaxonomyClassificationSlugPathParam"]]],["taxonomyAutocomplete","get","/v1/entity/taxonomies/{taxonomySlug}:autocomplete",[["TaxonomySlugPathParam"],["query","q"],["size","q"]]],["taxonomiesClassificationsSearch","post","/v1/entity/taxonomies/classifications:search",[["taxonomySlug","q"],["query","q"],["archived","q"],["include_archived","q"],["exclude_types","q"]],1],["listTaxonomyClassificationsForSchema","get","/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}",[["EntitySlugPathParam"],["TaxonomySlugPathParam"],["query","q"],["size","q"]]],["getTaxonomyBulkActionJobs","get","/v1/entity/taxonomies/bulk-jobs",[["status","q"],["size","q"],["created_after","q"],["sort_pending_first","q"],["scope","q"]]],["getTaxonomyBulkActionJobById","get","/v1/entity/taxonomies/bulk-jobs/{job_id}",[["job_id","p",true]]],["cancelBulkAction","post","/v1/entity/taxonomies/bulk-jobs/{job_id}/cancel",[["job_id","p",true]]],["bulkMoveClassifications","post","/v1/entity/taxonomies/classifications:move",null,1],["bulkMergeClassifications","post","/v1/entity/taxonomies/classifications:merge",null,1],["bulkDeleteClassifications","post","/v1/entity/taxonomies/classifications:delete",null,1],["createSchemaAttribute","post","/v1/entity/schemas/attributes",null,1],["getSchemaAttribute","get","/v1/entity/schemas/attributes/{composite_id}",[["composite_id","p",true]]],["putSchemaAttribute","put","/v1/entity/schemas/attributes/{composite_id}",[["composite_id","p",true]],1],["deleteSchemaAttribute","delete","/v1/entity/schemas/attributes/{composite_id}",[["composite_id","p",true]]],["createSchemaCapability","post","/v1/entity/schemas/capabilities",null,1],["getSchemaCapability","get","/v1/entity/schemas/capabilities/{composite_id}",[["composite_id","p",true]]],["putSchemaCapability","put","/v1/entity/schemas/capabilities/{composite_id}",[["composite_id","p",true]],1],["deleteSchemaCapability","delete","/v1/entity/schemas/capabilities/{composite_id}",[["composite_id","p",true]]],["createSchemaGroup","post","/v1/entity/schemas/group",null,1],["getSchemaGroup","get","/v1/entity/schemas/group/{composite_id}",[["composite_id","p",true]]],["putSchemaGroup","put","/v1/entity/schemas/group/{composite_id}",[["composite_id","p",true]],1],["deleteSchemaGroup","delete","/v1/entity/schemas/group/{composite_id}",[["composite_id","p",true]]],["createSchemaGroupHeadline","post","/v1/entity/schemas/headline",null,1],["getSchemaGroupHeadline","get","/v1/entity/schemas/headline/{composite_id}",[["composite_id","p",true]]],["putSchemaGroupHeadline","put","/v1/entity/schemas/headline/{composite_id}",[["composite_id","p",true]],1],["deleteSchemaGroupHeadline","delete","/v1/entity/schemas/headline/{composite_id}",[["composite_id","p",true]]]],"cp":{"EntityIdPathParam":["id","p",true],"EntitySlugPathParam":["slug","p",true],"EntitySlugPathPriceParam":["slug","p",true],"TaxonomySlugQueryParam":["taxonomySlug","q",true],"TaxonomySlugPathParam":["taxonomySlug","p",true],"TaxonomySlugQueryParamOptional":["taxonomySlug","q"],"TaxonomyClassificationSlugPathParam":["classificationSlug","p",true],"SavedViewIdPathParam":["id","p",true],"AsyncOperationQueryParam":["async","q"],"HydrateEntitiesQueryParam":["hydrate","q"],"ActivityIdQueryParam":["activity_id","q"],"ActivityIdPathParam":["id","p",true],"FromPageQueryParam":["from","q"],"IncludeReverseDeprecatedQueryParam":["include_reverse","q"],"IncludeReverseQueryParam":["include_reverse","q"],"IncludeSchemasQueryParam":["include_schemas","q",false,"form",false],"ExcludeSchemasQueryParam":["exclude_schemas","q",false,"form",false],"EntityRelationsModeQueryParam":["mode","q"],"DryRunQueryParam":["dry_run","q"],"FillActivityQueryParam":["fill_activity","q"],"ValidateEntityQueryParam":["validate","q"]}}
|
|
1
|
+
{"s":"https://entity.sls.epilot.io","o":[["listSchemas","get","/v1/entity/schemas",[["unpublished","q"],["latest","q"],["exclude","q",false,"form",false],["include","q",false,"form",false]]],["listSchemasV2","get","/v2/entity/schemas",[["full","q"],["unpublished","q"],["latest","q"],["exclude","q",false,"form",false],["include","q",false,"form",false]]],["getSchema","get","/v1/entity/schemas/{slug}",[["EntitySlugPathParam"],["id","q"],["latest","q"]]],["putSchema","put","/v1/entity/schemas/{slug}",[["EntitySlugPathParam"],["draft","q"]],1],["deleteSchema","delete","/v1/entity/schemas/{slug}",[["EntitySlugPathParam"]]],["getJsonSchema","get","/v1/entity/schemas/{slug}/json/schema",[["EntitySlugPathParam"],["dereference","q"]]],["getSchemaExample","get","/v1/entity/schemas/{slug}/json/example",[["EntitySlugPathParam"]]],["getSchemaVersions","get","/v1/entity/schemas/{slug}/versions",[["EntitySlugPathParam"],["versions_from","q"],["versions_size","q"],["drafts_from","q"],["drafts_size","q"],["fields","q",false,"form",false]]],["freezeSchema","post","/v1/entity/schemas/{slug}/freeze",[["EntitySlugPathParam"]],1],["unfreezeSchema","post","/v1/entity/schemas/{slug}/unfreeze",[["EntitySlugPathParam"]]],["listAvailableCapabilities","get","/v1/entity/schemas/{slug}/capabilities/available",[["EntitySlugPathParam"]]],["listSchemaBlueprints","get","/v1/entity/schemas/blueprints"],["searchEntities","post","/v1/entity:search",null,1],["listEntities","post","/v1/entity:list",null,1],["queryEntityGraph","post","/v1/entity:graph",null,1],["createEntity","post","/v1/entity/{slug}",[["EntitySlugPathParam"],["ActivityIdQueryParam"],["FillActivityQueryParam"],["AsyncOperationQueryParam"],["ValidateEntityQueryParam"]],1],["validateEntity","post","/v1/entity/{slug}:validate",[["EntitySlugPathPriceParam"]],1],["validateEntityV2","post","/v2/entity/{slug}:validate",[["EntitySlugPathPriceParam"]],1],["upsertEntity","patch","/v1/entity/{slug}:upsert",[["EntitySlugPathParam"],["ActivityIdQueryParam"],["FillActivityQueryParam"],["DryRunQueryParam"],["AsyncOperationQueryParam"],["ValidateEntityQueryParam"],["strict","q"]],1],["getEntityV2","get","/v2/entity/{slug}/{id}",[["EntityIdPathParam"],["EntitySlugPathParam"],["HydrateEntitiesQueryParam"],["fields","q",false,"form",false],["ApplyChangesetsQueryParam"]]],["restoreEntity","patch","/v1/entity/{slug}/{id}:restore",[["EntityIdPathParam"],["EntitySlugPathParam"],["ActivityIdQueryParam"]],1],["reindexEntity","post","/v1/entity/{slug}/{id}:reindex",[["EntityIdPathParam"],["EntitySlugPathParam"]],1],["getEntity","get","/v1/entity/{slug}/{id}",[["EntityIdPathParam"],["EntitySlugPathParam"],["HydrateEntitiesQueryParam"]]],["updateEntity","put","/v1/entity/{slug}/{id}",[["EntitySlugPathParam"],["EntityIdPathParam"],["ActivityIdQueryParam"],["FillActivityQueryParam"],["AsyncOperationQueryParam"],["ValidateEntityQueryParam"],["DirectQueryParam"]],1],["patchEntity","patch","/v1/entity/{slug}/{id}",[["EntitySlugPathParam"],["EntityIdPathParam"],["ActivityIdQueryParam"],["FillActivityQueryParam"],["DryRunQueryParam"],["AsyncOperationQueryParam"],["ValidateEntityQueryParam"],["DirectQueryParam"]],1],["deleteEntity","delete","/v1/entity/{slug}/{id}",[["EntitySlugPathParam"],["EntityIdPathParam"],["ActivityIdQueryParam"],["purge","q"]]],["autocomplete","get","/v1/entity:autocomplete",[["input","q"],["attribute","q",true],["slug","q"],["size","q"]]],["wipeAllEntities","post","/v1/entity:wipeAllEntities",null,1],["createActivity","post","/v1/entity/activity",[["entities","q",false,"form",false]],1],["getActivity","get","/v1/entity/activity/{id}",[["ActivityIdPathParam"],["operations_size","q"],["operations_from","q"]]],["attachActivity","post","/v1/entity/activity/{id}:attach",[["ActivityIdPathParam"],["entities","q",false,"form",false]]],["applyChangeset","post","/v1/entity/{slug}/{id}/changesets/{attribute}:apply",[["EntitySlugPathParam"],["EntityIdPathParam"],["attribute","p",true]]],["dismissChangeset","post","/v1/entity/{slug}/{id}/changesets/{attribute}:dismiss",[["EntitySlugPathParam"],["EntityIdPathParam"],["attribute","p",true]],1],["listChangesets","get","/v1/entity/{slug}/{id}/changesets",[["EntitySlugPathParam"],["EntityIdPathParam"]]],["getEntityActivityFeed","get","/v1/entity/{slug}/{id}/activity",[["EntitySlugPathParam"],["EntityIdPathParam"],["after","q"],["before","q"],["start_date","q"],["end_date","q"],["preset_range","q"],["FromPageQueryParam"],["size","q"],["type","q",false,"form",false],["include_relations","q"],["exclude_activity_groups","q"]]],["getRelations","get","/v1/entity/{slug}/{id}/relations",[["EntitySlugPathParam"],["EntityIdPathParam"],["HydrateEntitiesQueryParam"],["IncludeReverseQueryParam"],["FromPageQueryParam"],["size","q"],["IncludeSchemasQueryParam"],["ExcludeSchemasQueryParam"]]],["addRelations","post","/v1/entity/{slug}/{id}/relations",[["EntitySlugPathParam"],["EntityIdPathParam"],["AsyncOperationQueryParam"],["ActivityIdQueryParam"]],1],["removeRelations","delete","/v1/entity/{slug}/{id}/relations",[["EntitySlugPathParam"],["EntityIdPathParam"],["AsyncOperationQueryParam"],["ActivityIdQueryParam"]],1],["getRelationsV2","get","/v2/entity/{slug}/{id}/relations",[["EntitySlugPathParam"],["EntityIdPathParam"],["HydrateEntitiesQueryParam"],["query","q"],["IncludeReverseQueryParam"],["FromPageQueryParam"],["size","q"],["fields","q"]]],["getRelationsV3","get","/v3/entity/{slug}/{id}/relations",[["EntitySlugPathParam"],["EntityIdPathParam"],["HydrateEntitiesQueryParam"],["IncludeReverseDeprecatedQueryParam"],["FromPageQueryParam"],["size","q"],["IncludeSchemasQueryParam"],["ExcludeSchemasQueryParam"],["EntityRelationsModeQueryParam"],["fields","q"],["include_deleted","q"]]],["getRelatedEntitiesCount","get","/v2/entity/{slug}/{id}/relations/count",[["EntitySlugPathParam"],["EntityIdPathParam"],["ExcludeSchemasQueryParam"]]],["updateRelation","put","/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}",[["EntitySlugPathParam"],["EntityIdPathParam"],["attribute","p",true],["entity_id","p",true],["AsyncOperationQueryParam"],["ActivityIdQueryParam"]],1],["deleteRelation","delete","/v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}",[["EntitySlugPathParam"],["EntityIdPathParam"],["attribute","p",true],["entity_id","p",true],["AsyncOperationQueryParam"],["ActivityIdQueryParam"]]],["exportEntities","post","/v1/entity:export",[["job_id","q"],["is_template","q"],["language","q"]],1],["importEntities","post","/v1/entity:import",[["job_id","q"]],1],["listSavedViews","get","/v1/entity/views",[["slug","q"],["sort","q"],["from","q"],["size","q"],["fields","q"]]],["createSavedView","post","/v1/entity/view",null,1],["getSavedView","get","/v1/entity/view/{id}",[["SavedViewIdPathParam"]]],["updateSavedView","put","/v1/entity/view/{id}",[["SavedViewIdPathParam"]],1],["patchSavedView","patch","/v1/entity/view/{id}",[["SavedViewIdPathParam"]],1],["deleteSavedView","delete","/v1/entity/view/{id}",[["SavedViewIdPathParam"]]],["listFavoriteViewsForUser","get","/v1/entity/views/favorites"],["listTaxonomies","get","/v1/entity/taxonomies",[["include_disabled","q"],["type","q"]]],["createTaxonomy","post","/v1/entity/taxonomies",null,1],["getTaxonomy","get","/v1/entity/taxonomies/{taxonomySlug}",[["TaxonomySlugPathParam"]]],["updateTaxonomy","put","/v1/entity/taxonomies/{taxonomySlug}",[["TaxonomySlugPathParam"]],1],["deleteTaxonomy","delete","/v1/entity/taxonomies/{taxonomySlug}",[["TaxonomySlugPathParam"],["permanent","q"]]],["updateClassificationsForTaxonomy","post","/v1/entity/taxonomies/{taxonomySlug}/classifications",[["TaxonomySlugPathParam"]],1],["createTaxonomyClassification","post","/v2/entity/taxonomies/classifications",null,1],["getTaxonomyClassification","get","/v2/entity/taxonomies/classifications/{classificationSlug}",[["TaxonomyClassificationSlugPathParam"]]],["updateTaxonomyClassification","put","/v2/entity/taxonomies/classifications/{classificationSlug}",[["TaxonomyClassificationSlugPathParam"]],1],["deleteTaxonomyClassification","delete","/v2/entity/taxonomies/classifications/{classificationSlug}",[["TaxonomyClassificationSlugPathParam"]]],["taxonomyAutocomplete","get","/v1/entity/taxonomies/{taxonomySlug}:autocomplete",[["TaxonomySlugPathParam"],["query","q"],["size","q"]]],["taxonomiesClassificationsSearch","post","/v1/entity/taxonomies/classifications:search",[["taxonomySlug","q"],["query","q"],["archived","q"],["include_archived","q"],["exclude_types","q"]],1],["listTaxonomyClassificationsForSchema","get","/v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}",[["EntitySlugPathParam"],["TaxonomySlugPathParam"],["query","q"],["size","q"]]],["getTaxonomyBulkActionJobs","get","/v1/entity/taxonomies/bulk-jobs",[["status","q"],["size","q"],["created_after","q"],["sort_pending_first","q"],["scope","q"]]],["getTaxonomyBulkActionJobById","get","/v1/entity/taxonomies/bulk-jobs/{job_id}",[["job_id","p",true]]],["cancelBulkAction","post","/v1/entity/taxonomies/bulk-jobs/{job_id}/cancel",[["job_id","p",true]]],["bulkMoveClassifications","post","/v1/entity/taxonomies/classifications:move",null,1],["bulkMergeClassifications","post","/v1/entity/taxonomies/classifications:merge",null,1],["bulkDeleteClassifications","post","/v1/entity/taxonomies/classifications:delete",null,1],["createSchemaAttribute","post","/v1/entity/schemas/attributes",null,1],["getSchemaAttribute","get","/v1/entity/schemas/attributes/{composite_id}",[["composite_id","p",true]]],["putSchemaAttribute","put","/v1/entity/schemas/attributes/{composite_id}",[["composite_id","p",true]],1],["deleteSchemaAttribute","delete","/v1/entity/schemas/attributes/{composite_id}",[["composite_id","p",true]]],["createSchemaCapability","post","/v1/entity/schemas/capabilities",null,1],["getSchemaCapability","get","/v1/entity/schemas/capabilities/{composite_id}",[["composite_id","p",true]]],["putSchemaCapability","put","/v1/entity/schemas/capabilities/{composite_id}",[["composite_id","p",true]],1],["deleteSchemaCapability","delete","/v1/entity/schemas/capabilities/{composite_id}",[["composite_id","p",true]]],["createSchemaGroup","post","/v1/entity/schemas/group",null,1],["getSchemaGroup","get","/v1/entity/schemas/group/{composite_id}",[["composite_id","p",true]]],["putSchemaGroup","put","/v1/entity/schemas/group/{composite_id}",[["composite_id","p",true]],1],["deleteSchemaGroup","delete","/v1/entity/schemas/group/{composite_id}",[["composite_id","p",true]]],["createSchemaGroupHeadline","post","/v1/entity/schemas/headline",null,1],["getSchemaGroupHeadline","get","/v1/entity/schemas/headline/{composite_id}",[["composite_id","p",true]]],["putSchemaGroupHeadline","put","/v1/entity/schemas/headline/{composite_id}",[["composite_id","p",true]],1],["deleteSchemaGroupHeadline","delete","/v1/entity/schemas/headline/{composite_id}",[["composite_id","p",true]]]],"cp":{"EntityIdPathParam":["id","p",true],"EntitySlugPathParam":["slug","p",true],"EntitySlugPathPriceParam":["slug","p",true],"TaxonomySlugQueryParam":["taxonomySlug","q",true],"TaxonomySlugPathParam":["taxonomySlug","p",true],"TaxonomySlugQueryParamOptional":["taxonomySlug","q"],"TaxonomyClassificationSlugPathParam":["classificationSlug","p",true],"SavedViewIdPathParam":["id","p",true],"AsyncOperationQueryParam":["async","q"],"HydrateEntitiesQueryParam":["hydrate","q"],"ActivityIdQueryParam":["activity_id","q"],"ActivityIdPathParam":["id","p",true],"FromPageQueryParam":["from","q"],"IncludeReverseDeprecatedQueryParam":["include_reverse","q"],"IncludeReverseQueryParam":["include_reverse","q"],"IncludeSchemasQueryParam":["include_schemas","q",false,"form",false],"ExcludeSchemasQueryParam":["exclude_schemas","q",false,"form",false],"EntityRelationsModeQueryParam":["mode","q"],"DryRunQueryParam":["dry_run","q"],"FillActivityQueryParam":["fill_activity","q"],"ValidateEntityQueryParam":["validate","q"],"DirectQueryParam":["direct","q"],"ApplyChangesetsQueryParam":["apply_changesets","q"]}}
|
package/definitions/entity.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"openapi": "3.0.2",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Entity API",
|
|
5
|
-
"version": "2.
|
|
5
|
+
"version": "2.9.0",
|
|
6
6
|
"description": "Flexible data layer for epilot Entities.\n\nUse this API configure and access your business objects like Contacts, Opportunities and Products.\n\n[Feature Documentation](https://docs.epilot.io/docs/entities/flexible-entities)\n"
|
|
7
7
|
},
|
|
8
8
|
"tags": [
|
|
@@ -1428,6 +1428,9 @@
|
|
|
1428
1428
|
"schema": {
|
|
1429
1429
|
"$ref": "#/components/schemas/FieldsParam"
|
|
1430
1430
|
}
|
|
1431
|
+
},
|
|
1432
|
+
{
|
|
1433
|
+
"$ref": "#/components/parameters/ApplyChangesetsQueryParam"
|
|
1431
1434
|
}
|
|
1432
1435
|
],
|
|
1433
1436
|
"responses": {
|
|
@@ -1619,6 +1622,9 @@
|
|
|
1619
1622
|
},
|
|
1620
1623
|
{
|
|
1621
1624
|
"$ref": "#/components/parameters/ValidateEntityQueryParam"
|
|
1625
|
+
},
|
|
1626
|
+
{
|
|
1627
|
+
"$ref": "#/components/parameters/DirectQueryParam"
|
|
1622
1628
|
}
|
|
1623
1629
|
],
|
|
1624
1630
|
"requestBody": {
|
|
@@ -1682,6 +1688,9 @@
|
|
|
1682
1688
|
},
|
|
1683
1689
|
{
|
|
1684
1690
|
"$ref": "#/components/parameters/ValidateEntityQueryParam"
|
|
1691
|
+
},
|
|
1692
|
+
{
|
|
1693
|
+
"$ref": "#/components/parameters/DirectQueryParam"
|
|
1685
1694
|
}
|
|
1686
1695
|
],
|
|
1687
1696
|
"requestBody": {
|
|
@@ -2023,6 +2032,138 @@
|
|
|
2023
2032
|
}
|
|
2024
2033
|
}
|
|
2025
2034
|
},
|
|
2035
|
+
"/v1/entity/{slug}/{id}/changesets/{attribute}:apply": {
|
|
2036
|
+
"post": {
|
|
2037
|
+
"operationId": "applyChangeset",
|
|
2038
|
+
"summary": "applyChangeset",
|
|
2039
|
+
"description": "Applies the proposed value from a pending changeset to the entity attribute\nand removes the changeset. Used for human approval of pending changes.\n",
|
|
2040
|
+
"tags": [
|
|
2041
|
+
"Entities"
|
|
2042
|
+
],
|
|
2043
|
+
"parameters": [
|
|
2044
|
+
{
|
|
2045
|
+
"$ref": "#/components/parameters/EntitySlugPathParam"
|
|
2046
|
+
},
|
|
2047
|
+
{
|
|
2048
|
+
"$ref": "#/components/parameters/EntityIdPathParam"
|
|
2049
|
+
},
|
|
2050
|
+
{
|
|
2051
|
+
"in": "path",
|
|
2052
|
+
"name": "attribute",
|
|
2053
|
+
"required": true,
|
|
2054
|
+
"description": "Attribute name of the changeset to apply",
|
|
2055
|
+
"schema": {
|
|
2056
|
+
"type": "string"
|
|
2057
|
+
}
|
|
2058
|
+
}
|
|
2059
|
+
],
|
|
2060
|
+
"responses": {
|
|
2061
|
+
"200": {
|
|
2062
|
+
"description": "Changeset applied successfully — returns updated entity",
|
|
2063
|
+
"content": {
|
|
2064
|
+
"application/json": {
|
|
2065
|
+
"schema": {
|
|
2066
|
+
"$ref": "#/components/schemas/EntityItem"
|
|
2067
|
+
}
|
|
2068
|
+
}
|
|
2069
|
+
}
|
|
2070
|
+
},
|
|
2071
|
+
"404": {
|
|
2072
|
+
"$ref": "#/components/responses/NotFoundError"
|
|
2073
|
+
}
|
|
2074
|
+
}
|
|
2075
|
+
}
|
|
2076
|
+
},
|
|
2077
|
+
"/v1/entity/{slug}/{id}/changesets/{attribute}:dismiss": {
|
|
2078
|
+
"post": {
|
|
2079
|
+
"operationId": "dismissChangeset",
|
|
2080
|
+
"summary": "dismissChangeset",
|
|
2081
|
+
"description": "Removes a pending changeset without applying it. The attribute value remains unchanged.\n",
|
|
2082
|
+
"tags": [
|
|
2083
|
+
"Entities"
|
|
2084
|
+
],
|
|
2085
|
+
"parameters": [
|
|
2086
|
+
{
|
|
2087
|
+
"$ref": "#/components/parameters/EntitySlugPathParam"
|
|
2088
|
+
},
|
|
2089
|
+
{
|
|
2090
|
+
"$ref": "#/components/parameters/EntityIdPathParam"
|
|
2091
|
+
},
|
|
2092
|
+
{
|
|
2093
|
+
"in": "path",
|
|
2094
|
+
"name": "attribute",
|
|
2095
|
+
"required": true,
|
|
2096
|
+
"description": "Attribute name of the changeset to dismiss",
|
|
2097
|
+
"schema": {
|
|
2098
|
+
"type": "string"
|
|
2099
|
+
}
|
|
2100
|
+
}
|
|
2101
|
+
],
|
|
2102
|
+
"requestBody": {
|
|
2103
|
+
"content": {
|
|
2104
|
+
"application/json": {
|
|
2105
|
+
"schema": {
|
|
2106
|
+
"type": "object",
|
|
2107
|
+
"properties": {
|
|
2108
|
+
"reason": {
|
|
2109
|
+
"type": "string",
|
|
2110
|
+
"description": "Optional reason for dismissing the changeset"
|
|
2111
|
+
}
|
|
2112
|
+
}
|
|
2113
|
+
}
|
|
2114
|
+
}
|
|
2115
|
+
}
|
|
2116
|
+
},
|
|
2117
|
+
"responses": {
|
|
2118
|
+
"200": {
|
|
2119
|
+
"description": "Changeset dismissed successfully — returns updated entity",
|
|
2120
|
+
"content": {
|
|
2121
|
+
"application/json": {
|
|
2122
|
+
"schema": {
|
|
2123
|
+
"$ref": "#/components/schemas/EntityItem"
|
|
2124
|
+
}
|
|
2125
|
+
}
|
|
2126
|
+
}
|
|
2127
|
+
},
|
|
2128
|
+
"404": {
|
|
2129
|
+
"$ref": "#/components/responses/NotFoundError"
|
|
2130
|
+
}
|
|
2131
|
+
}
|
|
2132
|
+
}
|
|
2133
|
+
},
|
|
2134
|
+
"/v1/entity/{slug}/{id}/changesets": {
|
|
2135
|
+
"get": {
|
|
2136
|
+
"operationId": "listChangesets",
|
|
2137
|
+
"summary": "listChangesets",
|
|
2138
|
+
"description": "Returns all pending changesets for an entity.",
|
|
2139
|
+
"tags": [
|
|
2140
|
+
"Entities"
|
|
2141
|
+
],
|
|
2142
|
+
"parameters": [
|
|
2143
|
+
{
|
|
2144
|
+
"$ref": "#/components/parameters/EntitySlugPathParam"
|
|
2145
|
+
},
|
|
2146
|
+
{
|
|
2147
|
+
"$ref": "#/components/parameters/EntityIdPathParam"
|
|
2148
|
+
}
|
|
2149
|
+
],
|
|
2150
|
+
"responses": {
|
|
2151
|
+
"200": {
|
|
2152
|
+
"description": "Pending changesets for the entity",
|
|
2153
|
+
"content": {
|
|
2154
|
+
"application/json": {
|
|
2155
|
+
"schema": {
|
|
2156
|
+
"$ref": "#/components/schemas/ChangesetMap"
|
|
2157
|
+
}
|
|
2158
|
+
}
|
|
2159
|
+
}
|
|
2160
|
+
},
|
|
2161
|
+
"404": {
|
|
2162
|
+
"$ref": "#/components/responses/NotFoundError"
|
|
2163
|
+
}
|
|
2164
|
+
}
|
|
2165
|
+
}
|
|
2166
|
+
},
|
|
2026
2167
|
"/v1/entity/{slug}/{id}/activity": {
|
|
2027
2168
|
"get": {
|
|
2028
2169
|
"operationId": "getEntityActivityFeed",
|
|
@@ -3704,7 +3845,7 @@
|
|
|
3704
3845
|
"description": "ISO 8601 timestamp to filter jobs created after this time (e.g., 2023-01-01T00:00:00Z).",
|
|
3705
3846
|
"type": "string",
|
|
3706
3847
|
"format": "date-time",
|
|
3707
|
-
"example": "2023-01-01T00:00:
|
|
3848
|
+
"example": "2023-01-01T00:00:00Z"
|
|
3708
3849
|
}
|
|
3709
3850
|
},
|
|
3710
3851
|
{
|
|
@@ -5497,6 +5638,24 @@
|
|
|
5497
5638
|
},
|
|
5498
5639
|
"has_primary": {
|
|
5499
5640
|
"type": "boolean"
|
|
5641
|
+
},
|
|
5642
|
+
"edit_mode": {
|
|
5643
|
+
"type": "string",
|
|
5644
|
+
"description": "Controls how updates to this attribute are handled.\n- `direct` (default): update is applied immediately. No changeset created.\n- `external`: update creates a changeset, auto-cleared on matching external update (e.g. ERP inbound sync via ?direct=true).\n- `approval`: update creates a changeset, requires explicit human approval.\n",
|
|
5645
|
+
"enum": [
|
|
5646
|
+
"direct",
|
|
5647
|
+
"external",
|
|
5648
|
+
"approval"
|
|
5649
|
+
],
|
|
5650
|
+
"default": "direct"
|
|
5651
|
+
},
|
|
5652
|
+
"edit_mode_config": {
|
|
5653
|
+
"description": "Configuration for auto-clear matching on `edit_mode: external` attributes.\n`match_strategy` and `fuzzy_config` are only consulted for `external` mode —\nthey are ignored for `approval` mode, which resolves via explicit\n`:apply` / `:dismiss` endpoints and never auto-clears.\n",
|
|
5654
|
+
"allOf": [
|
|
5655
|
+
{
|
|
5656
|
+
"$ref": "#/components/schemas/EditModeConfig"
|
|
5657
|
+
}
|
|
5658
|
+
]
|
|
5500
5659
|
}
|
|
5501
5660
|
},
|
|
5502
5661
|
"required": [
|
|
@@ -7417,6 +7576,15 @@
|
|
|
7417
7576
|
"example": "123e4567-e89b-12d3-a456-426614174000"
|
|
7418
7577
|
},
|
|
7419
7578
|
"nullable": true
|
|
7579
|
+
},
|
|
7580
|
+
"_changesets": {
|
|
7581
|
+
"readOnly": true,
|
|
7582
|
+
"type": "object",
|
|
7583
|
+
"nullable": true,
|
|
7584
|
+
"description": "Pending attribute changesets for attributes configured with external or approval edit mode.\nRead-only via normal entity PATCH/PUT operations — cannot be set directly.\nUse the changeset management endpoints to apply or dismiss changesets.\n",
|
|
7585
|
+
"additionalProperties": {
|
|
7586
|
+
"$ref": "#/components/schemas/Changeset"
|
|
7587
|
+
}
|
|
7420
7588
|
}
|
|
7421
7589
|
},
|
|
7422
7590
|
"example": {
|
|
@@ -8350,6 +8518,11 @@
|
|
|
8350
8518
|
"type": "boolean",
|
|
8351
8519
|
"description": "If true, return full entity objects in entityNodes instead of just entity IDs in nodes",
|
|
8352
8520
|
"default": false
|
|
8521
|
+
},
|
|
8522
|
+
"apply_changesets": {
|
|
8523
|
+
"type": "boolean",
|
|
8524
|
+
"description": "When true and hydrate is also true, entity objects in entityNodes have pending changeset proposed values applied in-place. The _changesets field is still included in the response.",
|
|
8525
|
+
"default": false
|
|
8353
8526
|
}
|
|
8354
8527
|
}
|
|
8355
8528
|
},
|
|
@@ -8646,11 +8819,16 @@
|
|
|
8646
8819
|
"float",
|
|
8647
8820
|
"date",
|
|
8648
8821
|
"flattened",
|
|
8649
|
-
"nested"
|
|
8822
|
+
"nested",
|
|
8823
|
+
"object"
|
|
8650
8824
|
]
|
|
8651
8825
|
},
|
|
8652
8826
|
"fields": {
|
|
8653
8827
|
"additionalProperties": true
|
|
8828
|
+
},
|
|
8829
|
+
"dynamic": {
|
|
8830
|
+
"type": "boolean",
|
|
8831
|
+
"description": "When false, prevents ES from inferring types for nested fields. Used for _changesets where values can be any type."
|
|
8654
8832
|
}
|
|
8655
8833
|
}
|
|
8656
8834
|
}
|
|
@@ -8717,7 +8895,7 @@
|
|
|
8717
8895
|
},
|
|
8718
8896
|
"ActivityType": {
|
|
8719
8897
|
"type": "string",
|
|
8720
|
-
"description": "A type for the activity. Used to categorize activities in the activity feed and for event subscriptions.\n\nBuilt-in entity activity types (custom activities can be defined as well):\n- EntityCreated\n- EntityUpdated\n- EntityDeleted\n- EntitySoftDeleted\n- EntityRestored\n- RelationsAdded\n- RelationsRemoved\n- RelationsSoftDeleted\n- RelationsRestored\n- RelationsDeleted\n"
|
|
8898
|
+
"description": "A type for the activity. Used to categorize activities in the activity feed and for event subscriptions.\n\nBuilt-in entity activity types (custom activities can be defined as well):\n- EntityCreated\n- EntityUpdated\n- EntityDeleted\n- EntitySoftDeleted\n- EntityRestored\n- RelationsAdded\n- RelationsRemoved\n- RelationsSoftDeleted\n- RelationsRestored\n- RelationsDeleted\n- ChangesetCreated\n- ChangesetAutoCleared\n- ChangesetApplied\n- ChangesetDismissed\n"
|
|
8721
8899
|
},
|
|
8722
8900
|
"Activity": {
|
|
8723
8901
|
"type": "object",
|
|
@@ -9505,6 +9683,195 @@
|
|
|
9505
9683
|
"example": "Bad Request"
|
|
9506
9684
|
}
|
|
9507
9685
|
}
|
|
9686
|
+
},
|
|
9687
|
+
"ChangesetCreator": {
|
|
9688
|
+
"type": "object",
|
|
9689
|
+
"description": "Identifies the actor that created the changeset.",
|
|
9690
|
+
"properties": {
|
|
9691
|
+
"type": {
|
|
9692
|
+
"type": "string",
|
|
9693
|
+
"description": "Type of actor that created the changeset",
|
|
9694
|
+
"enum": [
|
|
9695
|
+
"user",
|
|
9696
|
+
"portal_user",
|
|
9697
|
+
"api_client",
|
|
9698
|
+
"automation"
|
|
9699
|
+
]
|
|
9700
|
+
},
|
|
9701
|
+
"id": {
|
|
9702
|
+
"type": "string",
|
|
9703
|
+
"description": "ID of the actor (user ID, portal user ID, API client ID, etc.)"
|
|
9704
|
+
}
|
|
9705
|
+
}
|
|
9706
|
+
},
|
|
9707
|
+
"Changeset": {
|
|
9708
|
+
"type": "object",
|
|
9709
|
+
"description": "A pending proposed change for a single entity attribute, awaiting external confirmation or human approval.",
|
|
9710
|
+
"required": [
|
|
9711
|
+
"proposed_value",
|
|
9712
|
+
"created_at",
|
|
9713
|
+
"edit_mode"
|
|
9714
|
+
],
|
|
9715
|
+
"properties": {
|
|
9716
|
+
"proposed_value": {
|
|
9717
|
+
"description": "The proposed new value for the attribute. Type matches the attribute type."
|
|
9718
|
+
},
|
|
9719
|
+
"previous_value": {
|
|
9720
|
+
"description": "The attribute value at the time the changeset was created. Stored for reference."
|
|
9721
|
+
},
|
|
9722
|
+
"created_at": {
|
|
9723
|
+
"type": "string",
|
|
9724
|
+
"format": "date-time",
|
|
9725
|
+
"description": "Timestamp when the changeset was created"
|
|
9726
|
+
},
|
|
9727
|
+
"created_by": {
|
|
9728
|
+
"$ref": "#/components/schemas/ChangesetCreator"
|
|
9729
|
+
},
|
|
9730
|
+
"edit_mode": {
|
|
9731
|
+
"type": "string",
|
|
9732
|
+
"description": "The edit mode that triggered this changeset.\n- `external`: auto-cleared by a matching `?direct=true` write (see `match_strategy`).\n- `approval`: resolved only via explicit `:apply` / `:dismiss` endpoints; never auto-clears.\n",
|
|
9733
|
+
"enum": [
|
|
9734
|
+
"external",
|
|
9735
|
+
"approval"
|
|
9736
|
+
]
|
|
9737
|
+
},
|
|
9738
|
+
"match_strategy": {
|
|
9739
|
+
"description": "Match strategy copied from the attribute's `edit_mode_config` at changeset\ncreation time. Only consulted when `edit_mode` is `external`; ignored for\n`approval` (which never auto-clears).\n",
|
|
9740
|
+
"allOf": [
|
|
9741
|
+
{
|
|
9742
|
+
"$ref": "#/components/schemas/MatchStrategy"
|
|
9743
|
+
}
|
|
9744
|
+
]
|
|
9745
|
+
},
|
|
9746
|
+
"source": {
|
|
9747
|
+
"type": "string",
|
|
9748
|
+
"description": "Optional label indicating where the change originated (e.g. end_customer_portal, installer_portal, journey, automation)"
|
|
9749
|
+
},
|
|
9750
|
+
"related_values": {
|
|
9751
|
+
"type": "object",
|
|
9752
|
+
"description": "Proposed and previous values for related fields in a multi-field attribute group (e.g. currency _decimal/_currency suffixes). Keyed by full field name.",
|
|
9753
|
+
"additionalProperties": {
|
|
9754
|
+
"type": "object",
|
|
9755
|
+
"properties": {
|
|
9756
|
+
"proposed_value": {
|
|
9757
|
+
"description": "The proposed new value for the related field."
|
|
9758
|
+
},
|
|
9759
|
+
"previous_value": {
|
|
9760
|
+
"description": "The value of the related field when the changeset was created."
|
|
9761
|
+
}
|
|
9762
|
+
}
|
|
9763
|
+
}
|
|
9764
|
+
}
|
|
9765
|
+
}
|
|
9766
|
+
},
|
|
9767
|
+
"ChangesetMap": {
|
|
9768
|
+
"type": "object",
|
|
9769
|
+
"description": "Map of attribute name to pending changeset. At most one changeset per attribute.",
|
|
9770
|
+
"additionalProperties": {
|
|
9771
|
+
"$ref": "#/components/schemas/Changeset"
|
|
9772
|
+
}
|
|
9773
|
+
},
|
|
9774
|
+
"EditModeConfig": {
|
|
9775
|
+
"type": "object",
|
|
9776
|
+
"description": "Configuration for `edit_mode: external` auto-clear matching.\nFields here (`match_strategy`, `fuzzy_config`) only take effect when\n`edit_mode` is `external`. They are ignored for `edit_mode: approval`,\nwhich never auto-clears and is resolved exclusively via the\n`:apply` / `:dismiss` changeset endpoints.\n",
|
|
9777
|
+
"properties": {
|
|
9778
|
+
"match_strategy": {
|
|
9779
|
+
"$ref": "#/components/schemas/MatchStrategy"
|
|
9780
|
+
},
|
|
9781
|
+
"fuzzy_config": {
|
|
9782
|
+
"$ref": "#/components/schemas/FuzzyConfig"
|
|
9783
|
+
}
|
|
9784
|
+
}
|
|
9785
|
+
},
|
|
9786
|
+
"FuzzyConfig": {
|
|
9787
|
+
"type": "object",
|
|
9788
|
+
"description": "Configuration for fuzzy auto-clear matching on `edit_mode: external` attributes.\nNot used for `edit_mode: approval`.\n\nType compatibility with attribute shape is enforced at schema save time:\n- scalar string attributes: `suffix`, `digits_only`, `regex`\n- repeatable attributes: `set_equivalent`, `entry_match`, `ignore_fields`, `normalize_phone`\n- relation attributes: `relation_set`\n",
|
|
9789
|
+
"required": [
|
|
9790
|
+
"type"
|
|
9791
|
+
],
|
|
9792
|
+
"properties": {
|
|
9793
|
+
"type": {
|
|
9794
|
+
"type": "string",
|
|
9795
|
+
"description": "Which fuzzy algorithm to apply.",
|
|
9796
|
+
"enum": [
|
|
9797
|
+
"suffix",
|
|
9798
|
+
"digits_only",
|
|
9799
|
+
"normalize_phone",
|
|
9800
|
+
"ignore_fields",
|
|
9801
|
+
"set_equivalent",
|
|
9802
|
+
"entry_match",
|
|
9803
|
+
"relation_set",
|
|
9804
|
+
"regex"
|
|
9805
|
+
]
|
|
9806
|
+
},
|
|
9807
|
+
"suffix_length": {
|
|
9808
|
+
"type": "integer",
|
|
9809
|
+
"description": "For type=suffix: number of characters to compare from end of string."
|
|
9810
|
+
},
|
|
9811
|
+
"fields_to_ignore": {
|
|
9812
|
+
"type": "array",
|
|
9813
|
+
"items": {
|
|
9814
|
+
"type": "string"
|
|
9815
|
+
},
|
|
9816
|
+
"description": "For type=ignore_fields and type=set_equivalent: field names to exclude when comparing array entries. `_id` is always stripped by the platform regardless of this config."
|
|
9817
|
+
},
|
|
9818
|
+
"regex_flags": {
|
|
9819
|
+
"type": "string",
|
|
9820
|
+
"description": "For type=regex: flags to apply to the regex (e.g. 'i' for case-insensitive)."
|
|
9821
|
+
},
|
|
9822
|
+
"country_code": {
|
|
9823
|
+
"type": "string",
|
|
9824
|
+
"description": "For type=normalize_phone: country dialing code digits to strip (e.g. '49' for Germany). No '+' prefix."
|
|
9825
|
+
},
|
|
9826
|
+
"match_on": {
|
|
9827
|
+
"type": "string",
|
|
9828
|
+
"description": "For type=normalize_phone: attribute key within array entries to compare on (e.g. 'phone_number')."
|
|
9829
|
+
},
|
|
9830
|
+
"key": {
|
|
9831
|
+
"description": "For type=entry_match: business key(s) within each entry used to match proposed entries against incoming entries.",
|
|
9832
|
+
"oneOf": [
|
|
9833
|
+
{
|
|
9834
|
+
"type": "string"
|
|
9835
|
+
},
|
|
9836
|
+
{
|
|
9837
|
+
"type": "array",
|
|
9838
|
+
"items": {
|
|
9839
|
+
"type": "string"
|
|
9840
|
+
}
|
|
9841
|
+
}
|
|
9842
|
+
]
|
|
9843
|
+
},
|
|
9844
|
+
"mode": {
|
|
9845
|
+
"type": "string",
|
|
9846
|
+
"description": "For type=entry_match and type=set_equivalent: how strict the comparison is.\n- `subset` (default for entry_match): every proposed entry must exist in incoming; extra incoming entries are allowed.\n- `exact_set` (default for set_equivalent): the two sides must contain the same entries (order-insensitive, multiset semantics).\n",
|
|
9847
|
+
"enum": [
|
|
9848
|
+
"subset",
|
|
9849
|
+
"exact_set"
|
|
9850
|
+
]
|
|
9851
|
+
},
|
|
9852
|
+
"ordered": {
|
|
9853
|
+
"type": "boolean",
|
|
9854
|
+
"description": "For type=relation_set: when true, relation order is significant. Defaults to false (order-insensitive)."
|
|
9855
|
+
},
|
|
9856
|
+
"require_tags_match": {
|
|
9857
|
+
"type": "boolean",
|
|
9858
|
+
"description": "For type=relation_set: when true, each relation item's `_tags` must match on both sides (order-insensitive). Defaults to false — `_tags` are stripped before compare."
|
|
9859
|
+
},
|
|
9860
|
+
"pattern": {
|
|
9861
|
+
"type": "string",
|
|
9862
|
+
"description": "For type=regex: regular expression pattern to test the incoming value against."
|
|
9863
|
+
}
|
|
9864
|
+
}
|
|
9865
|
+
},
|
|
9866
|
+
"MatchStrategy": {
|
|
9867
|
+
"type": "string",
|
|
9868
|
+
"description": "Strategy for auto-clearing a changeset on an `edit_mode: external` attribute\nwhen a direct write (`?direct=true`) arrives — typically an ERP inbound sync.\nIgnored for `edit_mode: approval`, which does not auto-clear and is resolved\nexclusively via the `:apply` / `:dismiss` changeset endpoints.\n- `exact`: The inbound value must exactly match the proposed value (deep equality).\n- `fuzzy`: The inbound value is compared using the configured `fuzzy_config` algorithm.\n- `any`: Any update to the attribute clears the changeset, regardless of value.\n",
|
|
9869
|
+
"enum": [
|
|
9870
|
+
"exact",
|
|
9871
|
+
"fuzzy",
|
|
9872
|
+
"any"
|
|
9873
|
+
],
|
|
9874
|
+
"default": "exact"
|
|
9508
9875
|
}
|
|
9509
9876
|
},
|
|
9510
9877
|
"parameters": {
|
|
@@ -9741,6 +10108,26 @@
|
|
|
9741
10108
|
"default": false,
|
|
9742
10109
|
"type": "boolean"
|
|
9743
10110
|
}
|
|
10111
|
+
},
|
|
10112
|
+
"DirectQueryParam": {
|
|
10113
|
+
"name": "direct",
|
|
10114
|
+
"description": "When true, bypasses changeset interception: attribute values in the payload\nare written directly to the entity regardless of each attribute's `edit_mode`.\nThe write always lands, independently of any auto-clear outcome below.\n\nAfter the direct write, for each attribute in the payload that also has a\npending changeset:\n- `edit_mode: external` — the incoming value is checked against the\n changeset's `match_strategy` (and `fuzzy_config` when `fuzzy`). On match,\n `_changesets[attr]` is cleared. On no-match, the write still stands and\n the changeset stays pending (signalling the ERP/trusted source applied a\n different correction than originally proposed; resolve via a later\n matching direct write, or via the `:apply` / `:dismiss` endpoints).\n- `edit_mode: approval` — never auto-cleared. The write lands but the\n pending changeset remains until explicitly resolved via `:apply` or\n `:dismiss`.\n\nIntended for trusted integrations (e.g. ERP inbound sync). ERP middleware\nmust always use `?direct=true` — without it, an inbound sync on an\n`external` attribute would create a new changeset instead of confirming\nthe pending one.\n\nDefaults to false — no breaking change for existing callers.\n",
|
|
10115
|
+
"in": "query",
|
|
10116
|
+
"required": false,
|
|
10117
|
+
"schema": {
|
|
10118
|
+
"type": "boolean",
|
|
10119
|
+
"default": false
|
|
10120
|
+
}
|
|
10121
|
+
},
|
|
10122
|
+
"ApplyChangesetsQueryParam": {
|
|
10123
|
+
"name": "apply_changesets",
|
|
10124
|
+
"description": "When true, applies pending changeset proposed values in-place on the response entity.\nThe response includes both the hydrated values and the raw _changesets field.\nDoes not mutate stored data — pure read-time transform.\n",
|
|
10125
|
+
"in": "query",
|
|
10126
|
+
"required": false,
|
|
10127
|
+
"schema": {
|
|
10128
|
+
"type": "boolean",
|
|
10129
|
+
"default": false
|
|
10130
|
+
}
|
|
9744
10131
|
}
|
|
9745
10132
|
},
|
|
9746
10133
|
"examples": {
|
|
@@ -6,25 +6,25 @@ var _chunkOXJOO2YFcjs = require('../chunk-OXJOO2YF.cjs');
|
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
var
|
|
9
|
+
var _chunkOK74PNHYcjs = require('../chunk-OK74PNHY.cjs');
|
|
10
10
|
require('../chunk-NJK5F5TF.cjs');
|
|
11
11
|
|
|
12
12
|
// src/apis/access-token.ts
|
|
13
13
|
var loadDefinition = () => {
|
|
14
14
|
const mod = _chunkOXJOO2YFcjs.require_access_token_runtime.call(void 0, );
|
|
15
|
-
return
|
|
15
|
+
return _chunkOK74PNHYcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
|
|
16
16
|
};
|
|
17
17
|
var _instance = null;
|
|
18
18
|
var resolve = () => {
|
|
19
19
|
if (!_instance) {
|
|
20
20
|
const def = loadDefinition();
|
|
21
|
-
_instance =
|
|
21
|
+
_instance = _chunkOK74PNHYcjs.createApiClient.call(void 0, { definition: def, apiName: "accessToken" });
|
|
22
22
|
}
|
|
23
23
|
return _instance;
|
|
24
24
|
};
|
|
25
|
-
var _handle =
|
|
25
|
+
var _handle = _chunkOK74PNHYcjs.createApiHandle.call(void 0, {
|
|
26
26
|
resolveClient: resolve,
|
|
27
|
-
createClient: () =>
|
|
27
|
+
createClient: () => _chunkOK74PNHYcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "accessToken" }),
|
|
28
28
|
apiName: "accessToken"
|
|
29
29
|
});
|
|
30
30
|
var getClient = _handle.getClient;
|
|
@@ -35,4 +35,4 @@ var accessToken = _handle;
|
|
|
35
35
|
|
|
36
36
|
|
|
37
37
|
|
|
38
|
-
exports.accessToken = accessToken; exports.authorize =
|
|
38
|
+
exports.accessToken = accessToken; exports.authorize = _chunkOK74PNHYcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
|
|
@@ -6,25 +6,25 @@ var _chunkLKRBFBFNcjs = require('../chunk-LKRBFBFN.cjs');
|
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
var
|
|
9
|
+
var _chunkOK74PNHYcjs = require('../chunk-OK74PNHY.cjs');
|
|
10
10
|
require('../chunk-NJK5F5TF.cjs');
|
|
11
11
|
|
|
12
12
|
// src/apis/address-suggestions.ts
|
|
13
13
|
var loadDefinition = () => {
|
|
14
14
|
const mod = _chunkLKRBFBFNcjs.require_address_suggestions_runtime.call(void 0, );
|
|
15
|
-
return
|
|
15
|
+
return _chunkOK74PNHYcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
|
|
16
16
|
};
|
|
17
17
|
var _instance = null;
|
|
18
18
|
var resolve = () => {
|
|
19
19
|
if (!_instance) {
|
|
20
20
|
const def = loadDefinition();
|
|
21
|
-
_instance =
|
|
21
|
+
_instance = _chunkOK74PNHYcjs.createApiClient.call(void 0, { definition: def, apiName: "addressSuggestions" });
|
|
22
22
|
}
|
|
23
23
|
return _instance;
|
|
24
24
|
};
|
|
25
|
-
var _handle =
|
|
25
|
+
var _handle = _chunkOK74PNHYcjs.createApiHandle.call(void 0, {
|
|
26
26
|
resolveClient: resolve,
|
|
27
|
-
createClient: () =>
|
|
27
|
+
createClient: () => _chunkOK74PNHYcjs.createApiClient.call(void 0, { definition: loadDefinition(), apiName: "addressSuggestions" }),
|
|
28
28
|
apiName: "addressSuggestions"
|
|
29
29
|
});
|
|
30
30
|
var getClient = _handle.getClient;
|
|
@@ -35,4 +35,4 @@ var addressSuggestions = _handle;
|
|
|
35
35
|
|
|
36
36
|
|
|
37
37
|
|
|
38
|
-
exports.addressSuggestions = addressSuggestions; exports.authorize =
|
|
38
|
+
exports.addressSuggestions = addressSuggestions; exports.authorize = _chunkOK74PNHYcjs.authorize; exports.createClient = createClient; exports.getClient = getClient;
|