sequenzy 2.1.10 → 2.1.12
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/dist/cjs/api/resources/analytics/types/GetSequenceMetricsResponse.d.ts +1 -0
- package/dist/cjs/api/resources/sequences/client/Client.d.ts +52 -3
- package/dist/cjs/api/resources/sequences/client/Client.js +164 -3
- package/dist/cjs/api/resources/sequences/client/requests/ListEnrollmentsSequencesRequest.d.ts +1 -1
- package/dist/cjs/api/resources/sequences/client/requests/SequenceEnrollmentCancelRequest.d.ts +1 -1
- package/dist/cjs/api/resources/sequences/client/requests/SequenceEnrollmentPauseRequest.d.ts +24 -0
- package/dist/cjs/api/resources/sequences/client/requests/SequenceEnrollmentPauseRequest.js +3 -0
- package/dist/cjs/api/resources/sequences/client/requests/SequenceEnrollmentResumeRequest.d.ts +15 -0
- package/dist/cjs/api/resources/sequences/client/requests/SequenceEnrollmentResumeRequest.js +3 -0
- package/dist/cjs/api/resources/sequences/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/sequences/types/GetStatsSequencesResponse.d.ts +1 -0
- package/dist/cjs/api/types/Company.d.ts +1 -1
- package/dist/cjs/api/types/SequenceEnrollmentCancelResponse.d.ts +1 -1
- package/dist/cjs/api/types/SequenceEnrollmentGetResponseEnrollment.d.ts +6 -1
- package/dist/cjs/api/types/SequenceEnrollmentGetResponseEnrollmentStatus.d.ts +2 -0
- package/dist/cjs/api/types/SequenceEnrollmentGetResponseEnrollmentStatus.js +2 -0
- package/dist/cjs/api/types/SequenceEnrollmentListResponseEnrollmentsItem.d.ts +6 -1
- package/dist/cjs/api/types/SequenceEnrollmentListResponseEnrollmentsItemStatus.d.ts +2 -0
- package/dist/cjs/api/types/SequenceEnrollmentListResponseEnrollmentsItemStatus.js +2 -0
- package/dist/cjs/api/types/SequenceEnrollmentPauseItem.d.ts +16 -0
- package/dist/cjs/api/types/SequenceEnrollmentPauseItem.js +3 -0
- package/dist/cjs/api/types/SequenceEnrollmentPauseItemOutcome.d.ts +9 -0
- package/dist/cjs/api/types/SequenceEnrollmentPauseItemOutcome.js +12 -0
- package/dist/cjs/api/types/SequenceEnrollmentPauseItemStatus.d.ts +7 -0
- package/dist/cjs/api/types/SequenceEnrollmentPauseItemStatus.js +10 -0
- package/dist/cjs/api/types/SequenceEnrollmentPauseResponse.d.ts +9 -0
- package/dist/cjs/api/types/SequenceEnrollmentPauseResponse.js +3 -0
- package/dist/cjs/api/types/SequenceEnrollmentPauseResultBase.d.ts +11 -0
- package/dist/cjs/api/types/SequenceEnrollmentPauseResultBase.js +3 -0
- package/dist/cjs/api/types/SequenceEnrollmentPauseResultBaseNotEnrolledItem.d.ts +4 -0
- package/dist/cjs/api/types/SequenceEnrollmentPauseResultBaseNotEnrolledItem.js +3 -0
- package/dist/cjs/api/types/SequenceEnrollmentPauseResultBaseNotFound.d.ts +4 -0
- package/dist/cjs/api/types/SequenceEnrollmentPauseResultBaseNotFound.js +3 -0
- package/dist/cjs/api/types/SequenceEnrollmentResumeResponse.d.ts +13 -0
- package/dist/cjs/api/types/SequenceEnrollmentResumeResponse.js +3 -0
- package/dist/cjs/api/types/SequenceEnrollmentResumeResponseEnqueueErrorsItem.d.ts +4 -0
- package/dist/cjs/api/types/SequenceEnrollmentResumeResponseEnqueueErrorsItem.js +3 -0
- package/dist/cjs/api/types/SequencePausedEnrollmentCounts.d.ts +10 -0
- package/dist/cjs/api/types/SequencePausedEnrollmentCounts.js +3 -0
- package/dist/cjs/api/types/SequencePausedEnrollmentCountsByCurrentNodeItem.d.ts +6 -0
- package/dist/cjs/api/types/SequencePausedEnrollmentCountsByCurrentNodeItem.js +3 -0
- package/dist/cjs/api/types/SubscriberSequenceEnrollment.d.ts +1 -0
- package/dist/cjs/api/types/index.d.ts +11 -0
- package/dist/cjs/api/types/index.js +11 -0
- package/dist/cjs/serialization/resources/analytics/types/GetSequenceMetricsResponse.d.ts +2 -0
- package/dist/cjs/serialization/resources/analytics/types/GetSequenceMetricsResponse.js +2 -0
- package/dist/cjs/serialization/resources/sequences/client/requests/SequenceEnrollmentPauseRequest.d.ts +11 -0
- package/dist/cjs/serialization/resources/sequences/client/requests/SequenceEnrollmentPauseRequest.js +33 -0
- package/dist/cjs/serialization/resources/sequences/client/requests/SequenceEnrollmentResumeRequest.d.ts +10 -0
- package/dist/cjs/serialization/resources/sequences/client/requests/SequenceEnrollmentResumeRequest.js +32 -0
- package/dist/cjs/serialization/resources/sequences/client/requests/index.d.ts +2 -0
- package/dist/cjs/serialization/resources/sequences/client/requests/index.js +5 -1
- package/dist/cjs/serialization/resources/sequences/types/GetStatsSequencesResponse.d.ts +2 -0
- package/dist/cjs/serialization/resources/sequences/types/GetStatsSequencesResponse.js +2 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentGetResponseEnrollment.d.ts +2 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentGetResponseEnrollment.js +2 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentGetResponseEnrollmentStatus.d.ts +1 -1
- package/dist/cjs/serialization/types/SequenceEnrollmentGetResponseEnrollmentStatus.js +1 -1
- package/dist/cjs/serialization/types/SequenceEnrollmentListResponseEnrollmentsItem.d.ts +2 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentListResponseEnrollmentsItem.js +2 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentListResponseEnrollmentsItemStatus.d.ts +1 -1
- package/dist/cjs/serialization/types/SequenceEnrollmentListResponseEnrollmentsItemStatus.js +1 -1
- package/dist/cjs/serialization/types/SequenceEnrollmentPauseItem.d.ts +18 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentPauseItem.js +40 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentPauseItemOutcome.d.ts +7 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentPauseItemOutcome.js +29 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentPauseItemStatus.d.ts +7 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentPauseItemStatus.js +29 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentPauseResponse.d.ts +12 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentPauseResponse.js +36 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentPauseResultBase.d.ts +17 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentPauseResultBase.js +39 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentPauseResultBaseNotEnrolledItem.d.ts +10 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentPauseResultBaseNotEnrolledItem.js +32 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentPauseResultBaseNotFound.d.ts +10 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentPauseResultBaseNotFound.js +32 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentResumeResponse.d.ts +15 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentResumeResponse.js +39 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentResumeResponseEnqueueErrorsItem.d.ts +10 -0
- package/dist/cjs/serialization/types/SequenceEnrollmentResumeResponseEnqueueErrorsItem.js +32 -0
- package/dist/cjs/serialization/types/SequencePausedEnrollmentCounts.d.ts +11 -0
- package/dist/cjs/serialization/types/SequencePausedEnrollmentCounts.js +33 -0
- package/dist/cjs/serialization/types/SequencePausedEnrollmentCountsByCurrentNodeItem.d.ts +11 -0
- package/dist/cjs/serialization/types/SequencePausedEnrollmentCountsByCurrentNodeItem.js +33 -0
- package/dist/cjs/serialization/types/index.d.ts +11 -0
- package/dist/cjs/serialization/types/index.js +11 -0
- package/dist/esm/api/resources/analytics/types/GetSequenceMetricsResponse.d.ts +1 -0
- package/dist/esm/api/resources/sequences/client/Client.d.ts +52 -3
- package/dist/esm/api/resources/sequences/client/Client.js +164 -3
- package/dist/esm/api/resources/sequences/client/requests/ListEnrollmentsSequencesRequest.d.ts +1 -1
- package/dist/esm/api/resources/sequences/client/requests/SequenceEnrollmentCancelRequest.d.ts +1 -1
- package/dist/esm/api/resources/sequences/client/requests/SequenceEnrollmentPauseRequest.d.ts +24 -0
- package/dist/esm/api/resources/sequences/client/requests/SequenceEnrollmentPauseRequest.js +2 -0
- package/dist/esm/api/resources/sequences/client/requests/SequenceEnrollmentResumeRequest.d.ts +15 -0
- package/dist/esm/api/resources/sequences/client/requests/SequenceEnrollmentResumeRequest.js +2 -0
- package/dist/esm/api/resources/sequences/client/requests/index.d.ts +2 -0
- package/dist/esm/api/resources/sequences/types/GetStatsSequencesResponse.d.ts +1 -0
- package/dist/esm/api/types/Company.d.ts +1 -1
- package/dist/esm/api/types/SequenceEnrollmentCancelResponse.d.ts +1 -1
- package/dist/esm/api/types/SequenceEnrollmentGetResponseEnrollment.d.ts +6 -1
- package/dist/esm/api/types/SequenceEnrollmentGetResponseEnrollmentStatus.d.ts +2 -0
- package/dist/esm/api/types/SequenceEnrollmentGetResponseEnrollmentStatus.js +2 -0
- package/dist/esm/api/types/SequenceEnrollmentListResponseEnrollmentsItem.d.ts +6 -1
- package/dist/esm/api/types/SequenceEnrollmentListResponseEnrollmentsItemStatus.d.ts +2 -0
- package/dist/esm/api/types/SequenceEnrollmentListResponseEnrollmentsItemStatus.js +2 -0
- package/dist/esm/api/types/SequenceEnrollmentPauseItem.d.ts +16 -0
- package/dist/esm/api/types/SequenceEnrollmentPauseItem.js +2 -0
- package/dist/esm/api/types/SequenceEnrollmentPauseItemOutcome.d.ts +9 -0
- package/dist/esm/api/types/SequenceEnrollmentPauseItemOutcome.js +9 -0
- package/dist/esm/api/types/SequenceEnrollmentPauseItemStatus.d.ts +7 -0
- package/dist/esm/api/types/SequenceEnrollmentPauseItemStatus.js +7 -0
- package/dist/esm/api/types/SequenceEnrollmentPauseResponse.d.ts +9 -0
- package/dist/esm/api/types/SequenceEnrollmentPauseResponse.js +2 -0
- package/dist/esm/api/types/SequenceEnrollmentPauseResultBase.d.ts +11 -0
- package/dist/esm/api/types/SequenceEnrollmentPauseResultBase.js +2 -0
- package/dist/esm/api/types/SequenceEnrollmentPauseResultBaseNotEnrolledItem.d.ts +4 -0
- package/dist/esm/api/types/SequenceEnrollmentPauseResultBaseNotEnrolledItem.js +2 -0
- package/dist/esm/api/types/SequenceEnrollmentPauseResultBaseNotFound.d.ts +4 -0
- package/dist/esm/api/types/SequenceEnrollmentPauseResultBaseNotFound.js +2 -0
- package/dist/esm/api/types/SequenceEnrollmentResumeResponse.d.ts +13 -0
- package/dist/esm/api/types/SequenceEnrollmentResumeResponse.js +2 -0
- package/dist/esm/api/types/SequenceEnrollmentResumeResponseEnqueueErrorsItem.d.ts +4 -0
- package/dist/esm/api/types/SequenceEnrollmentResumeResponseEnqueueErrorsItem.js +2 -0
- package/dist/esm/api/types/SequencePausedEnrollmentCounts.d.ts +10 -0
- package/dist/esm/api/types/SequencePausedEnrollmentCounts.js +2 -0
- package/dist/esm/api/types/SequencePausedEnrollmentCountsByCurrentNodeItem.d.ts +6 -0
- package/dist/esm/api/types/SequencePausedEnrollmentCountsByCurrentNodeItem.js +2 -0
- package/dist/esm/api/types/SubscriberSequenceEnrollment.d.ts +1 -0
- package/dist/esm/api/types/index.d.ts +11 -0
- package/dist/esm/api/types/index.js +11 -0
- package/dist/esm/serialization/resources/analytics/types/GetSequenceMetricsResponse.d.ts +2 -0
- package/dist/esm/serialization/resources/analytics/types/GetSequenceMetricsResponse.js +2 -0
- package/dist/esm/serialization/resources/sequences/client/requests/SequenceEnrollmentPauseRequest.d.ts +11 -0
- package/dist/esm/serialization/resources/sequences/client/requests/SequenceEnrollmentPauseRequest.js +7 -0
- package/dist/esm/serialization/resources/sequences/client/requests/SequenceEnrollmentResumeRequest.d.ts +10 -0
- package/dist/esm/serialization/resources/sequences/client/requests/SequenceEnrollmentResumeRequest.js +6 -0
- package/dist/esm/serialization/resources/sequences/client/requests/index.d.ts +2 -0
- package/dist/esm/serialization/resources/sequences/client/requests/index.js +2 -0
- package/dist/esm/serialization/resources/sequences/types/GetStatsSequencesResponse.d.ts +2 -0
- package/dist/esm/serialization/resources/sequences/types/GetStatsSequencesResponse.js +2 -0
- package/dist/esm/serialization/types/SequenceEnrollmentGetResponseEnrollment.d.ts +2 -0
- package/dist/esm/serialization/types/SequenceEnrollmentGetResponseEnrollment.js +2 -0
- package/dist/esm/serialization/types/SequenceEnrollmentGetResponseEnrollmentStatus.d.ts +1 -1
- package/dist/esm/serialization/types/SequenceEnrollmentGetResponseEnrollmentStatus.js +1 -1
- package/dist/esm/serialization/types/SequenceEnrollmentListResponseEnrollmentsItem.d.ts +2 -0
- package/dist/esm/serialization/types/SequenceEnrollmentListResponseEnrollmentsItem.js +2 -0
- package/dist/esm/serialization/types/SequenceEnrollmentListResponseEnrollmentsItemStatus.d.ts +1 -1
- package/dist/esm/serialization/types/SequenceEnrollmentListResponseEnrollmentsItemStatus.js +1 -1
- package/dist/esm/serialization/types/SequenceEnrollmentPauseItem.d.ts +18 -0
- package/dist/esm/serialization/types/SequenceEnrollmentPauseItem.js +14 -0
- package/dist/esm/serialization/types/SequenceEnrollmentPauseItemOutcome.d.ts +7 -0
- package/dist/esm/serialization/types/SequenceEnrollmentPauseItemOutcome.js +3 -0
- package/dist/esm/serialization/types/SequenceEnrollmentPauseItemStatus.d.ts +7 -0
- package/dist/esm/serialization/types/SequenceEnrollmentPauseItemStatus.js +3 -0
- package/dist/esm/serialization/types/SequenceEnrollmentPauseResponse.d.ts +12 -0
- package/dist/esm/serialization/types/SequenceEnrollmentPauseResponse.js +10 -0
- package/dist/esm/serialization/types/SequenceEnrollmentPauseResultBase.d.ts +17 -0
- package/dist/esm/serialization/types/SequenceEnrollmentPauseResultBase.js +13 -0
- package/dist/esm/serialization/types/SequenceEnrollmentPauseResultBaseNotEnrolledItem.d.ts +10 -0
- package/dist/esm/serialization/types/SequenceEnrollmentPauseResultBaseNotEnrolledItem.js +6 -0
- package/dist/esm/serialization/types/SequenceEnrollmentPauseResultBaseNotFound.d.ts +10 -0
- package/dist/esm/serialization/types/SequenceEnrollmentPauseResultBaseNotFound.js +6 -0
- package/dist/esm/serialization/types/SequenceEnrollmentResumeResponse.d.ts +15 -0
- package/dist/esm/serialization/types/SequenceEnrollmentResumeResponse.js +13 -0
- package/dist/esm/serialization/types/SequenceEnrollmentResumeResponseEnqueueErrorsItem.d.ts +10 -0
- package/dist/esm/serialization/types/SequenceEnrollmentResumeResponseEnqueueErrorsItem.js +6 -0
- package/dist/esm/serialization/types/SequencePausedEnrollmentCounts.d.ts +11 -0
- package/dist/esm/serialization/types/SequencePausedEnrollmentCounts.js +7 -0
- package/dist/esm/serialization/types/SequencePausedEnrollmentCountsByCurrentNodeItem.d.ts +11 -0
- package/dist/esm/serialization/types/SequencePausedEnrollmentCountsByCurrentNodeItem.js +7 -0
- package/dist/esm/serialization/types/index.d.ts +11 -0
- package/dist/esm/serialization/types/index.js +11 -0
- package/package.json +1 -1
|
@@ -3,6 +3,7 @@ export interface GetSequenceMetricsResponse {
|
|
|
3
3
|
enrollmentCounts?: Sequenzy.SequenceEnrollmentCounts;
|
|
4
4
|
/** Trigger matches where the contact could not be enrolled because they are unsubscribed or bounced. Defaults to the last 30 days when no explicit time range is provided. */
|
|
5
5
|
enrollmentSkipped?: Sequenzy.GetSequenceMetricsResponseEnrollmentSkipped;
|
|
6
|
+
pausedEnrollments?: Sequenzy.SequencePausedEnrollmentCounts;
|
|
6
7
|
/** Echoed back when `period` is provided. */
|
|
7
8
|
period?: string;
|
|
8
9
|
recommendations?: Sequenzy.RecommendationMetrics;
|
|
@@ -48,7 +48,7 @@ export declare class SequencesClient {
|
|
|
48
48
|
cancelAudienceEnrollment(request: Sequenzy.CancelAudienceEnrollmentSequencesRequest, requestOptions?: SequencesClient.RequestOptions): core.HttpResponsePromise<Sequenzy.CancelAudienceEnrollmentSequencesResponse>;
|
|
49
49
|
private __cancelAudienceEnrollment;
|
|
50
50
|
/**
|
|
51
|
-
* Cancels active or
|
|
51
|
+
* Cancels active, waiting, or paused enrollments in one sequence. Target every enrollment with cancelAll, a batch with subscriberIds, one contact with subscriberId, or matching stored entry event property values with fieldValues. Bulk cancellation is capped at 1000 enrollments per request; repeat the request while remainingCount is above zero.
|
|
52
52
|
*
|
|
53
53
|
* @param {Sequenzy.SequenceEnrollmentCancelRequest} request
|
|
54
54
|
* @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -439,7 +439,7 @@ export declare class SequencesClient {
|
|
|
439
439
|
enable(request: Sequenzy.EnableSequencesRequest, requestOptions?: SequencesClient.RequestOptions): core.HttpResponsePromise<Sequenzy.SequenceActionResponse>;
|
|
440
440
|
private __enable;
|
|
441
441
|
/**
|
|
442
|
-
* Starts a background run that enrolls every active contact matching the audience (everyone, lists, a segment, a filter, or rules) into the sequence, in batches, with no per-request cap. Contacts already active or
|
|
442
|
+
* Starts a background run that enrolls every active contact matching the audience (everyone, lists, a segment, a filter, or rules) into the sequence, in batches, with no per-request cap. Contacts already active, waiting, or paused in the sequence are skipped; one_time sequences also skip contacts who completed or were cancelled before; unsubscribed and bounced contacts are never enrolled. Only one run per sequence can be queued or running at a time. The sequence must be enabled and accepting entrants. This is how a manual-trigger countdown sequence gets its audience; late enrollees skip the steps whose key date already passed.
|
|
443
443
|
*
|
|
444
444
|
* @param {Sequenzy.EnrollAudienceSequencesRequest} request
|
|
445
445
|
* @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -748,7 +748,7 @@ export declare class SequencesClient {
|
|
|
748
748
|
listEmailVariations(request: Sequenzy.ListEmailVariationsSequencesRequest, requestOptions?: SequencesClient.RequestOptions): core.HttpResponsePromise<Sequenzy.ListEmailVariationsSequencesResponse>;
|
|
749
749
|
private __listEmailVariations;
|
|
750
750
|
/**
|
|
751
|
-
* Lists the individual contacts enrolled in one sequence, with the node each one is currently sitting on. Defaults to active and
|
|
751
|
+
* Lists the individual contacts enrolled in one sequence, with the node each one is currently sitting on. Defaults to active, waiting, and paused enrollments, which is everyone still in the sequence. Use this when sequence stats give you enrollmentCounts and you need the actual subscribers behind a number.
|
|
752
752
|
*
|
|
753
753
|
* @param {Sequenzy.ListEnrollmentsSequencesRequest} request
|
|
754
754
|
* @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -844,6 +844,34 @@ export declare class SequencesClient {
|
|
|
844
844
|
*/
|
|
845
845
|
pauseEnrollments(request: Sequenzy.PauseEnrollmentsSequencesRequest, requestOptions?: SequencesClient.RequestOptions): core.HttpResponsePromise<Sequenzy.SequenceActionResponse>;
|
|
846
846
|
private __pauseEnrollments;
|
|
847
|
+
/**
|
|
848
|
+
* Holds specific contacts on the sequence step they are on. A paused enrollment gets no further steps, keeps its entry event properties and stop-condition snapshots, and still counts as enrolled, so the same contact cannot enter this sequence again while paused. Unsubscribes, bounces, and enrollment cancellation still end it. A wait-for-event step does not react while paused; an event that arrived meanwhile is picked up on resume. Applies immediately with no dry run. An enrollment whose current step is running at that moment is left alone with outcome in_progress; repeat the request shortly. To stop new contacts entering the whole sequence instead, use POST /sequences/{sequenceId}/pause-enrollments.
|
|
849
|
+
*
|
|
850
|
+
* @param {Sequenzy.SequenceEnrollmentPauseRequest} request
|
|
851
|
+
* @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
852
|
+
*
|
|
853
|
+
* @throws {@link Sequenzy.BadRequestError}
|
|
854
|
+
* @throws {@link Sequenzy.UnauthorizedError}
|
|
855
|
+
* @throws {@link Sequenzy.ForbiddenError}
|
|
856
|
+
* @throws {@link Sequenzy.NotFoundError}
|
|
857
|
+
* @throws {@link errors.SequenzyError}
|
|
858
|
+
* @throws {@link errors.SequenzyTimeoutError}
|
|
859
|
+
*
|
|
860
|
+
* @example
|
|
861
|
+
* await client.sequences.pauseSubscribers({
|
|
862
|
+
* sequenceId: "sequenceId",
|
|
863
|
+
* emails: ["ada@example.com"],
|
|
864
|
+
* reason: "Project blocked"
|
|
865
|
+
* })
|
|
866
|
+
*
|
|
867
|
+
* @example
|
|
868
|
+
* await client.sequences.pauseSubscribers({
|
|
869
|
+
* sequenceId: "sequenceId",
|
|
870
|
+
* subscriberIds: ["sub_abc123", "sub_def456"]
|
|
871
|
+
* })
|
|
872
|
+
*/
|
|
873
|
+
pauseSubscribers(request: Sequenzy.SequenceEnrollmentPauseRequest, requestOptions?: SequencesClient.RequestOptions): core.HttpResponsePromise<Sequenzy.SequenceEnrollmentPauseResponse>;
|
|
874
|
+
private __pauseSubscribers;
|
|
847
875
|
/**
|
|
848
876
|
* Rewrites the first 3 emails of a public gallery sequence for your brand, or for another `website`, and returns them without creating anything. Emails that could not be written are counted in `failedEmailCount`; the call fails only when none could be written. Usually takes 10 to 30 seconds. Requires `sequences:write`.
|
|
849
877
|
*
|
|
@@ -940,6 +968,27 @@ export declare class SequencesClient {
|
|
|
940
968
|
*/
|
|
941
969
|
resumeEnrollments(request: Sequenzy.ResumeEnrollmentsSequencesRequest, requestOptions?: SequencesClient.RequestOptions): core.HttpResponsePromise<Sequenzy.SequenceActionResponse>;
|
|
942
970
|
private __resumeEnrollments;
|
|
971
|
+
/**
|
|
972
|
+
* Continues paused contacts from the step they were paused on, with the status they had. Nothing restarts or is skipped. Waits keep their original wall-clock time, like a whole-sequence pause - a wait that ran out while paused continues right away, and one that has not still ends when it would have. Enrollments of the targeted contacts that are not paused are reported with outcome not_paused and left alone. When the sequence itself is disabled, sequenceRunning is false and the resumed contacts continue once it is enabled.
|
|
973
|
+
*
|
|
974
|
+
* @param {Sequenzy.SequenceEnrollmentResumeRequest} request
|
|
975
|
+
* @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
976
|
+
*
|
|
977
|
+
* @throws {@link Sequenzy.BadRequestError}
|
|
978
|
+
* @throws {@link Sequenzy.UnauthorizedError}
|
|
979
|
+
* @throws {@link Sequenzy.ForbiddenError}
|
|
980
|
+
* @throws {@link Sequenzy.NotFoundError}
|
|
981
|
+
* @throws {@link errors.SequenzyError}
|
|
982
|
+
* @throws {@link errors.SequenzyTimeoutError}
|
|
983
|
+
*
|
|
984
|
+
* @example
|
|
985
|
+
* await client.sequences.resumeSubscribers({
|
|
986
|
+
* sequenceId: "sequenceId",
|
|
987
|
+
* emails: ["ada@example.com"]
|
|
988
|
+
* })
|
|
989
|
+
*/
|
|
990
|
+
resumeSubscribers(request: Sequenzy.SequenceEnrollmentResumeRequest, requestOptions?: SequencesClient.RequestOptions): core.HttpResponsePromise<Sequenzy.SequenceEnrollmentResumeResponse>;
|
|
991
|
+
private __resumeSubscribers;
|
|
943
992
|
/**
|
|
944
993
|
* Immediately invalidates the previous URL and returns the replacement endpoint.
|
|
945
994
|
*
|
|
@@ -168,7 +168,7 @@ class SequencesClient {
|
|
|
168
168
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/sequences/{sequenceId}/audience-enrollments/{runId}/cancel");
|
|
169
169
|
}
|
|
170
170
|
/**
|
|
171
|
-
* Cancels active or
|
|
171
|
+
* Cancels active, waiting, or paused enrollments in one sequence. Target every enrollment with cancelAll, a batch with subscriberIds, one contact with subscriberId, or matching stored entry event property values with fieldValues. Bulk cancellation is capped at 1000 enrollments per request; repeat the request while remainingCount is above zero.
|
|
172
172
|
*
|
|
173
173
|
* @param {Sequenzy.SequenceEnrollmentCancelRequest} request
|
|
174
174
|
* @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -1257,7 +1257,7 @@ class SequencesClient {
|
|
|
1257
1257
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/sequences/{sequenceId}/enable");
|
|
1258
1258
|
}
|
|
1259
1259
|
/**
|
|
1260
|
-
* Starts a background run that enrolls every active contact matching the audience (everyone, lists, a segment, a filter, or rules) into the sequence, in batches, with no per-request cap. Contacts already active or
|
|
1260
|
+
* Starts a background run that enrolls every active contact matching the audience (everyone, lists, a segment, a filter, or rules) into the sequence, in batches, with no per-request cap. Contacts already active, waiting, or paused in the sequence are skipped; one_time sequences also skip contacts who completed or were cancelled before; unsubscribed and bounced contacts are never enrolled. Only one run per sequence can be queued or running at a time. The sequence must be enabled and accepting entrants. This is how a manual-trigger countdown sequence gets its audience; late enrollees skip the steps whose key date already passed.
|
|
1261
1261
|
*
|
|
1262
1262
|
* @param {Sequenzy.EnrollAudienceSequencesRequest} request
|
|
1263
1263
|
* @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -2376,7 +2376,7 @@ class SequencesClient {
|
|
|
2376
2376
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/sequences/{sequenceId}/emails/{emailId}/variations");
|
|
2377
2377
|
}
|
|
2378
2378
|
/**
|
|
2379
|
-
* Lists the individual contacts enrolled in one sequence, with the node each one is currently sitting on. Defaults to active and
|
|
2379
|
+
* Lists the individual contacts enrolled in one sequence, with the node each one is currently sitting on. Defaults to active, waiting, and paused enrollments, which is everyone still in the sequence. Use this when sequence stats give you enrollmentCounts and you need the actual subscribers behind a number.
|
|
2380
2380
|
*
|
|
2381
2381
|
* @param {Sequenzy.ListEnrollmentsSequencesRequest} request
|
|
2382
2382
|
* @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -2695,6 +2695,90 @@ class SequencesClient {
|
|
|
2695
2695
|
}
|
|
2696
2696
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/sequences/{sequenceId}/pause-enrollments");
|
|
2697
2697
|
}
|
|
2698
|
+
/**
|
|
2699
|
+
* Holds specific contacts on the sequence step they are on. A paused enrollment gets no further steps, keeps its entry event properties and stop-condition snapshots, and still counts as enrolled, so the same contact cannot enter this sequence again while paused. Unsubscribes, bounces, and enrollment cancellation still end it. A wait-for-event step does not react while paused; an event that arrived meanwhile is picked up on resume. Applies immediately with no dry run. An enrollment whose current step is running at that moment is left alone with outcome in_progress; repeat the request shortly. To stop new contacts entering the whole sequence instead, use POST /sequences/{sequenceId}/pause-enrollments.
|
|
2700
|
+
*
|
|
2701
|
+
* @param {Sequenzy.SequenceEnrollmentPauseRequest} request
|
|
2702
|
+
* @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
2703
|
+
*
|
|
2704
|
+
* @throws {@link Sequenzy.BadRequestError}
|
|
2705
|
+
* @throws {@link Sequenzy.UnauthorizedError}
|
|
2706
|
+
* @throws {@link Sequenzy.ForbiddenError}
|
|
2707
|
+
* @throws {@link Sequenzy.NotFoundError}
|
|
2708
|
+
* @throws {@link errors.SequenzyError}
|
|
2709
|
+
* @throws {@link errors.SequenzyTimeoutError}
|
|
2710
|
+
*
|
|
2711
|
+
* @example
|
|
2712
|
+
* await client.sequences.pauseSubscribers({
|
|
2713
|
+
* sequenceId: "sequenceId",
|
|
2714
|
+
* emails: ["ada@example.com"],
|
|
2715
|
+
* reason: "Project blocked"
|
|
2716
|
+
* })
|
|
2717
|
+
*
|
|
2718
|
+
* @example
|
|
2719
|
+
* await client.sequences.pauseSubscribers({
|
|
2720
|
+
* sequenceId: "sequenceId",
|
|
2721
|
+
* subscriberIds: ["sub_abc123", "sub_def456"]
|
|
2722
|
+
* })
|
|
2723
|
+
*/
|
|
2724
|
+
pauseSubscribers(request, requestOptions) {
|
|
2725
|
+
return core.HttpResponsePromise.fromPromise(this.__pauseSubscribers(request, requestOptions));
|
|
2726
|
+
}
|
|
2727
|
+
async __pauseSubscribers(request, requestOptions) {
|
|
2728
|
+
const { sequenceId, ..._body } = request;
|
|
2729
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
2730
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, requestOptions?.headers);
|
|
2731
|
+
const _response = await core.fetcher({
|
|
2732
|
+
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
2733
|
+
(await core.Supplier.get(this._options.environment)) ??
|
|
2734
|
+
environments.SequenzyEnvironment.Default, `sequences/${core.url.encodePathParam(sequenceId)}/enrollments/pause`),
|
|
2735
|
+
method: "POST",
|
|
2736
|
+
headers: _headers,
|
|
2737
|
+
contentType: "application/json",
|
|
2738
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
2739
|
+
requestType: "json",
|
|
2740
|
+
body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(serializers.SequenceEnrollmentPauseRequest.jsonOrThrow(_body, {
|
|
2741
|
+
unrecognizedObjectKeys: "strip",
|
|
2742
|
+
omitUndefined: true,
|
|
2743
|
+
}), requestOptions?.additionalBodyParameters),
|
|
2744
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
|
|
2745
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
2746
|
+
abortSignal: requestOptions?.abortSignal,
|
|
2747
|
+
fetchFn: this._options?.fetch,
|
|
2748
|
+
logging: this._options.logging,
|
|
2749
|
+
});
|
|
2750
|
+
if (_response.ok) {
|
|
2751
|
+
return {
|
|
2752
|
+
data: serializers.SequenceEnrollmentPauseResponse.parseOrThrow(_response.body, {
|
|
2753
|
+
unrecognizedObjectKeys: "passthrough",
|
|
2754
|
+
allowUnrecognizedUnionMembers: true,
|
|
2755
|
+
allowUnrecognizedEnumValues: true,
|
|
2756
|
+
skipValidation: true,
|
|
2757
|
+
breadcrumbsPrefix: ["response"],
|
|
2758
|
+
}),
|
|
2759
|
+
rawResponse: _response.rawResponse,
|
|
2760
|
+
};
|
|
2761
|
+
}
|
|
2762
|
+
if (_response.error.reason === "status-code") {
|
|
2763
|
+
switch (_response.error.statusCode) {
|
|
2764
|
+
case 400:
|
|
2765
|
+
throw new Sequenzy.BadRequestError(_response.error.body, _response.rawResponse);
|
|
2766
|
+
case 401:
|
|
2767
|
+
throw new Sequenzy.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
2768
|
+
case 403:
|
|
2769
|
+
throw new Sequenzy.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
2770
|
+
case 404:
|
|
2771
|
+
throw new Sequenzy.NotFoundError(_response.error.body, _response.rawResponse);
|
|
2772
|
+
default:
|
|
2773
|
+
throw new errors.SequenzyError({
|
|
2774
|
+
statusCode: _response.error.statusCode,
|
|
2775
|
+
body: _response.error.body,
|
|
2776
|
+
rawResponse: _response.rawResponse,
|
|
2777
|
+
});
|
|
2778
|
+
}
|
|
2779
|
+
}
|
|
2780
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/sequences/{sequenceId}/enrollments/pause");
|
|
2781
|
+
}
|
|
2698
2782
|
/**
|
|
2699
2783
|
* Rewrites the first 3 emails of a public gallery sequence for your brand, or for another `website`, and returns them without creating anything. Emails that could not be written are counted in `failedEmailCount`; the call fails only when none could be written. Usually takes 10 to 30 seconds. Requires `sequences:write`.
|
|
2700
2784
|
*
|
|
@@ -3014,6 +3098,83 @@ class SequencesClient {
|
|
|
3014
3098
|
}
|
|
3015
3099
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/sequences/{sequenceId}/resume-enrollments");
|
|
3016
3100
|
}
|
|
3101
|
+
/**
|
|
3102
|
+
* Continues paused contacts from the step they were paused on, with the status they had. Nothing restarts or is skipped. Waits keep their original wall-clock time, like a whole-sequence pause - a wait that ran out while paused continues right away, and one that has not still ends when it would have. Enrollments of the targeted contacts that are not paused are reported with outcome not_paused and left alone. When the sequence itself is disabled, sequenceRunning is false and the resumed contacts continue once it is enabled.
|
|
3103
|
+
*
|
|
3104
|
+
* @param {Sequenzy.SequenceEnrollmentResumeRequest} request
|
|
3105
|
+
* @param {SequencesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
3106
|
+
*
|
|
3107
|
+
* @throws {@link Sequenzy.BadRequestError}
|
|
3108
|
+
* @throws {@link Sequenzy.UnauthorizedError}
|
|
3109
|
+
* @throws {@link Sequenzy.ForbiddenError}
|
|
3110
|
+
* @throws {@link Sequenzy.NotFoundError}
|
|
3111
|
+
* @throws {@link errors.SequenzyError}
|
|
3112
|
+
* @throws {@link errors.SequenzyTimeoutError}
|
|
3113
|
+
*
|
|
3114
|
+
* @example
|
|
3115
|
+
* await client.sequences.resumeSubscribers({
|
|
3116
|
+
* sequenceId: "sequenceId",
|
|
3117
|
+
* emails: ["ada@example.com"]
|
|
3118
|
+
* })
|
|
3119
|
+
*/
|
|
3120
|
+
resumeSubscribers(request, requestOptions) {
|
|
3121
|
+
return core.HttpResponsePromise.fromPromise(this.__resumeSubscribers(request, requestOptions));
|
|
3122
|
+
}
|
|
3123
|
+
async __resumeSubscribers(request, requestOptions) {
|
|
3124
|
+
const { sequenceId, ..._body } = request;
|
|
3125
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
3126
|
+
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, this._options?.headers, requestOptions?.headers);
|
|
3127
|
+
const _response = await core.fetcher({
|
|
3128
|
+
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
3129
|
+
(await core.Supplier.get(this._options.environment)) ??
|
|
3130
|
+
environments.SequenzyEnvironment.Default, `sequences/${core.url.encodePathParam(sequenceId)}/enrollments/resume`),
|
|
3131
|
+
method: "POST",
|
|
3132
|
+
headers: _headers,
|
|
3133
|
+
contentType: "application/json",
|
|
3134
|
+
queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
|
|
3135
|
+
requestType: "json",
|
|
3136
|
+
body: (0, requestBody_js_1.mergeAdditionalBodyParameters)(serializers.SequenceEnrollmentResumeRequest.jsonOrThrow(_body, {
|
|
3137
|
+
unrecognizedObjectKeys: "strip",
|
|
3138
|
+
omitUndefined: true,
|
|
3139
|
+
}), requestOptions?.additionalBodyParameters),
|
|
3140
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
|
|
3141
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
3142
|
+
abortSignal: requestOptions?.abortSignal,
|
|
3143
|
+
fetchFn: this._options?.fetch,
|
|
3144
|
+
logging: this._options.logging,
|
|
3145
|
+
});
|
|
3146
|
+
if (_response.ok) {
|
|
3147
|
+
return {
|
|
3148
|
+
data: serializers.SequenceEnrollmentResumeResponse.parseOrThrow(_response.body, {
|
|
3149
|
+
unrecognizedObjectKeys: "passthrough",
|
|
3150
|
+
allowUnrecognizedUnionMembers: true,
|
|
3151
|
+
allowUnrecognizedEnumValues: true,
|
|
3152
|
+
skipValidation: true,
|
|
3153
|
+
breadcrumbsPrefix: ["response"],
|
|
3154
|
+
}),
|
|
3155
|
+
rawResponse: _response.rawResponse,
|
|
3156
|
+
};
|
|
3157
|
+
}
|
|
3158
|
+
if (_response.error.reason === "status-code") {
|
|
3159
|
+
switch (_response.error.statusCode) {
|
|
3160
|
+
case 400:
|
|
3161
|
+
throw new Sequenzy.BadRequestError(_response.error.body, _response.rawResponse);
|
|
3162
|
+
case 401:
|
|
3163
|
+
throw new Sequenzy.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
3164
|
+
case 403:
|
|
3165
|
+
throw new Sequenzy.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
3166
|
+
case 404:
|
|
3167
|
+
throw new Sequenzy.NotFoundError(_response.error.body, _response.rawResponse);
|
|
3168
|
+
default:
|
|
3169
|
+
throw new errors.SequenzyError({
|
|
3170
|
+
statusCode: _response.error.statusCode,
|
|
3171
|
+
body: _response.error.body,
|
|
3172
|
+
rawResponse: _response.rawResponse,
|
|
3173
|
+
});
|
|
3174
|
+
}
|
|
3175
|
+
}
|
|
3176
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/sequences/{sequenceId}/enrollments/resume");
|
|
3177
|
+
}
|
|
3017
3178
|
/**
|
|
3018
3179
|
* Immediately invalidates the previous URL and returns the replacement endpoint.
|
|
3019
3180
|
*
|
package/dist/cjs/api/resources/sequences/client/requests/ListEnrollmentsSequencesRequest.d.ts
CHANGED
|
@@ -22,7 +22,7 @@ export interface ListEnrollmentsSequencesRequest {
|
|
|
22
22
|
offset?: number;
|
|
23
23
|
/** Result order. Defaults to enrolled_at_desc. Enrollments with no scheduled resume sort last under wait_until ordering. */
|
|
24
24
|
sort?: Sequenzy.ListEnrollmentsSequencesRequestSort;
|
|
25
|
-
/** Comma-separated enrollment statuses: active, waiting, completed, failed, cancelled. Defaults to active,waiting. */
|
|
25
|
+
/** Comma-separated enrollment statuses: active, waiting, paused, completed, failed, cancelled. Defaults to active,waiting,paused. */
|
|
26
26
|
status?: string;
|
|
27
27
|
/** Annotate each returned active or waiting enrollment with whether the sequence stop condition already matches for that contact right now. Stop conditions are re-evaluated when an enrollment next runs a step, not when their event arrives, so a stopped contact keeps reporting waiting until its delay expires. Use this to confirm a stop event registered without waiting the delay out. Caps the page at 100 regardless of limit. */
|
|
28
28
|
stopConditionMatch?: boolean;
|
package/dist/cjs/api/resources/sequences/client/requests/SequenceEnrollmentCancelRequest.d.ts
CHANGED
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
export interface SequenceEnrollmentCancelRequest {
|
|
34
34
|
/** Sequence ID */
|
|
35
35
|
sequenceId: string;
|
|
36
|
-
/** Cancel every active or
|
|
36
|
+
/** Cancel every active, waiting, or paused enrollment in the sequence, regardless of how contacts entered it. Use this when segment-triggered enrollments share no entry field value. Defaults to dry run unless dryRun is explicitly false. */
|
|
37
37
|
cancelAll?: boolean;
|
|
38
38
|
/** When true, returns matching enrollments without cancelling them. cancelAll, subscriberIds, and fieldValues default to dry run unless explicitly false; a single subscriberId cancels immediately. */
|
|
39
39
|
dryRun?: boolean;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* sequenceId: "sequenceId",
|
|
5
|
+
* emails: ["ada@example.com"],
|
|
6
|
+
* reason: "Project blocked"
|
|
7
|
+
* }
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* {
|
|
11
|
+
* sequenceId: "sequenceId",
|
|
12
|
+
* subscriberIds: ["sub_abc123", "sub_def456"]
|
|
13
|
+
* }
|
|
14
|
+
*/
|
|
15
|
+
export interface SequenceEnrollmentPauseRequest {
|
|
16
|
+
/** Sequence ID */
|
|
17
|
+
sequenceId: string;
|
|
18
|
+
/** Subscriber emails to pause, matched case-insensitively. Emails that match no contact come back in notFound.emails. */
|
|
19
|
+
emails?: string[];
|
|
20
|
+
/** Note stored on each paused enrollment and returned as pauseReason by list enrollments. */
|
|
21
|
+
reason?: string;
|
|
22
|
+
/** Subscriber IDs to pause. IDs that match no contact come back in notFound.subscriberIds. */
|
|
23
|
+
subscriberIds?: string[];
|
|
24
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* sequenceId: "sequenceId",
|
|
5
|
+
* emails: ["ada@example.com"]
|
|
6
|
+
* }
|
|
7
|
+
*/
|
|
8
|
+
export interface SequenceEnrollmentResumeRequest {
|
|
9
|
+
/** Sequence ID */
|
|
10
|
+
sequenceId: string;
|
|
11
|
+
/** Subscriber emails to resume, matched case-insensitively. */
|
|
12
|
+
emails?: string[];
|
|
13
|
+
/** Subscriber IDs to resume. */
|
|
14
|
+
subscriberIds?: string[];
|
|
15
|
+
}
|
|
@@ -37,7 +37,9 @@ export type { SendTestEmailSequencesRequest } from "./SendTestEmailSequencesRequ
|
|
|
37
37
|
export type { SequenceCreateRequest } from "./SequenceCreateRequest.js";
|
|
38
38
|
export type { SequenceEnrollmentCancelRequest } from "./SequenceEnrollmentCancelRequest.js";
|
|
39
39
|
export type { SequenceEnrollmentMoveRequest } from "./SequenceEnrollmentMoveRequest.js";
|
|
40
|
+
export type { SequenceEnrollmentPauseRequest } from "./SequenceEnrollmentPauseRequest.js";
|
|
40
41
|
export type { SequenceEnrollmentRealignRequest } from "./SequenceEnrollmentRealignRequest.js";
|
|
42
|
+
export type { SequenceEnrollmentResumeRequest } from "./SequenceEnrollmentResumeRequest.js";
|
|
41
43
|
export type { SequenceUpdateRequest } from "./SequenceUpdateRequest.js";
|
|
42
44
|
export type { SimulateSequencesRequest } from "./SimulateSequencesRequest.js";
|
|
43
45
|
export type { StartTestRunSequencesRequest } from "./StartTestRunSequencesRequest.js";
|
|
@@ -3,6 +3,7 @@ export interface GetStatsSequencesResponse {
|
|
|
3
3
|
enrollmentCounts?: Sequenzy.SequenceEnrollmentCounts;
|
|
4
4
|
/** Trigger matches where the contact could not be enrolled because they are unsubscribed or bounced. Defaults to the last 30 days when no explicit time range is provided. */
|
|
5
5
|
enrollmentSkipped?: Sequenzy.GetStatsSequencesResponseEnrollmentSkipped;
|
|
6
|
+
pausedEnrollments?: Sequenzy.SequencePausedEnrollmentCounts;
|
|
6
7
|
/** Echoed back when `period` is provided. */
|
|
7
8
|
period?: string;
|
|
8
9
|
recommendations?: Sequenzy.RecommendationMetrics;
|
|
@@ -47,7 +47,7 @@ export interface Company {
|
|
|
47
47
|
replyTrackingDomainMode?: Sequenzy.CompanyReplyTrackingDomainMode;
|
|
48
48
|
/** Whether inbound reply capture is enabled for this company. */
|
|
49
49
|
replyTrackingEnabled?: boolean;
|
|
50
|
-
/** Profile URL per platform. Bare hosts (`x.com/acme`) and mistyped web schemes (`ttps://`, `https:/`) are saved as `https://` URLs. */
|
|
50
|
+
/** Profile URL per platform. Bare hosts (`x.com/acme`) and mistyped web schemes (`ttps://`, `https:/`) are saved as `https://` URLs. Branded footers show an icon for `x` (or `twitter`), `threads`, `bluesky`, `linkedin`, `instagram`, `facebook`, `youtube`, `tiktok`, `pinterest`, `discord`, `reddit`, and the mobile app store listings `appstore` and `googleplay`. Other keys are stored but get no icon. */
|
|
51
51
|
socialLinks?: Record<string, string | null> | null;
|
|
52
52
|
status?: string;
|
|
53
53
|
termsUrl?: string | null;
|
|
@@ -5,7 +5,7 @@ export interface SequenceEnrollmentCancelResponse {
|
|
|
5
5
|
dryRun?: boolean;
|
|
6
6
|
enrollments?: Sequenzy.SequenceEnrollmentCancelResponseEnrollmentsItem[];
|
|
7
7
|
hasMore?: boolean;
|
|
8
|
-
/** Active or
|
|
8
|
+
/** Active, waiting, or paused enrollments matching the target when the request started. */
|
|
9
9
|
matchedCount?: number;
|
|
10
10
|
message?: string;
|
|
11
11
|
/** Enrollments still matching the target after this request. Repeat the same request while this is above zero. */
|
|
@@ -34,7 +34,12 @@ export interface SequenceEnrollmentGetResponseEnrollment {
|
|
|
34
34
|
movedFromNodeId?: string | null;
|
|
35
35
|
/** Note recorded with that release, or null when none was given. */
|
|
36
36
|
moveReason?: string | null;
|
|
37
|
+
/** When the current pause began, or null when the enrollment is not paused. */
|
|
38
|
+
pausedAt?: Date | null;
|
|
39
|
+
/** Reason given when the enrollment was paused, or null. */
|
|
40
|
+
pauseReason?: string | null;
|
|
37
41
|
sequenceId?: string;
|
|
42
|
+
/** `paused` means the enrollment is held on its current step by POST /sequences/{sequenceId}/enrollments/pause. */
|
|
38
43
|
status?: Sequenzy.SequenceEnrollmentGetResponseEnrollmentStatus;
|
|
39
44
|
/** Whether the sequence stop condition matches for this contact right now. Null when it was not determined - stopConditionMatch was not requested, the sequence has no stop condition, this enrollment is no longer active or waiting, or it fell outside the evaluated window. Null never means "does not match". This is a non-atomic snapshot; the worker re-checks before a future step, but the condition can change and a step already past its stop check may still finish. */
|
|
40
45
|
stopConditionMatches?: boolean | null;
|
|
@@ -42,6 +47,6 @@ export interface SequenceEnrollmentGetResponseEnrollment {
|
|
|
42
47
|
stopConditionMatchReason?: string | null;
|
|
43
48
|
subscriberId?: string;
|
|
44
49
|
subscriberStatus?: string | null;
|
|
45
|
-
/** When a waiting enrollment is scheduled to resume, or null when nothing is scheduled. */
|
|
50
|
+
/** When a waiting enrollment is scheduled to resume, or null when nothing is scheduled. Always null for a paused enrollment, because nothing runs until it is resumed. */
|
|
46
51
|
waitUntil?: Date | null;
|
|
47
52
|
}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
|
+
/** `paused` means the enrollment is held on its current step by POST /sequences/{sequenceId}/enrollments/pause. */
|
|
1
2
|
export declare const SequenceEnrollmentGetResponseEnrollmentStatus: {
|
|
2
3
|
readonly Active: "active";
|
|
3
4
|
readonly Waiting: "waiting";
|
|
5
|
+
readonly Paused: "paused";
|
|
4
6
|
readonly Completed: "completed";
|
|
5
7
|
readonly Failed: "failed";
|
|
6
8
|
readonly Cancelled: "cancelled";
|
|
@@ -2,9 +2,11 @@
|
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.SequenceEnrollmentGetResponseEnrollmentStatus = void 0;
|
|
5
|
+
/** `paused` means the enrollment is held on its current step by POST /sequences/{sequenceId}/enrollments/pause. */
|
|
5
6
|
exports.SequenceEnrollmentGetResponseEnrollmentStatus = {
|
|
6
7
|
Active: "active",
|
|
7
8
|
Waiting: "waiting",
|
|
9
|
+
Paused: "paused",
|
|
8
10
|
Completed: "completed",
|
|
9
11
|
Failed: "failed",
|
|
10
12
|
Cancelled: "cancelled",
|
|
@@ -34,7 +34,12 @@ export interface SequenceEnrollmentListResponseEnrollmentsItem {
|
|
|
34
34
|
movedFromNodeId?: string | null;
|
|
35
35
|
/** Note recorded with that release, or null when none was given. */
|
|
36
36
|
moveReason?: string | null;
|
|
37
|
+
/** When the current pause began, or null when the enrollment is not paused. */
|
|
38
|
+
pausedAt?: Date | null;
|
|
39
|
+
/** Reason given when the enrollment was paused, or null. */
|
|
40
|
+
pauseReason?: string | null;
|
|
37
41
|
sequenceId?: string;
|
|
42
|
+
/** `paused` means the enrollment is held on its current step by POST /sequences/{sequenceId}/enrollments/pause. */
|
|
38
43
|
status?: Sequenzy.SequenceEnrollmentListResponseEnrollmentsItemStatus;
|
|
39
44
|
/** Whether the sequence stop condition matches for this contact right now. Null when it was not determined - stopConditionMatch was not requested, the sequence has no stop condition, this enrollment is no longer active or waiting, or it fell outside the evaluated window. Null never means "does not match". This is a non-atomic snapshot; the worker re-checks before a future step, but the condition can change and a step already past its stop check may still finish. */
|
|
40
45
|
stopConditionMatches?: boolean | null;
|
|
@@ -42,6 +47,6 @@ export interface SequenceEnrollmentListResponseEnrollmentsItem {
|
|
|
42
47
|
stopConditionMatchReason?: string | null;
|
|
43
48
|
subscriberId?: string;
|
|
44
49
|
subscriberStatus?: string | null;
|
|
45
|
-
/** When a waiting enrollment is scheduled to resume, or null when nothing is scheduled. */
|
|
50
|
+
/** When a waiting enrollment is scheduled to resume, or null when nothing is scheduled. Always null for a paused enrollment, because nothing runs until it is resumed. */
|
|
46
51
|
waitUntil?: Date | null;
|
|
47
52
|
}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
|
+
/** `paused` means the enrollment is held on its current step by POST /sequences/{sequenceId}/enrollments/pause. */
|
|
1
2
|
export declare const SequenceEnrollmentListResponseEnrollmentsItemStatus: {
|
|
2
3
|
readonly Active: "active";
|
|
3
4
|
readonly Waiting: "waiting";
|
|
5
|
+
readonly Paused: "paused";
|
|
4
6
|
readonly Completed: "completed";
|
|
5
7
|
readonly Failed: "failed";
|
|
6
8
|
readonly Cancelled: "cancelled";
|
|
@@ -2,9 +2,11 @@
|
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.SequenceEnrollmentListResponseEnrollmentsItemStatus = void 0;
|
|
5
|
+
/** `paused` means the enrollment is held on its current step by POST /sequences/{sequenceId}/enrollments/pause. */
|
|
5
6
|
exports.SequenceEnrollmentListResponseEnrollmentsItemStatus = {
|
|
6
7
|
Active: "active",
|
|
7
8
|
Waiting: "waiting",
|
|
9
|
+
Paused: "paused",
|
|
8
10
|
Completed: "completed",
|
|
9
11
|
Failed: "failed",
|
|
10
12
|
Cancelled: "cancelled",
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type * as Sequenzy from "../index.js";
|
|
2
|
+
export interface SequenceEnrollmentPauseItem {
|
|
3
|
+
/** Step the enrollment is on. Pausing and resuming never change it. */
|
|
4
|
+
currentNodeId: string;
|
|
5
|
+
enrollmentId: string;
|
|
6
|
+
/** paused, already_paused, or in_progress (a step was running at that moment; repeat the request shortly) for pause. resumed or not_paused for resume. */
|
|
7
|
+
outcome: Sequenzy.SequenceEnrollmentPauseItemOutcome;
|
|
8
|
+
/** When the current pause began; null unless status is paused. */
|
|
9
|
+
pausedAt: Date | null;
|
|
10
|
+
/** Status after this request. */
|
|
11
|
+
status: Sequenzy.SequenceEnrollmentPauseItemStatus;
|
|
12
|
+
subscriberEmail: string | null;
|
|
13
|
+
subscriberId: string;
|
|
14
|
+
/** When a waiting enrollment next runs its step, or null. */
|
|
15
|
+
waitUntil: Date | null;
|
|
16
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/** paused, already_paused, or in_progress (a step was running at that moment; repeat the request shortly) for pause. resumed or not_paused for resume. */
|
|
2
|
+
export declare const SequenceEnrollmentPauseItemOutcome: {
|
|
3
|
+
readonly Paused: "paused";
|
|
4
|
+
readonly AlreadyPaused: "already_paused";
|
|
5
|
+
readonly InProgress: "in_progress";
|
|
6
|
+
readonly Resumed: "resumed";
|
|
7
|
+
readonly NotPaused: "not_paused";
|
|
8
|
+
};
|
|
9
|
+
export type SequenceEnrollmentPauseItemOutcome = (typeof SequenceEnrollmentPauseItemOutcome)[keyof typeof SequenceEnrollmentPauseItemOutcome];
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.SequenceEnrollmentPauseItemOutcome = void 0;
|
|
5
|
+
/** paused, already_paused, or in_progress (a step was running at that moment; repeat the request shortly) for pause. resumed or not_paused for resume. */
|
|
6
|
+
exports.SequenceEnrollmentPauseItemOutcome = {
|
|
7
|
+
Paused: "paused",
|
|
8
|
+
AlreadyPaused: "already_paused",
|
|
9
|
+
InProgress: "in_progress",
|
|
10
|
+
Resumed: "resumed",
|
|
11
|
+
NotPaused: "not_paused",
|
|
12
|
+
};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/** Status after this request. */
|
|
2
|
+
export declare const SequenceEnrollmentPauseItemStatus: {
|
|
3
|
+
readonly Active: "active";
|
|
4
|
+
readonly Waiting: "waiting";
|
|
5
|
+
readonly Paused: "paused";
|
|
6
|
+
};
|
|
7
|
+
export type SequenceEnrollmentPauseItemStatus = (typeof SequenceEnrollmentPauseItemStatus)[keyof typeof SequenceEnrollmentPauseItemStatus];
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.SequenceEnrollmentPauseItemStatus = void 0;
|
|
5
|
+
/** Status after this request. */
|
|
6
|
+
exports.SequenceEnrollmentPauseItemStatus = {
|
|
7
|
+
Active: "active",
|
|
8
|
+
Waiting: "waiting",
|
|
9
|
+
Paused: "paused",
|
|
10
|
+
};
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type * as Sequenzy from "../index.js";
|
|
2
|
+
export interface SequenceEnrollmentPauseResponse extends Sequenzy.SequenceEnrollmentPauseResultBase {
|
|
3
|
+
/** Enrollments that were already paused and were left as they were. */
|
|
4
|
+
alreadyPausedCount: number;
|
|
5
|
+
/** Enrollments not paused because their current step was running. Repeat the request shortly. */
|
|
6
|
+
inProgressCount: number;
|
|
7
|
+
/** Enrollments paused by this request. */
|
|
8
|
+
pausedCount: number;
|
|
9
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as Sequenzy from "../index.js";
|
|
2
|
+
export interface SequenceEnrollmentPauseResultBase {
|
|
3
|
+
/** Every active, waiting, or paused enrollment of the targeted contacts in this sequence, with its outcome. */
|
|
4
|
+
enrollments: Sequenzy.SequenceEnrollmentPauseItem[];
|
|
5
|
+
message: string;
|
|
6
|
+
/** Targeted contacts that exist but have no active, waiting, or paused enrollment in this sequence. */
|
|
7
|
+
notEnrolled: Sequenzy.SequenceEnrollmentPauseResultBaseNotEnrolledItem[];
|
|
8
|
+
notFound: Sequenzy.SequenceEnrollmentPauseResultBaseNotFound;
|
|
9
|
+
sequenceId: string;
|
|
10
|
+
success: boolean;
|
|
11
|
+
}
|