@epilot/sdk 2.20.47 → 2.20.48
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/event-catalog.json +16 -0
- package/definitions/integration-toolkit.json +2 -1
- 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/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/chat.cjs +6 -6
- package/dist/apis/chat.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 +6 -6
- package/dist/apis/entity.js +1 -1
- 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.d.cts +2 -2
- package/dist/apis/event-catalog.d.ts +2 -2
- 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/identity.cjs +6 -6
- package/dist/apis/identity.js +1 -1
- package/dist/apis/integration-toolkit.cjs +10 -6
- package/dist/apis/integration-toolkit.d.cts +2 -2
- package/dist/apis/integration-toolkit.d.ts +2 -2
- package/dist/apis/integration-toolkit.js +5 -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/snapshot.cjs +6 -6
- package/dist/apis/snapshot.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/{chunk-5NZXNIBE.cjs → chunk-KP2RRRO5.cjs} +2 -2
- package/dist/{chunk-KHQACGLY.js → chunk-UORN27QE.js} +2 -2
- package/dist/event-catalog-R4ZGZQVY.js +7 -0
- package/dist/event-catalog-YYCD2DBK.cjs +7 -0
- package/dist/{event-catalog.d-BQqG_LGF.d.cts → event-catalog.d-BrAxYS9D.d.cts} +21 -0
- package/dist/{event-catalog.d-BQqG_LGF.d.ts → event-catalog.d-BrAxYS9D.d.ts} +21 -0
- package/dist/index.cjs +8 -8
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/{integration-toolkit-GGXTCIBG.cjs → integration-toolkit-CG6SFVKC.cjs} +1 -1
- package/dist/{integration-toolkit-XPSFIGHA.js → integration-toolkit-TLIEE3DY.js} +1 -1
- package/dist/{integration-toolkit.d-93TYFohH.d.cts → integration-toolkit.d-CLlaZx6b.d.cts} +1 -1
- package/dist/{integration-toolkit.d-93TYFohH.d.ts → integration-toolkit.d-CLlaZx6b.d.ts} +1 -1
- package/docs/event-catalog.md +41 -12
- package/docs/integration-toolkit.md +1 -1
- package/package.json +1 -1
- package/dist/event-catalog-5HHAS7NI.js +0 -7
- package/dist/event-catalog-SAH4ZEOO.cjs +0 -7
|
@@ -5797,7 +5797,7 @@ declare namespace Components {
|
|
|
5797
5797
|
* `monitoring-code-enum.test.ts`, which fails if the two diverge.
|
|
5798
5798
|
*
|
|
5799
5799
|
*/
|
|
5800
|
-
export type MonitoringCode = "ACK_CONFIRMED" | "ACK_PENDING" | "ACK_TIMEOUT" | "ATTACHMENT_NOT_FOUND" | "ATTRIBUTE_TYPE_MISMATCH" | "CONDITIONAL_VARIANTS_WRITTEN" | "CONDITIONAL_VARIANT_WRITE_FAILED" | "CONDITIONAL_VARIANT_WRITE_WARNING" | "DEPRECATED_ENDPOINT" | "DIRECT_ENTITY_NOT_ALLOWED" | "DIRECT_PAYLOAD_INVALID" | "DIRECT_VERSION_UNSUPPORTED" | "DUPLICATE_EVENT" | "ENTITY_CREATED" | "ENTITY_DELETED" | "ENTITY_NO_OP" | "ENTITY_REFERENCE_NOT_FOUND" | "ENTITY_UPDATED" | "EVENT_NOT_CONFIGURED" | "EXTERNAL_API_ERROR" | "EXTERNAL_ERROR" | "EXTERNAL_INFO" | "EXTERNAL_SUCCESS" | "EXTERNAL_WARNING" | "FAN_OUT_EMPTY" | "FAN_OUT_INVALID_RESULT" | "FILE_EXTRACTION_FAILED" | "FILE_FETCH_FAILED" | "FILE_PROXY_OK" | "FILE_PROXY_UPLOADED" | "FILE_PROXY_UPLOAD_ENQUEUED" | "FILE_PROXY_UPLOAD_FAILED" | "FILE_PROXY_UPLOAD_RETRYING" | "FILE_TOO_LARGE" | "INTEGRATION_NOT_FOUND" | "INVALID_METER_READING_ATTRIBUTES" | "LOOKUP_UNMAPPED" | "MALFORMED_PAYLOAD" | "MAPPING_EXPRESSION_FAILED" | "METERING_API_ERROR" | "METER_READING_DELETED" | "METER_READING_GROUP_FAILED" | "METER_READING_GROUP_RETRYING" | "METER_READING_UPSERTED" | "MISSING_REQUIRED_PARAM" | "MISSING_UNIQUE_IDENTIFIERS" | "MSG_ACKED" | "MSG_DEAD_LETTERED" | "MSG_ENQUEUED" | "MSG_EXPIRED_UNPOLLED" | "MSG_HEAD_BLOCKED" | "MSG_LATE_ARRIVAL" | "OAUTH2_TOKEN_FAILURE" | "PAYLOAD_TOO_LARGE" | "PRUNE_SCOPE_COMPLETED" | "PRUNE_SCOPE_PARTIAL_FAILURE" | "RECURSION_DEPTH_EXCEEDED" | "RELATION_REF_ITEM_NOT_FOUND" | "RELATION_REF_VALUE_UNDEFINED" | "REQUIRED_PARAM_MISSING" | "SECURE_PROXY_DISABLED" | "SECURE_PROXY_DOMAIN_BLOCKED" | "SECURE_PROXY_DOMAIN_NOT_ALLOWED" | "SECURE_PROXY_ERROR" | "SECURE_PROXY_INVALID_CONFIG" | "SECURE_PROXY_INVALID_TYPE" | "SECURE_PROXY_INVALID_URL" | "SECURE_PROXY_IP_BLOCKED" | "SECURE_PROXY_IP_NOT_ALLOWED" | "SECURE_PROXY_NOT_FOUND" | "SECURE_PROXY_UNAVAILABLE" | "SIGNATURE_VERIFICATION_FAILED" | "SIGNATURE_VERIFICATION_UNAVAILABLE" | "SOFT_DELETED_ENTITY_MATCHED" | "STEP_DISABLED" | "TIMEOUT" | "UNIQUE_ID_MULTIPLE_MATCHES" | "UNIQUE_ID_NOT_IN_SCHEMA" | "UNKNOWN_ERROR" | "USE_CASE_DISABLED" | "USE_CASE_INVALID_TYPE" | "USE_CASE_MISSING_CONFIG" | "USE_CASE_NOT_FOUND" | "WEBHOOK_DELIVERED";
|
|
5800
|
+
export type MonitoringCode = "ACK_CONFIRMED" | "ACK_PENDING" | "ACK_TIMEOUT" | "ATTACHMENT_NOT_FOUND" | "ATTRIBUTE_TYPE_MISMATCH" | "CONDITIONAL_VARIANTS_WRITTEN" | "CONDITIONAL_VARIANT_WRITE_FAILED" | "CONDITIONAL_VARIANT_WRITE_WARNING" | "DEPRECATED_ENDPOINT" | "DIRECT_ENTITY_NOT_ALLOWED" | "DIRECT_PAYLOAD_INVALID" | "DIRECT_VERSION_UNSUPPORTED" | "DUPLICATE_EVENT" | "ENTITY_CREATED" | "ENTITY_DELETED" | "ENTITY_NO_OP" | "ENTITY_REFERENCE_NOT_FOUND" | "ENTITY_UPDATED" | "EVENT_NOT_CONFIGURED" | "EXTERNAL_API_ERROR" | "EXTERNAL_ERROR" | "EXTERNAL_INFO" | "EXTERNAL_SUCCESS" | "EXTERNAL_WARNING" | "FAN_OUT_EMPTY" | "FAN_OUT_INVALID_RESULT" | "FILE_EXTRACTION_FAILED" | "FILE_FETCH_FAILED" | "FILE_PROXY_OK" | "FILE_PROXY_UPLOADED" | "FILE_PROXY_UPLOAD_ENQUEUED" | "FILE_PROXY_UPLOAD_FAILED" | "FILE_PROXY_UPLOAD_RETRYING" | "FILE_TOO_LARGE" | "INTEGRATION_NOT_FOUND" | "INVALID_METER_READING_ATTRIBUTES" | "LOOKUP_UNMAPPED" | "MALFORMED_PAYLOAD" | "MAPPING_EXPRESSION_FAILED" | "METERING_API_ERROR" | "METER_READING_DELETED" | "METER_READING_GROUP_FAILED" | "METER_READING_GROUP_RETRYING" | "METER_READING_UPSERTED" | "MISSING_REQUIRED_PARAM" | "MISSING_UNIQUE_IDENTIFIERS" | "MSG_ACKED" | "MSG_DEAD_LETTERED" | "MSG_ENQUEUED" | "MSG_EXPIRED_UNPOLLED" | "MSG_HEAD_BLOCKED" | "MSG_LATE_ARRIVAL" | "OAUTH2_TOKEN_FAILURE" | "PAYLOAD_TOO_LARGE" | "PRUNE_SCOPE_COMPLETED" | "PRUNE_SCOPE_PARTIAL_FAILURE" | "RECURSION_DEPTH_EXCEEDED" | "RELATION_REF_ITEM_NOT_FOUND" | "RELATION_REF_VALUE_UNDEFINED" | "REQUIRED_PARAM_MISSING" | "SECURE_PROXY_DISABLED" | "SECURE_PROXY_DOMAIN_BLOCKED" | "SECURE_PROXY_DOMAIN_NOT_ALLOWED" | "SECURE_PROXY_ERROR" | "SECURE_PROXY_INVALID_CONFIG" | "SECURE_PROXY_INVALID_TYPE" | "SECURE_PROXY_INVALID_URL" | "SECURE_PROXY_IP_BLOCKED" | "SECURE_PROXY_IP_NOT_ALLOWED" | "SECURE_PROXY_NOT_FOUND" | "SECURE_PROXY_UNAVAILABLE" | "SIGNATURE_VERIFICATION_FAILED" | "SIGNATURE_VERIFICATION_UNAVAILABLE" | "SOFT_DELETED_ENTITY_MATCHED" | "STEP_DISABLED" | "TIMEOUT" | "UNIQUE_ID_LOOKUP_UNRESOLVABLE" | "UNIQUE_ID_MULTIPLE_MATCHES" | "UNIQUE_ID_NOT_IN_SCHEMA" | "UNKNOWN_ERROR" | "USE_CASE_DISABLED" | "USE_CASE_INVALID_TYPE" | "USE_CASE_MISSING_CONFIG" | "USE_CASE_NOT_FOUND" | "WEBHOOK_DELIVERED";
|
|
5801
5801
|
export interface MonitoringEventV2 {
|
|
5802
5802
|
/**
|
|
5803
5803
|
* Unique monitoring event ID
|
|
@@ -5797,7 +5797,7 @@ declare namespace Components {
|
|
|
5797
5797
|
* `monitoring-code-enum.test.ts`, which fails if the two diverge.
|
|
5798
5798
|
*
|
|
5799
5799
|
*/
|
|
5800
|
-
export type MonitoringCode = "ACK_CONFIRMED" | "ACK_PENDING" | "ACK_TIMEOUT" | "ATTACHMENT_NOT_FOUND" | "ATTRIBUTE_TYPE_MISMATCH" | "CONDITIONAL_VARIANTS_WRITTEN" | "CONDITIONAL_VARIANT_WRITE_FAILED" | "CONDITIONAL_VARIANT_WRITE_WARNING" | "DEPRECATED_ENDPOINT" | "DIRECT_ENTITY_NOT_ALLOWED" | "DIRECT_PAYLOAD_INVALID" | "DIRECT_VERSION_UNSUPPORTED" | "DUPLICATE_EVENT" | "ENTITY_CREATED" | "ENTITY_DELETED" | "ENTITY_NO_OP" | "ENTITY_REFERENCE_NOT_FOUND" | "ENTITY_UPDATED" | "EVENT_NOT_CONFIGURED" | "EXTERNAL_API_ERROR" | "EXTERNAL_ERROR" | "EXTERNAL_INFO" | "EXTERNAL_SUCCESS" | "EXTERNAL_WARNING" | "FAN_OUT_EMPTY" | "FAN_OUT_INVALID_RESULT" | "FILE_EXTRACTION_FAILED" | "FILE_FETCH_FAILED" | "FILE_PROXY_OK" | "FILE_PROXY_UPLOADED" | "FILE_PROXY_UPLOAD_ENQUEUED" | "FILE_PROXY_UPLOAD_FAILED" | "FILE_PROXY_UPLOAD_RETRYING" | "FILE_TOO_LARGE" | "INTEGRATION_NOT_FOUND" | "INVALID_METER_READING_ATTRIBUTES" | "LOOKUP_UNMAPPED" | "MALFORMED_PAYLOAD" | "MAPPING_EXPRESSION_FAILED" | "METERING_API_ERROR" | "METER_READING_DELETED" | "METER_READING_GROUP_FAILED" | "METER_READING_GROUP_RETRYING" | "METER_READING_UPSERTED" | "MISSING_REQUIRED_PARAM" | "MISSING_UNIQUE_IDENTIFIERS" | "MSG_ACKED" | "MSG_DEAD_LETTERED" | "MSG_ENQUEUED" | "MSG_EXPIRED_UNPOLLED" | "MSG_HEAD_BLOCKED" | "MSG_LATE_ARRIVAL" | "OAUTH2_TOKEN_FAILURE" | "PAYLOAD_TOO_LARGE" | "PRUNE_SCOPE_COMPLETED" | "PRUNE_SCOPE_PARTIAL_FAILURE" | "RECURSION_DEPTH_EXCEEDED" | "RELATION_REF_ITEM_NOT_FOUND" | "RELATION_REF_VALUE_UNDEFINED" | "REQUIRED_PARAM_MISSING" | "SECURE_PROXY_DISABLED" | "SECURE_PROXY_DOMAIN_BLOCKED" | "SECURE_PROXY_DOMAIN_NOT_ALLOWED" | "SECURE_PROXY_ERROR" | "SECURE_PROXY_INVALID_CONFIG" | "SECURE_PROXY_INVALID_TYPE" | "SECURE_PROXY_INVALID_URL" | "SECURE_PROXY_IP_BLOCKED" | "SECURE_PROXY_IP_NOT_ALLOWED" | "SECURE_PROXY_NOT_FOUND" | "SECURE_PROXY_UNAVAILABLE" | "SIGNATURE_VERIFICATION_FAILED" | "SIGNATURE_VERIFICATION_UNAVAILABLE" | "SOFT_DELETED_ENTITY_MATCHED" | "STEP_DISABLED" | "TIMEOUT" | "UNIQUE_ID_MULTIPLE_MATCHES" | "UNIQUE_ID_NOT_IN_SCHEMA" | "UNKNOWN_ERROR" | "USE_CASE_DISABLED" | "USE_CASE_INVALID_TYPE" | "USE_CASE_MISSING_CONFIG" | "USE_CASE_NOT_FOUND" | "WEBHOOK_DELIVERED";
|
|
5800
|
+
export type MonitoringCode = "ACK_CONFIRMED" | "ACK_PENDING" | "ACK_TIMEOUT" | "ATTACHMENT_NOT_FOUND" | "ATTRIBUTE_TYPE_MISMATCH" | "CONDITIONAL_VARIANTS_WRITTEN" | "CONDITIONAL_VARIANT_WRITE_FAILED" | "CONDITIONAL_VARIANT_WRITE_WARNING" | "DEPRECATED_ENDPOINT" | "DIRECT_ENTITY_NOT_ALLOWED" | "DIRECT_PAYLOAD_INVALID" | "DIRECT_VERSION_UNSUPPORTED" | "DUPLICATE_EVENT" | "ENTITY_CREATED" | "ENTITY_DELETED" | "ENTITY_NO_OP" | "ENTITY_REFERENCE_NOT_FOUND" | "ENTITY_UPDATED" | "EVENT_NOT_CONFIGURED" | "EXTERNAL_API_ERROR" | "EXTERNAL_ERROR" | "EXTERNAL_INFO" | "EXTERNAL_SUCCESS" | "EXTERNAL_WARNING" | "FAN_OUT_EMPTY" | "FAN_OUT_INVALID_RESULT" | "FILE_EXTRACTION_FAILED" | "FILE_FETCH_FAILED" | "FILE_PROXY_OK" | "FILE_PROXY_UPLOADED" | "FILE_PROXY_UPLOAD_ENQUEUED" | "FILE_PROXY_UPLOAD_FAILED" | "FILE_PROXY_UPLOAD_RETRYING" | "FILE_TOO_LARGE" | "INTEGRATION_NOT_FOUND" | "INVALID_METER_READING_ATTRIBUTES" | "LOOKUP_UNMAPPED" | "MALFORMED_PAYLOAD" | "MAPPING_EXPRESSION_FAILED" | "METERING_API_ERROR" | "METER_READING_DELETED" | "METER_READING_GROUP_FAILED" | "METER_READING_GROUP_RETRYING" | "METER_READING_UPSERTED" | "MISSING_REQUIRED_PARAM" | "MISSING_UNIQUE_IDENTIFIERS" | "MSG_ACKED" | "MSG_DEAD_LETTERED" | "MSG_ENQUEUED" | "MSG_EXPIRED_UNPOLLED" | "MSG_HEAD_BLOCKED" | "MSG_LATE_ARRIVAL" | "OAUTH2_TOKEN_FAILURE" | "PAYLOAD_TOO_LARGE" | "PRUNE_SCOPE_COMPLETED" | "PRUNE_SCOPE_PARTIAL_FAILURE" | "RECURSION_DEPTH_EXCEEDED" | "RELATION_REF_ITEM_NOT_FOUND" | "RELATION_REF_VALUE_UNDEFINED" | "REQUIRED_PARAM_MISSING" | "SECURE_PROXY_DISABLED" | "SECURE_PROXY_DOMAIN_BLOCKED" | "SECURE_PROXY_DOMAIN_NOT_ALLOWED" | "SECURE_PROXY_ERROR" | "SECURE_PROXY_INVALID_CONFIG" | "SECURE_PROXY_INVALID_TYPE" | "SECURE_PROXY_INVALID_URL" | "SECURE_PROXY_IP_BLOCKED" | "SECURE_PROXY_IP_NOT_ALLOWED" | "SECURE_PROXY_NOT_FOUND" | "SECURE_PROXY_UNAVAILABLE" | "SIGNATURE_VERIFICATION_FAILED" | "SIGNATURE_VERIFICATION_UNAVAILABLE" | "SOFT_DELETED_ENTITY_MATCHED" | "STEP_DISABLED" | "TIMEOUT" | "UNIQUE_ID_LOOKUP_UNRESOLVABLE" | "UNIQUE_ID_MULTIPLE_MATCHES" | "UNIQUE_ID_NOT_IN_SCHEMA" | "UNKNOWN_ERROR" | "USE_CASE_DISABLED" | "USE_CASE_INVALID_TYPE" | "USE_CASE_MISSING_CONFIG" | "USE_CASE_NOT_FOUND" | "WEBHOOK_DELIVERED";
|
|
5801
5801
|
export interface MonitoringEventV2 {
|
|
5802
5802
|
/**
|
|
5803
5803
|
* Unique monitoring event ID
|
package/docs/event-catalog.md
CHANGED
|
@@ -105,6 +105,7 @@ const { data } = await client.listEvents()
|
|
|
105
105
|
"event_description": "Triggered when a new meter reading is added",
|
|
106
106
|
"event_version": "1.0",
|
|
107
107
|
"event_status": "active",
|
|
108
|
+
"deprecated_at": "2026-09-30T12:00:00.000Z",
|
|
108
109
|
"event_tags": ["builtin", "metering", "erp"],
|
|
109
110
|
"schema_fields": {},
|
|
110
111
|
"entity_graph": {
|
|
@@ -144,7 +145,8 @@ const { data } = await client.listEvents()
|
|
|
144
145
|
"event_origin": "builtin",
|
|
145
146
|
"mapping": {
|
|
146
147
|
"mode": "guided",
|
|
147
|
-
"jsonata": "string"
|
|
148
|
+
"jsonata": "string",
|
|
149
|
+
"payload": "extend"
|
|
148
150
|
},
|
|
149
151
|
"lineage": {
|
|
150
152
|
"base_event_name": "string",
|
|
@@ -218,7 +220,8 @@ const { data } = await client.createCustomEvent(
|
|
|
218
220
|
automation_trigger_seed_node: 'string',
|
|
219
221
|
mapping: {
|
|
220
222
|
mode: 'guided',
|
|
221
|
-
jsonata: 'string'
|
|
223
|
+
jsonata: 'string',
|
|
224
|
+
payload: 'extend'
|
|
222
225
|
},
|
|
223
226
|
lineage: {
|
|
224
227
|
base_event_name: 'string',
|
|
@@ -239,6 +242,7 @@ const { data } = await client.createCustomEvent(
|
|
|
239
242
|
"event_description": "Triggered when a new meter reading is added",
|
|
240
243
|
"event_version": "1.0",
|
|
241
244
|
"event_status": "active",
|
|
245
|
+
"deprecated_at": "2026-09-30T12:00:00.000Z",
|
|
242
246
|
"event_tags": ["builtin", "metering", "erp"],
|
|
243
247
|
"schema_fields": {},
|
|
244
248
|
"entity_graph": {
|
|
@@ -278,7 +282,8 @@ const { data } = await client.createCustomEvent(
|
|
|
278
282
|
"event_origin": "builtin",
|
|
279
283
|
"mapping": {
|
|
280
284
|
"mode": "guided",
|
|
281
|
-
"jsonata": "string"
|
|
285
|
+
"jsonata": "string",
|
|
286
|
+
"payload": "extend"
|
|
282
287
|
},
|
|
283
288
|
"lineage": {
|
|
284
289
|
"base_event_name": "string",
|
|
@@ -323,6 +328,7 @@ const { data } = await client.getEvent({
|
|
|
323
328
|
"event_description": "Triggered when a new meter reading is added",
|
|
324
329
|
"event_version": "1.0",
|
|
325
330
|
"event_status": "active",
|
|
331
|
+
"deprecated_at": "2026-09-30T12:00:00.000Z",
|
|
326
332
|
"event_tags": ["builtin", "metering", "erp"],
|
|
327
333
|
"schema_fields": {},
|
|
328
334
|
"entity_graph": {
|
|
@@ -362,7 +368,8 @@ const { data } = await client.getEvent({
|
|
|
362
368
|
"event_origin": "builtin",
|
|
363
369
|
"mapping": {
|
|
364
370
|
"mode": "guided",
|
|
365
|
-
"jsonata": "string"
|
|
371
|
+
"jsonata": "string",
|
|
372
|
+
"payload": "extend"
|
|
366
373
|
},
|
|
367
374
|
"lineage": {
|
|
368
375
|
"base_event_name": "string",
|
|
@@ -419,6 +426,7 @@ const { data } = await client.patchEvent(
|
|
|
419
426
|
"event_description": "Triggered when a new meter reading is added",
|
|
420
427
|
"event_version": "1.0",
|
|
421
428
|
"event_status": "active",
|
|
429
|
+
"deprecated_at": "2026-09-30T12:00:00.000Z",
|
|
422
430
|
"event_tags": ["builtin", "metering", "erp"],
|
|
423
431
|
"schema_fields": {},
|
|
424
432
|
"entity_graph": {
|
|
@@ -458,7 +466,8 @@ const { data } = await client.patchEvent(
|
|
|
458
466
|
"event_origin": "builtin",
|
|
459
467
|
"mapping": {
|
|
460
468
|
"mode": "guided",
|
|
461
|
-
"jsonata": "string"
|
|
469
|
+
"jsonata": "string",
|
|
470
|
+
"payload": "extend"
|
|
462
471
|
},
|
|
463
472
|
"lineage": {
|
|
464
473
|
"base_event_name": "string",
|
|
@@ -534,7 +543,8 @@ const { data } = await client.replaceCustomEventDraft(
|
|
|
534
543
|
automation_trigger_seed_node: 'string',
|
|
535
544
|
mapping: {
|
|
536
545
|
mode: 'guided',
|
|
537
|
-
jsonata: 'string'
|
|
546
|
+
jsonata: 'string',
|
|
547
|
+
payload: 'extend'
|
|
538
548
|
},
|
|
539
549
|
lineage: {
|
|
540
550
|
base_event_name: 'string',
|
|
@@ -555,6 +565,7 @@ const { data } = await client.replaceCustomEventDraft(
|
|
|
555
565
|
"event_description": "Triggered when a new meter reading is added",
|
|
556
566
|
"event_version": "1.0",
|
|
557
567
|
"event_status": "active",
|
|
568
|
+
"deprecated_at": "2026-09-30T12:00:00.000Z",
|
|
558
569
|
"event_tags": ["builtin", "metering", "erp"],
|
|
559
570
|
"schema_fields": {},
|
|
560
571
|
"entity_graph": {
|
|
@@ -594,7 +605,8 @@ const { data } = await client.replaceCustomEventDraft(
|
|
|
594
605
|
"event_origin": "builtin",
|
|
595
606
|
"mapping": {
|
|
596
607
|
"mode": "guided",
|
|
597
|
-
"jsonata": "string"
|
|
608
|
+
"jsonata": "string",
|
|
609
|
+
"payload": "extend"
|
|
598
610
|
},
|
|
599
611
|
"lineage": {
|
|
600
612
|
"base_event_name": "string",
|
|
@@ -701,6 +713,7 @@ const { data } = await client.publishCustomEventDefinition(
|
|
|
701
713
|
"event_description": "Triggered when a new meter reading is added",
|
|
702
714
|
"event_version": "1.0",
|
|
703
715
|
"event_status": "active",
|
|
716
|
+
"deprecated_at": "2026-09-30T12:00:00.000Z",
|
|
704
717
|
"event_tags": ["builtin", "metering", "erp"],
|
|
705
718
|
"schema_fields": {},
|
|
706
719
|
"entity_graph": {
|
|
@@ -740,7 +753,8 @@ const { data } = await client.publishCustomEventDefinition(
|
|
|
740
753
|
"event_origin": "builtin",
|
|
741
754
|
"mapping": {
|
|
742
755
|
"mode": "guided",
|
|
743
|
-
"jsonata": "string"
|
|
756
|
+
"jsonata": "string",
|
|
757
|
+
"payload": "extend"
|
|
744
758
|
},
|
|
745
759
|
"lineage": {
|
|
746
760
|
"base_event_name": "string",
|
|
@@ -787,6 +801,7 @@ const { data } = await client.getCustomEventVersionDraft({
|
|
|
787
801
|
"event_description": "Triggered when a new meter reading is added",
|
|
788
802
|
"event_version": "1.0",
|
|
789
803
|
"event_status": "active",
|
|
804
|
+
"deprecated_at": "2026-09-30T12:00:00.000Z",
|
|
790
805
|
"event_tags": ["builtin", "metering", "erp"],
|
|
791
806
|
"schema_fields": {},
|
|
792
807
|
"entity_graph": {
|
|
@@ -826,7 +841,8 @@ const { data } = await client.getCustomEventVersionDraft({
|
|
|
826
841
|
"event_origin": "builtin",
|
|
827
842
|
"mapping": {
|
|
828
843
|
"mode": "guided",
|
|
829
|
-
"jsonata": "string"
|
|
844
|
+
"jsonata": "string",
|
|
845
|
+
"payload": "extend"
|
|
830
846
|
},
|
|
831
847
|
"lineage": {
|
|
832
848
|
"base_event_name": "string",
|
|
@@ -915,7 +931,8 @@ const { data } = await client.putCustomEventVersionDraft(
|
|
|
915
931
|
automation_trigger_seed_node: 'string',
|
|
916
932
|
mapping: {
|
|
917
933
|
mode: 'guided',
|
|
918
|
-
jsonata: 'string'
|
|
934
|
+
jsonata: 'string',
|
|
935
|
+
payload: 'extend'
|
|
919
936
|
},
|
|
920
937
|
lineage: {
|
|
921
938
|
base_event_name: 'string',
|
|
@@ -937,6 +954,7 @@ const { data } = await client.putCustomEventVersionDraft(
|
|
|
937
954
|
"event_description": "Triggered when a new meter reading is added",
|
|
938
955
|
"event_version": "1.0",
|
|
939
956
|
"event_status": "active",
|
|
957
|
+
"deprecated_at": "2026-09-30T12:00:00.000Z",
|
|
940
958
|
"event_tags": ["builtin", "metering", "erp"],
|
|
941
959
|
"schema_fields": {},
|
|
942
960
|
"entity_graph": {
|
|
@@ -976,7 +994,8 @@ const { data } = await client.putCustomEventVersionDraft(
|
|
|
976
994
|
"event_origin": "builtin",
|
|
977
995
|
"mapping": {
|
|
978
996
|
"mode": "guided",
|
|
979
|
-
"jsonata": "string"
|
|
997
|
+
"jsonata": "string",
|
|
998
|
+
"payload": "extend"
|
|
980
999
|
},
|
|
981
1000
|
"lineage": {
|
|
982
1001
|
"base_event_name": "string",
|
|
@@ -1055,6 +1074,7 @@ const { data } = await client.publishCustomEventVersion(
|
|
|
1055
1074
|
"event_description": "Triggered when a new meter reading is added",
|
|
1056
1075
|
"event_version": "1.0",
|
|
1057
1076
|
"event_status": "active",
|
|
1077
|
+
"deprecated_at": "2026-09-30T12:00:00.000Z",
|
|
1058
1078
|
"event_tags": ["builtin", "metering", "erp"],
|
|
1059
1079
|
"schema_fields": {},
|
|
1060
1080
|
"entity_graph": {
|
|
@@ -1094,7 +1114,8 @@ const { data } = await client.publishCustomEventVersion(
|
|
|
1094
1114
|
"event_origin": "builtin",
|
|
1095
1115
|
"mapping": {
|
|
1096
1116
|
"mode": "guided",
|
|
1097
|
-
"jsonata": "string"
|
|
1117
|
+
"jsonata": "string",
|
|
1118
|
+
"payload": "extend"
|
|
1098
1119
|
},
|
|
1099
1120
|
"lineage": {
|
|
1100
1121
|
"base_event_name": "string",
|
|
@@ -1532,6 +1553,7 @@ type EventConfigBase = {
|
|
|
1532
1553
|
event_description?: string
|
|
1533
1554
|
event_version?: string
|
|
1534
1555
|
event_status?: "active" | "deprecated" | "draft" | "disabled"
|
|
1556
|
+
deprecated_at?: string // date-time
|
|
1535
1557
|
event_tags?: string[]
|
|
1536
1558
|
schema_fields?: Record<string, {
|
|
1537
1559
|
json_schema: object
|
|
@@ -1584,6 +1606,7 @@ type EventConfigBase = {
|
|
|
1584
1606
|
mapping?: {
|
|
1585
1607
|
mode: "guided" | "jsonata"
|
|
1586
1608
|
jsonata?: string
|
|
1609
|
+
payload?: "extend" | "replace"
|
|
1587
1610
|
}
|
|
1588
1611
|
lineage?: {
|
|
1589
1612
|
base_event_name: string
|
|
@@ -1607,6 +1630,7 @@ type EventConfig = {
|
|
|
1607
1630
|
event_description?: string
|
|
1608
1631
|
event_version: string
|
|
1609
1632
|
event_status?: "active" | "deprecated" | "draft" | "disabled"
|
|
1633
|
+
deprecated_at?: string // date-time
|
|
1610
1634
|
event_tags?: string[]
|
|
1611
1635
|
schema_fields: Record<string, {
|
|
1612
1636
|
json_schema: object
|
|
@@ -1659,6 +1683,7 @@ type EventConfig = {
|
|
|
1659
1683
|
mapping?: {
|
|
1660
1684
|
mode: "guided" | "jsonata"
|
|
1661
1685
|
jsonata?: string
|
|
1686
|
+
payload?: "extend" | "replace"
|
|
1662
1687
|
}
|
|
1663
1688
|
lineage?: {
|
|
1664
1689
|
base_event_name: string
|
|
@@ -1718,6 +1743,7 @@ type CreateCustomEventPayload = {
|
|
|
1718
1743
|
mapping?: {
|
|
1719
1744
|
mode: "guided" | "jsonata"
|
|
1720
1745
|
jsonata?: string
|
|
1746
|
+
payload?: "extend" | "replace"
|
|
1721
1747
|
}
|
|
1722
1748
|
lineage?: {
|
|
1723
1749
|
base_event_name: string
|
|
@@ -1735,6 +1761,7 @@ Guided mappings use schema_fields graph_source expressions; raw mode evaluates o
|
|
|
1735
1761
|
type EventMapping = {
|
|
1736
1762
|
mode: "guided" | "jsonata"
|
|
1737
1763
|
jsonata?: string
|
|
1764
|
+
payload?: "extend" | "replace"
|
|
1738
1765
|
}
|
|
1739
1766
|
```
|
|
1740
1767
|
|
|
@@ -1781,6 +1808,7 @@ type CustomEventVersionDraft = {
|
|
|
1781
1808
|
event_description?: string
|
|
1782
1809
|
event_version: string
|
|
1783
1810
|
event_status?: "active" | "deprecated" | "draft" | "disabled"
|
|
1811
|
+
deprecated_at?: string // date-time
|
|
1784
1812
|
event_tags?: string[]
|
|
1785
1813
|
schema_fields: Record<string, {
|
|
1786
1814
|
json_schema: { ... }
|
|
@@ -1814,6 +1842,7 @@ type CustomEventVersionDraft = {
|
|
|
1814
1842
|
mapping?: {
|
|
1815
1843
|
mode: { ... }
|
|
1816
1844
|
jsonata?: { ... }
|
|
1845
|
+
payload?: { ... }
|
|
1817
1846
|
}
|
|
1818
1847
|
lineage?: {
|
|
1819
1848
|
base_event_name: { ... }
|
|
@@ -9590,7 +9590,7 @@ This schema exists so consumers can import the union as a type. It is
|
|
|
9590
9590
|
deliberately
|
|
9591
9591
|
|
|
9592
9592
|
```ts
|
|
9593
|
-
type MonitoringCode = "ACK_CONFIRMED" | "ACK_PENDING" | "ACK_TIMEOUT" | "ATTACHMENT_NOT_FOUND" | "ATTRIBUTE_TYPE_MISMATCH" | "CONDITIONAL_VARIANTS_WRITTEN" | "CONDITIONAL_VARIANT_WRITE_FAILED" | "CONDITIONAL_VARIANT_WRITE_WARNING" | "DEPRECATED_ENDPOINT" | "DIRECT_ENTITY_NOT_ALLOWED" | "DIRECT_PAYLOAD_INVALID" | "DIRECT_VERSION_UNSUPPORTED" | "DUPLICATE_EVENT" | "ENTITY_CREATED" | "ENTITY_DELETED" | "ENTITY_NO_OP" | "ENTITY_REFERENCE_NOT_FOUND" | "ENTITY_UPDATED" | "EVENT_NOT_CONFIGURED" | "EXTERNAL_API_ERROR" | "EXTERNAL_ERROR" | "EXTERNAL_INFO" | "EXTERNAL_SUCCESS" | "EXTERNAL_WARNING" | "FAN_OUT_EMPTY" | "FAN_OUT_INVALID_RESULT" | "FILE_EXTRACTION_FAILED" | "FILE_FETCH_FAILED" | "FILE_PROXY_OK" | "FILE_PROXY_UPLOADED" | "FILE_PROXY_UPLOAD_ENQUEUED" | "FILE_PROXY_UPLOAD_FAILED" | "FILE_PROXY_UPLOAD_RETRYING" | "FILE_TOO_LARGE" | "INTEGRATION_NOT_FOUND" | "INVALID_METER_READING_ATTRIBUTES" | "LOOKUP_UNMAPPED" | "MALFORMED_PAYLOAD" | "MAPPING_EXPRESSION_FAILED" | "METERING_API_ERROR" | "METER_READING_DELETED" | "METER_READING_GROUP_FAILED" | "METER_READING_GROUP_RETRYING" | "METER_READING_UPSERTED" | "MISSING_REQUIRED_PARAM" | "MISSING_UNIQUE_IDENTIFIERS" | "MSG_ACKED" | "MSG_DEAD_LETTERED" | "MSG_ENQUEUED" | "MSG_EXPIRED_UNPOLLED" | "MSG_HEAD_BLOCKED" | "MSG_LATE_ARRIVAL" | "OAUTH2_TOKEN_FAILURE" | "PAYLOAD_TOO_LARGE" | "PRUNE_SCOPE_COMPLETED" | "PRUNE_SCOPE_PARTIAL_FAILURE" | "RECURSION_DEPTH_EXCEEDED" | "RELATION_REF_ITEM_NOT_FOUND" | "RELATION_REF_VALUE_UNDEFINED" | "REQUIRED_PARAM_MISSING" | "SECURE_PROXY_DISABLED" | "SECURE_PROXY_DOMAIN_BLOCKED" | "SECURE_PROXY_DOMAIN_NOT_ALLOWED" | "SECURE_PROXY_ERROR" | "SECURE_PROXY_INVALID_CONFIG" | "SECURE_PROXY_INVALID_TYPE" | "SECURE_PROXY_INVALID_URL" | "SECURE_PROXY_IP_BLOCKED" | "SECURE_PROXY_IP_NOT_ALLOWED" | "SECURE_PROXY_NOT_FOUND" | "SECURE_PROXY_UNAVAILABLE" | "SIGNATURE_VERIFICATION_FAILED" | "SIGNATURE_VERIFICATION_UNAVAILABLE" | "SOFT_DELETED_ENTITY_MATCHED" | "STEP_DISABLED" | "TIMEOUT" | "UNIQUE_ID_MULTIPLE_MATCHES" | "UNIQUE_ID_NOT_IN_SCHEMA" | "UNKNOWN_ERROR" | "USE_CASE_DISABLED" | "USE_CASE_INVALID_TYPE" | "USE_CASE_MISSING_CONFIG" | "USE_CASE_NOT_FOUND" | "WEBHOOK_DELIVERED"
|
|
9593
|
+
type MonitoringCode = "ACK_CONFIRMED" | "ACK_PENDING" | "ACK_TIMEOUT" | "ATTACHMENT_NOT_FOUND" | "ATTRIBUTE_TYPE_MISMATCH" | "CONDITIONAL_VARIANTS_WRITTEN" | "CONDITIONAL_VARIANT_WRITE_FAILED" | "CONDITIONAL_VARIANT_WRITE_WARNING" | "DEPRECATED_ENDPOINT" | "DIRECT_ENTITY_NOT_ALLOWED" | "DIRECT_PAYLOAD_INVALID" | "DIRECT_VERSION_UNSUPPORTED" | "DUPLICATE_EVENT" | "ENTITY_CREATED" | "ENTITY_DELETED" | "ENTITY_NO_OP" | "ENTITY_REFERENCE_NOT_FOUND" | "ENTITY_UPDATED" | "EVENT_NOT_CONFIGURED" | "EXTERNAL_API_ERROR" | "EXTERNAL_ERROR" | "EXTERNAL_INFO" | "EXTERNAL_SUCCESS" | "EXTERNAL_WARNING" | "FAN_OUT_EMPTY" | "FAN_OUT_INVALID_RESULT" | "FILE_EXTRACTION_FAILED" | "FILE_FETCH_FAILED" | "FILE_PROXY_OK" | "FILE_PROXY_UPLOADED" | "FILE_PROXY_UPLOAD_ENQUEUED" | "FILE_PROXY_UPLOAD_FAILED" | "FILE_PROXY_UPLOAD_RETRYING" | "FILE_TOO_LARGE" | "INTEGRATION_NOT_FOUND" | "INVALID_METER_READING_ATTRIBUTES" | "LOOKUP_UNMAPPED" | "MALFORMED_PAYLOAD" | "MAPPING_EXPRESSION_FAILED" | "METERING_API_ERROR" | "METER_READING_DELETED" | "METER_READING_GROUP_FAILED" | "METER_READING_GROUP_RETRYING" | "METER_READING_UPSERTED" | "MISSING_REQUIRED_PARAM" | "MISSING_UNIQUE_IDENTIFIERS" | "MSG_ACKED" | "MSG_DEAD_LETTERED" | "MSG_ENQUEUED" | "MSG_EXPIRED_UNPOLLED" | "MSG_HEAD_BLOCKED" | "MSG_LATE_ARRIVAL" | "OAUTH2_TOKEN_FAILURE" | "PAYLOAD_TOO_LARGE" | "PRUNE_SCOPE_COMPLETED" | "PRUNE_SCOPE_PARTIAL_FAILURE" | "RECURSION_DEPTH_EXCEEDED" | "RELATION_REF_ITEM_NOT_FOUND" | "RELATION_REF_VALUE_UNDEFINED" | "REQUIRED_PARAM_MISSING" | "SECURE_PROXY_DISABLED" | "SECURE_PROXY_DOMAIN_BLOCKED" | "SECURE_PROXY_DOMAIN_NOT_ALLOWED" | "SECURE_PROXY_ERROR" | "SECURE_PROXY_INVALID_CONFIG" | "SECURE_PROXY_INVALID_TYPE" | "SECURE_PROXY_INVALID_URL" | "SECURE_PROXY_IP_BLOCKED" | "SECURE_PROXY_IP_NOT_ALLOWED" | "SECURE_PROXY_NOT_FOUND" | "SECURE_PROXY_UNAVAILABLE" | "SIGNATURE_VERIFICATION_FAILED" | "SIGNATURE_VERIFICATION_UNAVAILABLE" | "SOFT_DELETED_ENTITY_MATCHED" | "STEP_DISABLED" | "TIMEOUT" | "UNIQUE_ID_LOOKUP_UNRESOLVABLE" | "UNIQUE_ID_MULTIPLE_MATCHES" | "UNIQUE_ID_NOT_IN_SCHEMA" | "UNKNOWN_ERROR" | "USE_CASE_DISABLED" | "USE_CASE_INVALID_TYPE" | "USE_CASE_MISSING_CONFIG" | "USE_CASE_NOT_FOUND" | "WEBHOOK_DELIVERED"
|
|
9594
9594
|
```
|
|
9595
9595
|
|
|
9596
9596
|
### `MonitoringEventV2`
|
package/package.json
CHANGED
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import "./chunk-YPSWSI3M.js";
|
|
2
|
-
|
|
3
|
-
// src/docs/event-catalog.json
|
|
4
|
-
var event_catalog_default = '# Event Catalog API\n\n- **Base URL:** `https://event-catalog.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/event-catalog](https://docs.epilot.io/api/event-catalog)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.eventCatalog.listEvents(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/event-catalog\'\n\nconst eventCatalogClient = getClient()\nauthorize(eventCatalogClient, () => \'<token>\')\nconst { data } = await eventCatalogClient.listEvents(...)\n```\n\n## Operations\n\n**Event Catalog**\n- [`listEvents`](#listevents)\n- [`createCustomEvent`](#createcustomevent)\n- [`getEvent`](#getevent)\n- [`patchEvent`](#patchevent)\n- [`replaceCustomEventDraft`](#replacecustomeventdraft)\n- [`deprecateCustomEvent`](#deprecatecustomevent)\n- [`previewCustomEvent`](#previewcustomevent)\n- [`publishCustomEventDefinition`](#publishcustomeventdefinition)\n- [`getCustomEventVersionDraft`](#getcustomeventversiondraft)\n- [`putCustomEventVersionDraft`](#putcustomeventversiondraft)\n- [`deleteCustomEventVersionDraft`](#deletecustomeventversiondraft)\n- [`publishCustomEventVersion`](#publishcustomeventversion)\n- [`getEventJSONSchema`](#geteventjsonschema)\n- [`getEventExample`](#geteventexample)\n- [`listEventVersions`](#listeventversions)\n- [`searchEventHistory`](#searcheventhistory)\n- [`searchEventHistoryV2`](#searcheventhistoryv2)\n- [`getHistoricalEvent`](#gethistoricalevent)\n- [`triggerEvent`](#triggerevent)\n\n**Schemas**\n- [`EventConfigBase`](#eventconfigbase)\n- [`EventConfig`](#eventconfig)\n- [`CreateCustomEventPayload`](#createcustomeventpayload)\n- [`EventMapping`](#eventmapping)\n- [`CustomEventLineage`](#customeventlineage)\n- [`PurposeFilterSnapshot`](#purposefiltersnapshot)\n- [`PublishCustomEventPayload`](#publishcustomeventpayload)\n- [`CustomEventVersionDraft`](#customeventversiondraft)\n- [`PublishCustomEventVersionPayload`](#publishcustomeventversionpayload)\n- [`ValidationIssue`](#validationissue)\n- [`PreviewEventResponse`](#previeweventresponse)\n- [`UpdateEventPayload`](#updateeventpayload)\n- [`PrimitiveField`](#primitivefield)\n- [`ContextEntity`](#contextentity)\n- [`AttachmentField`](#attachmentfield)\n- [`CustomSchemaField`](#customschemafield)\n- [`SchemaField`](#schemafield)\n- [`SuccessCriterion`](#successcriterion)\n- [`CommonEventMetadata`](#commoneventmetadata)\n- [`EventJsonSchema`](#eventjsonschema)\n- [`InlineDowngradeStep`](#inlinedowngradestep)\n- [`Event`](#event)\n- [`EventSummary`](#eventsummary)\n- [`GraphDefinition`](#graphdefinition)\n- [`GraphNode`](#graphnode)\n- [`GraphEdge`](#graphedge)\n- [`EntityOperationTrigger`](#entityoperationtrigger)\n- [`SearchOptions`](#searchoptions)\n- [`SearchOptionsV2`](#searchoptionsv2)\n- [`FieldsParam`](#fieldsparam)\n- [`TriggerEventPayload`](#triggereventpayload)\n- [`TriggerEventResponse`](#triggereventresponse)\n- [`EventAttachment`](#eventattachment)\n- [`FieldChange`](#fieldchange)\n- [`VersionMeta`](#versionmeta)\n- [`EventVersionRegistrySummary`](#eventversionregistrysummary)\n\n### `listEvents`\n\nRetrieve list of available business events\n\n`GET /v1/events`\n\n```ts\nconst { data } = await client.listEvents()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "event_name": "AddMeterReading",\n "event_title": "Add Meter Reading",\n "event_description": "Triggered when a new meter reading is added",\n "event_version": "1.0",\n "event_status": "active",\n "event_tags": ["builtin", "metering", "erp"],\n "schema_fields": {},\n "entity_graph": {\n "nodes": [\n {\n "id": "contact",\n "schema": "contact",\n "cardinality": "one",\n "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n }\n ],\n "edges": [\n {\n "from": "contact",\n "to": "billing_account"\n }\n ]\n },\n "entity_operation": {\n "operation": ["createEntity", "updateEntity"],\n "schema": ["contact", "contract", "order"],\n "attribute": ["email", "phone", "status"],\n "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n "purpose_filters": [\n {\n "id": "string",\n "display_name": "string"\n }\n ]\n },\n "enabled": true,\n "auto_trigger": true,\n "automation_trigger": true,\n "api_trigger": true,\n "automation_trigger_only": true,\n "automation_trigger_seed_node": "ticket",\n "event_origin": "builtin",\n "mapping": {\n "mode": "guided",\n "jsonata": "string"\n },\n "lineage": {\n "base_event_name": "string",\n "base_event_version": "string"\n },\n "success_criteria": [\n {\n "entity_schema": "contract",\n "attribute": "installment_amount"\n },\n {\n "entity_schema": "billing_account",\n "attribute": "due_date"\n }\n ]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createCustomEvent`\n\nReserve an org-scoped custom event name and persist its immutable v1.0 draft definition. Custom events are always projected from an entity graph: entity_graph is required and, in guided mapping mode, \n\n`POST /v1/events`\n\n```ts\nconst { data } = await client.createCustomEvent(\n null,\n {\n event_name: \'string\',\n event_title: \'string\',\n event_description: \'string\',\n event_tags: [\'string\'],\n schema_fields: {},\n entity_graph: {\n nodes: [\n {\n id: \'contact\',\n schema: \'contact\',\n cardinality: \'one\',\n fields: [\'_id\', \'_title\', \'first_name\', \'account\', \'!account.*._files\', \'**._product\']\n }\n ],\n edges: [\n {\n from: \'contact\',\n to: \'billing_account\'\n }\n ]\n },\n entity_operation: {\n operation: [\'createEntity\', \'updateEntity\'],\n schema: [\'contact\', \'contract\', \'order\'],\n attribute: [\'email\', \'phone\', \'status\'],\n purpose: [\'K\xFCndigung\', \'Umzug/Auszug\'],\n purpose_filters: [\n {\n id: \'string\',\n display_name: \'string\'\n }\n ]\n },\n automation_trigger: true,\n api_trigger: true,\n automation_trigger_only: false,\n automation_trigger_seed_node: \'string\',\n mapping: {\n mode: \'guided\',\n jsonata: \'string\'\n },\n lineage: {\n base_event_name: \'string\',\n base_event_version: \'string\'\n },\n example: {}\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "event_name": "AddMeterReading",\n "event_title": "Add Meter Reading",\n "event_description": "Triggered when a new meter reading is added",\n "event_version": "1.0",\n "event_status": "active",\n "event_tags": ["builtin", "metering", "erp"],\n "schema_fields": {},\n "entity_graph": {\n "nodes": [\n {\n "id": "contact",\n "schema": "contact",\n "cardinality": "one",\n "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n }\n ],\n "edges": [\n {\n "from": "contact",\n "to": "billing_account"\n }\n ]\n },\n "entity_operation": {\n "operation": ["createEntity", "updateEntity"],\n "schema": ["contact", "contract", "order"],\n "attribute": ["email", "phone", "status"],\n "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n "purpose_filters": [\n {\n "id": "string",\n "display_name": "string"\n }\n ]\n },\n "enabled": true,\n "auto_trigger": true,\n "automation_trigger": true,\n "api_trigger": true,\n "automation_trigger_only": true,\n "automation_trigger_seed_node": "ticket",\n "event_origin": "builtin",\n "mapping": {\n "mode": "guided",\n "jsonata": "string"\n },\n "lineage": {\n "base_event_name": "string",\n "base_event_version": "string"\n },\n "success_criteria": [\n {\n "entity_schema": "contract",\n "attribute": "installment_amount"\n },\n {\n "entity_schema": "billing_account",\n "attribute": "due_date"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getEvent`\n\nRetrieve the configuration of a specific business event\n\n`GET /v1/events/{event_name}`\n\n```ts\nconst { data } = await client.getEvent({\n event_name: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "event_name": "AddMeterReading",\n "event_title": "Add Meter Reading",\n "event_description": "Triggered when a new meter reading is added",\n "event_version": "1.0",\n "event_status": "active",\n "event_tags": ["builtin", "metering", "erp"],\n "schema_fields": {},\n "entity_graph": {\n "nodes": [\n {\n "id": "contact",\n "schema": "contact",\n "cardinality": "one",\n "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n }\n ],\n "edges": [\n {\n "from": "contact",\n "to": "billing_account"\n }\n ]\n },\n "entity_operation": {\n "operation": ["createEntity", "updateEntity"],\n "schema": ["contact", "contract", "order"],\n "attribute": ["email", "phone", "status"],\n "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n "purpose_filters": [\n {\n "id": "string",\n "display_name": "string"\n }\n ]\n },\n "enabled": true,\n "auto_trigger": true,\n "automation_trigger": true,\n "api_trigger": true,\n "automation_trigger_only": true,\n "automation_trigger_seed_node": "ticket",\n "event_origin": "builtin",\n "mapping": {\n "mode": "guided",\n "jsonata": "string"\n },\n "lineage": {\n "base_event_name": "string",\n "base_event_version": "string"\n },\n "success_criteria": [\n {\n "entity_schema": "contract",\n "attribute": "installment_amount"\n },\n {\n "entity_schema": "billing_account",\n "attribute": "due_date"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `patchEvent`\n\nUpdate the configuration of a specific business event for the organization\n\n`PATCH /v1/events/{event_name}`\n\n```ts\nconst { data } = await client.patchEvent(\n {\n event_name: \'example\',\n },\n {\n enabled: true,\n auto_trigger: true,\n success_criteria: [\n {\n entity_schema: \'contract\',\n attribute: \'installment_amount\'\n }\n ]\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "event_name": "AddMeterReading",\n "event_title": "Add Meter Reading",\n "event_description": "Triggered when a new meter reading is added",\n "event_version": "1.0",\n "event_status": "active",\n "event_tags": ["builtin", "metering", "erp"],\n "schema_fields": {},\n "entity_graph": {\n "nodes": [\n {\n "id": "contact",\n "schema": "contact",\n "cardinality": "one",\n "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n }\n ],\n "edges": [\n {\n "from": "contact",\n "to": "billing_account"\n }\n ]\n },\n "entity_operation": {\n "operation": ["createEntity", "updateEntity"],\n "schema": ["contact", "contract", "order"],\n "attribute": ["email", "phone", "status"],\n "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n "purpose_filters": [\n {\n "id": "string",\n "display_name": "string"\n }\n ]\n },\n "enabled": true,\n "auto_trigger": true,\n "automation_trigger": true,\n "api_trigger": true,\n "automation_trigger_only": true,\n "automation_trigger_seed_node": "ticket",\n "event_origin": "builtin",\n "mapping": {\n "mode": "guided",\n "jsonata": "string"\n },\n "lineage": {\n "base_event_name": "string",\n "base_event_version": "string"\n },\n "success_criteria": [\n {\n "entity_schema": "contract",\n "attribute": "installment_amount"\n },\n {\n "entity_schema": "billing_account",\n "attribute": "due_date"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `replaceCustomEventDraft`\n\nReplace the complete v1.0 definition of an org-scoped custom event while it is still an\nunpublished draft. Drafts have no consumers, so their definition is not yet immutable;\nthe event name is the ide\n\n`PUT /v1/events/{event_name}`\n\n```ts\nconst { data } = await client.replaceCustomEventDraft(\n {\n event_name: \'example\',\n },\n {\n event_name: \'string\',\n event_title: \'string\',\n event_description: \'string\',\n event_tags: [\'string\'],\n schema_fields: {},\n entity_graph: {\n nodes: [\n {\n id: \'contact\',\n schema: \'contact\',\n cardinality: \'one\',\n fields: [\'_id\', \'_title\', \'first_name\', \'account\', \'!account.*._files\', \'**._product\']\n }\n ],\n edges: [\n {\n from: \'contact\',\n to: \'billing_account\'\n }\n ]\n },\n entity_operation: {\n operation: [\'createEntity\', \'updateEntity\'],\n schema: [\'contact\', \'contract\', \'order\'],\n attribute: [\'email\', \'phone\', \'status\'],\n purpose: [\'K\xFCndigung\', \'Umzug/Auszug\'],\n purpose_filters: [\n {\n id: \'string\',\n display_name: \'string\'\n }\n ]\n },\n automation_trigger: true,\n api_trigger: true,\n automation_trigger_only: false,\n automation_trigger_seed_node: \'string\',\n mapping: {\n mode: \'guided\',\n jsonata: \'string\'\n },\n lineage: {\n base_event_name: \'string\',\n base_event_version: \'string\'\n },\n example: {}\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "event_name": "AddMeterReading",\n "event_title": "Add Meter Reading",\n "event_description": "Triggered when a new meter reading is added",\n "event_version": "1.0",\n "event_status": "active",\n "event_tags": ["builtin", "metering", "erp"],\n "schema_fields": {},\n "entity_graph": {\n "nodes": [\n {\n "id": "contact",\n "schema": "contact",\n "cardinality": "one",\n "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n }\n ],\n "edges": [\n {\n "from": "contact",\n "to": "billing_account"\n }\n ]\n },\n "entity_operation": {\n "operation": ["createEntity", "updateEntity"],\n "schema": ["contact", "contract", "order"],\n "attribute": ["email", "phone", "status"],\n "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n "purpose_filters": [\n {\n "id": "string",\n "display_name": "string"\n }\n ]\n },\n "enabled": true,\n "auto_trigger": true,\n "automation_trigger": true,\n "api_trigger": true,\n "automation_trigger_only": true,\n "automation_trigger_seed_node": "ticket",\n "event_origin": "builtin",\n "mapping": {\n "mode": "guided",\n "jsonata": "string"\n },\n "lineage": {\n "base_event_name": "string",\n "base_event_version": "string"\n },\n "success_criteria": [\n {\n "entity_schema": "contract",\n "attribute": "installment_amount"\n },\n {\n "entity_schema": "billing_account",\n "attribute": "due_date"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `deprecateCustomEvent`\n\nSoft-deprecate an org-scoped custom event. Definitions and v1.0 history remain readable.\n\n`DELETE /v1/events/{event_name}`\n\n```ts\nconst { data } = await client.deprecateCustomEvent({\n event_name: \'example\',\n})\n```\n\n---\n\n### `previewCustomEvent`\n\nAssemble and fully validate a persisted custom-event draft without publishing it.\n\n`POST /v1/events/{event_name}:preview`\n\n```ts\nconst { data } = await client.previewCustomEvent(\n {\n event_name: \'example\',\n },\n {\n seed: {\n entity_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n node_id: \'ticket\'\n },\n _trigger_source_type: \'automation\',\n _trigger_source: \'execution-id/action-id\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "payload": {},\n "errors": [\n {\n "path": "string",\n "message": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `publishCustomEventDefinition`\n\nConditionally activate an immutable custom-event v1.0 definition.\n\n`POST /v1/events/{event_name}:publish`\n\n```ts\nconst { data } = await client.publishCustomEventDefinition(\n {\n event_name: \'example\',\n },\n {\n enabled: true,\n auto_trigger: true,\n base_auto_trigger_enabled: true\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "event_name": "AddMeterReading",\n "event_title": "Add Meter Reading",\n "event_description": "Triggered when a new meter reading is added",\n "event_version": "1.0",\n "event_status": "active",\n "event_tags": ["builtin", "metering", "erp"],\n "schema_fields": {},\n "entity_graph": {\n "nodes": [\n {\n "id": "contact",\n "schema": "contact",\n "cardinality": "one",\n "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n }\n ],\n "edges": [\n {\n "from": "contact",\n "to": "billing_account"\n }\n ]\n },\n "entity_operation": {\n "operation": ["createEntity", "updateEntity"],\n "schema": ["contact", "contract", "order"],\n "attribute": ["email", "phone", "status"],\n "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n "purpose_filters": [\n {\n "id": "string",\n "display_name": "string"\n }\n ]\n },\n "enabled": true,\n "auto_trigger": true,\n "automation_trigger": true,\n "api_trigger": true,\n "automation_trigger_only": true,\n "automation_trigger_seed_node": "ticket",\n "event_origin": "builtin",\n "mapping": {\n "mode": "guided",\n "jsonata": "string"\n },\n "lineage": {\n "base_event_name": "string",\n "base_event_version": "string"\n },\n "success_criteria": [\n {\n "entity_schema": "contract",\n "attribute": "installment_amount"\n },\n {\n "entity_schema": "billing_account",\n "attribute": "due_date"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getCustomEventVersionDraft`\n\nRead the in-progress successor of a published custom event, together with the version it\nwould be published as. The live version keeps firing while the successor is authored.\n\n`GET /v1/events/{event_name}/version_draft`\n\n```ts\nconst { data } = await client.getCustomEventVersionDraft({\n event_name: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "config": {\n "event_name": "AddMeterReading",\n "event_title": "Add Meter Reading",\n "event_description": "Triggered when a new meter reading is added",\n "event_version": "1.0",\n "event_status": "active",\n "event_tags": ["builtin", "metering", "erp"],\n "schema_fields": {},\n "entity_graph": {\n "nodes": [\n {\n "id": "contact",\n "schema": "contact",\n "cardinality": "one",\n "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n }\n ],\n "edges": [\n {\n "from": "contact",\n "to": "billing_account"\n }\n ]\n },\n "entity_operation": {\n "operation": ["createEntity", "updateEntity"],\n "schema": ["contact", "contract", "order"],\n "attribute": ["email", "phone", "status"],\n "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n "purpose_filters": [\n {\n "id": "string",\n "display_name": "string"\n }\n ]\n },\n "enabled": true,\n "auto_trigger": true,\n "automation_trigger": true,\n "api_trigger": true,\n "automation_trigger_only": true,\n "automation_trigger_seed_node": "ticket",\n "event_origin": "builtin",\n "mapping": {\n "mode": "guided",\n "jsonata": "string"\n },\n "lineage": {\n "base_event_name": "string",\n "base_event_version": "string"\n },\n "success_criteria": [\n {\n "entity_schema": "contract",\n "attribute": "installment_amount"\n },\n {\n "entity_schema": "billing_account",\n "attribute": "due_date"\n }\n ]\n },\n "change_class": "none",\n "next_version": "1.1",\n "changes": [\n {\n "field": "reading",\n "op": "added",\n "type_old": "string",\n "type_new": "string"\n }\n ],\n "remapped_fields": ["string"],\n "added_nodes": ["string"],\n "blocked_reason": "string"\n}\n```\n\n</details>\n\n---\n\n### `putCustomEventVersionDraft`\n\nCreate or replace the successor of a published custom event. The published definition stays\nimmutable and keeps firing; only publishing the draft promotes it.\n\n`PUT /v1/events/{event_name}/version_draft`\n\n```ts\nconst { data } = await client.putCustomEventVersionDraft(\n {\n event_name: \'example\',\n },\n {\n event_name: \'string\',\n event_title: \'string\',\n event_description: \'string\',\n event_tags: [\'string\'],\n schema_fields: {},\n entity_graph: {\n nodes: [\n {\n id: \'contact\',\n schema: \'contact\',\n cardinality: \'one\',\n fields: [\'_id\', \'_title\', \'first_name\', \'account\', \'!account.*._files\', \'**._product\']\n }\n ],\n edges: [\n {\n from: \'contact\',\n to: \'billing_account\'\n }\n ]\n },\n entity_operation: {\n operation: [\'createEntity\', \'updateEntity\'],\n schema: [\'contact\', \'contract\', \'order\'],\n attribute: [\'email\', \'phone\', \'status\'],\n purpose: [\'K\xFCndigung\', \'Umzug/Auszug\'],\n purpose_filters: [\n {\n id: \'string\',\n display_name: \'string\'\n }\n ]\n },\n automation_trigger: true,\n api_trigger: true,\n automation_trigger_only: false,\n automation_trigger_seed_node: \'string\',\n mapping: {\n mode: \'guided\',\n jsonata: \'string\'\n },\n lineage: {\n base_event_name: \'string\',\n base_event_version: \'string\'\n },\n example: {}\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "config": {\n "event_name": "AddMeterReading",\n "event_title": "Add Meter Reading",\n "event_description": "Triggered when a new meter reading is added",\n "event_version": "1.0",\n "event_status": "active",\n "event_tags": ["builtin", "metering", "erp"],\n "schema_fields": {},\n "entity_graph": {\n "nodes": [\n {\n "id": "contact",\n "schema": "contact",\n "cardinality": "one",\n "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n }\n ],\n "edges": [\n {\n "from": "contact",\n "to": "billing_account"\n }\n ]\n },\n "entity_operation": {\n "operation": ["createEntity", "updateEntity"],\n "schema": ["contact", "contract", "order"],\n "attribute": ["email", "phone", "status"],\n "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n "purpose_filters": [\n {\n "id": "string",\n "display_name": "string"\n }\n ]\n },\n "enabled": true,\n "auto_trigger": true,\n "automation_trigger": true,\n "api_trigger": true,\n "automation_trigger_only": true,\n "automation_trigger_seed_node": "ticket",\n "event_origin": "builtin",\n "mapping": {\n "mode": "guided",\n "jsonata": "string"\n },\n "lineage": {\n "base_event_name": "string",\n "base_event_version": "string"\n },\n "success_criteria": [\n {\n "entity_schema": "contract",\n "attribute": "installment_amount"\n },\n {\n "entity_schema": "billing_account",\n "attribute": "due_date"\n }\n ]\n },\n "change_class": "none",\n "next_version": "1.1",\n "changes": [\n {\n "field": "reading",\n "op": "added",\n "type_old": "string",\n "type_new": "string"\n }\n ],\n "remapped_fields": ["string"],\n "added_nodes": ["string"],\n "blocked_reason": "string"\n}\n```\n\n</details>\n\n---\n\n### `deleteCustomEventVersionDraft`\n\nDiscard the next-version draft. The published version is untouched.\n\n`DELETE /v1/events/{event_name}/version_draft`\n\n```ts\nconst { data } = await client.deleteCustomEventVersionDraft({\n event_name: \'example\',\n})\n```\n\n---\n\n### `publishCustomEventVersion`\n\nPublish the next-version draft as the event\'s new live version.\n\n`POST /v1/events/{event_name}/version_draft:publish`\n\n```ts\nconst { data } = await client.publishCustomEventVersion(\n {\n event_name: \'example\',\n },\n {\n change_summary: \'string\',\n change_notes: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "event_name": "AddMeterReading",\n "event_title": "Add Meter Reading",\n "event_description": "Triggered when a new meter reading is added",\n "event_version": "1.0",\n "event_status": "active",\n "event_tags": ["builtin", "metering", "erp"],\n "schema_fields": {},\n "entity_graph": {\n "nodes": [\n {\n "id": "contact",\n "schema": "contact",\n "cardinality": "one",\n "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"]\n }\n ],\n "edges": [\n {\n "from": "contact",\n "to": "billing_account"\n }\n ]\n },\n "entity_operation": {\n "operation": ["createEntity", "updateEntity"],\n "schema": ["contact", "contract", "order"],\n "attribute": ["email", "phone", "status"],\n "purpose": ["K\xFCndigung", "Umzug/Auszug"],\n "purpose_filters": [\n {\n "id": "string",\n "display_name": "string"\n }\n ]\n },\n "enabled": true,\n "auto_trigger": true,\n "automation_trigger": true,\n "api_trigger": true,\n "automation_trigger_only": true,\n "automation_trigger_seed_node": "ticket",\n "event_origin": "builtin",\n "mapping": {\n "mode": "guided",\n "jsonata": "string"\n },\n "lineage": {\n "base_event_name": "string",\n "base_event_version": "string"\n },\n "success_criteria": [\n {\n "entity_schema": "contract",\n "attribute": "installment_amount"\n },\n {\n "entity_schema": "billing_account",\n "attribute": "due_date"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getEventJSONSchema`\n\nRetrieve the JSON Schema of a specific business event. Pass an optional\n`Epilot-Event-Version` header to retrieve a specific version\'s schema;\nwhen omitted, the event\'s latest version is returned.\n\n`GET /v1/events/{event_name}/json_schema`\n\n```ts\nconst { data } = await client.getEventJSONSchema({\n event_name: \'example\',\n Epilot-Event-Version: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "type": "object",\n "properties": {\n "_org_id": {\n "type": "string",\n "description": "epilot tenant/organization ID"\n },\n "_event_time": {\n "type": "string",\n "format": "date-time",\n "description": "ISO 8601 timestamp when event occurred"\n },\n "_event_id": {\n "type": "string",\n "description": "Unique event identifier (ULID)"\n },\n "_event_name": {\n "type": "string",\n "description": "Event name from catalog"\n },\n "_event_version": {\n "type": "string",\n "description": "Event payload version (MAJOR.MINOR)"\n },\n "_event_source": {\n "type": "string",\n "description": "Source that triggered the event"\n },\n "reading_value": {\n "type": "number",\n "description": "The meter reading value"\n },\n "reading_date": {\n "type": "string",\n "format": "date-time",\n "description": "ISO 8601 timestamp when reading was taken"\n },\n "read_by": {\n "type": "string",\n "description": "Name or identifier of who submitted the reading"\n },\n "reason": {\n "type": "string",\n "enum": ["regular", "move-in", "move-out", "supplier-change", "correction", "final"],\n "description": "Reason for the meter reading"\n },\n "direction": {\n "type": "string",\n "enum": ["feed-in", "feed-out"],\n "description": "Direction of energy flow"\n },\n "source": {\n "type": "string",\n "enum": ["portal", "360", "api", "automation"],\n "description": "Source system where reading was submitted"\n },\n "meter_id": {\n "type": "string",\n "format": "uuid",\n "description": "Entity ID of the meter"\n },\n "counter_id": {\n "type": "string",\n "format": "uuid",\n "description": "Entity ID of the meter counter"\n },\n "meter_number": {\n "type": "string",\n "description": "Human-readable meter number"\n },\n "obis_number": {\n "type": "string",\n "description": "OBIS code of the counter"\n },\n "unit": {\n "type": "string",\n "description": "Unit of measurement (e.g., kWh, m3)"\n },\n "customer_id": {\n "type": "string",\n "format": "uuid",\n "description": "Entity ID of the customer"\n },\n "contract_id": {\n "type": "string",\n "format": "uuid",\n "description": "Entity ID of the contract"\n },\n "user_id": {\n "type": "string",\n "description": "ID of the user who submitted the reading"\n },\n "user_email": {\n "type": "string",\n "format": "email",\n "description": "Email of the user who submitted the reading"\n }\n },\n "required": ["_org_id", "_event_time", "_event_id", "_event_name", "_event_version", "_event_source", "reading_value", "reading_date", "read_by", "reason", "direction", "source", "meter_id", "counter_id", "meter_number", "obis_number", "unit", "customer_id", "contract_id"]\n}\n```\n\n</details>\n\n---\n\n### `getEventExample`\n\nGenerate a sample event payload based on the event\'s JSON Schema. Pass an\noptional `Epilot-Event-Version` header to generate the example for a\nspecific version; when omitted, the event\'s latest versio\n\n`GET /v1/events/{event_name}/example`\n\n```ts\nconst { data } = await client.getEventExample({\n event_name: \'example\',\n Epilot-Event-Version: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `listEventVersions`\n\nList every known version of an event, along with the `latest`\nand the set of currently `active` versions. See \xA73.2 of the\nEvent Payload Versioning RFC.\n\n`GET /v1/events/{event_name}/versions`\n\n```ts\nconst { data } = await client.listEventVersions({\n event_name: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "event_name": "MeterReadingAdded",\n "latest": "1.0",\n "versions": [\n {\n "version": "1.0",\n "released_at": "2025-11-15",\n "change_summary": "string",\n "change_notes": "string",\n "changes": [\n {\n "field": "reading",\n "op": "added",\n "type_old": "string",\n "type_new": "string"\n }\n ]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `searchEventHistory`\n\nPaginated history of events\n\n`POST /v1/events/{event_name}:history`\n\n```ts\nconst { data } = await client.searchEventHistory(\n {\n event_name: \'example\',\n },\n {\n limit: 10,\n cursor: {\n event_time: \'2025-10-31 12:34:56\',\n event_id: \'evt_1234567890abcdef\'\n },\n timestamp: {\n from: \'2025-10-01T00:00:00Z\',\n to: \'2025-10-31T23:59:59Z\'\n },\n event_id: \'evt_1234567890abcdef\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "_org_id": "org_123456",\n "_event_time": "2024-01-01T12:00:00Z",\n "_event_id": "01FZ4Z5FZ5FZ5FZ5FZ5FZ5FZ5F",\n "_event_name": "MeterReading",\n "_event_version": "1.0",\n "_event_source": "api",\n "_trigger_source_type": "api",\n "_trigger_source": "user_123456",\n "reading_value": 123.45,\n "reading_date": "2024-01-01T11:59:00Z",\n "read_by": "John Doe",\n "reason": "regular",\n "direction": "feed-out",\n "source": "portal",\n "meter_id": "550e8400-e29b-41d4-a716-446655440000",\n "counter_id": "660e8400-e29b-41d4-a716-446655440000",\n "meter_number": "MT123456789",\n "obis_number": "1-0:1.8.0",\n "unit": "kWh",\n "customer_id": "770e8400-e29b-41d4-a716-446655440000",\n "contract_id": "880e8400-e29b-41d4-a716-446655440000"\n }\n ],\n "next_cursor": {\n "event_time": "2025-10-31T12:34:56Z",\n "event_id": "evt_1234567890abcdef"\n }\n}\n```\n\n</details>\n\n---\n\n### `searchEventHistoryV2`\n\nPaginated history of events with projected/lightweight payload (v2).\n\n`POST /v2/events/{event_name}:history`\n\n```ts\nconst { data } = await client.searchEventHistoryV2(\n {\n event_name: \'example\',\n },\n {\n limit: 10,\n cursor: {\n event_time: \'2025-10-31 12:34:56\',\n event_id: \'evt_1234567890abcdef\'\n },\n timestamp: {\n from: \'2025-10-01T00:00:00Z\',\n to: \'2025-10-31T23:59:59Z\'\n },\n event_id: \'evt_1234567890abcdef\',\n fields: [\'_id\', \'_title\', \'first_name\', \'account\', \'!account.*._files\', \'**._product\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "_org_id": "string",\n "_event_time": "1970-01-01T00:00:00.000Z",\n "_event_id": "string",\n "_event_name": "string",\n "_event_version": "1.0",\n "_event_source": "string",\n "_trigger_source_type": "api",\n "_trigger_source": "string",\n "_ack_id": "string"\n }\n ],\n "next_cursor": {\n "event_time": "2025-10-31T12:34:56Z",\n "event_id": "evt_1234567890abcdef"\n }\n}\n```\n\n</details>\n\n---\n\n### `getHistoricalEvent`\n\nFetch a single historical event by id with full hydration\n\n`GET /v2/events/{event_name}/history/{event_id}`\n\n```ts\nconst { data } = await client.getHistoricalEvent({\n event_name: \'example\',\n event_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "_org_id": "org_123456",\n "_event_time": "2024-01-01T12:00:00Z",\n "_event_id": "01FZ4Z5FZ5FZ5FZ5FZ5FZ5FZ5F",\n "_event_name": "MeterReading",\n "_event_version": "1.0",\n "_event_source": "api",\n "_trigger_source_type": "api",\n "_trigger_source": "user_123456",\n "reading_value": 123.45,\n "reading_date": "2024-01-01T11:59:00Z",\n "read_by": "John Doe",\n "reason": "regular",\n "direction": "feed-out",\n "source": "portal",\n "meter_id": "550e8400-e29b-41d4-a716-446655440000",\n "counter_id": "660e8400-e29b-41d4-a716-446655440000",\n "meter_number": "MT123456789",\n "obis_number": "1-0:1.8.0",\n "unit": "kWh",\n "customer_id": "770e8400-e29b-41d4-a716-446655440000",\n "contract_id": "880e8400-e29b-41d4-a716-446655440000"\n}\n```\n\n</details>\n\n---\n\n### `triggerEvent`\n\nExplicitly trigger an event by providing input field values and an optional entity seed\nfor graph hydration. The event must be enabled for the organization.\n\n`POST /v1/events/{event_name}:trigger`\n\n```ts\nconst { data } = await client.triggerEvent(\n {\n event_name: \'example\',\n },\n {\n seed: {\n entity_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n node_id: \'ticket\'\n },\n _trigger_source_type: \'automation\',\n _trigger_source: \'execution-id/action-id\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "success": true,\n "event_id": "string",\n "event_bridge_event_id": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `EventConfigBase`\n\nBase properties shared between EventConfig and UpdateEventPayload\n\n```ts\ntype EventConfigBase = {\n event_name?: string\n event_title?: string\n event_description?: string\n event_version?: string\n event_status?: "active" | "deprecated" | "draft" | "disabled"\n event_tags?: string[]\n schema_fields?: Record<string, {\n json_schema: object\n required?: boolean\n graph_source?: string\n } | {\n entity_schema: string\n required?: boolean\n } | {\n items: {\n entity_id: { ... }\n filename?: { ... }\n mime_type?: { ... }\n size_bytes?: { ... }\n s3ref?: { ... }\n version_index: { ... }\n readable_size?: { ... }\n }\n required?: boolean\n }>\n entity_graph?: {\n nodes: Array<{\n id: { ... }\n schema: { ... }\n cardinality?: { ... }\n fields?: { ... }\n }>\n edges: Array<{\n from: { ... }\n to: { ... }\n }>\n }\n entity_operation?: {\n operation: "createEntity" | "updateEntity" | "deleteEntity"[]\n schema: string[]\n attribute?: string[]\n purpose?: string[]\n purpose_filters?: Array<{\n id: { ... }\n display_name: { ... }\n }>\n }\n enabled?: boolean\n auto_trigger?: boolean\n automation_trigger?: boolean\n api_trigger?: boolean\n automation_trigger_only?: boolean\n automation_trigger_seed_node?: string\n event_origin?: "builtin" | "custom"\n mapping?: {\n mode: "guided" | "jsonata"\n jsonata?: string\n }\n lineage?: {\n base_event_name: string\n base_event_version: string\n }\n success_criteria?: Array<{\n entity_schema: string\n attribute: string\n }>\n}\n```\n\n### `EventConfig`\n\nEvent configuration with required fields\n\n```ts\ntype EventConfig = {\n event_name: string\n event_title?: string\n event_description?: string\n event_version: string\n event_status?: "active" | "deprecated" | "draft" | "disabled"\n event_tags?: string[]\n schema_fields: Record<string, {\n json_schema: object\n required?: boolean\n graph_source?: string\n } | {\n entity_schema: string\n required?: boolean\n } | {\n items: {\n entity_id: { ... }\n filename?: { ... }\n mime_type?: { ... }\n size_bytes?: { ... }\n s3ref?: { ... }\n version_index: { ... }\n readable_size?: { ... }\n }\n required?: boolean\n }>\n entity_graph?: {\n nodes: Array<{\n id: { ... }\n schema: { ... }\n cardinality?: { ... }\n fields?: { ... }\n }>\n edges: Array<{\n from: { ... }\n to: { ... }\n }>\n }\n entity_operation?: {\n operation: "createEntity" | "updateEntity" | "deleteEntity"[]\n schema: string[]\n attribute?: string[]\n purpose?: string[]\n purpose_filters?: Array<{\n id: { ... }\n display_name: { ... }\n }>\n }\n enabled?: boolean\n auto_trigger?: boolean\n automation_trigger?: boolean\n api_trigger?: boolean\n automation_trigger_only?: boolean\n automation_trigger_seed_node?: string\n event_origin?: "builtin" | "custom"\n mapping?: {\n mode: "guided" | "jsonata"\n jsonata?: string\n }\n lineage?: {\n base_event_name: string\n base_event_version: string\n }\n success_criteria?: Array<{\n entity_schema: string\n attribute: string\n }>\n}\n```\n\n### `CreateCustomEventPayload`\n\nComplete immutable custom-event v1.0 definition projected from a required entity graph. Publication is a separate conditional action.\n\n```ts\ntype CreateCustomEventPayload = {\n event_name: string\n event_title: string\n event_description?: string\n event_tags?: string[]\n schema_fields: Record<string, {\n json_schema: object\n required?: boolean\n graph_source?: string\n } | {\n entity_schema: string\n required?: boolean\n }>\n entity_graph: {\n nodes: Array<{\n id: { ... }\n schema: { ... }\n cardinality?: { ... }\n fields?: { ... }\n }>\n edges: Array<{\n from: { ... }\n to: { ... }\n }>\n }\n entity_operation?: {\n operation: "createEntity" | "updateEntity" | "deleteEntity"[]\n schema: string[]\n attribute?: string[]\n purpose?: string[]\n purpose_filters?: Array<{\n id: { ... }\n display_name: { ... }\n }>\n }\n automation_trigger?: boolean\n api_trigger?: boolean\n automation_trigger_only?: boolean\n automation_trigger_seed_node?: string\n mapping?: {\n mode: "guided" | "jsonata"\n jsonata?: string\n }\n lineage?: {\n base_event_name: string\n base_event_version: string\n }\n example?: Record<string, unknown>\n}\n```\n\n### `EventMapping`\n\nGuided mappings use schema_fields graph_source expressions; raw mode evaluates one JSONata object transform.\n\n```ts\ntype EventMapping = {\n mode: "guided" | "jsonata"\n jsonata?: string\n}\n```\n\n### `CustomEventLineage`\n\nOptional catalog lineage to a separately named base event. Built-in inheritance is validated against this exact registered version; its trigger restrictions cannot be removed or replaced. It does not replace the base event.\n\n```ts\ntype CustomEventLineage = {\n base_event_name: string\n base_event_version: string\n}\n```\n\n### `PurposeFilterSnapshot`\n\n```ts\ntype PurposeFilterSnapshot = {\n id: string\n display_name: string\n}\n```\n\n### `PublishCustomEventPayload`\n\n```ts\ntype PublishCustomEventPayload = {\n enabled?: boolean\n auto_trigger?: boolean\n base_auto_trigger_enabled?: boolean\n}\n```\n\n### `CustomEventVersionDraft`\n\nA pending successor to a published custom event, with the version it would become.\n\n\n```ts\ntype CustomEventVersionDraft = {\n config: {\n event_name: string\n event_title?: string\n event_description?: string\n event_version: string\n event_status?: "active" | "deprecated" | "draft" | "disabled"\n event_tags?: string[]\n schema_fields: Record<string, {\n json_schema: { ... }\n required?: { ... }\n graph_source?: { ... }\n } | {\n entity_schema: { ... }\n required?: { ... }\n } | {\n items: { ... }\n required?: { ... }\n }>\n entity_graph?: {\n nodes: { ... }\n edges: { ... }\n }\n entity_operation?: {\n operation: { ... }\n schema: { ... }\n attribute?: { ... }\n purpose?: { ... }\n purpose_filters?: { ... }\n }\n enabled?: boolean\n auto_trigger?: boolean\n automation_trigger?: boolean\n api_trigger?: boolean\n automation_trigger_only?: boolean\n automation_trigger_seed_node?: string\n event_origin?: "builtin" | "custom"\n mapping?: {\n mode: { ... }\n jsonata?: { ... }\n }\n lineage?: {\n base_event_name: { ... }\n base_event_version: { ... }\n }\n success_criteria?: Array<{\n entity_schema: { ... }\n attribute: { ... }\n }>\n }\n change_class: "none" | "minor" | "major" | "blocked"\n next_version?: string\n changes: Array<{\n field: string\n op: "added" | "removed" | "type-changed"\n type_old?: string\n type_new?: string\n }>\n remapped_fields: string[]\n added_nodes: string[]\n blocked_reason?: string\n}\n```\n\n### `PublishCustomEventVersionPayload`\n\n```ts\ntype PublishCustomEventVersionPayload = {\n change_summary?: string\n change_notes?: string\n}\n```\n\n### `ValidationIssue`\n\n```ts\ntype ValidationIssue = {\n path: string\n message: string\n}\n```\n\n### `PreviewEventResponse`\n\n```ts\ntype PreviewEventResponse = {\n payload: Record<string, unknown>\n errors: Array<{\n path: string\n message: string\n }>\n}\n```\n\n### `UpdateEventPayload`\n\nMutable org activation overlay. Immutable event definition fields are not accepted.\n\n```ts\ntype UpdateEventPayload = {\n enabled?: boolean\n auto_trigger?: boolean\n success_criteria?: Array<{\n entity_schema: string\n attribute: string\n }>\n}\n```\n\n### `PrimitiveField`\n\nA primitive JSON Schema field definition\n\n```ts\ntype PrimitiveField = {\n json_schema: object\n required?: boolean\n graph_source?: string\n}\n```\n\n### `ContextEntity`\n\n```ts\ntype ContextEntity = {\n entity_schema: string\n required?: boolean\n}\n```\n\n### `AttachmentField`\n\nA schema field representing file attachments associated with the event.\nPresent in schema_fields for events tagged with "attachment".\n\n\n```ts\ntype AttachmentField = {\n items: {\n entity_id: string // uuid\n filename?: string\n mime_type?: string\n size_bytes?: number\n s3ref?: {\n bucket: { ... }\n key: { ... }\n }\n version_index: number\n readable_size?: string\n }\n required?: boolean\n}\n```\n\n### `CustomSchemaField`\n\nCustom v1 fields support graph-projected JSON Schema values and context entities; attachment semantics are built-in-only.\n\n```ts\ntype CustomSchemaField = {\n json_schema: object\n required?: boolean\n graph_source?: string\n} | {\n entity_schema: string\n required?: boolean\n}\n```\n\n### `SchemaField`\n\n```ts\ntype SchemaField = {\n json_schema: object\n required?: boolean\n graph_source?: string\n} | {\n entity_schema: string\n required?: boolean\n} | {\n items: {\n entity_id: string // uuid\n filename?: string\n mime_type?: string\n size_bytes?: number\n s3ref?: {\n bucket: { ... }\n key: { ... }\n }\n version_index: number\n readable_size?: string\n }\n required?: boolean\n}\n```\n\n### `SuccessCriterion`\n\nA single org-defined success criterion: an entity attribute that must be captured\nfor this event\'s change request to be considered complete.\n\nIdentity is the entity schema plus the attribute name \u2014 mirroring the\nEntityOperationTrigger `schema`/`attribute` vocabulary. On write (PATCH), both\n`attribut\n\n```ts\ntype SuccessCriterion = {\n entity_schema: string\n attribute: string\n}\n```\n\n### `CommonEventMetadata`\n\nCommon metadata fields present in all event payloads\n\n```ts\ntype CommonEventMetadata = object\n```\n\n### `EventJsonSchema`\n\nJSON Schema declaring the event payload structure\n\n```ts\ntype EventJsonSchema = object\n```\n\n### `InlineDowngradeStep`\n\nOne step of an event\'s inline `_downgrades` chain. Maps the current-version payload to the previous version via a JSONata expression. Stamped by Event Catalog at publish time; executed by consumers during walk-back, never by EC itself.\n\n```ts\ntype InlineDowngradeStep = {\n to: string\n jsonata: string\n}\n```\n\n### `Event`\n\nAn event instance in the event history\n\n```ts\ntype Event = {\n _org_id: string\n _event_time: string // date-time\n _event_id: string\n _event_name: string\n _event_version: string\n _event_source: string\n _trigger_source_type?: string\n _trigger_source?: string\n _ack_id?: string\n _downgrades?: Array<{\n to: string\n jsonata: string\n }>\n _automation_chain?: string[]\n}\n```\n\n### `EventSummary`\n\nA lightweight event summary returned by the v2 history endpoint.\n\nIncludes the standard `_*` metadata fields plus a projected subset of the\nevent payload. Hydrated entity objects (values carrying `_schema` or `_id`)\n\u2014 and arrays of such objects \u2014 are reduced to reference stubs\n`{_schema, _id, _title\n\n```ts\ntype EventSummary = {\n _org_id: string\n _event_time: string // date-time\n _event_id: string\n _event_name: string\n _event_version: string\n _event_source: string\n _trigger_source_type?: string\n _trigger_source?: string\n _ack_id?: string\n}\n```\n\n### `GraphDefinition`\n\nEntity graph definition for resolving related entities\n\n```ts\ntype GraphDefinition = {\n nodes: Array<{\n id: string\n schema: string\n cardinality?: "one" | "many"\n fields?: object\n }>\n edges: Array<{\n from: string\n to: string\n }>\n}\n```\n\n### `GraphNode`\n\nA node in the entity graph\n\n```ts\ntype GraphNode = {\n id: string\n schema: string\n cardinality?: "one" | "many"\n fields?: object\n}\n```\n\n### `GraphEdge`\n\nAn edge connecting two nodes in the graph\n\n```ts\ntype GraphEdge = {\n from: string\n to: string\n}\n```\n\n### `EntityOperationTrigger`\n\nConfiguration for triggering an event based on entity operations.\n\nWhen an entity operation matches the configured criteria, the event will be triggered.\n- On createEntity: the attribute must be present in the entity payload\n- On updateEntity: the attribute must be in diff.added, diff.updated, or di\n\n```ts\ntype EntityOperationTrigger = {\n operation: "createEntity" | "updateEntity" | "deleteEntity"[]\n schema: string[]\n attribute?: string[]\n purpose?: string[]\n purpose_filters?: Array<{\n id: string\n display_name: string\n }>\n}\n```\n\n### `SearchOptions`\n\n```ts\ntype SearchOptions = {\n limit?: number\n cursor?: {\n event_time?: string\n event_id?: string\n }\n timestamp?: {\n from?: string // date-time\n to?: string // date-time\n }\n event_id?: string\n}\n```\n\n### `SearchOptionsV2`\n\nSearch options for the v2 history endpoint.\n\nExtends `SearchOptions` with an optional `fields` projection. When `fields`\nis omitted, the response includes all `_*` metadata plus all scalar payload\nfields (and primitive arrays / empty objects/arrays) after entity stripping.\nWhen `fields` is provided,\n\n```ts\ntype SearchOptionsV2 = {\n limit?: number\n cursor?: {\n event_time?: string\n event_id?: string\n }\n timestamp?: {\n from?: string // date-time\n to?: string // date-time\n }\n event_id?: string\n fields?: string[]\n}\n```\n\n### `FieldsParam`\n\nList of entity fields to include or exclude in the response\n\nUse ! to exclude fields, e.g. `!_id` to exclude the `_id` field.\n\nGlobbing and globstart (**) is supported for nested fields.\n\n\n```ts\ntype FieldsParam = string[]\n```\n\n### `TriggerEventPayload`\n\nPayload for explicitly triggering an event via API\n\n```ts\ntype TriggerEventPayload = {\n seed?: {\n entity_id: string // uuid\n node_id: string\n }\n fields?: Record<string, unknown>\n skip_hydration?: string[]\n _trigger_source_type?: string\n _trigger_source?: string\n _automation_chain?: string[]\n}\n```\n\n### `TriggerEventResponse`\n\nResponse from triggering an event\n\n```ts\ntype TriggerEventResponse = {\n success: boolean\n event_id: string\n event_bridge_event_id?: string\n}\n```\n\n### `EventAttachment`\n\nA file attachment associated with an event\n\n```ts\ntype EventAttachment = {\n entity_id: string // uuid\n filename?: string\n mime_type?: string\n size_bytes?: number\n s3ref?: {\n bucket: string\n key: string\n }\n version_index: number\n readable_size?: string\n}\n```\n\n### `FieldChange`\n\nA field-level change descriptor. Powers the declarative half of the\nversion DSL.\n\n\n```ts\ntype FieldChange = {\n field: string\n op: "added" | "removed" | "type-changed"\n type_old?: string\n type_new?: string\n}\n```\n\n### `VersionMeta`\n\nOne entry of an event\'s version timeline.\n\n```ts\ntype VersionMeta = {\n version: string\n released_at: string\n change_summary: string\n change_notes?: string\n changes: Array<{\n field: string\n op: "added" | "removed" | "type-changed"\n type_old?: string\n type_new?: string\n }>\n}\n```\n\n### `EventVersionRegistrySummary`\n\nSummary of an event\'s version timeline returned by\n`GET /v1/events/{event_name}/versions`.\n\n\n```ts\ntype EventVersionRegistrySummary = {\n event_name: string\n latest: string\n versions: Array<{\n version: string\n released_at: string\n change_summary: string\n change_notes?: string\n changes: Array<{\n field: { ... }\n op: { ... }\n type_old?: { ... }\n type_new?: { ... }\n }>\n }>\n}\n```\n';
|
|
5
|
-
export {
|
|
6
|
-
event_catalog_default as default
|
|
7
|
-
};
|