Skip to content

Commit a00981d

Browse files
author
Flavius Mardare
committed
chore(event-catalog-client): update client with new spec
1 parent a30a016 commit a00981d

File tree

3 files changed

+50
-8
lines changed

3 files changed

+50
-8
lines changed

clients/event-catalog-client/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@epilot/event-catalog-client",
3-
"version": "0.4.1",
3+
"version": "0.4.2",
44
"description": "Client for epilot Event Catalog API",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",

clients/event-catalog-client/src/openapi.d.ts

Lines changed: 41 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -316,13 +316,25 @@ declare namespace Components {
316316
};
317317
/**
318318
* Whether this event is enabled for the organization.
319-
* When disabled, the event will not be triggered.
319+
* When disabled, the event will not be triggered by any means
320+
* (automatic, API, or automation).
320321
* Defaults to true if not specified.
321322
*
322323
* example:
323324
* true
324325
*/
325326
enabled?: boolean;
327+
/**
328+
* Whether the event should be triggered automatically by built-in logic
329+
* (e.g., portal submissions, entity mutations, EventBridge rules).
330+
* When false, the event can still be triggered manually via API or automations.
331+
* Only meaningful for builtin events that have automatic trigger sources.
332+
* Defaults to true if not specified.
333+
*
334+
* example:
335+
* true
336+
*/
337+
auto_trigger?: boolean;
326338
/**
327339
* Whether this event can be explicitly triggered by automations.
328340
* When true, the event will appear in the automation builder as a
@@ -454,13 +466,25 @@ declare namespace Components {
454466
};
455467
/**
456468
* Whether this event is enabled for the organization.
457-
* When disabled, the event will not be triggered.
469+
* When disabled, the event will not be triggered by any means
470+
* (automatic, API, or automation).
458471
* Defaults to true if not specified.
459472
*
460473
* example:
461474
* true
462475
*/
463476
enabled?: boolean;
477+
/**
478+
* Whether the event should be triggered automatically by built-in logic
479+
* (e.g., portal submissions, entity mutations, EventBridge rules).
480+
* When false, the event can still be triggered manually via API or automations.
481+
* Only meaningful for builtin events that have automatic trigger sources.
482+
* Defaults to true if not specified.
483+
*
484+
* example:
485+
* true
486+
*/
487+
auto_trigger?: boolean;
464488
/**
465489
* Whether this event can be explicitly triggered by automations.
466490
* When true, the event will appear in the automation builder as a
@@ -859,7 +883,7 @@ declare namespace Components {
859883
/**
860884
* Payload for updating an event configuration.
861885
* Accepts the same fields as EventConfig (all optional for PATCH).
862-
* Currently only the `enabled` field is processed, other fields are ignored.
886+
* Currently only `enabled` and `auto_trigger` fields are processed, other fields are ignored.
863887
*
864888
*/
865889
export interface UpdateEventPayload {
@@ -979,13 +1003,25 @@ declare namespace Components {
9791003
};
9801004
/**
9811005
* Whether this event is enabled for the organization.
982-
* When disabled, the event will not be triggered.
1006+
* When disabled, the event will not be triggered by any means
1007+
* (automatic, API, or automation).
9831008
* Defaults to true if not specified.
9841009
*
9851010
* example:
9861011
* true
9871012
*/
9881013
enabled?: boolean;
1014+
/**
1015+
* Whether the event should be triggered automatically by built-in logic
1016+
* (e.g., portal submissions, entity mutations, EventBridge rules).
1017+
* When false, the event can still be triggered manually via API or automations.
1018+
* Only meaningful for builtin events that have automatic trigger sources.
1019+
* Defaults to true if not specified.
1020+
*
1021+
* example:
1022+
* true
1023+
*/
1024+
auto_trigger?: boolean;
9891025
/**
9901026
* Whether this event can be explicitly triggered by automations.
9911027
* When true, the event will appear in the automation builder as a
@@ -1193,7 +1229,7 @@ declare namespace Paths {
11931229
export type RequestBody = /**
11941230
* Payload for updating an event configuration.
11951231
* Accepts the same fields as EventConfig (all optional for PATCH).
1196-
* Currently only the `enabled` field is processed, other fields are ignored.
1232+
* Currently only `enabled` and `auto_trigger` fields are processed, other fields are ignored.
11971233
*
11981234
*/
11991235
Components.Schemas.UpdateEventPayload;

clients/event-catalog-client/src/openapi.json

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,13 @@
406406
},
407407
"enabled": {
408408
"type": "boolean",
409-
"description": "Whether this event is enabled for the organization.\nWhen disabled, the event will not be triggered.\nDefaults to true if not specified.\n",
409+
"description": "Whether this event is enabled for the organization.\nWhen disabled, the event will not be triggered by any means\n(automatic, API, or automation).\nDefaults to true if not specified.\n",
410+
"default": true,
411+
"example": true
412+
},
413+
"auto_trigger": {
414+
"type": "boolean",
415+
"description": "Whether the event should be triggered automatically by built-in logic\n(e.g., portal submissions, entity mutations, EventBridge rules).\nWhen false, the event can still be triggered manually via API or automations.\nOnly meaningful for builtin events that have automatic trigger sources.\nDefaults to true if not specified.\n",
410416
"default": true,
411417
"example": true
412418
},
@@ -435,7 +441,7 @@
435441
]
436442
},
437443
"UpdateEventPayload": {
438-
"description": "Payload for updating an event configuration.\nAccepts the same fields as EventConfig (all optional for PATCH).\nCurrently only the `enabled` field is processed, other fields are ignored.\n",
444+
"description": "Payload for updating an event configuration.\nAccepts the same fields as EventConfig (all optional for PATCH).\nCurrently only `enabled` and `auto_trigger` fields are processed, other fields are ignored.\n",
439445
"allOf": [
440446
{
441447
"$ref": "#/components/schemas/EventConfigBase"

0 commit comments

Comments
 (0)