sequenzy 2.1.56 → 2.1.60

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.
@@ -11,6 +11,8 @@ export interface SendTestEmailSequencesRequest {
11
11
  sequenceId: string;
12
12
  /** action_email step node ID returned by the sequence detail endpoint. Do not pass an action_ab_test node. */
13
13
  nodeId: string;
14
+ /** Optional custom attributes to render the test as, for example `{"trader_type":"prop_firm"}`. They override each reviewer's stored attributes for merge tags and block conditions in this test only. No contact is created or changed. When a reviewer is a stored contact, email, first name, last name and full name keys such as `firstName` or `name` come from that contact and are ignored. */
15
+ customAttributes?: Record<string, unknown>;
14
16
  /** Internal reviewer email addresses. Duplicate addresses are sent only once. */
15
17
  recipients: string[];
16
18
  }
@@ -11,7 +11,7 @@ export declare class SyncRulesClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<SyncRulesClient.Options>;
12
12
  constructor(options?: SyncRulesClient.Options);
13
13
  /**
14
- * Returns the company's effective sync rules - the automatic tag changes applied when events fire. New companies start with an empty rule set; legacy companies may inherit the optional SaaS/ecommerce platform preset. isDefault reports whether that preset is active.
14
+ * Returns the company's effective sync rules - the automatic tag changes applied when events fire. New companies start with the platform preset's payment and ecommerce rules, saved as their own rule set; older companies may inherit the SaaS/ecommerce platform preset. isDefault reports whether that preset is active.
15
15
  *
16
16
  * @param {SyncRulesClient.RequestOptions} requestOptions - Request-specific configuration.
17
17
  *
@@ -39,7 +39,7 @@ class SyncRulesClient {
39
39
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
40
40
  }
41
41
  /**
42
- * Returns the company's effective sync rules - the automatic tag changes applied when events fire. New companies start with an empty rule set; legacy companies may inherit the optional SaaS/ecommerce platform preset. isDefault reports whether that preset is active.
42
+ * Returns the company's effective sync rules - the automatic tag changes applied when events fire. New companies start with the platform preset's payment and ecommerce rules, saved as their own rule set; older companies may inherit the SaaS/ecommerce platform preset. isDefault reports whether that preset is active.
43
43
  *
44
44
  * @param {SyncRulesClient.RequestOptions} requestOptions - Request-specific configuration.
45
45
  *
@@ -26,6 +26,6 @@ export interface UpdateTrackingSettingsRequest {
26
26
  transactionalClickTrackingEnabled?: boolean;
27
27
  /** Open tracking default for sends through the Send Email API. Account-wide open tracking must also be enabled; per-send trackingSettings can only opt out. */
28
28
  transactionalOpenTrackingEnabled?: boolean;
29
- /** Whether to track unsubscribe link clicks. When false, Sequenzy unsubscribe links go directly to https://sequenzy.com, even with a custom tracking domain. Actual unsubscribes and their email attribution are still recorded. */
29
+ /** Whether unsubscribe links that point to other services are routed through your tracking domain. Sequenzy's own unsubscribe and preference links, including the one-click unsubscribe header, always use your tracking domain (or the shared one). Actual unsubscribes and their email attribution are recorded either way. */
30
30
  unsubscribeTrackingEnabled?: boolean;
31
31
  }
@@ -10,6 +10,6 @@ export interface TrackingSettingsTracking {
10
10
  transactionalClickTrackingEnabled?: boolean;
11
11
  /** Open tracking default for sends through the Send Email API. Account-wide open tracking must also be enabled; per-send trackingSettings can only opt out. */
12
12
  transactionalOpenTrackingEnabled?: boolean;
13
- /** Whether to track unsubscribe link clicks. When false, Sequenzy unsubscribe links go directly to https://sequenzy.com, even with a custom tracking domain. Actual unsubscribes and their email attribution are still recorded. */
13
+ /** Whether unsubscribe links that point to other services are routed through your tracking domain. Sequenzy's own unsubscribe and preference links, including the one-click unsubscribe header, always use your tracking domain (or the shared one). Actual unsubscribes and their email attribution are recorded either way. */
14
14
  unsubscribeTrackingEnabled?: boolean;
15
15
  }
@@ -4,6 +4,7 @@ import type * as serializers from "../../../../index.js";
4
4
  export declare const SendTestEmailSequencesRequest: core.serialization.Schema<serializers.SendTestEmailSequencesRequest.Raw, Omit<Sequenzy.SendTestEmailSequencesRequest, "sequenceId" | "nodeId">>;
5
5
  export declare namespace SendTestEmailSequencesRequest {
6
6
  interface Raw {
7
+ customAttributes?: Record<string, unknown> | null;
7
8
  recipients: string[];
8
9
  }
9
10
  }
@@ -27,5 +27,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
27
27
  exports.SendTestEmailSequencesRequest = void 0;
28
28
  const core = __importStar(require("../../../../../core/index.js"));
29
29
  exports.SendTestEmailSequencesRequest = core.serialization.object({
30
+ customAttributes: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
30
31
  recipients: core.serialization.list(core.serialization.string()),
31
32
  });
