@epilot/sdk 2.20.18 → 2.20.20
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/automation-runtime.json +1 -1
- package/definitions/automation.json +64 -179
- package/definitions/journey-runtime.json +1 -1
- package/definitions/journey.json +29 -4
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +8 -8
- package/dist/apis/automation.d.cts +2 -2
- package/dist/apis/automation.d.ts +2 -2
- package/dist/apis/automation.js +2 -2
- 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/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.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +8 -8
- package/dist/apis/journey.d.cts +2 -2
- package/dist/apis/journey.d.ts +2 -2
- package/dist/apis/journey.js +2 -2
- 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/automation-FTFGFHT7.cjs +7 -0
- package/dist/automation-HJGT6QK5.js +7 -0
- package/dist/{automation-runtime-Y52HM57N.js → automation-runtime-ORW5BVCD.js} +1 -1
- package/dist/{automation-runtime-KLCXZKEC.cjs → automation-runtime-RM5EOZH2.cjs} +2 -2
- package/dist/{automation.d-D8JxyoFa.d.cts → automation.d-Bp45eKlU.d.cts} +111 -178
- package/dist/{automation.d-D8JxyoFa.d.ts → automation.d-Bp45eKlU.d.ts} +111 -178
- package/dist/{chunk-5SYOSYED.cjs → chunk-23SGQN24.cjs} +4 -4
- package/dist/chunk-ADSWGLIV.cjs +14 -0
- package/dist/chunk-LCE7N4ZL.js +14 -0
- package/dist/{chunk-XV6GVGUN.js → chunk-N4SIVR5Y.js} +4 -4
- package/dist/chunk-SJS5S6Z5.js +14 -0
- package/dist/chunk-X7UJYAG5.cjs +14 -0
- package/dist/index.cjs +12 -12
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +3 -3
- package/dist/journey-LIJDXSEC.js +7 -0
- package/dist/journey-LNA7JFP3.cjs +7 -0
- package/dist/{journey-runtime-EFWGEDUE.cjs → journey-runtime-BVSPJTYH.cjs} +2 -2
- package/dist/{journey-runtime-VCADGDRV.js → journey-runtime-S5I3K4NH.js} +1 -1
- package/dist/{journey.d-6Bs1uNLT.d.ts → journey.d-DvwLALwc.d.cts} +36 -2
- package/dist/{journey.d-6Bs1uNLT.d.cts → journey.d-DvwLALwc.d.ts} +36 -2
- package/docs/automation.md +93 -87
- package/docs/journey.md +17 -2
- package/package.json +1 -1
- package/dist/automation-23XNDPBF.cjs +0 -7
- package/dist/automation-OMESM3H3.js +0 -7
- package/dist/chunk-HL4MZXEK.js +0 -14
- package/dist/chunk-QW3ROE6H.js +0 -14
- package/dist/chunk-W6R2J6KQ.cjs +0 -14
- package/dist/chunk-WOUASZJW.cjs +0 -14
- package/dist/journey-FNWHSZW3.js +0 -7
- package/dist/journey-FUJDOH5O.cjs +0 -7
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
"use strict";Object.defineProperty(exports, "__esModule", {value: true});
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var _chunkX7UJYAG5cjs = require('./chunk-X7UJYAG5.cjs');
|
|
4
4
|
require('./chunk-NJK5F5TF.cjs');
|
|
5
|
-
exports. default =
|
|
5
|
+
exports. default = _chunkX7UJYAG5cjs.require_journey_runtime.call(void 0, );
|
|
@@ -1682,6 +1682,13 @@ declare namespace Components {
|
|
|
1682
1682
|
* 12
|
|
1683
1683
|
*/
|
|
1684
1684
|
mapping_config_version?: number;
|
|
1685
|
+
/**
|
|
1686
|
+
* What this save changed, for the revision history to list. Distinct from `name`, which is the journey's own name. A publish replaces it with the version name.
|
|
1687
|
+
*
|
|
1688
|
+
* example:
|
|
1689
|
+
* Changes to Steps and Logic
|
|
1690
|
+
*/
|
|
1691
|
+
revision_name?: string;
|
|
1685
1692
|
}
|
|
1686
1693
|
export interface JourneyRevisionSummary {
|
|
1687
1694
|
/**
|
|
@@ -1720,6 +1727,17 @@ declare namespace Components {
|
|
|
1720
1727
|
*/
|
|
1721
1728
|
mapping_config_version?: number;
|
|
1722
1729
|
}
|
|
1730
|
+
/**
|
|
1731
|
+
* Which revision the runtime read served: the requested one, or the published version when no revision was requested. Absent while the journey has not adopted versioning and on legacy `version` reads.
|
|
1732
|
+
*
|
|
1733
|
+
*/
|
|
1734
|
+
export interface JourneyServedRevision {
|
|
1735
|
+
/**
|
|
1736
|
+
* example:
|
|
1737
|
+
* 42
|
|
1738
|
+
*/
|
|
1739
|
+
revision_id?: string;
|
|
1740
|
+
}
|
|
1723
1741
|
export interface JourneyValidationError {
|
|
1724
1742
|
/**
|
|
1725
1743
|
* Error type identifier
|
|
@@ -2243,6 +2261,11 @@ declare namespace Paths {
|
|
|
2243
2261
|
*/
|
|
2244
2262
|
export type Id = string; // uuid
|
|
2245
2263
|
export type OrgId = string;
|
|
2264
|
+
/**
|
|
2265
|
+
* example:
|
|
2266
|
+
* 42
|
|
2267
|
+
*/
|
|
2268
|
+
export type RevisionId = string;
|
|
2246
2269
|
export type Source = string;
|
|
2247
2270
|
export type Version = number;
|
|
2248
2271
|
}
|
|
@@ -2255,12 +2278,17 @@ declare namespace Paths {
|
|
|
2255
2278
|
}
|
|
2256
2279
|
export interface QueryParameters {
|
|
2257
2280
|
version?: Parameters.Version;
|
|
2281
|
+
revision_id?: /**
|
|
2282
|
+
* example:
|
|
2283
|
+
* 42
|
|
2284
|
+
*/
|
|
2285
|
+
Parameters.RevisionId;
|
|
2258
2286
|
source?: Parameters.Source;
|
|
2259
2287
|
orgId?: Parameters.OrgId;
|
|
2260
2288
|
}
|
|
2261
2289
|
namespace Responses {
|
|
2262
2290
|
/**
|
|
2263
|
-
*
|
|
2291
|
+
* Which revision the runtime read served: the requested one, or the published version when no revision was requested. Absent while the journey has not adopted versioning and on legacy `version` reads.
|
|
2264
2292
|
*
|
|
2265
2293
|
*/
|
|
2266
2294
|
export interface $200 {
|
|
@@ -2552,6 +2580,11 @@ declare namespace Paths {
|
|
|
2552
2580
|
featureFlags?: {
|
|
2553
2581
|
[name: string]: any;
|
|
2554
2582
|
};
|
|
2583
|
+
/**
|
|
2584
|
+
* example:
|
|
2585
|
+
* 42
|
|
2586
|
+
*/
|
|
2587
|
+
revision_id?: string;
|
|
2555
2588
|
}
|
|
2556
2589
|
}
|
|
2557
2590
|
}
|
|
@@ -3766,6 +3799,7 @@ type JourneyRevisionConflict = Components.Schemas.JourneyRevisionConflict;
|
|
|
3766
3799
|
type JourneyRevisionList = Components.Schemas.JourneyRevisionList;
|
|
3767
3800
|
type JourneyRevisionRequest = Components.Schemas.JourneyRevisionRequest;
|
|
3768
3801
|
type JourneyRevisionSummary = Components.Schemas.JourneyRevisionSummary;
|
|
3802
|
+
type JourneyServedRevision = Components.Schemas.JourneyServedRevision;
|
|
3769
3803
|
type JourneyValidationError = Components.Schemas.JourneyValidationError;
|
|
3770
3804
|
type JourneyValidationResponse = Components.Schemas.JourneyValidationResponse;
|
|
3771
3805
|
type PatchUpdateJourneyRequest = Components.Schemas.PatchUpdateJourneyRequest;
|
|
@@ -3778,4 +3812,4 @@ type SearchJourneysResponse = Components.Schemas.SearchJourneysResponse;
|
|
|
3778
3812
|
type TemplateSettings = Components.Schemas.TemplateSettings;
|
|
3779
3813
|
type ValidationRuleRef = Components.Schemas.ValidationRuleRef;
|
|
3780
3814
|
|
|
3781
|
-
export { type
|
|
3815
|
+
export { type PublishRevisionRequest as A, type ButtonOption as B, type Client as C, type SearchJourneysQueryRequest as D, type EnvironmentMap as E, type SearchJourneysResponse as F, type GenerateDocumentRequest as G, type Journey as J, type OperationMethods as O, Paths as P, type RuleRef as R, type S3Reference as S, type TemplateSettings as T, type ValidationRuleRef as V, Components as a, type PathsDictionary as b, type EnvironmentMapEntry as c, type GenerateDocumentResponse as d, type GetJourneysResponse as e, GetSettingsForJourney as f, type JourneyActivationGuarantee as g, type JourneyAuditInfo as h, type JourneyCreationRequest as i, type JourneyCreationRequestV2 as j, type JourneyEnvironmentResponse as k, type JourneyEnvironmentVariablesResponse as l, type JourneyFeatureFlags as m, type JourneyProductsResponse as n, type JourneyPublishState as o, type JourneyResponse as p, type JourneyRevision as q, type JourneyRevisionConflict as r, type JourneyRevisionList as s, type JourneyRevisionRequest as t, type JourneyRevisionSummary as u, type JourneyServedRevision as v, type JourneyValidationError as w, type JourneyValidationResponse as x, type PatchUpdateJourneyRequest as y, type PublishResult as z };
|
|
@@ -1682,6 +1682,13 @@ declare namespace Components {
|
|
|
1682
1682
|
* 12
|
|
1683
1683
|
*/
|
|
1684
1684
|
mapping_config_version?: number;
|
|
1685
|
+
/**
|
|
1686
|
+
* What this save changed, for the revision history to list. Distinct from `name`, which is the journey's own name. A publish replaces it with the version name.
|
|
1687
|
+
*
|
|
1688
|
+
* example:
|
|
1689
|
+
* Changes to Steps and Logic
|
|
1690
|
+
*/
|
|
1691
|
+
revision_name?: string;
|
|
1685
1692
|
}
|
|
1686
1693
|
export interface JourneyRevisionSummary {
|
|
1687
1694
|
/**
|
|
@@ -1720,6 +1727,17 @@ declare namespace Components {
|
|
|
1720
1727
|
*/
|
|
1721
1728
|
mapping_config_version?: number;
|
|
1722
1729
|
}
|
|
1730
|
+
/**
|
|
1731
|
+
* Which revision the runtime read served: the requested one, or the published version when no revision was requested. Absent while the journey has not adopted versioning and on legacy `version` reads.
|
|
1732
|
+
*
|
|
1733
|
+
*/
|
|
1734
|
+
export interface JourneyServedRevision {
|
|
1735
|
+
/**
|
|
1736
|
+
* example:
|
|
1737
|
+
* 42
|
|
1738
|
+
*/
|
|
1739
|
+
revision_id?: string;
|
|
1740
|
+
}
|
|
1723
1741
|
export interface JourneyValidationError {
|
|
1724
1742
|
/**
|
|
1725
1743
|
* Error type identifier
|
|
@@ -2243,6 +2261,11 @@ declare namespace Paths {
|
|
|
2243
2261
|
*/
|
|
2244
2262
|
export type Id = string; // uuid
|
|
2245
2263
|
export type OrgId = string;
|
|
2264
|
+
/**
|
|
2265
|
+
* example:
|
|
2266
|
+
* 42
|
|
2267
|
+
*/
|
|
2268
|
+
export type RevisionId = string;
|
|
2246
2269
|
export type Source = string;
|
|
2247
2270
|
export type Version = number;
|
|
2248
2271
|
}
|
|
@@ -2255,12 +2278,17 @@ declare namespace Paths {
|
|
|
2255
2278
|
}
|
|
2256
2279
|
export interface QueryParameters {
|
|
2257
2280
|
version?: Parameters.Version;
|
|
2281
|
+
revision_id?: /**
|
|
2282
|
+
* example:
|
|
2283
|
+
* 42
|
|
2284
|
+
*/
|
|
2285
|
+
Parameters.RevisionId;
|
|
2258
2286
|
source?: Parameters.Source;
|
|
2259
2287
|
orgId?: Parameters.OrgId;
|
|
2260
2288
|
}
|
|
2261
2289
|
namespace Responses {
|
|
2262
2290
|
/**
|
|
2263
|
-
*
|
|
2291
|
+
* Which revision the runtime read served: the requested one, or the published version when no revision was requested. Absent while the journey has not adopted versioning and on legacy `version` reads.
|
|
2264
2292
|
*
|
|
2265
2293
|
*/
|
|
2266
2294
|
export interface $200 {
|
|
@@ -2552,6 +2580,11 @@ declare namespace Paths {
|
|
|
2552
2580
|
featureFlags?: {
|
|
2553
2581
|
[name: string]: any;
|
|
2554
2582
|
};
|
|
2583
|
+
/**
|
|
2584
|
+
* example:
|
|
2585
|
+
* 42
|
|
2586
|
+
*/
|
|
2587
|
+
revision_id?: string;
|
|
2555
2588
|
}
|
|
2556
2589
|
}
|
|
2557
2590
|
}
|
|
@@ -3766,6 +3799,7 @@ type JourneyRevisionConflict = Components.Schemas.JourneyRevisionConflict;
|
|
|
3766
3799
|
type JourneyRevisionList = Components.Schemas.JourneyRevisionList;
|
|
3767
3800
|
type JourneyRevisionRequest = Components.Schemas.JourneyRevisionRequest;
|
|
3768
3801
|
type JourneyRevisionSummary = Components.Schemas.JourneyRevisionSummary;
|
|
3802
|
+
type JourneyServedRevision = Components.Schemas.JourneyServedRevision;
|
|
3769
3803
|
type JourneyValidationError = Components.Schemas.JourneyValidationError;
|
|
3770
3804
|
type JourneyValidationResponse = Components.Schemas.JourneyValidationResponse;
|
|
3771
3805
|
type PatchUpdateJourneyRequest = Components.Schemas.PatchUpdateJourneyRequest;
|
|
@@ -3778,4 +3812,4 @@ type SearchJourneysResponse = Components.Schemas.SearchJourneysResponse;
|
|
|
3778
3812
|
type TemplateSettings = Components.Schemas.TemplateSettings;
|
|
3779
3813
|
type ValidationRuleRef = Components.Schemas.ValidationRuleRef;
|
|
3780
3814
|
|
|
3781
|
-
export { type
|
|
3815
|
+
export { type PublishRevisionRequest as A, type ButtonOption as B, type Client as C, type SearchJourneysQueryRequest as D, type EnvironmentMap as E, type SearchJourneysResponse as F, type GenerateDocumentRequest as G, type Journey as J, type OperationMethods as O, Paths as P, type RuleRef as R, type S3Reference as S, type TemplateSettings as T, type ValidationRuleRef as V, Components as a, type PathsDictionary as b, type EnvironmentMapEntry as c, type GenerateDocumentResponse as d, type GetJourneysResponse as e, GetSettingsForJourney as f, type JourneyActivationGuarantee as g, type JourneyAuditInfo as h, type JourneyCreationRequest as i, type JourneyCreationRequestV2 as j, type JourneyEnvironmentResponse as k, type JourneyEnvironmentVariablesResponse as l, type JourneyFeatureFlags as m, type JourneyProductsResponse as n, type JourneyPublishState as o, type JourneyResponse as p, type JourneyRevision as q, type JourneyRevisionConflict as r, type JourneyRevisionList as s, type JourneyRevisionRequest as t, type JourneyRevisionSummary as u, type JourneyServedRevision as v, type JourneyValidationError as w, type JourneyValidationResponse as x, type PatchUpdateJourneyRequest as y, type PublishResult as z };
|
package/docs/automation.md
CHANGED
|
@@ -146,8 +146,6 @@ const { data } = await automationClient.searchFlows(...)
|
|
|
146
146
|
- [`TriggerEventEntityActivity`](#triggerevententityactivity)
|
|
147
147
|
- [`TriggerEventMessaging`](#triggereventmessaging)
|
|
148
148
|
- [`TriggerEventEntityOperation`](#triggerevententityoperation)
|
|
149
|
-
- [`TriggerEventEventCatalog`](#triggereventeventcatalog)
|
|
150
|
-
- [`TriggerEventPayloadRef`](#triggereventpayloadref)
|
|
151
149
|
- [`ApiCallerContext`](#apicallercontext)
|
|
152
150
|
- [`ExecutionStatus`](#executionstatus)
|
|
153
151
|
- [`GetExecutionsResp`](#getexecutionsresp)
|
|
@@ -177,7 +175,6 @@ const { data } = await automationClient.searchFlows(...)
|
|
|
177
175
|
- [`EntitySearchFilter`](#entitysearchfilter)
|
|
178
176
|
- [`EntitySearchFilterValue`](#entitysearchfiltervalue)
|
|
179
177
|
- [`EntityManualTrigger`](#entitymanualtrigger)
|
|
180
|
-
- [`EventCatalogTrigger`](#eventcatalogtrigger)
|
|
181
178
|
- [`TriggerCondition`](#triggercondition)
|
|
182
179
|
- [`Comparison`](#comparison)
|
|
183
180
|
- [`FilterConditionOnEvent`](#filterconditiononevent)
|
|
@@ -213,7 +210,6 @@ const { data } = await client.searchFlows({
|
|
|
213
210
|
from: 1,
|
|
214
211
|
trigger_source_id: 'example',
|
|
215
212
|
target_workflow: 'example',
|
|
216
|
-
trigger_event_name: 'example',
|
|
217
213
|
include_flows: true,
|
|
218
214
|
})
|
|
219
215
|
```
|
|
@@ -1320,16 +1316,6 @@ type AutomationFlow = {
|
|
|
1320
1316
|
configuration?: {
|
|
1321
1317
|
journey_id?: { ... }
|
|
1322
1318
|
}
|
|
1323
|
-
} | {
|
|
1324
|
-
id?: string // uuid
|
|
1325
|
-
type: "event_catalog"
|
|
1326
|
-
configuration: {
|
|
1327
|
-
event_name: { ... }
|
|
1328
|
-
event_version: { ... }
|
|
1329
|
-
entity_node_id: { ... }
|
|
1330
|
-
entity_schema: { ... }
|
|
1331
|
-
ignore_automation_triggered?: { ... }
|
|
1332
|
-
}
|
|
1333
1319
|
}>
|
|
1334
1320
|
trigger_conditions?: Array<{
|
|
1335
1321
|
source: string
|
|
@@ -1350,6 +1336,16 @@ type AutomationFlow = {
|
|
|
1350
1336
|
allow_failure?: boolean
|
|
1351
1337
|
statements?: Array<{
|
|
1352
1338
|
id?: { ... }
|
|
1339
|
+
source?: { ... }
|
|
1340
|
+
operation?: { ... }
|
|
1341
|
+
values?: { ... }
|
|
1342
|
+
}>
|
|
1343
|
+
}>
|
|
1344
|
+
schedules?: Array<{
|
|
1345
|
+
id: string
|
|
1346
|
+
scheduleApiId?: string
|
|
1347
|
+
numberOfUnits?: number
|
|
1348
|
+
timePeriod?: "minutes" | "hours" | "days" | "weeks" | "months"
|
|
1353
1349
|
// ...
|
|
1354
1350
|
}
|
|
1355
1351
|
```
|
|
@@ -1412,10 +1408,6 @@ type SearchAutomationsResp = {
|
|
|
1412
1408
|
id?: { ... }
|
|
1413
1409
|
type: { ... }
|
|
1414
1410
|
configuration?: { ... }
|
|
1415
|
-
} | {
|
|
1416
|
-
id?: { ... }
|
|
1417
|
-
type: { ... }
|
|
1418
|
-
configuration: { ... }
|
|
1419
1411
|
}>
|
|
1420
1412
|
trigger_conditions?: Array<{
|
|
1421
1413
|
source: { ... }
|
|
@@ -1465,6 +1457,10 @@ type SearchAutomationsResp = {
|
|
|
1465
1457
|
type?: { ... }
|
|
1466
1458
|
config?: { ... }
|
|
1467
1459
|
} | {
|
|
1460
|
+
type?: { ... }
|
|
1461
|
+
config?: { ... }
|
|
1462
|
+
} | {
|
|
1463
|
+
type?: { ... }
|
|
1468
1464
|
// ...
|
|
1469
1465
|
}
|
|
1470
1466
|
```
|
|
@@ -1540,16 +1536,6 @@ type AnyTrigger = {
|
|
|
1540
1536
|
configuration?: {
|
|
1541
1537
|
journey_id?: string // uuid
|
|
1542
1538
|
}
|
|
1543
|
-
} | {
|
|
1544
|
-
id?: string // uuid
|
|
1545
|
-
type: "event_catalog"
|
|
1546
|
-
configuration: {
|
|
1547
|
-
event_name: string
|
|
1548
|
-
event_version: string
|
|
1549
|
-
entity_node_id: string
|
|
1550
|
-
entity_schema: string
|
|
1551
|
-
ignore_automation_triggered?: boolean
|
|
1552
|
-
}
|
|
1553
1539
|
}
|
|
1554
1540
|
```
|
|
1555
1541
|
|
|
@@ -2295,6 +2281,7 @@ type GraphContextEntry = {
|
|
|
2295
2281
|
cardinality?: { ... }
|
|
2296
2282
|
fields?: { ... }
|
|
2297
2283
|
filter?: { ... }
|
|
2284
|
+
optional?: { ... }
|
|
2298
2285
|
}>
|
|
2299
2286
|
edges: Array<{
|
|
2300
2287
|
from: { ... }
|
|
@@ -2326,6 +2313,7 @@ type GraphDefinition = {
|
|
|
2326
2313
|
attribute: { ... }
|
|
2327
2314
|
value: { ... }
|
|
2328
2315
|
}>
|
|
2316
|
+
optional?: boolean
|
|
2329
2317
|
}>
|
|
2330
2318
|
edges: Array<{
|
|
2331
2319
|
from: string
|
|
@@ -2346,6 +2334,7 @@ type GraphNode = {
|
|
|
2346
2334
|
attribute: string
|
|
2347
2335
|
value: string | number | boolean
|
|
2348
2336
|
}>
|
|
2337
|
+
optional?: boolean
|
|
2349
2338
|
}
|
|
2350
2339
|
```
|
|
2351
2340
|
|
|
@@ -2594,7 +2583,31 @@ type AssignEntityConfig = {
|
|
|
2594
2583
|
email?: string
|
|
2595
2584
|
}>
|
|
2596
2585
|
write_mode?: "replace" | "append"
|
|
2597
|
-
assignment_type?: "direct"
|
|
2586
|
+
assignment_type?: "direct" | "sequential" | "even_distribution"
|
|
2587
|
+
candidate_group?: {
|
|
2588
|
+
type: "user" | "partner_user" | "partner_organization" | "group"
|
|
2589
|
+
user_id?: string
|
|
2590
|
+
group_id?: string
|
|
2591
|
+
org_id?: string
|
|
2592
|
+
partner_id?: string
|
|
2593
|
+
display_name?: string
|
|
2594
|
+
email?: string
|
|
2595
|
+
}
|
|
2596
|
+
reset_interval?: "daily" | "weekly" | "monthly" | "never"
|
|
2597
|
+
workload_filter?: {
|
|
2598
|
+
attribute?: string
|
|
2599
|
+
values?: string[]
|
|
2600
|
+
}
|
|
2601
|
+
fallback?: "leave_unassigned" | "assign_to_fallback"
|
|
2602
|
+
fallback_assignees?: Array<{
|
|
2603
|
+
type: "user" | "partner_user" | "partner_organization" | "group"
|
|
2604
|
+
user_id?: string
|
|
2605
|
+
group_id?: string
|
|
2606
|
+
org_id?: string
|
|
2607
|
+
partner_id?: string
|
|
2608
|
+
display_name?: string
|
|
2609
|
+
email?: string
|
|
2610
|
+
}>
|
|
2598
2611
|
source?: {
|
|
2599
2612
|
id?: string
|
|
2600
2613
|
origin?: "trigger" | "action"
|
|
@@ -2623,7 +2636,31 @@ type AssignEntityActionConfig = {
|
|
|
2623
2636
|
email?: { ... }
|
|
2624
2637
|
}>
|
|
2625
2638
|
write_mode?: "replace" | "append"
|
|
2626
|
-
assignment_type?: "direct"
|
|
2639
|
+
assignment_type?: "direct" | "sequential" | "even_distribution"
|
|
2640
|
+
candidate_group?: {
|
|
2641
|
+
type: { ... }
|
|
2642
|
+
user_id?: { ... }
|
|
2643
|
+
group_id?: { ... }
|
|
2644
|
+
org_id?: { ... }
|
|
2645
|
+
partner_id?: { ... }
|
|
2646
|
+
display_name?: { ... }
|
|
2647
|
+
email?: { ... }
|
|
2648
|
+
}
|
|
2649
|
+
reset_interval?: "daily" | "weekly" | "monthly" | "never"
|
|
2650
|
+
workload_filter?: {
|
|
2651
|
+
attribute?: { ... }
|
|
2652
|
+
values?: { ... }
|
|
2653
|
+
}
|
|
2654
|
+
fallback?: "leave_unassigned" | "assign_to_fallback"
|
|
2655
|
+
fallback_assignees?: Array<{
|
|
2656
|
+
type: { ... }
|
|
2657
|
+
user_id?: { ... }
|
|
2658
|
+
group_id?: { ... }
|
|
2659
|
+
org_id?: { ... }
|
|
2660
|
+
partner_id?: { ... }
|
|
2661
|
+
display_name?: { ... }
|
|
2662
|
+
email?: { ... }
|
|
2663
|
+
}>
|
|
2627
2664
|
source?: {
|
|
2628
2665
|
id?: { ... }
|
|
2629
2666
|
origin?: { ... }
|
|
@@ -2660,7 +2697,31 @@ type AssignEntityAction = {
|
|
|
2660
2697
|
email?: { ... }
|
|
2661
2698
|
}>
|
|
2662
2699
|
write_mode?: "replace" | "append"
|
|
2663
|
-
assignment_type?: "direct"
|
|
2700
|
+
assignment_type?: "direct" | "sequential" | "even_distribution"
|
|
2701
|
+
candidate_group?: {
|
|
2702
|
+
type: { ... }
|
|
2703
|
+
user_id?: { ... }
|
|
2704
|
+
group_id?: { ... }
|
|
2705
|
+
org_id?: { ... }
|
|
2706
|
+
partner_id?: { ... }
|
|
2707
|
+
display_name?: { ... }
|
|
2708
|
+
email?: { ... }
|
|
2709
|
+
}
|
|
2710
|
+
reset_interval?: "daily" | "weekly" | "monthly" | "never"
|
|
2711
|
+
workload_filter?: {
|
|
2712
|
+
attribute?: { ... }
|
|
2713
|
+
values?: { ... }
|
|
2714
|
+
}
|
|
2715
|
+
fallback?: "leave_unassigned" | "assign_to_fallback"
|
|
2716
|
+
fallback_assignees?: Array<{
|
|
2717
|
+
type: { ... }
|
|
2718
|
+
user_id?: { ... }
|
|
2719
|
+
group_id?: { ... }
|
|
2720
|
+
org_id?: { ... }
|
|
2721
|
+
partner_id?: { ... }
|
|
2722
|
+
display_name?: { ... }
|
|
2723
|
+
email?: { ... }
|
|
2724
|
+
}>
|
|
2664
2725
|
source?: {
|
|
2665
2726
|
id?: { ... }
|
|
2666
2727
|
origin?: { ... }
|
|
@@ -3334,7 +3395,7 @@ type ConditionStatement = {
|
|
|
3334
3395
|
source?: {
|
|
3335
3396
|
id?: string
|
|
3336
3397
|
origin?: "trigger" | "action"
|
|
3337
|
-
originType?: "entity" | "workflow" | "journey_block"
|
|
3398
|
+
originType?: "entity" | "workflow" | "journey_block"
|
|
3338
3399
|
schema?: string
|
|
3339
3400
|
attribute?: string
|
|
3340
3401
|
attributeType?: "string" | "text" | "number" | "boolean" | "date" | "datetime" | "tags" | "country" | "email" | "phone" | "product" | "price" | "status" | "relation" | "multiselect" | "select" | "radio" | "relation_user" | "purpose" | "label" | "payment" | "relation_payment_method"
|
|
@@ -3656,42 +3717,6 @@ type TriggerEventEntityOperation = {
|
|
|
3656
3717
|
}
|
|
3657
3718
|
```
|
|
3658
3719
|
|
|
3659
|
-
### `TriggerEventEventCatalog`
|
|
3660
|
-
|
|
3661
|
-
Set on executions started by an Event Catalog event (see EventCatalogTrigger). The full event payload is not stored inline (it may be up to 256 KB) but by reference in `payload_ref`; automation workers hydrate it before every action.
|
|
3662
|
-
|
|
3663
|
-
|
|
3664
|
-
```ts
|
|
3665
|
-
type TriggerEventEventCatalog = {
|
|
3666
|
-
type: "event_catalog"
|
|
3667
|
-
org_id: string
|
|
3668
|
-
entity_id: string
|
|
3669
|
-
entity_node_id: string
|
|
3670
|
-
event_id: string
|
|
3671
|
-
event_name: string
|
|
3672
|
-
event_version: string
|
|
3673
|
-
published_version?: string
|
|
3674
|
-
event_time?: string // date-time
|
|
3675
|
-
trigger_source_type?: string
|
|
3676
|
-
trigger_source?: string
|
|
3677
|
-
payload_ref?: {
|
|
3678
|
-
bucket: string
|
|
3679
|
-
key: string
|
|
3680
|
-
}
|
|
3681
|
-
}
|
|
3682
|
-
```
|
|
3683
|
-
|
|
3684
|
-
### `TriggerEventPayloadRef`
|
|
3685
|
-
|
|
3686
|
-
S3 reference to the stored trigger event payload (`_downgrades` stripped, downgraded to the pinned version)
|
|
3687
|
-
|
|
3688
|
-
```ts
|
|
3689
|
-
type TriggerEventPayloadRef = {
|
|
3690
|
-
bucket: string
|
|
3691
|
-
key: string
|
|
3692
|
-
}
|
|
3693
|
-
```
|
|
3694
|
-
|
|
3695
3720
|
### `ApiCallerContext`
|
|
3696
3721
|
|
|
3697
3722
|
```ts
|
|
@@ -4413,25 +4438,6 @@ type EntityManualTrigger = {
|
|
|
4413
4438
|
}
|
|
4414
4439
|
```
|
|
4415
4440
|
|
|
4416
|
-
### `EventCatalogTrigger`
|
|
4417
|
-
|
|
4418
|
-
Starts the flow when an Event Catalog event is published for the organization. The execution runs in the context of one entity from the event's entity graph (`entity_node_id`), and the event payload is available to conditions and actions as the `event` variable context.
|
|
4419
|
-
|
|
4420
|
-
|
|
4421
|
-
```ts
|
|
4422
|
-
type EventCatalogTrigger = {
|
|
4423
|
-
id?: string // uuid
|
|
4424
|
-
type: "event_catalog"
|
|
4425
|
-
configuration: {
|
|
4426
|
-
event_name: string
|
|
4427
|
-
event_version: string
|
|
4428
|
-
entity_node_id: string
|
|
4429
|
-
entity_schema: string
|
|
4430
|
-
ignore_automation_triggered?: boolean
|
|
4431
|
-
}
|
|
4432
|
-
}
|
|
4433
|
-
```
|
|
4434
|
-
|
|
4435
4441
|
### `TriggerCondition`
|
|
4436
4442
|
|
|
4437
4443
|
```ts
|
package/docs/journey.md
CHANGED
|
@@ -65,6 +65,7 @@ const { data } = await journeyClient.getJourneysByOrgId(...)
|
|
|
65
65
|
- [`SearchJourneysQueryRequest`](#searchjourneysqueryrequest)
|
|
66
66
|
- [`SearchJourneysResponse`](#searchjourneysresponse)
|
|
67
67
|
- [`Journey`](#journey)
|
|
68
|
+
- [`JourneyServedRevision`](#journeyservedrevision)
|
|
68
69
|
- [`JourneyActivationGuarantee`](#journeyactivationguarantee)
|
|
69
70
|
- [`JourneyFeatureFlags`](#journeyfeatureflags)
|
|
70
71
|
- [`JourneyAuditInfo`](#journeyauditinfo)
|
|
@@ -121,6 +122,7 @@ Get journey by id. Private journeys requires valid private token to be passed
|
|
|
121
122
|
const { data } = await client.getJourney({
|
|
122
123
|
id: '123e4567-e89b-12d3-a456-426614174000',
|
|
123
124
|
version: 1,
|
|
125
|
+
revision_id: 'example',
|
|
124
126
|
source: 'example',
|
|
125
127
|
orgId: 'example',
|
|
126
128
|
})
|
|
@@ -248,7 +250,8 @@ const { data } = await client.getJourney({
|
|
|
248
250
|
"deletedAt": "string",
|
|
249
251
|
"version": 0,
|
|
250
252
|
"revisions": 0,
|
|
251
|
-
"featureFlags": {}
|
|
253
|
+
"featureFlags": {},
|
|
254
|
+
"revision_id": "42"
|
|
252
255
|
}
|
|
253
256
|
```
|
|
254
257
|
|
|
@@ -396,7 +399,8 @@ const { data } = await client.createJourneyRevision(
|
|
|
396
399
|
__lastModifiedAt: 'string',
|
|
397
400
|
parent_revision_id: '41',
|
|
398
401
|
based_on_revision_id: '37',
|
|
399
|
-
mapping_config_version: 12
|
|
402
|
+
mapping_config_version: 12,
|
|
403
|
+
revision_name: 'Changes to Steps and Logic'
|
|
400
404
|
},
|
|
401
405
|
)
|
|
402
406
|
```
|
|
@@ -2732,6 +2736,17 @@ type Journey = {
|
|
|
2732
2736
|
}
|
|
2733
2737
|
```
|
|
2734
2738
|
|
|
2739
|
+
### `JourneyServedRevision`
|
|
2740
|
+
|
|
2741
|
+
Which revision the runtime read served: the requested one, or the published version when no revision was requested. Absent while the journey has not adopted versioning and on legacy `version` reads.
|
|
2742
|
+
|
|
2743
|
+
|
|
2744
|
+
```ts
|
|
2745
|
+
type JourneyServedRevision = {
|
|
2746
|
+
revision_id?: string
|
|
2747
|
+
}
|
|
2748
|
+
```
|
|
2749
|
+
|
|
2735
2750
|
### `JourneyActivationGuarantee`
|
|
2736
2751
|
|
|
2737
2752
|
Journeys read from the API always carry an explicit `settings.isActive`. The flag remains optional in request bodies.
|