@outseta/api-client 0.3.14 → 0.3.16

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@outseta/api-client",
3
- "version": "0.3.14",
3
+ "version": "0.3.16",
4
4
  "description": "Generated API client for the Outseta REST API",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -465,8 +465,8 @@ export const dripCampaignUpdateDripCampaignMessage = async (dripCampaignUid: str
465
465
 
466
466
 
467
467
  /**
468
- * If the drip campaign is active, the drip is rescheduled for its existing members after the
469
- message is removed.
468
+ * Deleting a message deactivates the drip campaign (like adding a message) so its schedule can be
469
+ reviewed before it resumes. Reactivate the campaign to resume sending.
470
470
  * @summary Delete a message from a drip campaign.
471
471
  */
472
472
  export type dripCampaignDeleteDripCampaignMessageResponse200 = {
@@ -624,19 +624,27 @@ still be supplied directly (a JSON string of the form
624
624
  {"BroadcastRecipientsEmailLists":[{"Uid":"..."}],"BroadcastRecipientsSegments":[{"Uid":"..."}]});
625
625
  when both are present they are merged.
626
626
 
627
- Message.Body is the complete HTML email and is exactly what gets sent. It is rendered as a
628
- Liquid template, so it may include merge tags such as {{ Person.FirstName }}; unknown {{ }}
629
- tokens render as empty text. An inline-styled HTML fragment is recommended, though a full
630
- HTML document is also accepted. Message.Design (the drag-and-drop editor state) is optional
631
- when omitted it is generated automatically from Body, so callers (including LLM tools) do not
632
- need to understand it. Use Message.PreviewText for inbox preview text rather than an in-body
627
+ Message.Body is rendered as a Liquid template, so it may include merge tags such as
628
+ {{ Person.FirstName }}; unknown {{ }} tokens render as empty text. An inline-styled HTML
629
+ fragment is recommended. Message.Design (the drag-and-drop editor state) is optional when
630
+ omitted it is derived automatically, so callers (including LLM tools) do not need to
631
+ understand it. Use Message.PreviewText for inbox preview text rather than an in-body
633
632
  preheader.
634
633
 
635
- You must include a visible unsubscribe link in the body yourself: add {{ UnsubscribeLink }}
636
- (a ready-made anchor) or {{ UnsubscribeUrl }} (the raw URL) where you want it. One is not
637
- inserted automatically, and its presence is not validated. A one-click List-Unsubscribe
638
- header is always added, but most anti-spam laws (e.g. CAN-SPAM) also require a visible
639
- unsubscribe link in the body.
634
+ When Body is a bare content fragment (no Design and no unsubscribe token), it is composed
635
+ into the account's API email layout a branded header and footer that includes the
636
+ unsubscribe and manage-subscriptions links — and the composed result is what is sent and
637
+ opened in the editor. The layout is editable in the app; TemplateUid selects a specific
638
+ layout template when the account has more than one.
639
+
640
+ The layout is NOT applied when the body already contains an unsubscribe token
641
+ ({{ UnsubscribeLink }}, {{ UnsubscribeUrl }} or {{ OneClickUnsubscribeUrl }}), when a
642
+ Design is supplied, or when the body is a complex full HTML document (Outlook conditional
643
+ comments, stylesheet links) — in those cases the body is sent exactly as supplied, and you
644
+ must include a visible unsubscribe link in it yourself: add {{ UnsubscribeLink }} (a
645
+ ready-made anchor) or {{ UnsubscribeUrl }} (the raw URL) where you want it. Its presence is
646
+ not validated. A one-click List-Unsubscribe header is always added, but most anti-spam laws
647
+ (e.g. CAN-SPAM) also require a visible unsubscribe link in the body.
640
648
  * @summary Create a new broadcast.
641
649
  */
642
650
  export type campaignAddBroadcastEmailResponse200 = {
@@ -742,8 +750,11 @@ set, send RecipientData directly.
742
750
 
743
751
  When changing Message.Body, omit Message.Design: it is regenerated from the new Body so the
744
752
  drag-and-drop editor stays in sync. Sending a Design that was captured from an earlier
745
- response alongside an edited Body would otherwise keep the stale design. See the create
746
- endpoint for how Body is rendered (Liquid) and the unsubscribe-token expectation.
753
+ response alongside an edited Body would otherwise keep the stale design. A body that was
754
+ composed into the API email layout keeps the layout on such updates without duplicating
755
+ it — its content is re-composed into the layout — and a bare fragment is composed like on
756
+ create. See the create endpoint for how Body is rendered (Liquid), when the layout
757
+ applies, and the unsubscribe-token expectation when it does not.
747
758
  * @summary Update a broadcast.
748
759
  */
749
760
  export type campaignUpdateBroadcastEmailResponse200 = {
@@ -19,6 +19,8 @@ export type BroadcastCampaignAllOf = {
19
19
  EmailListUids?: string[] | null;
20
20
  /** @nullable */
21
21
  SegmentUids?: string[] | null;
22
+ /** @nullable */
23
+ TemplateUid?: string | null;
22
24
  Status?: BroadcastCampaignStatus;
23
25
  /**
24
26
  * @maxLength 500
@@ -15,4 +15,5 @@ export type DripCampaignAllOf = {
15
15
  DripCampaignMessages?: DripCampaignMessage[] | null;
16
16
  AllowRepeatProcessing?: boolean;
17
17
  StartDripToExistingMembers?: boolean;
18
+ MarkExistingRecipientsDone?: boolean;
18
19
  };
@@ -530,6 +530,10 @@ export * from './sendTestEmailRequest';
530
530
  export * from './sendTestEmailRequest2';
531
531
  export * from './sendTestEmailRequest2BroadcastCampaign';
532
532
  export * from './sendTestEmailRequestDripCampaign';
533
+ export * from './sequenceFreeze';
534
+ export * from './sequenceState';
535
+ export * from './sequenceVersion';
536
+ export * from './sequenceVersionMessage';
533
537
  export * from './sessionFlowDataAfterCompletionHostedConfirmationOptions';
534
538
  export * from './sessionFlowDataAfterCompletionOptions';
535
539
  export * from './sessionFlowDataAfterCompletionOptionsHostedConfirmation';
@@ -0,0 +1,7 @@
1
+ // @ts-nocheck
2
+
3
+ export interface SequenceFreeze {
4
+ FrozenAt?: string;
5
+ /** @nullable */
6
+ CreatedByUserId?: number | null;
7
+ }
@@ -0,0 +1,10 @@
1
+ // @ts-nocheck
2
+ import type { SequenceFreeze } from './sequenceFreeze';
3
+ import type { SequenceVersion } from './sequenceVersion';
4
+
5
+ export interface SequenceState {
6
+ /** @nullable */
7
+ Freezes?: SequenceFreeze[] | null;
8
+ /** @nullable */
9
+ Versions?: SequenceVersion[] | null;
10
+ }
@@ -0,0 +1,10 @@
1
+ // @ts-nocheck
2
+ import type { SequenceVersionMessage } from './sequenceVersionMessage';
3
+
4
+ export interface SequenceVersion {
5
+ EffectiveFrom?: string;
6
+ /** @nullable */
7
+ Messages?: SequenceVersionMessage[] | null;
8
+ /** @nullable */
9
+ CreatedByUserId?: number | null;
10
+ }
@@ -0,0 +1,6 @@
1
+ // @ts-nocheck
2
+
3
+ export interface SequenceVersionMessage {
4
+ MessageId?: number;
5
+ OffsetHours?: number;
6
+ }