@epilot/sdk 2.20.17 → 2.20.19
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/environments.json +290 -5
- 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 +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/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.d.cts +2 -2
- package/dist/apis/environments.d.ts +2 -2
- 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/{chunk-OZHARSW5.cjs → chunk-5EIG7AKU.cjs} +3 -3
- package/dist/{chunk-HQJ5AG4I.js → chunk-ACIBIJN5.js} +3 -3
- package/dist/chunk-SJS5S6Z5.js +14 -0
- package/dist/chunk-X7UJYAG5.cjs +14 -0
- package/dist/environments-OYCH6VUD.js +7 -0
- package/dist/environments-S3O6ASTY.cjs +7 -0
- package/dist/{environments.d-C_BTxz4W.d.cts → environments.d-qL1urwAq.d.cts} +252 -22
- package/dist/{environments.d-C_BTxz4W.d.ts → environments.d-qL1urwAq.d.ts} +252 -22
- 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/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.cts → journey.d-DvwLALwc.d.cts} +36 -2
- package/dist/{journey.d-6Bs1uNLT.d.ts → journey.d-DvwLALwc.d.ts} +36 -2
- package/docs/environments.md +327 -11
- package/docs/journey.md +17 -2
- package/package.json +1 -1
- package/dist/chunk-HL4MZXEK.js +0 -14
- package/dist/chunk-W6R2J6KQ.cjs +0 -14
- package/dist/environments-EAVUY4FC.cjs +0 -7
- package/dist/environments-RNOROUFZ.js +0 -7
- package/dist/journey-FNWHSZW3.js +0 -7
- package/dist/journey-FUJDOH5O.cjs +0 -7
|
@@ -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/environments.md
CHANGED
|
@@ -41,6 +41,16 @@ const { data } = await environmentsClient.listEnvironmentVariables(...)
|
|
|
41
41
|
- [`MapValue`](#mapvalue)
|
|
42
42
|
- [`JsonValue`](#jsonvalue)
|
|
43
43
|
- [`LinkValue`](#linkvalue)
|
|
44
|
+
- [`LinkFields`](#linkfields)
|
|
45
|
+
- [`ListItemType`](#listitemtype)
|
|
46
|
+
- [`ListOfText`](#listoftext)
|
|
47
|
+
- [`ListOfString`](#listofstring)
|
|
48
|
+
- [`ListOfSecretString`](#listofsecretstring)
|
|
49
|
+
- [`ListOfNumber`](#listofnumber)
|
|
50
|
+
- [`ListOfBoolean`](#listofboolean)
|
|
51
|
+
- [`ListOfJson`](#listofjson)
|
|
52
|
+
- [`ListOfLink`](#listoflink)
|
|
53
|
+
- [`ListValue`](#listvalue)
|
|
44
54
|
- [`EnvironmentValue`](#environmentvalue)
|
|
45
55
|
- [`EnvironmentVariable`](#environmentvariable)
|
|
46
56
|
- [`EnvironmentVariableListItem`](#environmentvariablelistitem)
|
|
@@ -70,6 +80,7 @@ const { data } = await client.listEnvironmentVariables()
|
|
|
70
80
|
{
|
|
71
81
|
"key": "string",
|
|
72
82
|
"type": "String",
|
|
83
|
+
"item_type": "String",
|
|
73
84
|
"description": "string",
|
|
74
85
|
"group": "string",
|
|
75
86
|
"value": "string",
|
|
@@ -112,6 +123,7 @@ const { data } = await client.createEnvironmentVariable(
|
|
|
112
123
|
{
|
|
113
124
|
"key": "string",
|
|
114
125
|
"type": "String",
|
|
126
|
+
"item_type": "String",
|
|
115
127
|
"description": "string",
|
|
116
128
|
"group": "string",
|
|
117
129
|
"value": "string",
|
|
@@ -221,6 +233,7 @@ const { data } = await client.getEnvironmentVariable({
|
|
|
221
233
|
{
|
|
222
234
|
"key": "string",
|
|
223
235
|
"type": "String",
|
|
236
|
+
"item_type": "String",
|
|
224
237
|
"description": "string",
|
|
225
238
|
"group": "string",
|
|
226
239
|
"value": "string",
|
|
@@ -262,6 +275,7 @@ const { data } = await client.updateEnvironmentVariable(
|
|
|
262
275
|
{
|
|
263
276
|
"key": "string",
|
|
264
277
|
"type": "String",
|
|
278
|
+
"item_type": "String",
|
|
265
279
|
"description": "string",
|
|
266
280
|
"group": "string",
|
|
267
281
|
"value": "string",
|
|
@@ -295,11 +309,11 @@ const { data } = await client.deleteEnvironmentVariable({
|
|
|
295
309
|
|
|
296
310
|
The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
297
311
|
its value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON` and `Link`
|
|
298
|
-
may be served to browser-facing consumers; `String` and `SecretString` may not.
|
|
299
|
-
|
|
312
|
+
may be served to browser-facing consumers; `String` and `SecretString` may not. A
|
|
313
|
+
`List` inherits this from its element type: a `List` is
|
|
300
314
|
|
|
301
315
|
```ts
|
|
302
|
-
type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
316
|
+
type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
|
|
303
317
|
```
|
|
304
318
|
|
|
305
319
|
### `StringTranslations`
|
|
@@ -369,13 +383,160 @@ type LinkValue = {
|
|
|
369
383
|
}
|
|
370
384
|
```
|
|
371
385
|
|
|
386
|
+
### `LinkFields`
|
|
387
|
+
|
|
388
|
+
The fields of a link, without a fallback language — the shape a `List`
|
|
389
|
+
item carries. Inside a list the fallback belongs to the wrapper, which
|
|
390
|
+
owns the language tabs for every row.
|
|
391
|
+
|
|
392
|
+
Restated rather than composed with `LinkValue`: `allOf` plus
|
|
393
|
+
`additionalProperties: false` is rejected by most validato
|
|
394
|
+
|
|
395
|
+
```ts
|
|
396
|
+
type LinkFields = {
|
|
397
|
+
url: string
|
|
398
|
+
label: string | Record<string, string>
|
|
399
|
+
description?: string | Record<string, string>
|
|
400
|
+
}
|
|
401
|
+
```
|
|
402
|
+
|
|
403
|
+
### `ListItemType`
|
|
404
|
+
|
|
405
|
+
The element type a `List` holds — every value type except the
|
|
406
|
+
containers. `Map` is already a keyed collection and a list of lists has
|
|
407
|
+
no consumer. A list is exactly as client-safe and exactly as secret as
|
|
408
|
+
its element type: a list of `SecretString` is encrypted per item and its
|
|
409
|
+
value is never returne
|
|
410
|
+
|
|
411
|
+
```ts
|
|
412
|
+
type ListItemType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"
|
|
413
|
+
```
|
|
414
|
+
|
|
415
|
+
### `ListOfText`
|
|
416
|
+
|
|
417
|
+
```ts
|
|
418
|
+
type ListOfText = {
|
|
419
|
+
itemType: "Text"
|
|
420
|
+
items: string[]
|
|
421
|
+
}
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
### `ListOfString`
|
|
425
|
+
|
|
426
|
+
```ts
|
|
427
|
+
type ListOfString = {
|
|
428
|
+
itemType: "String"
|
|
429
|
+
items: string[]
|
|
430
|
+
}
|
|
431
|
+
```
|
|
432
|
+
|
|
433
|
+
### `ListOfSecretString`
|
|
434
|
+
|
|
435
|
+
Write-only in effect: the items are encrypted per item at rest and the
|
|
436
|
+
whole value is omitted from every read response, exactly as a
|
|
437
|
+
`SecretString` variable's value is. Read `item_type` to learn what a
|
|
438
|
+
list holds when its value is withheld.
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
```ts
|
|
442
|
+
type ListOfSecretString = {
|
|
443
|
+
itemType: "SecretString"
|
|
444
|
+
items: string[]
|
|
445
|
+
}
|
|
446
|
+
```
|
|
447
|
+
|
|
448
|
+
### `ListOfNumber`
|
|
449
|
+
|
|
450
|
+
```ts
|
|
451
|
+
type ListOfNumber = {
|
|
452
|
+
itemType: "Number"
|
|
453
|
+
items: number[]
|
|
454
|
+
}
|
|
455
|
+
```
|
|
456
|
+
|
|
457
|
+
### `ListOfBoolean`
|
|
458
|
+
|
|
459
|
+
```ts
|
|
460
|
+
type ListOfBoolean = {
|
|
461
|
+
itemType: "Boolean"
|
|
462
|
+
items: boolean[]
|
|
463
|
+
}
|
|
464
|
+
```
|
|
465
|
+
|
|
466
|
+
### `ListOfJson`
|
|
467
|
+
|
|
468
|
+
```ts
|
|
469
|
+
type ListOfJson = {
|
|
470
|
+
itemType: "JSON"
|
|
471
|
+
items: Record<string, unknown>[]
|
|
472
|
+
}
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
### `ListOfLink`
|
|
476
|
+
|
|
477
|
+
A list of links. `fallbackLanguage` applies to every item's translated
|
|
478
|
+
`label` and `description`; items may mix plain and translated fields
|
|
479
|
+
freely, since a plain string is a complete answer for any language.
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
```ts
|
|
483
|
+
type ListOfLink = {
|
|
484
|
+
itemType: "Link"
|
|
485
|
+
fallbackLanguage?: string
|
|
486
|
+
items: Array<{
|
|
487
|
+
url: string
|
|
488
|
+
label: string | Record<string, string>
|
|
489
|
+
description?: string | Record<string, string>
|
|
490
|
+
}>
|
|
491
|
+
}
|
|
492
|
+
```
|
|
493
|
+
|
|
494
|
+
### `ListValue`
|
|
495
|
+
|
|
496
|
+
An ordered collection of one declared element type. Items round-trip in
|
|
497
|
+
the order written; nothing sorts them. Holds at most 100 items.
|
|
498
|
+
|
|
499
|
+
The whole value is limited to 32768 characters when serialised — the
|
|
500
|
+
server enforces this, and it is not expressible per-property here.
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
```ts
|
|
504
|
+
type ListValue = {
|
|
505
|
+
itemType: "Text"
|
|
506
|
+
items: string[]
|
|
507
|
+
} | {
|
|
508
|
+
itemType: "Number"
|
|
509
|
+
items: number[]
|
|
510
|
+
} | {
|
|
511
|
+
itemType: "Boolean"
|
|
512
|
+
items: boolean[]
|
|
513
|
+
} | {
|
|
514
|
+
itemType: "JSON"
|
|
515
|
+
items: Record<string, unknown>[]
|
|
516
|
+
} | {
|
|
517
|
+
itemType: "Link"
|
|
518
|
+
fallbackLanguage?: string
|
|
519
|
+
items: Array<{
|
|
520
|
+
url: string
|
|
521
|
+
label: string | Record<string, string>
|
|
522
|
+
description?: string | Record<string, string>
|
|
523
|
+
}>
|
|
524
|
+
} | {
|
|
525
|
+
itemType: "String"
|
|
526
|
+
items: string[]
|
|
527
|
+
} | {
|
|
528
|
+
itemType: "SecretString"
|
|
529
|
+
items: string[]
|
|
530
|
+
}
|
|
531
|
+
```
|
|
532
|
+
|
|
372
533
|
### `EnvironmentValue`
|
|
373
534
|
|
|
374
535
|
A variable's value. The JSON type corresponds to the variable's `type`:
|
|
375
536
|
`String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
376
|
-
`Boolean` is a boolean, and `Map`, `JSON` and `
|
|
377
|
-
IEEE 754 doubles; integers above 2^53 may lose precision on
|
|
378
|
-
|
|
537
|
+
`Boolean` is a boolean, and `Map`, `JSON`, `Link` and `List` are objects.
|
|
538
|
+
Numbers are IEEE 754 doubles; integers above 2^53 may lose precision on
|
|
539
|
+
round-trip.
|
|
379
540
|
|
|
380
541
|
```ts
|
|
381
542
|
type EnvironmentValue = string | number | boolean | {
|
|
@@ -389,6 +550,32 @@ type EnvironmentValue = string | number | boolean | {
|
|
|
389
550
|
label: string | Record<string, string>
|
|
390
551
|
description?: string | Record<string, string>
|
|
391
552
|
fallbackLanguage?: string
|
|
553
|
+
} | {
|
|
554
|
+
itemType: "Text"
|
|
555
|
+
items: string[]
|
|
556
|
+
} | {
|
|
557
|
+
itemType: "Number"
|
|
558
|
+
items: number[]
|
|
559
|
+
} | {
|
|
560
|
+
itemType: "Boolean"
|
|
561
|
+
items: boolean[]
|
|
562
|
+
} | {
|
|
563
|
+
itemType: "JSON"
|
|
564
|
+
items: Record<string, unknown>[]
|
|
565
|
+
} | {
|
|
566
|
+
itemType: "Link"
|
|
567
|
+
fallbackLanguage?: string
|
|
568
|
+
items: Array<{
|
|
569
|
+
url: string
|
|
570
|
+
label: string | Record<string, string>
|
|
571
|
+
description?: string | Record<string, string>
|
|
572
|
+
}>
|
|
573
|
+
} | {
|
|
574
|
+
itemType: "String"
|
|
575
|
+
items: string[]
|
|
576
|
+
} | {
|
|
577
|
+
itemType: "SecretString"
|
|
578
|
+
items: string[]
|
|
392
579
|
}
|
|
393
580
|
```
|
|
394
581
|
|
|
@@ -397,7 +584,8 @@ type EnvironmentValue = string | number | boolean | {
|
|
|
397
584
|
```ts
|
|
398
585
|
type EnvironmentVariable = {
|
|
399
586
|
key: string
|
|
400
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
587
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
|
|
588
|
+
item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"
|
|
401
589
|
description?: string
|
|
402
590
|
group?: string
|
|
403
591
|
value?: string | number | boolean | {
|
|
@@ -411,6 +599,32 @@ type EnvironmentVariable = {
|
|
|
411
599
|
label: string | Record<string, string>
|
|
412
600
|
description?: string | Record<string, string>
|
|
413
601
|
fallbackLanguage?: string
|
|
602
|
+
} | {
|
|
603
|
+
itemType: "Text"
|
|
604
|
+
items: string[]
|
|
605
|
+
} | {
|
|
606
|
+
itemType: "Number"
|
|
607
|
+
items: number[]
|
|
608
|
+
} | {
|
|
609
|
+
itemType: "Boolean"
|
|
610
|
+
items: boolean[]
|
|
611
|
+
} | {
|
|
612
|
+
itemType: "JSON"
|
|
613
|
+
items: Record<string, unknown>[]
|
|
614
|
+
} | {
|
|
615
|
+
itemType: "Link"
|
|
616
|
+
fallbackLanguage?: string
|
|
617
|
+
items: Array<{
|
|
618
|
+
url: { ... }
|
|
619
|
+
label: { ... }
|
|
620
|
+
description?: { ... }
|
|
621
|
+
}>
|
|
622
|
+
} | {
|
|
623
|
+
itemType: "String"
|
|
624
|
+
items: string[]
|
|
625
|
+
} | {
|
|
626
|
+
itemType: "SecretString"
|
|
627
|
+
items: string[]
|
|
414
628
|
}
|
|
415
629
|
protected?: boolean
|
|
416
630
|
created_at: string // date-time
|
|
@@ -423,7 +637,8 @@ type EnvironmentVariable = {
|
|
|
423
637
|
```ts
|
|
424
638
|
type EnvironmentVariableListItem = {
|
|
425
639
|
key: string
|
|
426
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
640
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
|
|
641
|
+
item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"
|
|
427
642
|
description?: string
|
|
428
643
|
group?: string
|
|
429
644
|
value?: string | number | boolean | {
|
|
@@ -437,6 +652,32 @@ type EnvironmentVariableListItem = {
|
|
|
437
652
|
label: string | Record<string, string>
|
|
438
653
|
description?: string | Record<string, string>
|
|
439
654
|
fallbackLanguage?: string
|
|
655
|
+
} | {
|
|
656
|
+
itemType: "Text"
|
|
657
|
+
items: string[]
|
|
658
|
+
} | {
|
|
659
|
+
itemType: "Number"
|
|
660
|
+
items: number[]
|
|
661
|
+
} | {
|
|
662
|
+
itemType: "Boolean"
|
|
663
|
+
items: boolean[]
|
|
664
|
+
} | {
|
|
665
|
+
itemType: "JSON"
|
|
666
|
+
items: Record<string, unknown>[]
|
|
667
|
+
} | {
|
|
668
|
+
itemType: "Link"
|
|
669
|
+
fallbackLanguage?: string
|
|
670
|
+
items: Array<{
|
|
671
|
+
url: { ... }
|
|
672
|
+
label: { ... }
|
|
673
|
+
description?: { ... }
|
|
674
|
+
}>
|
|
675
|
+
} | {
|
|
676
|
+
itemType: "String"
|
|
677
|
+
items: string[]
|
|
678
|
+
} | {
|
|
679
|
+
itemType: "SecretString"
|
|
680
|
+
items: string[]
|
|
440
681
|
}
|
|
441
682
|
protected?: boolean
|
|
442
683
|
created_at: string // date-time
|
|
@@ -450,7 +691,8 @@ type EnvironmentVariableListItem = {
|
|
|
450
691
|
type EnvironmentVariableList = {
|
|
451
692
|
items: Array<{
|
|
452
693
|
key: string
|
|
453
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
694
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
|
|
695
|
+
item_type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "JSON" | "Link"
|
|
454
696
|
description?: string
|
|
455
697
|
group?: string
|
|
456
698
|
value?: string | number | boolean | {
|
|
@@ -461,6 +703,28 @@ type EnvironmentVariableList = {
|
|
|
461
703
|
label: { ... }
|
|
462
704
|
description?: { ... }
|
|
463
705
|
fallbackLanguage?: { ... }
|
|
706
|
+
} | {
|
|
707
|
+
itemType: { ... }
|
|
708
|
+
items: { ... }
|
|
709
|
+
} | {
|
|
710
|
+
itemType: { ... }
|
|
711
|
+
items: { ... }
|
|
712
|
+
} | {
|
|
713
|
+
itemType: { ... }
|
|
714
|
+
items: { ... }
|
|
715
|
+
} | {
|
|
716
|
+
itemType: { ... }
|
|
717
|
+
items: { ... }
|
|
718
|
+
} | {
|
|
719
|
+
itemType: { ... }
|
|
720
|
+
fallbackLanguage?: { ... }
|
|
721
|
+
items: { ... }
|
|
722
|
+
} | {
|
|
723
|
+
itemType: { ... }
|
|
724
|
+
items: { ... }
|
|
725
|
+
} | {
|
|
726
|
+
itemType: { ... }
|
|
727
|
+
items: { ... }
|
|
464
728
|
}
|
|
465
729
|
protected?: boolean
|
|
466
730
|
created_at: string // date-time
|
|
@@ -474,7 +738,7 @@ type EnvironmentVariableList = {
|
|
|
474
738
|
```ts
|
|
475
739
|
type EnvironmentVariableCreateRequest = {
|
|
476
740
|
key: string
|
|
477
|
-
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
741
|
+
type: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
|
|
478
742
|
description?: string
|
|
479
743
|
group?: string
|
|
480
744
|
value?: string | number | boolean | {
|
|
@@ -488,6 +752,32 @@ type EnvironmentVariableCreateRequest = {
|
|
|
488
752
|
label: string | Record<string, string>
|
|
489
753
|
description?: string | Record<string, string>
|
|
490
754
|
fallbackLanguage?: string
|
|
755
|
+
} | {
|
|
756
|
+
itemType: "Text"
|
|
757
|
+
items: string[]
|
|
758
|
+
} | {
|
|
759
|
+
itemType: "Number"
|
|
760
|
+
items: number[]
|
|
761
|
+
} | {
|
|
762
|
+
itemType: "Boolean"
|
|
763
|
+
items: boolean[]
|
|
764
|
+
} | {
|
|
765
|
+
itemType: "JSON"
|
|
766
|
+
items: Record<string, unknown>[]
|
|
767
|
+
} | {
|
|
768
|
+
itemType: "Link"
|
|
769
|
+
fallbackLanguage?: string
|
|
770
|
+
items: Array<{
|
|
771
|
+
url: { ... }
|
|
772
|
+
label: { ... }
|
|
773
|
+
description?: { ... }
|
|
774
|
+
}>
|
|
775
|
+
} | {
|
|
776
|
+
itemType: "String"
|
|
777
|
+
items: string[]
|
|
778
|
+
} | {
|
|
779
|
+
itemType: "SecretString"
|
|
780
|
+
items: string[]
|
|
491
781
|
}
|
|
492
782
|
protected?: boolean
|
|
493
783
|
}
|
|
@@ -497,7 +787,7 @@ type EnvironmentVariableCreateRequest = {
|
|
|
497
787
|
|
|
498
788
|
```ts
|
|
499
789
|
type EnvironmentVariableUpdateRequest = {
|
|
500
|
-
type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link"
|
|
790
|
+
type?: "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Map" | "JSON" | "Link" | "List"
|
|
501
791
|
value?: string | number | boolean | {
|
|
502
792
|
fallbackLanguage?: string
|
|
503
793
|
options: Array<{
|
|
@@ -509,6 +799,32 @@ type EnvironmentVariableUpdateRequest = {
|
|
|
509
799
|
label: string | Record<string, string>
|
|
510
800
|
description?: string | Record<string, string>
|
|
511
801
|
fallbackLanguage?: string
|
|
802
|
+
} | {
|
|
803
|
+
itemType: "Text"
|
|
804
|
+
items: string[]
|
|
805
|
+
} | {
|
|
806
|
+
itemType: "Number"
|
|
807
|
+
items: number[]
|
|
808
|
+
} | {
|
|
809
|
+
itemType: "Boolean"
|
|
810
|
+
items: boolean[]
|
|
811
|
+
} | {
|
|
812
|
+
itemType: "JSON"
|
|
813
|
+
items: Record<string, unknown>[]
|
|
814
|
+
} | {
|
|
815
|
+
itemType: "Link"
|
|
816
|
+
fallbackLanguage?: string
|
|
817
|
+
items: Array<{
|
|
818
|
+
url: { ... }
|
|
819
|
+
label: { ... }
|
|
820
|
+
description?: { ... }
|
|
821
|
+
}>
|
|
822
|
+
} | {
|
|
823
|
+
itemType: "String"
|
|
824
|
+
items: string[]
|
|
825
|
+
} | {
|
|
826
|
+
itemType: "SecretString"
|
|
827
|
+
items: string[]
|
|
512
828
|
}
|
|
513
829
|
description?: string
|
|
514
830
|
group?: string
|
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.
|
package/package.json
CHANGED
package/dist/chunk-HL4MZXEK.js
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import {
|
|
2
|
-
__commonJS
|
|
3
|
-
} from "./chunk-YPSWSI3M.js";
|
|
4
|
-
|
|
5
|
-
// src/definitions/journey-runtime.json
|
|
6
|
-
var require_journey_runtime = __commonJS({
|
|
7
|
-
"src/definitions/journey-runtime.json"(exports, module) {
|
|
8
|
-
module.exports = { s: "https://journey-config.sls.epilot.io", o: [["getJourneysByOrgId", "get", "/v1/journey/organization/{id}", [["id", "p", true], ["hydrate", "q"]]], ["getJourney", "get", "/v1/journey/configuration/{id}", [["id", "p", true], ["version", "q"], ["source", "q"], ["orgId", "q"]]], ["removeJourney", "delete", "/v1/journey/configuration/{id}", [["id", "p", true]]], ["createJourneyRevision", "post", "/v1/journey/configuration/{id}/revisions", [["id", "p", true]], 1], ["listJourneyRevisions", "get", "/v1/journey/configuration/{id}/revisions", [["id", "p", true], ["limit", "q"], ["cursor", "q"]]], ["getJourneyRevision", "get", "/v1/journey/configuration/{id}/revisions/{revision_id}", [["id", "p", true], ["revision_id", "p", true]]], ["publishJourneyRevision", "post", "/v1/journey/configuration/{id}/publish", [["id", "p", true]], 1], ["getJourneyPublishState", "get", "/v1/journey/configuration/{id}/publish-state", [["id", "p", true]]], ["getJourneyEnvironment", "get", "/v1/journey/configuration/{id}/environment", [["id", "p", true]]], ["getJourneyEnvironmentVariables", "get", "/v1/journey/environment-variables"], ["getJourneyProducts", "get", "/v1/journey/products/{id}", [["id", "p", true], ["source", "q"], ["postal_code", "q"], ["city", "q"], ["street", "q"], ["street_number", "q"]]], ["createJourney", "post", "/v1/journey/configuration", [["skipAutomation", "q"]], 1], ["updateJourney", "put", "/v1/journey/configuration", null, 1], ["patchUpdateJourney", "patch", "/v1/journey/configuration", null, 1], ["searchJourneys", "post", "/v1/journey/configuration/search", null, 1], ["generateDocument", "post", "/v1/journey/document:generate", null, 1], ["createJourneyV2", "post", "/v2/journey/configuration", [["skipAutomation", "q"]], 1], ["updateJourneyV2", "put", "/v2/journey/configuration", null, 1], ["patchUpdateJourneyV2", "patch", "/v2/journey/configuration", null, 1], ["getJourneyV2", "get", "/v2/journey/configuration/{id}", [["id", "p", true], ["version", "q"]]], ["removeJourneyV2", "delete", "/v2/journey/configuration/{id}", [["id", "p", true]]], ["getSettingsForJourney", "get", "/v1/journey/{id}/settings", [["id", "p", true]]], ["getButtonOptions", "get", "/v1/journey/button-options", [["fileId", "q", true]]]], v: "3.0.0" };
|
|
9
|
-
}
|
|
10
|
-
});
|
|
11
|
-
|
|
12
|
-
export {
|
|
13
|
-
require_journey_runtime
|
|
14
|
-
};
|
package/dist/chunk-W6R2J6KQ.cjs
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports, "__esModule", {value: true});
|
|
2
|
-
|
|
3
|
-
var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
|
|
4
|
-
|
|
5
|
-
// src/definitions/journey-runtime.json
|
|
6
|
-
var require_journey_runtime = _chunkNJK5F5TFcjs.__commonJS.call(void 0, {
|
|
7
|
-
"src/definitions/journey-runtime.json"(exports, module) {
|
|
8
|
-
module.exports = { s: "https://journey-config.sls.epilot.io", o: [["getJourneysByOrgId", "get", "/v1/journey/organization/{id}", [["id", "p", true], ["hydrate", "q"]]], ["getJourney", "get", "/v1/journey/configuration/{id}", [["id", "p", true], ["version", "q"], ["source", "q"], ["orgId", "q"]]], ["removeJourney", "delete", "/v1/journey/configuration/{id}", [["id", "p", true]]], ["createJourneyRevision", "post", "/v1/journey/configuration/{id}/revisions", [["id", "p", true]], 1], ["listJourneyRevisions", "get", "/v1/journey/configuration/{id}/revisions", [["id", "p", true], ["limit", "q"], ["cursor", "q"]]], ["getJourneyRevision", "get", "/v1/journey/configuration/{id}/revisions/{revision_id}", [["id", "p", true], ["revision_id", "p", true]]], ["publishJourneyRevision", "post", "/v1/journey/configuration/{id}/publish", [["id", "p", true]], 1], ["getJourneyPublishState", "get", "/v1/journey/configuration/{id}/publish-state", [["id", "p", true]]], ["getJourneyEnvironment", "get", "/v1/journey/configuration/{id}/environment", [["id", "p", true]]], ["getJourneyEnvironmentVariables", "get", "/v1/journey/environment-variables"], ["getJourneyProducts", "get", "/v1/journey/products/{id}", [["id", "p", true], ["source", "q"], ["postal_code", "q"], ["city", "q"], ["street", "q"], ["street_number", "q"]]], ["createJourney", "post", "/v1/journey/configuration", [["skipAutomation", "q"]], 1], ["updateJourney", "put", "/v1/journey/configuration", null, 1], ["patchUpdateJourney", "patch", "/v1/journey/configuration", null, 1], ["searchJourneys", "post", "/v1/journey/configuration/search", null, 1], ["generateDocument", "post", "/v1/journey/document:generate", null, 1], ["createJourneyV2", "post", "/v2/journey/configuration", [["skipAutomation", "q"]], 1], ["updateJourneyV2", "put", "/v2/journey/configuration", null, 1], ["patchUpdateJourneyV2", "patch", "/v2/journey/configuration", null, 1], ["getJourneyV2", "get", "/v2/journey/configuration/{id}", [["id", "p", true], ["version", "q"]]], ["removeJourneyV2", "delete", "/v2/journey/configuration/{id}", [["id", "p", true]]], ["getSettingsForJourney", "get", "/v1/journey/{id}/settings", [["id", "p", true]]], ["getButtonOptions", "get", "/v1/journey/button-options", [["fileId", "q", true]]]], v: "3.0.0" };
|
|
9
|
-
}
|
|
10
|
-
});
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
exports.require_journey_runtime = require_journey_runtime;
|