@@ -11,6 +11,8 @@ export interface SendTestEmailSequencesRequest {
11
11
  sequenceId: string;
12
12
  /** action_email step node ID returned by the sequence detail endpoint. Do not pass an action_ab_test node. */
13
13
  nodeId: string;
14
+ /** Optional custom attributes to render the test as, for example `{"trader_type":"prop_firm"}`. They override each reviewer's stored attributes for merge tags and block conditions in this test only. No contact is created or changed. When a reviewer is a stored contact, email, first name, last name and full name keys such as `firstName` or `name` come from that contact and are ignored. */
15
+ customAttributes?: Record<string, unknown>;
14
16
  /** Internal reviewer email addresses. Duplicate addresses are sent only once. */
15
17
  recipients: string[];
16
18
  }
@@ -11,7 +11,7 @@ export declare class SyncRulesClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<SyncRulesClient.Options>;
12
12
  constructor(options?: SyncRulesClient.Options);
13
13
  /**
14
- * Returns the company's effective sync rules - the automatic tag changes applied when events fire. New companies start with an empty rule set; legacy companies may inherit the optional SaaS/ecommerce platform preset. isDefault reports whether that preset is active.
14
+ * Returns the company's effective sync rules - the automatic tag changes applied when events fire. New companies start with the platform preset's payment and ecommerce rules, saved as their own rule set; older companies may inherit the SaaS/ecommerce platform preset. isDefault reports whether that preset is active.
15
15
  *
16
16
  * @param {SyncRulesClient.RequestOptions} requestOptions - Request-specific configuration.
17
17
  *
@@ -13,7 +13,7 @@ export class SyncRulesClient {
13
13
  this._options = normalizeClientOptionsWithAuth(options);
14
14
  }
15
15
  /**
16
- * Returns the company's effective sync rules - the automatic tag changes applied when events fire. New companies start with an empty rule set; legacy companies may inherit the optional SaaS/ecommerce platform preset. isDefault reports whether that preset is active.
16
+ * Returns the company's effective sync rules - the automatic tag changes applied when events fire. New companies start with the platform preset's payment and ecommerce rules, saved as their own rule set; older companies may inherit the SaaS/ecommerce platform preset. isDefault reports whether that preset is active.
17
17
  *
18
18
  * @param {SyncRulesClient.RequestOptions} requestOptions - Request-specific configuration.
19
19
  *
@@ -26,6 +26,6 @@ export interface UpdateTrackingSettingsRequest {
26
26
  transactionalClickTrackingEnabled?: boolean;
27
27
  /** Open tracking default for sends through the Send Email API. Account-wide open tracking must also be enabled; per-send trackingSettings can only opt out. */
28
28
  transactionalOpenTrackingEnabled?: boolean;
29
- /** Whether to track unsubscribe link clicks. When false, Sequenzy unsubscribe links go directly to https://sequenzy.com, even with a custom tracking domain. Actual unsubscribes and their email attribution are still recorded. */
29
+ /** Whether unsubscribe links that point to other services are routed through your tracking domain. Sequenzy's own unsubscribe and preference links, including the one-click unsubscribe header, always use your tracking domain (or the shared one). Actual unsubscribes and their email attribution are recorded either way. */
30
30
  unsubscribeTrackingEnabled?: boolean;
31
31
  }
@@ -10,6 +10,6 @@ export interface TrackingSettingsTracking {
10
10
  transactionalClickTrackingEnabled?: boolean;
11
11
  /** Open tracking default for sends through the Send Email API. Account-wide open tracking must also be enabled; per-send trackingSettings can only opt out. */
12
12
  transactionalOpenTrackingEnabled?: boolean;
13
- /** Whether to track unsubscribe link clicks. When false, Sequenzy unsubscribe links go directly to https://sequenzy.com, even with a custom tracking domain. Actual unsubscribes and their email attribution are still recorded. */
13
+ /** Whether unsubscribe links that point to other services are routed through your tracking domain. Sequenzy's own unsubscribe and preference links, including the one-click unsubscribe header, always use your tracking domain (or the shared one). Actual unsubscribes and their email attribution are recorded either way. */
14
14
  unsubscribeTrackingEnabled?: boolean;
15
15
  }
@@ -4,6 +4,7 @@ import type * as serializers from "../../../../index.js";
4
4
  export declare const SendTestEmailSequencesRequest: core.serialization.Schema<serializers.SendTestEmailSequencesRequest.Raw, Omit<Sequenzy.SendTestEmailSequencesRequest, "sequenceId" | "nodeId">>;
5
5
  export declare namespace SendTestEmailSequencesRequest {
6
6
  interface Raw {
7
+ customAttributes?: Record<string, unknown> | null;
7
8
  recipients: string[];
8
9
  }
9
10
  }
@@ -1,5 +1,6 @@
1
1
  // This file was auto-generated by Fern from our API Definition.
2
2
  import * as core from "../../../../../core/index.js";
3
3
  export const SendTestEmailSequencesRequest = core.serialization.object({
4
+ customAttributes: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
4
5
  recipients: core.serialization.list(core.serialization.string()),
5
6
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sequenzy",
3
- "version": "2.1.56",
3
+ "version": "2.1.60",
4
4
  "description": "Official TypeScript SDK for the Sequenzy API",
5
5
  "license": "MIT",
6
6
  "homepage": "https://docs.sequenzy.com",