@trycourier/courier 9.6.0 → 9.8.0
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/CHANGELOG.md +19 -0
- package/package.json +1 -1
- package/resources/digests/digests.d.mts +8 -0
- package/resources/digests/digests.d.mts.map +1 -1
- package/resources/digests/digests.d.ts +8 -0
- package/resources/digests/digests.d.ts.map +1 -1
- package/resources/digests/digests.js.map +1 -1
- package/resources/digests/digests.mjs.map +1 -1
- package/resources/journeys/journeys.d.mts +30 -0
- package/resources/journeys/journeys.d.mts.map +1 -1
- package/resources/journeys/journeys.d.ts +30 -0
- package/resources/journeys/journeys.d.ts.map +1 -1
- package/resources/journeys/journeys.js.map +1 -1
- package/resources/journeys/journeys.mjs.map +1 -1
- package/resources/shared.d.mts +16 -3
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +16 -3
- package/resources/shared.d.ts.map +1 -1
- package/resources/users/preferences.d.mts +7 -2
- package/resources/users/preferences.d.mts.map +1 -1
- package/resources/users/preferences.d.ts +7 -2
- package/resources/users/preferences.d.ts.map +1 -1
- package/resources/workspace-preferences/topics.d.mts +62 -3
- package/resources/workspace-preferences/topics.d.mts.map +1 -1
- package/resources/workspace-preferences/topics.d.ts +62 -3
- package/resources/workspace-preferences/topics.d.ts.map +1 -1
- package/resources/workspace-preferences/workspace-preferences.d.mts +87 -9
- package/resources/workspace-preferences/workspace-preferences.d.mts.map +1 -1
- package/resources/workspace-preferences/workspace-preferences.d.ts +87 -9
- package/resources/workspace-preferences/workspace-preferences.d.ts.map +1 -1
- package/resources/workspace-preferences/workspace-preferences.js.map +1 -1
- package/resources/workspace-preferences/workspace-preferences.mjs.map +1 -1
- package/src/resources/digests/digests.ts +8 -0
- package/src/resources/journeys/journeys.ts +34 -0
- package/src/resources/shared.ts +16 -3
- package/src/resources/users/preferences.ts +7 -2
- package/src/resources/workspace-preferences/topics.ts +67 -3
- package/src/resources/workspace-preferences/workspace-preferences.ts +93 -10
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import * as WorkspacePreferencesAPI from "./workspace-preferences.js";
|
|
2
3
|
import * as Shared from "../shared.js";
|
|
3
4
|
import * as DigestsAPI from "../digests/digests.js";
|
|
4
5
|
import * as TopicsAPI from "./topics.js";
|
|
@@ -189,12 +190,6 @@ export interface TopicDigestReleaseRequest {
|
|
|
189
190
|
* merely off.
|
|
190
191
|
*/
|
|
191
192
|
export interface TopicDigestRequest {
|
|
192
|
-
/**
|
|
193
|
-
* The cadences this digest delivers on. At least one is required: a digest with no
|
|
194
|
-
* schedule collects events into an instance that can never fire. Omitting the key
|
|
195
|
-
* on a replace leaves stored schedules untouched; sending `[]` is a `400`.
|
|
196
|
-
*/
|
|
197
|
-
schedules: Array<TopicDigestScheduleRequest>;
|
|
198
193
|
/**
|
|
199
194
|
* The notification template that renders the digest. A digest with no template
|
|
200
195
|
* collects nothing, so this is required.
|
|
@@ -209,6 +204,24 @@ export interface TopicDigestRequest {
|
|
|
209
204
|
* retaining `FIRST`.
|
|
210
205
|
*/
|
|
211
206
|
categories?: Array<TopicDigestCategory>;
|
|
207
|
+
/**
|
|
208
|
+
* The cadences this digest delivers on.
|
|
209
|
+
*
|
|
210
|
+
* The array replaces the stored schedules wholesale, so a schedule you leave out
|
|
211
|
+
* of it is deleted along with its delivery rule. Omit the key entirely to leave
|
|
212
|
+
* the stored schedules untouched — useful for changing `template_id` or
|
|
213
|
+
* `categories` without restating every schedule.
|
|
214
|
+
*
|
|
215
|
+
* A digest must end up with at least one schedule, because one with none collects
|
|
216
|
+
* events into an instance that can never fire. So sending `[]` is always a `400`,
|
|
217
|
+
* and so is omitting the key on a topic that has no schedules stored yet.
|
|
218
|
+
*
|
|
219
|
+
* On **create** the key is required outright: a topic being created has nothing
|
|
220
|
+
* stored to leave alone, and the topic row is written before its digest, so
|
|
221
|
+
* rejecting it any later would leave the topic behind and let a retry duplicate
|
|
222
|
+
* it.
|
|
223
|
+
*/
|
|
224
|
+
schedules?: Array<TopicDigestScheduleRequest>;
|
|
212
225
|
/**
|
|
213
226
|
* Whether to deliver the digest even when nothing was collected.
|
|
214
227
|
*/
|
|
@@ -252,6 +265,12 @@ export interface TopicDigestResponse {
|
|
|
252
265
|
* existing schedule in place; omit it and one is assigned and returned. The
|
|
253
266
|
* `schedules` array is a full replacement, so a stored schedule absent from it is
|
|
254
267
|
* deleted along with its delivery rule.
|
|
268
|
+
*
|
|
269
|
+
* Updating by `schedule_id` replaces that schedule rather than merging into it:
|
|
270
|
+
* any field you leave out is cleared. Two of those change delivery silently — an
|
|
271
|
+
* omitted `timezone` reverts the schedule to UTC, and an omitted `is_default` can
|
|
272
|
+
* leave the topic with no default schedule, which is what recipients who have not
|
|
273
|
+
* chosen one fall back to. Restate every field you want to keep.
|
|
255
274
|
*/
|
|
256
275
|
export interface TopicDigestScheduleRequest {
|
|
257
276
|
/**
|
|
@@ -413,15 +432,20 @@ export interface WorkspacePreferenceTopicCreateRequest {
|
|
|
413
432
|
*/
|
|
414
433
|
description?: string | null;
|
|
415
434
|
/**
|
|
416
|
-
* A topic's digest
|
|
417
|
-
* delivers on, and how collected events are
|
|
435
|
+
* A topic's digest, as supplied when the topic itself is created: the template
|
|
436
|
+
* that renders it, the cadences it delivers on, and how collected events are
|
|
437
|
+
* retained.
|
|
438
|
+
*
|
|
439
|
+
* Identical to `TopicDigestRequest`, which a replace uses, except that `schedules`
|
|
440
|
+
* is required — a topic being created has no stored schedules for an absent key to
|
|
441
|
+
* leave alone.
|
|
418
442
|
*
|
|
419
443
|
* Send `null` for the whole object to turn a digest off, which unlinks the
|
|
420
444
|
* template and removes its schedules. There is no `enabled` flag, and
|
|
421
445
|
* `schedules: []` is rejected, because both states are un-deliverable rather than
|
|
422
446
|
* merely off.
|
|
423
447
|
*/
|
|
424
|
-
digest?:
|
|
448
|
+
digest?: WorkspacePreferenceTopicCreateRequest.Digest | null;
|
|
425
449
|
/**
|
|
426
450
|
* Whether to include a list-unsubscribe header on emails for this topic.
|
|
427
451
|
*/
|
|
@@ -437,6 +461,60 @@ export interface WorkspacePreferenceTopicCreateRequest {
|
|
|
437
461
|
[key: string]: unknown;
|
|
438
462
|
} | null;
|
|
439
463
|
}
|
|
464
|
+
export declare namespace WorkspacePreferenceTopicCreateRequest {
|
|
465
|
+
/**
|
|
466
|
+
* A topic's digest, as supplied when the topic itself is created: the template
|
|
467
|
+
* that renders it, the cadences it delivers on, and how collected events are
|
|
468
|
+
* retained.
|
|
469
|
+
*
|
|
470
|
+
* Identical to `TopicDigestRequest`, which a replace uses, except that `schedules`
|
|
471
|
+
* is required — a topic being created has no stored schedules for an absent key to
|
|
472
|
+
* leave alone.
|
|
473
|
+
*
|
|
474
|
+
* Send `null` for the whole object to turn a digest off, which unlinks the
|
|
475
|
+
* template and removes its schedules. There is no `enabled` flag, and
|
|
476
|
+
* `schedules: []` is rejected, because both states are un-deliverable rather than
|
|
477
|
+
* merely off.
|
|
478
|
+
*/
|
|
479
|
+
interface Digest {
|
|
480
|
+
/**
|
|
481
|
+
* The cadences this digest delivers on.
|
|
482
|
+
*
|
|
483
|
+
* The array replaces the stored schedules wholesale, so a schedule you leave out
|
|
484
|
+
* of it is deleted along with its delivery rule. Omit the key entirely to leave
|
|
485
|
+
* the stored schedules untouched — useful for changing `template_id` or
|
|
486
|
+
* `categories` without restating every schedule.
|
|
487
|
+
*
|
|
488
|
+
* A digest must end up with at least one schedule, because one with none collects
|
|
489
|
+
* events into an instance that can never fire. So sending `[]` is always a `400`,
|
|
490
|
+
* and so is omitting the key on a topic that has no schedules stored yet.
|
|
491
|
+
*
|
|
492
|
+
* On **create** the key is required outright: a topic being created has nothing
|
|
493
|
+
* stored to leave alone, and the topic row is written before its digest, so
|
|
494
|
+
* rejecting it any later would leave the topic behind and let a retry duplicate
|
|
495
|
+
* it.
|
|
496
|
+
*/
|
|
497
|
+
schedules: Array<WorkspacePreferencesAPI.TopicDigestScheduleRequest>;
|
|
498
|
+
/**
|
|
499
|
+
* The notification template that renders the digest. A digest with no template
|
|
500
|
+
* collects nothing, so this is required.
|
|
501
|
+
*/
|
|
502
|
+
template_id: string;
|
|
503
|
+
/**
|
|
504
|
+
* Optional audience the digest is scoped to.
|
|
505
|
+
*/
|
|
506
|
+
audience_id?: string;
|
|
507
|
+
/**
|
|
508
|
+
* Retention rules per category key. Defaults to a single `digest` category
|
|
509
|
+
* retaining `FIRST`.
|
|
510
|
+
*/
|
|
511
|
+
categories?: Array<WorkspacePreferencesAPI.TopicDigestCategory>;
|
|
512
|
+
/**
|
|
513
|
+
* Whether to deliver the digest even when nothing was collected.
|
|
514
|
+
*/
|
|
515
|
+
trigger_empty?: boolean;
|
|
516
|
+
}
|
|
517
|
+
}
|
|
440
518
|
/**
|
|
441
519
|
* A subscription preference topic in your workspace.
|
|
442
520
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workspace-preferences.d.ts","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,UAAU,8BAA2B;AACjD,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,EACvB,wBAAwB,EACxB,kBAAkB,EAClB,mBAAmB,EACnB,MAAM,EACP,oBAAiB;AAClB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAqB7C;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAIjG;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,+BAA+B,CAAC;IAI3E;;;;;;;;OAQG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOtE;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,MAAM,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAqBzC;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE1D;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;;;OAKG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC
|
|
1
|
+
{"version":3,"file":"workspace-preferences.d.ts","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,uBAAuB,mCAAgC;AACnE,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,UAAU,8BAA2B;AACjD,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,uBAAuB,EACvB,wBAAwB,EACxB,kBAAkB,EAClB,mBAAmB,EACnB,MAAM,EACP,oBAAiB;AAClB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,WAAW;IACnD,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAM,EAAE,+BAA+B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;IAqB7C;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;IAIjG;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,+BAA+B,CAAC;IAI3E;;;;;;;;OAQG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOtE;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,MAAM,GAAE,gCAAgC,GAAG,IAAI,GAAG,SAAc,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;IAqBzC;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,gCAAgC,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;IAE1D;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;;;OAKG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAExC;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAE9C;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAEvC;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,UAAU,CAAC,2BAA2B,CAAC,CAAC;IAEzD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,SAAS,EAAE,UAAU,CAAC,eAAe,CAAC;IAEtC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC;IAEzC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAErD;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAEnD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,OAAO,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAErE;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,qCAAqC,CAAC,MAAM,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAChD;AAED,yBAAiB,qCAAqC,CAAC;IACrD;;;;;;;;;;;;;OAaG;IACH,UAAiB,MAAM;QACrB;;;;;;;;;;;;;;;;WAgBG;QACH,SAAS,EAAE,KAAK,CAAC,uBAAuB,CAAC,0BAA0B,CAAC,CAAC;QAErE;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;QAEhE;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;KACzB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,CAAC;IAE7D;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAErD;;OAEG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACnD,OAAO,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,sCAAsC;IACrD;;OAEG;IACH,cAAc,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAEtD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAErE;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;IAE7D;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;CAC9D;AAID,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,gCAAgC,IAAI,gCAAgC,GAC1E,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workspace-preferences.js","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;
|
|
1
|
+
{"version":3,"file":"workspace-preferences.js","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAIlD,+DAAsC;AACtC,wCAQkB;AAElB,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,oBAAqB,SAAQ,sBAAW;IAArD;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA6IhE,CAAC;IA3IC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAuC,EACvC,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE;YAChD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,SAAiB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,EAAE,EAAE;YACnE,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,SAA8D,EAAE,EAChE,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,IAAI,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE;YAC/C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,SAAiB,EACjB,IAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AA9ID,oDA8IC;AAutBD,oBAAoB,CAAC,MAAM,GAAG,eAAM,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workspace-preferences.mjs","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;
|
|
1
|
+
{"version":3,"file":"workspace-preferences.mjs","sourceRoot":"","sources":["../../src/resources/workspace-preferences/workspace-preferences.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAOL,MAAM,GACP,qBAAiB;AAElB,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,oBAAqB,SAAQ,WAAW;IAArD;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA6IhE,CAAC;IA3IC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,MAAuC,EACvC,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,CAAC;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE;YAChD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,SAAiB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,yBAAyB,SAAS,EAAE,EAAE;YACnE,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,SAA8D,EAAE,EAChE,OAAwB;QAExB,MAAM,EACJ,iBAAiB,EAAE,cAAc,EACjC,0BAA0B,EAAE,sBAAsB,EAClD,GAAG,IAAI,EACR,GAAG,MAAM,IAAI,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE;YAC/C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,sBAAsB,IAAI,IAAI,CAAC,CAAC;wBAClC,EAAE,0BAA0B,EAAE,sBAAsB,EAAE;wBACxD,CAAC,CAAC,SAAS,CAAC;iBACb;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,OAAO,CACL,SAAiB,EACjB,IAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AAutBD,oBAAoB,CAAC,MAAM,GAAG,MAAM,CAAC"}
|
|
@@ -132,6 +132,14 @@ export interface TopicDigestScheduleResponse {
|
|
|
132
132
|
/**
|
|
133
133
|
* The schedule's identifier, assigned by the server. This is the value the
|
|
134
134
|
* `/digests/schedules/{schedule_id}` endpoints are keyed by.
|
|
135
|
+
*
|
|
136
|
+
* Two formats are in circulation and only one is safe to drop into a URL.
|
|
137
|
+
* Schedules created through the API are `sch_01m26xfcn3endt3nxy4e2kx2rh` and need
|
|
138
|
+
* no encoding. Schedules created in the Preferences Editor before that format are
|
|
139
|
+
* `sch/{uuid}` and contain a literal `/`, so they must be URL-encoded as
|
|
140
|
+
* `sch%2F{uuid}` — unencoded, the path does not match the route and the response
|
|
141
|
+
* is a bare `404` that reads like a broken endpoint. Existing ids are never
|
|
142
|
+
* migrated.
|
|
135
143
|
*/
|
|
136
144
|
schedule_id: string;
|
|
137
145
|
|
|
@@ -322,6 +322,15 @@ export interface CreateJourneyRequest {
|
|
|
322
322
|
|
|
323
323
|
nodes: Array<JourneyNode>;
|
|
324
324
|
|
|
325
|
+
/**
|
|
326
|
+
* Cancelation token stored on the journey definition. It tags every run the
|
|
327
|
+
* journey creates so that `POST /journeys/cancel` can later cancel those runs by
|
|
328
|
+
* token. Accepts a templated string such as `order-{{data.order_id}}`, which is
|
|
329
|
+
* resolved per run when the journey is invoked. On a replace, omitting this field
|
|
330
|
+
* preserves any existing token and sending a value replaces it.
|
|
331
|
+
*/
|
|
332
|
+
cancelation_token?: string;
|
|
333
|
+
|
|
325
334
|
enabled?: boolean;
|
|
326
335
|
|
|
327
336
|
/**
|
|
@@ -858,6 +867,13 @@ export interface JourneyPublishRequest {
|
|
|
858
867
|
export interface JourneyResponse {
|
|
859
868
|
id: string;
|
|
860
869
|
|
|
870
|
+
/**
|
|
871
|
+
* The journey cancelation token, or null when none is set. A token authored in the
|
|
872
|
+
* dashboard is returned in its raw templated form, such as
|
|
873
|
+
* `order-{{data.order_id}}`, so it can be read back and asserted.
|
|
874
|
+
*/
|
|
875
|
+
cancelation_token: string | null;
|
|
876
|
+
|
|
861
877
|
created: number | null;
|
|
862
878
|
|
|
863
879
|
creator: string | null;
|
|
@@ -1612,6 +1628,15 @@ export interface JourneyCreateParams {
|
|
|
1612
1628
|
*/
|
|
1613
1629
|
nodes: Array<JourneyNode>;
|
|
1614
1630
|
|
|
1631
|
+
/**
|
|
1632
|
+
* Body param: Cancelation token stored on the journey definition. It tags every
|
|
1633
|
+
* run the journey creates so that `POST /journeys/cancel` can later cancel those
|
|
1634
|
+
* runs by token. Accepts a templated string such as `order-{{data.order_id}}`,
|
|
1635
|
+
* which is resolved per run when the journey is invoked. On a replace, omitting
|
|
1636
|
+
* this field preserves any existing token and sending a value replaces it.
|
|
1637
|
+
*/
|
|
1638
|
+
cancelation_token?: string;
|
|
1639
|
+
|
|
1615
1640
|
/**
|
|
1616
1641
|
* Body param
|
|
1617
1642
|
*/
|
|
@@ -1790,6 +1815,15 @@ export interface JourneyReplaceParams {
|
|
|
1790
1815
|
|
|
1791
1816
|
nodes: Array<JourneyNode>;
|
|
1792
1817
|
|
|
1818
|
+
/**
|
|
1819
|
+
* Cancelation token stored on the journey definition. It tags every run the
|
|
1820
|
+
* journey creates so that `POST /journeys/cancel` can later cancel those runs by
|
|
1821
|
+
* token. Accepts a templated string such as `order-{{data.order_id}}`, which is
|
|
1822
|
+
* resolved per run when the journey is invoked. On a replace, omitting this field
|
|
1823
|
+
* preserves any existing token and sending a value replaces it.
|
|
1824
|
+
*/
|
|
1825
|
+
cancelation_token?: string;
|
|
1826
|
+
|
|
1793
1827
|
enabled?: boolean;
|
|
1794
1828
|
|
|
1795
1829
|
/**
|
package/src/resources/shared.ts
CHANGED
|
@@ -184,9 +184,22 @@ export interface ElementalActionNode extends ElementalBaseNode {
|
|
|
184
184
|
padding?: string | null;
|
|
185
185
|
|
|
186
186
|
/**
|
|
187
|
-
*
|
|
188
|
-
|
|
189
|
-
|
|
187
|
+
* How prominent the action should be. `button` is the default, `secondary` and
|
|
188
|
+
* `tertiary` are the other two button styles, and `link` renders as inline text
|
|
189
|
+
* rather than a button.
|
|
190
|
+
*
|
|
191
|
+
* Each channel draws these as closely as its medium allows. Email fills `button`,
|
|
192
|
+
* outlines `secondary`, and underlines `tertiary`. The in-app Inbox fills
|
|
193
|
+
* `button`, outlines `secondary`, and draws `tertiary` as a solid button. Slack
|
|
194
|
+
* renders all three as Block Kit buttons, with `secondary` in Slack's `primary`
|
|
195
|
+
* style and `tertiary` in its `danger` style.
|
|
196
|
+
*
|
|
197
|
+
* `background_color` is the fill for `button`, and the border and label color for
|
|
198
|
+
* `secondary`. For `tertiary` it colors the underline and label in email and the
|
|
199
|
+
* fill in the Inbox. It does not apply to `link`. An Inbox theme that sets its own
|
|
200
|
+
* action colors takes precedence over the template.
|
|
201
|
+
*/
|
|
202
|
+
style?: 'button' | 'secondary' | 'tertiary' | 'link' | null;
|
|
190
203
|
}
|
|
191
204
|
|
|
192
205
|
/**
|
|
@@ -242,8 +242,13 @@ export interface TopicPreference {
|
|
|
242
242
|
/**
|
|
243
243
|
* The digest schedule this recipient is on for the topic. Omitted rather than null
|
|
244
244
|
* when they have not chosen one, in which case the topic's default schedule
|
|
245
|
-
* applies. Ids come from the topic's digest configuration
|
|
246
|
-
*
|
|
245
|
+
* applies. Ids come from the topic's digest configuration, returned on any read of
|
|
246
|
+
* the topic.
|
|
247
|
+
*
|
|
248
|
+
* Also omitted when the schedule they chose has since been deleted or disabled:
|
|
249
|
+
* the recipient is on the topic's default from that point on, which is how a send
|
|
250
|
+
* already resolves it, so the field reports what would actually be used rather
|
|
251
|
+
* than a dead id.
|
|
247
252
|
*/
|
|
248
253
|
digest_schedule_id?: string;
|
|
249
254
|
|
|
@@ -220,15 +220,20 @@ export interface TopicCreateParams {
|
|
|
220
220
|
description?: string | null;
|
|
221
221
|
|
|
222
222
|
/**
|
|
223
|
-
* Body param: A topic's digest
|
|
224
|
-
* cadences it delivers on, and how collected events
|
|
223
|
+
* Body param: A topic's digest, as supplied when the topic itself is created: the
|
|
224
|
+
* template that renders it, the cadences it delivers on, and how collected events
|
|
225
|
+
* are retained.
|
|
226
|
+
*
|
|
227
|
+
* Identical to `TopicDigestRequest`, which a replace uses, except that `schedules`
|
|
228
|
+
* is required — a topic being created has no stored schedules for an absent key to
|
|
229
|
+
* leave alone.
|
|
225
230
|
*
|
|
226
231
|
* Send `null` for the whole object to turn a digest off, which unlinks the
|
|
227
232
|
* template and removes its schedules. There is no `enabled` flag, and
|
|
228
233
|
* `schedules: []` is rejected, because both states are un-deliverable rather than
|
|
229
234
|
* merely off.
|
|
230
235
|
*/
|
|
231
|
-
digest?:
|
|
236
|
+
digest?: TopicCreateParams.Digest | null;
|
|
232
237
|
|
|
233
238
|
/**
|
|
234
239
|
* Body param: Whether to include a list-unsubscribe header on emails for this
|
|
@@ -266,6 +271,65 @@ export interface TopicCreateParams {
|
|
|
266
271
|
'x-idempotency-expiration'?: string;
|
|
267
272
|
}
|
|
268
273
|
|
|
274
|
+
export namespace TopicCreateParams {
|
|
275
|
+
/**
|
|
276
|
+
* A topic's digest, as supplied when the topic itself is created: the template
|
|
277
|
+
* that renders it, the cadences it delivers on, and how collected events are
|
|
278
|
+
* retained.
|
|
279
|
+
*
|
|
280
|
+
* Identical to `TopicDigestRequest`, which a replace uses, except that `schedules`
|
|
281
|
+
* is required — a topic being created has no stored schedules for an absent key to
|
|
282
|
+
* leave alone.
|
|
283
|
+
*
|
|
284
|
+
* Send `null` for the whole object to turn a digest off, which unlinks the
|
|
285
|
+
* template and removes its schedules. There is no `enabled` flag, and
|
|
286
|
+
* `schedules: []` is rejected, because both states are un-deliverable rather than
|
|
287
|
+
* merely off.
|
|
288
|
+
*/
|
|
289
|
+
export interface Digest {
|
|
290
|
+
/**
|
|
291
|
+
* The cadences this digest delivers on.
|
|
292
|
+
*
|
|
293
|
+
* The array replaces the stored schedules wholesale, so a schedule you leave out
|
|
294
|
+
* of it is deleted along with its delivery rule. Omit the key entirely to leave
|
|
295
|
+
* the stored schedules untouched — useful for changing `template_id` or
|
|
296
|
+
* `categories` without restating every schedule.
|
|
297
|
+
*
|
|
298
|
+
* A digest must end up with at least one schedule, because one with none collects
|
|
299
|
+
* events into an instance that can never fire. So sending `[]` is always a `400`,
|
|
300
|
+
* and so is omitting the key on a topic that has no schedules stored yet.
|
|
301
|
+
*
|
|
302
|
+
* On **create** the key is required outright: a topic being created has nothing
|
|
303
|
+
* stored to leave alone, and the topic row is written before its digest, so
|
|
304
|
+
* rejecting it any later would leave the topic behind and let a retry duplicate
|
|
305
|
+
* it.
|
|
306
|
+
*/
|
|
307
|
+
schedules: Array<WorkspacePreferencesAPI.TopicDigestScheduleRequest>;
|
|
308
|
+
|
|
309
|
+
/**
|
|
310
|
+
* The notification template that renders the digest. A digest with no template
|
|
311
|
+
* collects nothing, so this is required.
|
|
312
|
+
*/
|
|
313
|
+
template_id: string;
|
|
314
|
+
|
|
315
|
+
/**
|
|
316
|
+
* Optional audience the digest is scoped to.
|
|
317
|
+
*/
|
|
318
|
+
audience_id?: string;
|
|
319
|
+
|
|
320
|
+
/**
|
|
321
|
+
* Retention rules per category key. Defaults to a single `digest` category
|
|
322
|
+
* retaining `FIRST`.
|
|
323
|
+
*/
|
|
324
|
+
categories?: Array<WorkspacePreferencesAPI.TopicDigestCategory>;
|
|
325
|
+
|
|
326
|
+
/**
|
|
327
|
+
* Whether to deliver the digest even when nothing was collected.
|
|
328
|
+
*/
|
|
329
|
+
trigger_empty?: boolean;
|
|
330
|
+
}
|
|
331
|
+
}
|
|
332
|
+
|
|
269
333
|
export interface TopicRetrieveParams {
|
|
270
334
|
/**
|
|
271
335
|
* Id of the workspace preference.
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
3
|
import { APIResource } from '../../core/resource';
|
|
4
|
+
import * as WorkspacePreferencesAPI from './workspace-preferences';
|
|
4
5
|
import * as Shared from '../shared';
|
|
5
6
|
import * as DigestsAPI from '../digests/digests';
|
|
6
7
|
import * as TopicsAPI from './topics';
|
|
@@ -282,13 +283,6 @@ export interface TopicDigestReleaseRequest {
|
|
|
282
283
|
* merely off.
|
|
283
284
|
*/
|
|
284
285
|
export interface TopicDigestRequest {
|
|
285
|
-
/**
|
|
286
|
-
* The cadences this digest delivers on. At least one is required: a digest with no
|
|
287
|
-
* schedule collects events into an instance that can never fire. Omitting the key
|
|
288
|
-
* on a replace leaves stored schedules untouched; sending `[]` is a `400`.
|
|
289
|
-
*/
|
|
290
|
-
schedules: Array<TopicDigestScheduleRequest>;
|
|
291
|
-
|
|
292
286
|
/**
|
|
293
287
|
* The notification template that renders the digest. A digest with no template
|
|
294
288
|
* collects nothing, so this is required.
|
|
@@ -306,6 +300,25 @@ export interface TopicDigestRequest {
|
|
|
306
300
|
*/
|
|
307
301
|
categories?: Array<TopicDigestCategory>;
|
|
308
302
|
|
|
303
|
+
/**
|
|
304
|
+
* The cadences this digest delivers on.
|
|
305
|
+
*
|
|
306
|
+
* The array replaces the stored schedules wholesale, so a schedule you leave out
|
|
307
|
+
* of it is deleted along with its delivery rule. Omit the key entirely to leave
|
|
308
|
+
* the stored schedules untouched — useful for changing `template_id` or
|
|
309
|
+
* `categories` without restating every schedule.
|
|
310
|
+
*
|
|
311
|
+
* A digest must end up with at least one schedule, because one with none collects
|
|
312
|
+
* events into an instance that can never fire. So sending `[]` is always a `400`,
|
|
313
|
+
* and so is omitting the key on a topic that has no schedules stored yet.
|
|
314
|
+
*
|
|
315
|
+
* On **create** the key is required outright: a topic being created has nothing
|
|
316
|
+
* stored to leave alone, and the topic row is written before its digest, so
|
|
317
|
+
* rejecting it any later would leave the topic behind and let a retry duplicate
|
|
318
|
+
* it.
|
|
319
|
+
*/
|
|
320
|
+
schedules?: Array<TopicDigestScheduleRequest>;
|
|
321
|
+
|
|
309
322
|
/**
|
|
310
323
|
* Whether to deliver the digest even when nothing was collected.
|
|
311
324
|
*/
|
|
@@ -357,6 +370,12 @@ export interface TopicDigestResponse {
|
|
|
357
370
|
* existing schedule in place; omit it and one is assigned and returned. The
|
|
358
371
|
* `schedules` array is a full replacement, so a stored schedule absent from it is
|
|
359
372
|
* deleted along with its delivery rule.
|
|
373
|
+
*
|
|
374
|
+
* Updating by `schedule_id` replaces that schedule rather than merging into it:
|
|
375
|
+
* any field you leave out is cleared. Two of those change delivery silently — an
|
|
376
|
+
* omitted `timezone` reverts the schedule to UTC, and an omitted `is_default` can
|
|
377
|
+
* leave the topic with no default schedule, which is what recipients who have not
|
|
378
|
+
* chosen one fall back to. Restate every field you want to keep.
|
|
360
379
|
*/
|
|
361
380
|
export interface TopicDigestScheduleRequest {
|
|
362
381
|
/**
|
|
@@ -550,15 +569,20 @@ export interface WorkspacePreferenceTopicCreateRequest {
|
|
|
550
569
|
description?: string | null;
|
|
551
570
|
|
|
552
571
|
/**
|
|
553
|
-
* A topic's digest
|
|
554
|
-
* delivers on, and how collected events are
|
|
572
|
+
* A topic's digest, as supplied when the topic itself is created: the template
|
|
573
|
+
* that renders it, the cadences it delivers on, and how collected events are
|
|
574
|
+
* retained.
|
|
575
|
+
*
|
|
576
|
+
* Identical to `TopicDigestRequest`, which a replace uses, except that `schedules`
|
|
577
|
+
* is required — a topic being created has no stored schedules for an absent key to
|
|
578
|
+
* leave alone.
|
|
555
579
|
*
|
|
556
580
|
* Send `null` for the whole object to turn a digest off, which unlinks the
|
|
557
581
|
* template and removes its schedules. There is no `enabled` flag, and
|
|
558
582
|
* `schedules: []` is rejected, because both states are un-deliverable rather than
|
|
559
583
|
* merely off.
|
|
560
584
|
*/
|
|
561
|
-
digest?:
|
|
585
|
+
digest?: WorkspacePreferenceTopicCreateRequest.Digest | null;
|
|
562
586
|
|
|
563
587
|
/**
|
|
564
588
|
* Whether to include a list-unsubscribe header on emails for this topic.
|
|
@@ -576,6 +600,65 @@ export interface WorkspacePreferenceTopicCreateRequest {
|
|
|
576
600
|
topic_data?: { [key: string]: unknown } | null;
|
|
577
601
|
}
|
|
578
602
|
|
|
603
|
+
export namespace WorkspacePreferenceTopicCreateRequest {
|
|
604
|
+
/**
|
|
605
|
+
* A topic's digest, as supplied when the topic itself is created: the template
|
|
606
|
+
* that renders it, the cadences it delivers on, and how collected events are
|
|
607
|
+
* retained.
|
|
608
|
+
*
|
|
609
|
+
* Identical to `TopicDigestRequest`, which a replace uses, except that `schedules`
|
|
610
|
+
* is required — a topic being created has no stored schedules for an absent key to
|
|
611
|
+
* leave alone.
|
|
612
|
+
*
|
|
613
|
+
* Send `null` for the whole object to turn a digest off, which unlinks the
|
|
614
|
+
* template and removes its schedules. There is no `enabled` flag, and
|
|
615
|
+
* `schedules: []` is rejected, because both states are un-deliverable rather than
|
|
616
|
+
* merely off.
|
|
617
|
+
*/
|
|
618
|
+
export interface Digest {
|
|
619
|
+
/**
|
|
620
|
+
* The cadences this digest delivers on.
|
|
621
|
+
*
|
|
622
|
+
* The array replaces the stored schedules wholesale, so a schedule you leave out
|
|
623
|
+
* of it is deleted along with its delivery rule. Omit the key entirely to leave
|
|
624
|
+
* the stored schedules untouched — useful for changing `template_id` or
|
|
625
|
+
* `categories` without restating every schedule.
|
|
626
|
+
*
|
|
627
|
+
* A digest must end up with at least one schedule, because one with none collects
|
|
628
|
+
* events into an instance that can never fire. So sending `[]` is always a `400`,
|
|
629
|
+
* and so is omitting the key on a topic that has no schedules stored yet.
|
|
630
|
+
*
|
|
631
|
+
* On **create** the key is required outright: a topic being created has nothing
|
|
632
|
+
* stored to leave alone, and the topic row is written before its digest, so
|
|
633
|
+
* rejecting it any later would leave the topic behind and let a retry duplicate
|
|
634
|
+
* it.
|
|
635
|
+
*/
|
|
636
|
+
schedules: Array<WorkspacePreferencesAPI.TopicDigestScheduleRequest>;
|
|
637
|
+
|
|
638
|
+
/**
|
|
639
|
+
* The notification template that renders the digest. A digest with no template
|
|
640
|
+
* collects nothing, so this is required.
|
|
641
|
+
*/
|
|
642
|
+
template_id: string;
|
|
643
|
+
|
|
644
|
+
/**
|
|
645
|
+
* Optional audience the digest is scoped to.
|
|
646
|
+
*/
|
|
647
|
+
audience_id?: string;
|
|
648
|
+
|
|
649
|
+
/**
|
|
650
|
+
* Retention rules per category key. Defaults to a single `digest` category
|
|
651
|
+
* retaining `FIRST`.
|
|
652
|
+
*/
|
|
653
|
+
categories?: Array<WorkspacePreferencesAPI.TopicDigestCategory>;
|
|
654
|
+
|
|
655
|
+
/**
|
|
656
|
+
* Whether to deliver the digest even when nothing was collected.
|
|
657
|
+
*/
|
|
658
|
+
trigger_empty?: boolean;
|
|
659
|
+
}
|
|
660
|
+
}
|
|
661
|
+
|
|
579
662
|
/**
|
|
580
663
|
* A subscription preference topic in your workspace.
|
|
581
664
|
*/
|
package/src/version.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '9.
|
|
1
|
+
export const VERSION = '9.8.0'; // x-release-please-version
|
package/version.d.mts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "9.
|
|
1
|
+
export declare const VERSION = "9.8.0";
|
|
2
2
|
//# sourceMappingURL=version.d.mts.map
|
package/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const VERSION = "9.
|
|
1
|
+
export declare const VERSION = "9.8.0";
|
|
2
2
|
//# sourceMappingURL=version.d.ts.map
|
package/version.js
CHANGED
package/version.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export const VERSION = '9.
|
|
1
|
+
export const VERSION = '9.8.0'; // x-release-please-version
|
|
2
2
|
//# sourceMappingURL=version.mjs.map
|