@epilot/sdk 2.20.33 → 2.20.34
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-runtime.json +1 -1
- package/definitions/event-catalog.json +310 -1
- package/definitions/focus-pocus-runtime.json +1 -0
- package/definitions/focus-pocus.json +757 -0
- package/definitions/integration-toolkit.json +272 -1
- package/definitions/metering.json +19 -8
- 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 +8 -8
- package/dist/apis/event-catalog.d.cts +2 -2
- package/dist/apis/event-catalog.d.ts +2 -2
- package/dist/apis/event-catalog.js +2 -2
- 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.d.cts +2 -2
- package/dist/apis/metering.d.ts +2 -2
- 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-M6G3GHCU.js +14 -0
- package/dist/{chunk-YEFQY72W.js → chunk-RJVNG46W.js} +3 -3
- package/dist/chunk-ULV6ZQQR.cjs +14 -0
- package/dist/{chunk-ZBFAP6AO.cjs → chunk-XFBOYWIP.cjs} +3 -3
- package/dist/event-catalog-5HHAS7NI.js +7 -0
- package/dist/event-catalog-SAH4ZEOO.cjs +7 -0
- package/dist/{event-catalog-runtime-XWSYNUGQ.cjs → event-catalog-runtime-2ACQMB22.cjs} +2 -2
- package/dist/{event-catalog-runtime-Z6OMHQBD.js → event-catalog-runtime-5IXAZVIB.js} +1 -1
- package/dist/{event-catalog.d-CCE1qmBN.d.cts → event-catalog.d-BQqG_LGF.d.cts} +248 -1
- package/dist/{event-catalog.d-CCE1qmBN.d.ts → event-catalog.d-BQqG_LGF.d.ts} +248 -1
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/dist/js-yaml-DLCVPJ7G.js +0 -0
- package/dist/{metering-COO4BTOC.js → metering-SHNCUA4O.js} +1 -1
- package/dist/{metering-FJI2AU7Q.cjs → metering-WAVFLJZD.cjs} +1 -1
- package/dist/{metering.d-DomHYl06.d.cts → metering.d-BP04w-gR.d.cts} +24 -15
- package/dist/{metering.d-DomHYl06.d.ts → metering.d-BP04w-gR.d.ts} +24 -15
- package/docs/event-catalog.md +439 -0
- package/docs/metering.md +4 -4
- package/package.json +12 -11
- package/dist/chunk-2Q6CNXJ2.cjs +0 -14
- package/dist/chunk-LTCN52JS.js +0 -14
- package/dist/event-catalog-S4OYTDIB.js +0 -7
- package/dist/event-catalog-Z6BO4L2G.cjs +0 -7
|
@@ -114,6 +114,52 @@ declare namespace Components {
|
|
|
114
114
|
base_event_name: string;
|
|
115
115
|
base_event_version: string;
|
|
116
116
|
}
|
|
117
|
+
/**
|
|
118
|
+
* A pending successor to a published custom event, with the version it would become.
|
|
119
|
+
*
|
|
120
|
+
*/
|
|
121
|
+
export interface CustomEventVersionDraft {
|
|
122
|
+
config: /* Event configuration with required fields */ EventConfig;
|
|
123
|
+
/**
|
|
124
|
+
* How the draft differs from the live version.
|
|
125
|
+
* - `none`: nothing changed, so there is nothing to publish.
|
|
126
|
+
* - `minor`: purely additive — new payload fields or new graph nodes. Pinned consumers keep
|
|
127
|
+
* their exact shape once the additions are stripped.
|
|
128
|
+
* - `major`: an existing field's projection changed. The schema is unchanged, so only a
|
|
129
|
+
* version bump tells a pinned consumer that familiar fields now carry different values.
|
|
130
|
+
* - `blocked`: removals, retypes or loosened requiredness. These need a transformer only a
|
|
131
|
+
* human can author, or data that no longer travels with the event.
|
|
132
|
+
*
|
|
133
|
+
*/
|
|
134
|
+
change_class: "none" | "minor" | "major" | "blocked";
|
|
135
|
+
/**
|
|
136
|
+
* The version this draft would be published as. Null when `change_class` is none or blocked.
|
|
137
|
+
* example:
|
|
138
|
+
* 1.1
|
|
139
|
+
*/
|
|
140
|
+
next_version?: string | null;
|
|
141
|
+
/**
|
|
142
|
+
* Declared field-level changes against the live version.
|
|
143
|
+
*/
|
|
144
|
+
changes: /**
|
|
145
|
+
* A field-level change descriptor. Powers the declarative half of the
|
|
146
|
+
* version DSL.
|
|
147
|
+
*
|
|
148
|
+
*/
|
|
149
|
+
FieldChange[];
|
|
150
|
+
/**
|
|
151
|
+
* Fields whose projection changed while their schema stayed identical.
|
|
152
|
+
*/
|
|
153
|
+
remapped_fields: string[];
|
|
154
|
+
/**
|
|
155
|
+
* Entity-graph nodes this draft adds, which surface as new top-level payload keys.
|
|
156
|
+
*/
|
|
157
|
+
added_nodes: string[];
|
|
158
|
+
/**
|
|
159
|
+
* Why the draft cannot be versioned automatically. Present only when `change_class` is `blocked`.
|
|
160
|
+
*/
|
|
161
|
+
blocked_reason?: string;
|
|
162
|
+
}
|
|
117
163
|
/**
|
|
118
164
|
* Custom v1 fields support graph-projected JSON Schema values and context entities; attachment semantics are built-in-only.
|
|
119
165
|
*/
|
|
@@ -1172,6 +1218,18 @@ declare namespace Components {
|
|
|
1172
1218
|
*/
|
|
1173
1219
|
base_auto_trigger_enabled?: boolean;
|
|
1174
1220
|
}
|
|
1221
|
+
export interface PublishCustomEventVersionPayload {
|
|
1222
|
+
/**
|
|
1223
|
+
* One line describing what changed, shown on the event's version timeline. Derived from the
|
|
1224
|
+
* diff when omitted.
|
|
1225
|
+
*
|
|
1226
|
+
*/
|
|
1227
|
+
change_summary?: string;
|
|
1228
|
+
/**
|
|
1229
|
+
* Optional longer-form prose (markdown) for the version timeline.
|
|
1230
|
+
*/
|
|
1231
|
+
change_notes?: string;
|
|
1232
|
+
}
|
|
1175
1233
|
export interface PurposeFilterSnapshot {
|
|
1176
1234
|
id: string;
|
|
1177
1235
|
display_name: string;
|
|
@@ -1482,6 +1540,20 @@ declare namespace Paths {
|
|
|
1482
1540
|
}
|
|
1483
1541
|
}
|
|
1484
1542
|
}
|
|
1543
|
+
namespace DeleteCustomEventVersionDraft {
|
|
1544
|
+
namespace Parameters {
|
|
1545
|
+
export type EventName = string;
|
|
1546
|
+
}
|
|
1547
|
+
export interface PathParameters {
|
|
1548
|
+
event_name: Parameters.EventName;
|
|
1549
|
+
}
|
|
1550
|
+
namespace Responses {
|
|
1551
|
+
export interface $204 {
|
|
1552
|
+
}
|
|
1553
|
+
export interface $404 {
|
|
1554
|
+
}
|
|
1555
|
+
}
|
|
1556
|
+
}
|
|
1485
1557
|
namespace DeprecateCustomEvent {
|
|
1486
1558
|
namespace Parameters {
|
|
1487
1559
|
export type EventName = string;
|
|
@@ -1498,6 +1570,23 @@ declare namespace Paths {
|
|
|
1498
1570
|
}
|
|
1499
1571
|
}
|
|
1500
1572
|
}
|
|
1573
|
+
namespace GetCustomEventVersionDraft {
|
|
1574
|
+
namespace Parameters {
|
|
1575
|
+
export type EventName = string;
|
|
1576
|
+
}
|
|
1577
|
+
export interface PathParameters {
|
|
1578
|
+
event_name: Parameters.EventName;
|
|
1579
|
+
}
|
|
1580
|
+
namespace Responses {
|
|
1581
|
+
export type $200 = /**
|
|
1582
|
+
* A pending successor to a published custom event, with the version it would become.
|
|
1583
|
+
*
|
|
1584
|
+
*/
|
|
1585
|
+
Components.Schemas.CustomEventVersionDraft;
|
|
1586
|
+
export interface $404 {
|
|
1587
|
+
}
|
|
1588
|
+
}
|
|
1589
|
+
}
|
|
1501
1590
|
namespace GetEvent {
|
|
1502
1591
|
namespace Parameters {
|
|
1503
1592
|
export type EventName = string;
|
|
@@ -1809,6 +1898,48 @@ declare namespace Paths {
|
|
|
1809
1898
|
}
|
|
1810
1899
|
}
|
|
1811
1900
|
}
|
|
1901
|
+
namespace PublishCustomEventVersion {
|
|
1902
|
+
namespace Parameters {
|
|
1903
|
+
export type EventName = string;
|
|
1904
|
+
}
|
|
1905
|
+
export interface PathParameters {
|
|
1906
|
+
event_name: Parameters.EventName;
|
|
1907
|
+
}
|
|
1908
|
+
export type RequestBody = Components.Schemas.PublishCustomEventVersionPayload;
|
|
1909
|
+
namespace Responses {
|
|
1910
|
+
export type $200 = /* Event configuration with required fields */ Components.Schemas.EventConfig;
|
|
1911
|
+
export interface $400 {
|
|
1912
|
+
}
|
|
1913
|
+
export interface $404 {
|
|
1914
|
+
}
|
|
1915
|
+
export interface $409 {
|
|
1916
|
+
}
|
|
1917
|
+
}
|
|
1918
|
+
}
|
|
1919
|
+
namespace PutCustomEventVersionDraft {
|
|
1920
|
+
namespace Parameters {
|
|
1921
|
+
export type EventName = string;
|
|
1922
|
+
}
|
|
1923
|
+
export interface PathParameters {
|
|
1924
|
+
event_name: Parameters.EventName;
|
|
1925
|
+
}
|
|
1926
|
+
export type RequestBody = /* Complete immutable custom-event v1.0 definition projected from a required entity graph. Publication is a separate conditional action. */ Components.Schemas.CreateCustomEventPayload;
|
|
1927
|
+
namespace Responses {
|
|
1928
|
+
export type $200 = /**
|
|
1929
|
+
* A pending successor to a published custom event, with the version it would become.
|
|
1930
|
+
*
|
|
1931
|
+
*/
|
|
1932
|
+
Components.Schemas.CustomEventVersionDraft;
|
|
1933
|
+
export interface $400 {
|
|
1934
|
+
}
|
|
1935
|
+
export interface $404 {
|
|
1936
|
+
}
|
|
1937
|
+
export interface $409 {
|
|
1938
|
+
}
|
|
1939
|
+
export interface $422 {
|
|
1940
|
+
}
|
|
1941
|
+
}
|
|
1942
|
+
}
|
|
1812
1943
|
namespace ReplaceCustomEventDraft {
|
|
1813
1944
|
namespace Parameters {
|
|
1814
1945
|
export type EventName = string;
|
|
@@ -2065,6 +2196,61 @@ interface OperationMethods {
|
|
|
2065
2196
|
data?: Paths.PublishCustomEventDefinition.RequestBody,
|
|
2066
2197
|
config?: AxiosRequestConfig
|
|
2067
2198
|
): OperationResponse<Paths.PublishCustomEventDefinition.Responses.$200>
|
|
2199
|
+
/**
|
|
2200
|
+
* getCustomEventVersionDraft - getCustomEventVersionDraft
|
|
2201
|
+
*
|
|
2202
|
+
* Read the in-progress successor of a published custom event, together with the version it
|
|
2203
|
+
* would be published as. The live version keeps firing while the successor is authored.
|
|
2204
|
+
*
|
|
2205
|
+
*/
|
|
2206
|
+
'getCustomEventVersionDraft'(
|
|
2207
|
+
parameters?: Parameters<Paths.GetCustomEventVersionDraft.PathParameters> | null,
|
|
2208
|
+
data?: any,
|
|
2209
|
+
config?: AxiosRequestConfig
|
|
2210
|
+
): OperationResponse<Paths.GetCustomEventVersionDraft.Responses.$200>
|
|
2211
|
+
/**
|
|
2212
|
+
* putCustomEventVersionDraft - putCustomEventVersionDraft
|
|
2213
|
+
*
|
|
2214
|
+
* Create or replace the successor of a published custom event. The published definition stays
|
|
2215
|
+
* immutable and keeps firing; only publishing the draft promotes it.
|
|
2216
|
+
*
|
|
2217
|
+
* The response classifies the change against the live version: additive changes mint a MINOR,
|
|
2218
|
+
* a changed projection mints a MAJOR (the schema is identical, so nothing else would warn a
|
|
2219
|
+
* pinned consumer that the values moved), and removals, retypes and loosened requiredness are
|
|
2220
|
+
* rejected as `blocked` because no sound downgrade can be generated for them.
|
|
2221
|
+
*
|
|
2222
|
+
*/
|
|
2223
|
+
'putCustomEventVersionDraft'(
|
|
2224
|
+
parameters?: Parameters<Paths.PutCustomEventVersionDraft.PathParameters> | null,
|
|
2225
|
+
data?: Paths.PutCustomEventVersionDraft.RequestBody,
|
|
2226
|
+
config?: AxiosRequestConfig
|
|
2227
|
+
): OperationResponse<Paths.PutCustomEventVersionDraft.Responses.$200>
|
|
2228
|
+
/**
|
|
2229
|
+
* deleteCustomEventVersionDraft - deleteCustomEventVersionDraft
|
|
2230
|
+
*
|
|
2231
|
+
* Discard the next-version draft. The published version is untouched.
|
|
2232
|
+
*/
|
|
2233
|
+
'deleteCustomEventVersionDraft'(
|
|
2234
|
+
parameters?: Parameters<Paths.DeleteCustomEventVersionDraft.PathParameters> | null,
|
|
2235
|
+
data?: any,
|
|
2236
|
+
config?: AxiosRequestConfig
|
|
2237
|
+
): OperationResponse<Paths.DeleteCustomEventVersionDraft.Responses.$204>
|
|
2238
|
+
/**
|
|
2239
|
+
* publishCustomEventVersion - publishCustomEventVersion
|
|
2240
|
+
*
|
|
2241
|
+
* Publish the next-version draft as the event's new live version.
|
|
2242
|
+
*
|
|
2243
|
+
* The version label, the declared field changes and the JSONata downgrade back to the previous
|
|
2244
|
+
* version are all derived from the diff — never supplied by the caller — so the downgrade
|
|
2245
|
+
* cannot disagree with the definition it accompanies. Consumers pinned to an earlier version
|
|
2246
|
+
* keep receiving their own shape through the stamped downgrade chain.
|
|
2247
|
+
*
|
|
2248
|
+
*/
|
|
2249
|
+
'publishCustomEventVersion'(
|
|
2250
|
+
parameters?: Parameters<Paths.PublishCustomEventVersion.PathParameters> | null,
|
|
2251
|
+
data?: Paths.PublishCustomEventVersion.RequestBody,
|
|
2252
|
+
config?: AxiosRequestConfig
|
|
2253
|
+
): OperationResponse<Paths.PublishCustomEventVersion.Responses.$200>
|
|
2068
2254
|
/**
|
|
2069
2255
|
* getEventJSONSchema - getEventJSONSchema
|
|
2070
2256
|
*
|
|
@@ -2255,6 +2441,65 @@ interface PathsDictionary {
|
|
|
2255
2441
|
config?: AxiosRequestConfig
|
|
2256
2442
|
): OperationResponse<Paths.PublishCustomEventDefinition.Responses.$200>
|
|
2257
2443
|
}
|
|
2444
|
+
['/v1/events/{event_name}/version_draft']: {
|
|
2445
|
+
/**
|
|
2446
|
+
* getCustomEventVersionDraft - getCustomEventVersionDraft
|
|
2447
|
+
*
|
|
2448
|
+
* Read the in-progress successor of a published custom event, together with the version it
|
|
2449
|
+
* would be published as. The live version keeps firing while the successor is authored.
|
|
2450
|
+
*
|
|
2451
|
+
*/
|
|
2452
|
+
'get'(
|
|
2453
|
+
parameters?: Parameters<Paths.GetCustomEventVersionDraft.PathParameters> | null,
|
|
2454
|
+
data?: any,
|
|
2455
|
+
config?: AxiosRequestConfig
|
|
2456
|
+
): OperationResponse<Paths.GetCustomEventVersionDraft.Responses.$200>
|
|
2457
|
+
/**
|
|
2458
|
+
* putCustomEventVersionDraft - putCustomEventVersionDraft
|
|
2459
|
+
*
|
|
2460
|
+
* Create or replace the successor of a published custom event. The published definition stays
|
|
2461
|
+
* immutable and keeps firing; only publishing the draft promotes it.
|
|
2462
|
+
*
|
|
2463
|
+
* The response classifies the change against the live version: additive changes mint a MINOR,
|
|
2464
|
+
* a changed projection mints a MAJOR (the schema is identical, so nothing else would warn a
|
|
2465
|
+
* pinned consumer that the values moved), and removals, retypes and loosened requiredness are
|
|
2466
|
+
* rejected as `blocked` because no sound downgrade can be generated for them.
|
|
2467
|
+
*
|
|
2468
|
+
*/
|
|
2469
|
+
'put'(
|
|
2470
|
+
parameters?: Parameters<Paths.PutCustomEventVersionDraft.PathParameters> | null,
|
|
2471
|
+
data?: Paths.PutCustomEventVersionDraft.RequestBody,
|
|
2472
|
+
config?: AxiosRequestConfig
|
|
2473
|
+
): OperationResponse<Paths.PutCustomEventVersionDraft.Responses.$200>
|
|
2474
|
+
/**
|
|
2475
|
+
* deleteCustomEventVersionDraft - deleteCustomEventVersionDraft
|
|
2476
|
+
*
|
|
2477
|
+
* Discard the next-version draft. The published version is untouched.
|
|
2478
|
+
*/
|
|
2479
|
+
'delete'(
|
|
2480
|
+
parameters?: Parameters<Paths.DeleteCustomEventVersionDraft.PathParameters> | null,
|
|
2481
|
+
data?: any,
|
|
2482
|
+
config?: AxiosRequestConfig
|
|
2483
|
+
): OperationResponse<Paths.DeleteCustomEventVersionDraft.Responses.$204>
|
|
2484
|
+
}
|
|
2485
|
+
['/v1/events/{event_name}/version_draft:publish']: {
|
|
2486
|
+
/**
|
|
2487
|
+
* publishCustomEventVersion - publishCustomEventVersion
|
|
2488
|
+
*
|
|
2489
|
+
* Publish the next-version draft as the event's new live version.
|
|
2490
|
+
*
|
|
2491
|
+
* The version label, the declared field changes and the JSONata downgrade back to the previous
|
|
2492
|
+
* version are all derived from the diff — never supplied by the caller — so the downgrade
|
|
2493
|
+
* cannot disagree with the definition it accompanies. Consumers pinned to an earlier version
|
|
2494
|
+
* keep receiving their own shape through the stamped downgrade chain.
|
|
2495
|
+
*
|
|
2496
|
+
*/
|
|
2497
|
+
'post'(
|
|
2498
|
+
parameters?: Parameters<Paths.PublishCustomEventVersion.PathParameters> | null,
|
|
2499
|
+
data?: Paths.PublishCustomEventVersion.RequestBody,
|
|
2500
|
+
config?: AxiosRequestConfig
|
|
2501
|
+
): OperationResponse<Paths.PublishCustomEventVersion.Responses.$200>
|
|
2502
|
+
}
|
|
2258
2503
|
['/v1/events/{event_name}/json_schema']: {
|
|
2259
2504
|
/**
|
|
2260
2505
|
* getEventJSONSchema - getEventJSONSchema
|
|
@@ -2375,6 +2620,7 @@ type CommonEventMetadata = Components.Schemas.CommonEventMetadata;
|
|
|
2375
2620
|
type ContextEntity = Components.Schemas.ContextEntity;
|
|
2376
2621
|
type CreateCustomEventPayload = Components.Schemas.CreateCustomEventPayload;
|
|
2377
2622
|
type CustomEventLineage = Components.Schemas.CustomEventLineage;
|
|
2623
|
+
type CustomEventVersionDraft = Components.Schemas.CustomEventVersionDraft;
|
|
2378
2624
|
type CustomSchemaField = Components.Schemas.CustomSchemaField;
|
|
2379
2625
|
type EntityOperationTrigger = Components.Schemas.EntityOperationTrigger;
|
|
2380
2626
|
type Event = Components.Schemas.Event;
|
|
@@ -2394,6 +2640,7 @@ type InlineDowngradeStep = Components.Schemas.InlineDowngradeStep;
|
|
|
2394
2640
|
type PreviewEventResponse = Components.Schemas.PreviewEventResponse;
|
|
2395
2641
|
type PrimitiveField = Components.Schemas.PrimitiveField;
|
|
2396
2642
|
type PublishCustomEventPayload = Components.Schemas.PublishCustomEventPayload;
|
|
2643
|
+
type PublishCustomEventVersionPayload = Components.Schemas.PublishCustomEventVersionPayload;
|
|
2397
2644
|
type PurposeFilterSnapshot = Components.Schemas.PurposeFilterSnapshot;
|
|
2398
2645
|
type SchemaField = Components.Schemas.SchemaField;
|
|
2399
2646
|
type SearchOptions = Components.Schemas.SearchOptions;
|
|
@@ -2405,4 +2652,4 @@ type UpdateEventPayload = Components.Schemas.UpdateEventPayload;
|
|
|
2405
2652
|
type ValidationIssue = Components.Schemas.ValidationIssue;
|
|
2406
2653
|
type VersionMeta = Components.Schemas.VersionMeta;
|
|
2407
2654
|
|
|
2408
|
-
export { type AttachmentField as A, type
|
|
2655
|
+
export { type AttachmentField as A, type SuccessCriterion as B, type Client as C, type TriggerEventResponse as D, type EntityOperationTrigger as E, type FieldChange as F, type GraphDefinition as G, type VersionMeta as H, type InlineDowngradeStep as I, type OperationMethods as O, Paths as P, type SchemaField as S, type TriggerEventPayload as T, type UpdateEventPayload as U, type ValidationIssue as V, Components as a, type PathsDictionary as b, type CommonEventMetadata as c, type ContextEntity as d, type CreateCustomEventPayload as e, type CustomEventLineage as f, type CustomEventVersionDraft as g, type CustomSchemaField as h, type Event as i, type EventAttachment as j, type EventConfig as k, type EventConfigBase as l, type EventJsonSchema as m, type EventMapping as n, type EventSummary as o, type EventVersionRegistrySummary as p, type FieldsParam as q, type GraphEdge as r, type GraphNode as s, type PreviewEventResponse as t, type PrimitiveField as u, type PublishCustomEventPayload as v, type PublishCustomEventVersionPayload as w, type PurposeFilterSnapshot as x, type SearchOptions as y, type SearchOptionsV2 as z };
|
|
@@ -114,6 +114,52 @@ declare namespace Components {
|
|
|
114
114
|
base_event_name: string;
|
|
115
115
|
base_event_version: string;
|
|
116
116
|
}
|
|
117
|
+
/**
|
|
118
|
+
* A pending successor to a published custom event, with the version it would become.
|
|
119
|
+
*
|
|
120
|
+
*/
|
|
121
|
+
export interface CustomEventVersionDraft {
|
|
122
|
+
config: /* Event configuration with required fields */ EventConfig;
|
|
123
|
+
/**
|
|
124
|
+
* How the draft differs from the live version.
|
|
125
|
+
* - `none`: nothing changed, so there is nothing to publish.
|
|
126
|
+
* - `minor`: purely additive — new payload fields or new graph nodes. Pinned consumers keep
|
|
127
|
+
* their exact shape once the additions are stripped.
|
|
128
|
+
* - `major`: an existing field's projection changed. The schema is unchanged, so only a
|
|
129
|
+
* version bump tells a pinned consumer that familiar fields now carry different values.
|
|
130
|
+
* - `blocked`: removals, retypes or loosened requiredness. These need a transformer only a
|
|
131
|
+
* human can author, or data that no longer travels with the event.
|
|
132
|
+
*
|
|
133
|
+
*/
|
|
134
|
+
change_class: "none" | "minor" | "major" | "blocked";
|
|
135
|
+
/**
|
|
136
|
+
* The version this draft would be published as. Null when `change_class` is none or blocked.
|
|
137
|
+
* example:
|
|
138
|
+
* 1.1
|
|
139
|
+
*/
|
|
140
|
+
next_version?: string | null;
|
|
141
|
+
/**
|
|
142
|
+
* Declared field-level changes against the live version.
|
|
143
|
+
*/
|
|
144
|
+
changes: /**
|
|
145
|
+
* A field-level change descriptor. Powers the declarative half of the
|
|
146
|
+
* version DSL.
|
|
147
|
+
*
|
|
148
|
+
*/
|
|
149
|
+
FieldChange[];
|
|
150
|
+
/**
|
|
151
|
+
* Fields whose projection changed while their schema stayed identical.
|
|
152
|
+
*/
|
|
153
|
+
remapped_fields: string[];
|
|
154
|
+
/**
|
|
155
|
+
* Entity-graph nodes this draft adds, which surface as new top-level payload keys.
|
|
156
|
+
*/
|
|
157
|
+
added_nodes: string[];
|
|
158
|
+
/**
|
|
159
|
+
* Why the draft cannot be versioned automatically. Present only when `change_class` is `blocked`.
|
|
160
|
+
*/
|
|
161
|
+
blocked_reason?: string;
|
|
162
|
+
}
|
|
117
163
|
/**
|
|
118
164
|
* Custom v1 fields support graph-projected JSON Schema values and context entities; attachment semantics are built-in-only.
|
|
119
165
|
*/
|
|
@@ -1172,6 +1218,18 @@ declare namespace Components {
|
|
|
1172
1218
|
*/
|
|
1173
1219
|
base_auto_trigger_enabled?: boolean;
|
|
1174
1220
|
}
|
|
1221
|
+
export interface PublishCustomEventVersionPayload {
|
|
1222
|
+
/**
|
|
1223
|
+
* One line describing what changed, shown on the event's version timeline. Derived from the
|
|
1224
|
+
* diff when omitted.
|
|
1225
|
+
*
|
|
1226
|
+
*/
|
|
1227
|
+
change_summary?: string;
|
|
1228
|
+
/**
|
|
1229
|
+
* Optional longer-form prose (markdown) for the version timeline.
|
|
1230
|
+
*/
|
|
1231
|
+
change_notes?: string;
|
|
1232
|
+
}
|
|
1175
1233
|
export interface PurposeFilterSnapshot {
|
|
1176
1234
|
id: string;
|
|
1177
1235
|
display_name: string;
|
|
@@ -1482,6 +1540,20 @@ declare namespace Paths {
|
|
|
1482
1540
|
}
|
|
1483
1541
|
}
|
|
1484
1542
|
}
|
|
1543
|
+
namespace DeleteCustomEventVersionDraft {
|
|
1544
|
+
namespace Parameters {
|
|
1545
|
+
export type EventName = string;
|
|
1546
|
+
}
|
|
1547
|
+
export interface PathParameters {
|
|
1548
|
+
event_name: Parameters.EventName;
|
|
1549
|
+
}
|
|
1550
|
+
namespace Responses {
|
|
1551
|
+
export interface $204 {
|
|
1552
|
+
}
|
|
1553
|
+
export interface $404 {
|
|
1554
|
+
}
|
|
1555
|
+
}
|
|
1556
|
+
}
|
|
1485
1557
|
namespace DeprecateCustomEvent {
|
|
1486
1558
|
namespace Parameters {
|
|
1487
1559
|
export type EventName = string;
|
|
@@ -1498,6 +1570,23 @@ declare namespace Paths {
|
|
|
1498
1570
|
}
|
|
1499
1571
|
}
|
|
1500
1572
|
}
|
|
1573
|
+
namespace GetCustomEventVersionDraft {
|
|
1574
|
+
namespace Parameters {
|
|
1575
|
+
export type EventName = string;
|
|
1576
|
+
}
|
|
1577
|
+
export interface PathParameters {
|
|
1578
|
+
event_name: Parameters.EventName;
|
|
1579
|
+
}
|
|
1580
|
+
namespace Responses {
|
|
1581
|
+
export type $200 = /**
|
|
1582
|
+
* A pending successor to a published custom event, with the version it would become.
|
|
1583
|
+
*
|
|
1584
|
+
*/
|
|
1585
|
+
Components.Schemas.CustomEventVersionDraft;
|
|
1586
|
+
export interface $404 {
|
|
1587
|
+
}
|
|
1588
|
+
}
|
|
1589
|
+
}
|
|
1501
1590
|
namespace GetEvent {
|
|
1502
1591
|
namespace Parameters {
|
|
1503
1592
|
export type EventName = string;
|
|
@@ -1809,6 +1898,48 @@ declare namespace Paths {
|
|
|
1809
1898
|
}
|
|
1810
1899
|
}
|
|
1811
1900
|
}
|
|
1901
|
+
namespace PublishCustomEventVersion {
|
|
1902
|
+
namespace Parameters {
|
|
1903
|
+
export type EventName = string;
|
|
1904
|
+
}
|
|
1905
|
+
export interface PathParameters {
|
|
1906
|
+
event_name: Parameters.EventName;
|
|
1907
|
+
}
|
|
1908
|
+
export type RequestBody = Components.Schemas.PublishCustomEventVersionPayload;
|
|
1909
|
+
namespace Responses {
|
|
1910
|
+
export type $200 = /* Event configuration with required fields */ Components.Schemas.EventConfig;
|
|
1911
|
+
export interface $400 {
|
|
1912
|
+
}
|
|
1913
|
+
export interface $404 {
|
|
1914
|
+
}
|
|
1915
|
+
export interface $409 {
|
|
1916
|
+
}
|
|
1917
|
+
}
|
|
1918
|
+
}
|
|
1919
|
+
namespace PutCustomEventVersionDraft {
|
|
1920
|
+
namespace Parameters {
|
|
1921
|
+
export type EventName = string;
|
|
1922
|
+
}
|
|
1923
|
+
export interface PathParameters {
|
|
1924
|
+
event_name: Parameters.EventName;
|
|
1925
|
+
}
|
|
1926
|
+
export type RequestBody = /* Complete immutable custom-event v1.0 definition projected from a required entity graph. Publication is a separate conditional action. */ Components.Schemas.CreateCustomEventPayload;
|
|
1927
|
+
namespace Responses {
|
|
1928
|
+
export type $200 = /**
|
|
1929
|
+
* A pending successor to a published custom event, with the version it would become.
|
|
1930
|
+
*
|
|
1931
|
+
*/
|
|
1932
|
+
Components.Schemas.CustomEventVersionDraft;
|
|
1933
|
+
export interface $400 {
|
|
1934
|
+
}
|
|
1935
|
+
export interface $404 {
|
|
1936
|
+
}
|
|
1937
|
+
export interface $409 {
|
|
1938
|
+
}
|
|
1939
|
+
export interface $422 {
|
|
1940
|
+
}
|
|
1941
|
+
}
|
|
1942
|
+
}
|
|
1812
1943
|
namespace ReplaceCustomEventDraft {
|
|
1813
1944
|
namespace Parameters {
|
|
1814
1945
|
export type EventName = string;
|
|
@@ -2065,6 +2196,61 @@ interface OperationMethods {
|
|
|
2065
2196
|
data?: Paths.PublishCustomEventDefinition.RequestBody,
|
|
2066
2197
|
config?: AxiosRequestConfig
|
|
2067
2198
|
): OperationResponse<Paths.PublishCustomEventDefinition.Responses.$200>
|
|
2199
|
+
/**
|
|
2200
|
+
* getCustomEventVersionDraft - getCustomEventVersionDraft
|
|
2201
|
+
*
|
|
2202
|
+
* Read the in-progress successor of a published custom event, together with the version it
|
|
2203
|
+
* would be published as. The live version keeps firing while the successor is authored.
|
|
2204
|
+
*
|
|
2205
|
+
*/
|
|
2206
|
+
'getCustomEventVersionDraft'(
|
|
2207
|
+
parameters?: Parameters<Paths.GetCustomEventVersionDraft.PathParameters> | null,
|
|
2208
|
+
data?: any,
|
|
2209
|
+
config?: AxiosRequestConfig
|
|
2210
|
+
): OperationResponse<Paths.GetCustomEventVersionDraft.Responses.$200>
|
|
2211
|
+
/**
|
|
2212
|
+
* putCustomEventVersionDraft - putCustomEventVersionDraft
|
|
2213
|
+
*
|
|
2214
|
+
* Create or replace the successor of a published custom event. The published definition stays
|
|
2215
|
+
* immutable and keeps firing; only publishing the draft promotes it.
|
|
2216
|
+
*
|
|
2217
|
+
* The response classifies the change against the live version: additive changes mint a MINOR,
|
|
2218
|
+
* a changed projection mints a MAJOR (the schema is identical, so nothing else would warn a
|
|
2219
|
+
* pinned consumer that the values moved), and removals, retypes and loosened requiredness are
|
|
2220
|
+
* rejected as `blocked` because no sound downgrade can be generated for them.
|
|
2221
|
+
*
|
|
2222
|
+
*/
|
|
2223
|
+
'putCustomEventVersionDraft'(
|
|
2224
|
+
parameters?: Parameters<Paths.PutCustomEventVersionDraft.PathParameters> | null,
|
|
2225
|
+
data?: Paths.PutCustomEventVersionDraft.RequestBody,
|
|
2226
|
+
config?: AxiosRequestConfig
|
|
2227
|
+
): OperationResponse<Paths.PutCustomEventVersionDraft.Responses.$200>
|
|
2228
|
+
/**
|
|
2229
|
+
* deleteCustomEventVersionDraft - deleteCustomEventVersionDraft
|
|
2230
|
+
*
|
|
2231
|
+
* Discard the next-version draft. The published version is untouched.
|
|
2232
|
+
*/
|
|
2233
|
+
'deleteCustomEventVersionDraft'(
|
|
2234
|
+
parameters?: Parameters<Paths.DeleteCustomEventVersionDraft.PathParameters> | null,
|
|
2235
|
+
data?: any,
|
|
2236
|
+
config?: AxiosRequestConfig
|
|
2237
|
+
): OperationResponse<Paths.DeleteCustomEventVersionDraft.Responses.$204>
|
|
2238
|
+
/**
|
|
2239
|
+
* publishCustomEventVersion - publishCustomEventVersion
|
|
2240
|
+
*
|
|
2241
|
+
* Publish the next-version draft as the event's new live version.
|
|
2242
|
+
*
|
|
2243
|
+
* The version label, the declared field changes and the JSONata downgrade back to the previous
|
|
2244
|
+
* version are all derived from the diff — never supplied by the caller — so the downgrade
|
|
2245
|
+
* cannot disagree with the definition it accompanies. Consumers pinned to an earlier version
|
|
2246
|
+
* keep receiving their own shape through the stamped downgrade chain.
|
|
2247
|
+
*
|
|
2248
|
+
*/
|
|
2249
|
+
'publishCustomEventVersion'(
|
|
2250
|
+
parameters?: Parameters<Paths.PublishCustomEventVersion.PathParameters> | null,
|
|
2251
|
+
data?: Paths.PublishCustomEventVersion.RequestBody,
|
|
2252
|
+
config?: AxiosRequestConfig
|
|
2253
|
+
): OperationResponse<Paths.PublishCustomEventVersion.Responses.$200>
|
|
2068
2254
|
/**
|
|
2069
2255
|
* getEventJSONSchema - getEventJSONSchema
|
|
2070
2256
|
*
|
|
@@ -2255,6 +2441,65 @@ interface PathsDictionary {
|
|
|
2255
2441
|
config?: AxiosRequestConfig
|
|
2256
2442
|
): OperationResponse<Paths.PublishCustomEventDefinition.Responses.$200>
|
|
2257
2443
|
}
|
|
2444
|
+
['/v1/events/{event_name}/version_draft']: {
|
|
2445
|
+
/**
|
|
2446
|
+
* getCustomEventVersionDraft - getCustomEventVersionDraft
|
|
2447
|
+
*
|
|
2448
|
+
* Read the in-progress successor of a published custom event, together with the version it
|
|
2449
|
+
* would be published as. The live version keeps firing while the successor is authored.
|
|
2450
|
+
*
|
|
2451
|
+
*/
|
|
2452
|
+
'get'(
|
|
2453
|
+
parameters?: Parameters<Paths.GetCustomEventVersionDraft.PathParameters> | null,
|
|
2454
|
+
data?: any,
|
|
2455
|
+
config?: AxiosRequestConfig
|
|
2456
|
+
): OperationResponse<Paths.GetCustomEventVersionDraft.Responses.$200>
|
|
2457
|
+
/**
|
|
2458
|
+
* putCustomEventVersionDraft - putCustomEventVersionDraft
|
|
2459
|
+
*
|
|
2460
|
+
* Create or replace the successor of a published custom event. The published definition stays
|
|
2461
|
+
* immutable and keeps firing; only publishing the draft promotes it.
|
|
2462
|
+
*
|
|
2463
|
+
* The response classifies the change against the live version: additive changes mint a MINOR,
|
|
2464
|
+
* a changed projection mints a MAJOR (the schema is identical, so nothing else would warn a
|
|
2465
|
+
* pinned consumer that the values moved), and removals, retypes and loosened requiredness are
|
|
2466
|
+
* rejected as `blocked` because no sound downgrade can be generated for them.
|
|
2467
|
+
*
|
|
2468
|
+
*/
|
|
2469
|
+
'put'(
|
|
2470
|
+
parameters?: Parameters<Paths.PutCustomEventVersionDraft.PathParameters> | null,
|
|
2471
|
+
data?: Paths.PutCustomEventVersionDraft.RequestBody,
|
|
2472
|
+
config?: AxiosRequestConfig
|
|
2473
|
+
): OperationResponse<Paths.PutCustomEventVersionDraft.Responses.$200>
|
|
2474
|
+
/**
|
|
2475
|
+
* deleteCustomEventVersionDraft - deleteCustomEventVersionDraft
|
|
2476
|
+
*
|
|
2477
|
+
* Discard the next-version draft. The published version is untouched.
|
|
2478
|
+
*/
|
|
2479
|
+
'delete'(
|
|
2480
|
+
parameters?: Parameters<Paths.DeleteCustomEventVersionDraft.PathParameters> | null,
|
|
2481
|
+
data?: any,
|
|
2482
|
+
config?: AxiosRequestConfig
|
|
2483
|
+
): OperationResponse<Paths.DeleteCustomEventVersionDraft.Responses.$204>
|
|
2484
|
+
}
|
|
2485
|
+
['/v1/events/{event_name}/version_draft:publish']: {
|
|
2486
|
+
/**
|
|
2487
|
+
* publishCustomEventVersion - publishCustomEventVersion
|
|
2488
|
+
*
|
|
2489
|
+
* Publish the next-version draft as the event's new live version.
|
|
2490
|
+
*
|
|
2491
|
+
* The version label, the declared field changes and the JSONata downgrade back to the previous
|
|
2492
|
+
* version are all derived from the diff — never supplied by the caller — so the downgrade
|
|
2493
|
+
* cannot disagree with the definition it accompanies. Consumers pinned to an earlier version
|
|
2494
|
+
* keep receiving their own shape through the stamped downgrade chain.
|
|
2495
|
+
*
|
|
2496
|
+
*/
|
|
2497
|
+
'post'(
|
|
2498
|
+
parameters?: Parameters<Paths.PublishCustomEventVersion.PathParameters> | null,
|
|
2499
|
+
data?: Paths.PublishCustomEventVersion.RequestBody,
|
|
2500
|
+
config?: AxiosRequestConfig
|
|
2501
|
+
): OperationResponse<Paths.PublishCustomEventVersion.Responses.$200>
|
|
2502
|
+
}
|
|
2258
2503
|
['/v1/events/{event_name}/json_schema']: {
|
|
2259
2504
|
/**
|
|
2260
2505
|
* getEventJSONSchema - getEventJSONSchema
|
|
@@ -2375,6 +2620,7 @@ type CommonEventMetadata = Components.Schemas.CommonEventMetadata;
|
|
|
2375
2620
|
type ContextEntity = Components.Schemas.ContextEntity;
|
|
2376
2621
|
type CreateCustomEventPayload = Components.Schemas.CreateCustomEventPayload;
|
|
2377
2622
|
type CustomEventLineage = Components.Schemas.CustomEventLineage;
|
|
2623
|
+
type CustomEventVersionDraft = Components.Schemas.CustomEventVersionDraft;
|
|
2378
2624
|
type CustomSchemaField = Components.Schemas.CustomSchemaField;
|
|
2379
2625
|
type EntityOperationTrigger = Components.Schemas.EntityOperationTrigger;
|
|
2380
2626
|
type Event = Components.Schemas.Event;
|
|
@@ -2394,6 +2640,7 @@ type InlineDowngradeStep = Components.Schemas.InlineDowngradeStep;
|
|
|
2394
2640
|
type PreviewEventResponse = Components.Schemas.PreviewEventResponse;
|
|
2395
2641
|
type PrimitiveField = Components.Schemas.PrimitiveField;
|
|
2396
2642
|
type PublishCustomEventPayload = Components.Schemas.PublishCustomEventPayload;
|
|
2643
|
+
type PublishCustomEventVersionPayload = Components.Schemas.PublishCustomEventVersionPayload;
|
|
2397
2644
|
type PurposeFilterSnapshot = Components.Schemas.PurposeFilterSnapshot;
|
|
2398
2645
|
type SchemaField = Components.Schemas.SchemaField;
|
|
2399
2646
|
type SearchOptions = Components.Schemas.SearchOptions;
|
|
@@ -2405,4 +2652,4 @@ type UpdateEventPayload = Components.Schemas.UpdateEventPayload;
|
|
|
2405
2652
|
type ValidationIssue = Components.Schemas.ValidationIssue;
|
|
2406
2653
|
type VersionMeta = Components.Schemas.VersionMeta;
|
|
2407
2654
|
|
|
2408
|
-
export { type AttachmentField as A, type
|
|
2655
|
+
export { type AttachmentField as A, type SuccessCriterion as B, type Client as C, type TriggerEventResponse as D, type EntityOperationTrigger as E, type FieldChange as F, type GraphDefinition as G, type VersionMeta as H, type InlineDowngradeStep as I, type OperationMethods as O, Paths as P, type SchemaField as S, type TriggerEventPayload as T, type UpdateEventPayload as U, type ValidationIssue as V, Components as a, type PathsDictionary as b, type CommonEventMetadata as c, type ContextEntity as d, type CreateCustomEventPayload as e, type CustomEventLineage as f, type CustomEventVersionDraft as g, type CustomSchemaField as h, type Event as i, type EventAttachment as j, type EventConfig as k, type EventConfigBase as l, type EventJsonSchema as m, type EventMapping as n, type EventSummary as o, type EventVersionRegistrySummary as p, type FieldsParam as q, type GraphEdge as r, type GraphNode as s, type PreviewEventResponse as t, type PrimitiveField as u, type PublishCustomEventPayload as v, type PublishCustomEventVersionPayload as w, type PurposeFilterSnapshot as x, type SearchOptions as y, type SearchOptionsV2 as z };
|