sequenzy 2.1.37 → 2.1.39
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/integrations/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/integrations/client/Client.js +1 -1
- package/dist/cjs/api/resources/integrations/client/requests/ConnectIntegrationsRequest.d.ts +2 -2
- package/dist/cjs/api/resources/integrations/types/ConnectIntegrationsRequestProvider.d.ts +1 -0
- package/dist/cjs/api/resources/integrations/types/ConnectIntegrationsRequestProvider.js +1 -0
- package/dist/cjs/api/types/SequenceKeyDates.d.ts +2 -0
- package/dist/cjs/api/types/SequenceKeyDatesSendWindow.d.ts +7 -0
- package/dist/cjs/api/types/SequenceKeyDatesSendWindow.js +3 -0
- package/dist/cjs/api/types/index.d.ts +1 -0
- package/dist/cjs/api/types/index.js +1 -0
- package/dist/cjs/serialization/resources/integrations/types/ConnectIntegrationsRequestProvider.d.ts +1 -1
- package/dist/cjs/serialization/resources/integrations/types/ConnectIntegrationsRequestProvider.js +1 -0
- package/dist/cjs/serialization/types/SequenceKeyDates.d.ts +2 -0
- package/dist/cjs/serialization/types/SequenceKeyDates.js +2 -0
- package/dist/cjs/serialization/types/SequenceKeyDatesSendWindow.d.ts +9 -0
- package/dist/cjs/serialization/types/SequenceKeyDatesSendWindow.js +31 -0
- package/dist/cjs/serialization/types/index.d.ts +1 -0
- package/dist/cjs/serialization/types/index.js +1 -0
- package/dist/esm/api/resources/integrations/client/Client.d.ts +1 -1
- package/dist/esm/api/resources/integrations/client/Client.js +1 -1
- package/dist/esm/api/resources/integrations/client/requests/ConnectIntegrationsRequest.d.ts +2 -2
- package/dist/esm/api/resources/integrations/types/ConnectIntegrationsRequestProvider.d.ts +1 -0
- package/dist/esm/api/resources/integrations/types/ConnectIntegrationsRequestProvider.js +1 -0
- package/dist/esm/api/types/SequenceKeyDates.d.ts +2 -0
- package/dist/esm/api/types/SequenceKeyDatesSendWindow.d.ts +7 -0
- package/dist/esm/api/types/SequenceKeyDatesSendWindow.js +2 -0
- package/dist/esm/api/types/index.d.ts +1 -0
- package/dist/esm/api/types/index.js +1 -0
- package/dist/esm/serialization/resources/integrations/types/ConnectIntegrationsRequestProvider.d.ts +1 -1
- package/dist/esm/serialization/resources/integrations/types/ConnectIntegrationsRequestProvider.js +1 -0
- package/dist/esm/serialization/types/SequenceKeyDates.d.ts +2 -0
- package/dist/esm/serialization/types/SequenceKeyDates.js +2 -0
- package/dist/esm/serialization/types/SequenceKeyDatesSendWindow.d.ts +9 -0
- package/dist/esm/serialization/types/SequenceKeyDatesSendWindow.js +5 -0
- package/dist/esm/serialization/types/index.d.ts +1 -0
- package/dist/esm/serialization/types/index.js +1 -0
- package/package.json +1 -1
|
@@ -30,7 +30,7 @@ export declare class IntegrationsClient {
|
|
|
30
30
|
activatePixel(request: Sequenzy.ActivatePixelIntegrationsRequest, requestOptions?: IntegrationsClient.RequestOptions): core.HttpResponsePromise<Sequenzy.ActivatePixelIntegrationsResponse>;
|
|
31
31
|
private __activatePixel;
|
|
32
32
|
/**
|
|
33
|
-
* Connects an API-key / webhook-secret integration: polar, paddle, dodo, lemon_squeezy, whop, revenuecat, superwall, creem, chargebee, clerk, posthog, segment, affonso, attio, or sparkloop. Credentials are validated, stored encrypted, and never returned. Lemon Squeezy creates a managed signed webhook when webhookSecret is omitted, or uses a caller-managed secret as fallback. Payment providers queue their initial revenue backfill, except RevenueCat and
|
|
33
|
+
* Connects an API-key / webhook-secret integration: polar, paddle, dodo, lemon_squeezy, whop, revenuecat, superwall, adapty, creem, chargebee, clerk, posthog, segment, affonso, attio, or sparkloop. Credentials are validated, stored encrypted, and never returned. Lemon Squeezy creates a managed signed webhook when webhookSecret is omitted, or uses a caller-managed secret as fallback. Payment providers queue their initial revenue backfill, except RevenueCat, Superwall, and Adapty, which are webhook-only; Affonso queues its affiliate backfill; PostHog and Segment can optionally import event history. Attio registers its own webhook when inbound mappings are saved, so it takes no webhookSecret. SparkLoop registers its webhook in SparkLoop during connect and receives partner referrals for one publication (providerAccountId, required only when the account has several). Reconnecting replaces stored credentials. OAuth and app-install providers require the dashboard. Requires the integrations:manage scope.
|
|
34
34
|
*
|
|
35
35
|
* @param {Sequenzy.ConnectIntegrationsRequest} request
|
|
36
36
|
* @param {IntegrationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -106,7 +106,7 @@ class IntegrationsClient {
|
|
|
106
106
|
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/integrations/{id}/pixel");
|
|
107
107
|
}
|
|
108
108
|
/**
|
|
109
|
-
* Connects an API-key / webhook-secret integration: polar, paddle, dodo, lemon_squeezy, whop, revenuecat, superwall, creem, chargebee, clerk, posthog, segment, affonso, attio, or sparkloop. Credentials are validated, stored encrypted, and never returned. Lemon Squeezy creates a managed signed webhook when webhookSecret is omitted, or uses a caller-managed secret as fallback. Payment providers queue their initial revenue backfill, except RevenueCat and
|
|
109
|
+
* Connects an API-key / webhook-secret integration: polar, paddle, dodo, lemon_squeezy, whop, revenuecat, superwall, adapty, creem, chargebee, clerk, posthog, segment, affonso, attio, or sparkloop. Credentials are validated, stored encrypted, and never returned. Lemon Squeezy creates a managed signed webhook when webhookSecret is omitted, or uses a caller-managed secret as fallback. Payment providers queue their initial revenue backfill, except RevenueCat, Superwall, and Adapty, which are webhook-only; Affonso queues its affiliate backfill; PostHog and Segment can optionally import event history. Attio registers its own webhook when inbound mappings are saved, so it takes no webhookSecret. SparkLoop registers its webhook in SparkLoop during connect and receives partner referrals for one publication (providerAccountId, required only when the account has several). Reconnecting replaces stored credentials. OAuth and app-install providers require the dashboard. Requires the integrations:manage scope.
|
|
110
110
|
*
|
|
111
111
|
* @param {Sequenzy.ConnectIntegrationsRequest} request
|
|
112
112
|
* @param {IntegrationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -12,10 +12,10 @@ export interface ConnectIntegrationsRequest {
|
|
|
12
12
|
historyImport?: Sequenzy.ConnectIntegrationsRequestHistoryImport;
|
|
13
13
|
/** Provider to connect. */
|
|
14
14
|
provider: Sequenzy.ConnectIntegrationsRequestProvider;
|
|
15
|
-
/** Provider account id: Paddle seller ID, Dodo business ID, Lemon Squeezy numeric store ID, Whop company ID, Creem store ID, or Chargebee site name. Polar resolves it from the API key. RevenueCat resolves its project ID from the API key; pass it only when the key can access several projects. Superwall
|
|
15
|
+
/** Provider account id: Paddle seller ID, Dodo business ID, Lemon Squeezy numeric store ID, Whop company ID, Creem store ID, or Chargebee site name. Polar resolves it from the API key. RevenueCat resolves its project ID from the API key; pass it only when the key can access several projects. Superwall and Adapty do not use one. SparkLoop: the publication ID (pub_...), required only when the account has several publications. */
|
|
16
16
|
providerAccountId?: string;
|
|
17
17
|
/** PostHog and Segment: event delivery scope. Attio: listMap (Sequenzy list id to Attio list id or slug) and syncCompanyFromDomain. SparkLoop: listIds for new referrals. */
|
|
18
18
|
settings?: Sequenzy.ConnectIntegrationsRequestSettings;
|
|
19
|
-
/** Signing secret of the provider webhook. Optional for lemon_squeezy managed provisioning and for sparkloop, and not used by attio; required for other providers. Lemon Squeezy manual secrets use 16-40 characters. For Chargebee, pass username:password. For RevenueCat, pass at least 16 characters: the authorization header value set on the RevenueCat webhook, or its HMAC signing secret. For Superwall, pass the webhook's whsec_ signing secret, the only credential it needs. For Segment, use 16-153 UTF-8 bytes. For SparkLoop, omit it so Sequenzy authenticates deliveries with a secret in the webhook URL it registers, or pass the account's webhook authentication token to verify the SparkLoop-Token header instead. */
|
|
19
|
+
/** Signing secret of the provider webhook. Optional for lemon_squeezy managed provisioning and for sparkloop, and not used by attio; required for other providers. Lemon Squeezy manual secrets use 16-40 characters. For Chargebee, pass username:password. For RevenueCat, pass at least 16 characters: the authorization header value set on the RevenueCat webhook, or its HMAC signing secret. For Superwall, pass the webhook's whsec_ signing secret, the only credential it needs. For Adapty, pass at least 16 characters: the authorization header value set on the Adapty webhook. For Segment, use 16-153 UTF-8 bytes. For SparkLoop, omit it so Sequenzy authenticates deliveries with a secret in the webhook URL it registers, or pass the account's webhook authentication token to verify the SparkLoop-Token header instead. */
|
|
20
20
|
webhookSecret?: string;
|
|
21
21
|
}
|
|
@@ -7,6 +7,7 @@ export declare const ConnectIntegrationsRequestProvider: {
|
|
|
7
7
|
readonly Whop: "whop";
|
|
8
8
|
readonly Revenuecat: "revenuecat";
|
|
9
9
|
readonly Superwall: "superwall";
|
|
10
|
+
readonly Adapty: "adapty";
|
|
10
11
|
readonly Creem: "creem";
|
|
11
12
|
readonly Chargebee: "chargebee";
|
|
12
13
|
readonly Clerk: "clerk";
|
|
@@ -5,6 +5,8 @@ import type * as Sequenzy from "../index.js";
|
|
|
5
5
|
export interface SequenceKeyDates {
|
|
6
6
|
/** Sorted by time when returned. */
|
|
7
7
|
dates: Sequenzy.SequenceKeyDate[];
|
|
8
|
+
/** How sends timed from these moments are spread out, so a whole audience is not emailed in the same second. Each contact gets their own stable send time within the spread, after the moment for steps at or after it and in the hours leading up to the step's time for steps timed before it, so a "1 hour before Black Friday ends" email never lands after the sale ended. Omit it on update to keep the current spread, and send null to reset it to the default. Responses always include the effective value. */
|
|
9
|
+
sendWindow?: Sequenzy.SequenceKeyDatesSendWindow | null;
|
|
8
10
|
/** IANA timezone the dates are shown and edited in. Required when dates is non-empty. */
|
|
9
11
|
timezone?: string;
|
|
10
12
|
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* How sends timed from these moments are spread out, so a whole audience is not emailed in the same second. Each contact gets their own stable send time within the spread, after the moment for steps at or after it and in the hours leading up to the step's time for steps timed before it, so a "1 hour before Black Friday ends" email never lands after the sale ended. Omit it on update to keep the current spread, and send null to reset it to the default. Responses always include the effective value.
|
|
3
|
+
*/
|
|
4
|
+
export interface SequenceKeyDatesSendWindow {
|
|
5
|
+
/** Spread each email over this many hours. 0 sends everyone at the exact time. */
|
|
6
|
+
spreadOverHours?: number;
|
|
7
|
+
}
|
|
@@ -699,6 +699,7 @@ export * from "./SequenceInboundWebhookFieldMapping.js";
|
|
|
699
699
|
export * from "./SequenceInboundWebhookStatus.js";
|
|
700
700
|
export * from "./SequenceKeyDate.js";
|
|
701
701
|
export * from "./SequenceKeyDates.js";
|
|
702
|
+
export * from "./SequenceKeyDatesSendWindow.js";
|
|
702
703
|
export * from "./SequenceLinearStepInsertionInput.js";
|
|
703
704
|
export * from "./SequenceNode.js";
|
|
704
705
|
export * from "./SequenceNodeUpdateHints.js";
|
|
@@ -715,6 +715,7 @@ __exportStar(require("./SequenceInboundWebhookFieldMapping.js"), exports);
|
|
|
715
715
|
__exportStar(require("./SequenceInboundWebhookStatus.js"), exports);
|
|
716
716
|
__exportStar(require("./SequenceKeyDate.js"), exports);
|
|
717
717
|
__exportStar(require("./SequenceKeyDates.js"), exports);
|
|
718
|
+
__exportStar(require("./SequenceKeyDatesSendWindow.js"), exports);
|
|
718
719
|
__exportStar(require("./SequenceLinearStepInsertionInput.js"), exports);
|
|
719
720
|
__exportStar(require("./SequenceNode.js"), exports);
|
|
720
721
|
__exportStar(require("./SequenceNodeUpdateHints.js"), exports);
|
package/dist/cjs/serialization/resources/integrations/types/ConnectIntegrationsRequestProvider.d.ts
CHANGED
|
@@ -3,5 +3,5 @@ import * as core from "../../../../core/index.js";
|
|
|
3
3
|
import type * as serializers from "../../../index.js";
|
|
4
4
|
export declare const ConnectIntegrationsRequestProvider: core.serialization.Schema<serializers.ConnectIntegrationsRequestProvider.Raw, Sequenzy.ConnectIntegrationsRequestProvider>;
|
|
5
5
|
export declare namespace ConnectIntegrationsRequestProvider {
|
|
6
|
-
type Raw = "polar" | "paddle" | "dodo" | "lemon_squeezy" | "whop" | "revenuecat" | "superwall" | "creem" | "chargebee" | "clerk" | "posthog" | "segment" | "affonso" | "attio" | "sparkloop";
|
|
6
|
+
type Raw = "polar" | "paddle" | "dodo" | "lemon_squeezy" | "whop" | "revenuecat" | "superwall" | "adapty" | "creem" | "chargebee" | "clerk" | "posthog" | "segment" | "affonso" | "attio" | "sparkloop";
|
|
7
7
|
}
|
|
@@ -2,10 +2,12 @@ import type * as Sequenzy from "../../api/index.js";
|
|
|
2
2
|
import * as core from "../../core/index.js";
|
|
3
3
|
import type * as serializers from "../index.js";
|
|
4
4
|
import { SequenceKeyDate } from "./SequenceKeyDate.js";
|
|
5
|
+
import { SequenceKeyDatesSendWindow } from "./SequenceKeyDatesSendWindow.js";
|
|
5
6
|
export declare const SequenceKeyDates: core.serialization.ObjectSchema<serializers.SequenceKeyDates.Raw, Sequenzy.SequenceKeyDates>;
|
|
6
7
|
export declare namespace SequenceKeyDates {
|
|
7
8
|
interface Raw {
|
|
8
9
|
dates: SequenceKeyDate.Raw[];
|
|
10
|
+
sendWindow?: (SequenceKeyDatesSendWindow.Raw | null | undefined) | null;
|
|
9
11
|
timezone?: string | null;
|
|
10
12
|
}
|
|
11
13
|
}
|
|
@@ -27,7 +27,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
27
27
|
exports.SequenceKeyDates = void 0;
|
|
28
28
|
const core = __importStar(require("../../core/index.js"));
|
|
29
29
|
const SequenceKeyDate_js_1 = require("./SequenceKeyDate.js");
|
|
30
|
+
const SequenceKeyDatesSendWindow_js_1 = require("./SequenceKeyDatesSendWindow.js");
|
|
30
31
|
exports.SequenceKeyDates = core.serialization.object({
|
|
31
32
|
dates: core.serialization.list(SequenceKeyDate_js_1.SequenceKeyDate),
|
|
33
|
+
sendWindow: SequenceKeyDatesSendWindow_js_1.SequenceKeyDatesSendWindow.optionalNullable(),
|
|
32
34
|
timezone: core.serialization.string().optional(),
|
|
33
35
|
});
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type * as Sequenzy from "../../api/index.js";
|
|
2
|
+
import * as core from "../../core/index.js";
|
|
3
|
+
import type * as serializers from "../index.js";
|
|
4
|
+
export declare const SequenceKeyDatesSendWindow: core.serialization.ObjectSchema<serializers.SequenceKeyDatesSendWindow.Raw, Sequenzy.SequenceKeyDatesSendWindow>;
|
|
5
|
+
export declare namespace SequenceKeyDatesSendWindow {
|
|
6
|
+
interface Raw {
|
|
7
|
+
spreadOverHours?: number | null;
|
|
8
|
+
}
|
|
9
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
15
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
16
|
+
}) : function(o, v) {
|
|
17
|
+
o["default"] = v;
|
|
18
|
+
});
|
|
19
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
20
|
+
if (mod && mod.__esModule) return mod;
|
|
21
|
+
var result = {};
|
|
22
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
23
|
+
__setModuleDefault(result, mod);
|
|
24
|
+
return result;
|
|
25
|
+
};
|
|
26
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
27
|
+
exports.SequenceKeyDatesSendWindow = void 0;
|
|
28
|
+
const core = __importStar(require("../../core/index.js"));
|
|
29
|
+
exports.SequenceKeyDatesSendWindow = core.serialization.object({
|
|
30
|
+
spreadOverHours: core.serialization.number().optional(),
|
|
31
|
+
});
|
|
@@ -699,6 +699,7 @@ export * from "./SequenceInboundWebhookFieldMapping.js";
|
|
|
699
699
|
export * from "./SequenceInboundWebhookStatus.js";
|
|
700
700
|
export * from "./SequenceKeyDate.js";
|
|
701
701
|
export * from "./SequenceKeyDates.js";
|
|
702
|
+
export * from "./SequenceKeyDatesSendWindow.js";
|
|
702
703
|
export * from "./SequenceLinearStepInsertionInput.js";
|
|
703
704
|
export * from "./SequenceNode.js";
|
|
704
705
|
export * from "./SequenceNodeUpdateHints.js";
|
|
@@ -715,6 +715,7 @@ __exportStar(require("./SequenceInboundWebhookFieldMapping.js"), exports);
|
|
|
715
715
|
__exportStar(require("./SequenceInboundWebhookStatus.js"), exports);
|
|
716
716
|
__exportStar(require("./SequenceKeyDate.js"), exports);
|
|
717
717
|
__exportStar(require("./SequenceKeyDates.js"), exports);
|
|
718
|
+
__exportStar(require("./SequenceKeyDatesSendWindow.js"), exports);
|
|
718
719
|
__exportStar(require("./SequenceLinearStepInsertionInput.js"), exports);
|
|
719
720
|
__exportStar(require("./SequenceNode.js"), exports);
|
|
720
721
|
__exportStar(require("./SequenceNodeUpdateHints.js"), exports);
|
|
@@ -30,7 +30,7 @@ export declare class IntegrationsClient {
|
|
|
30
30
|
activatePixel(request: Sequenzy.ActivatePixelIntegrationsRequest, requestOptions?: IntegrationsClient.RequestOptions): core.HttpResponsePromise<Sequenzy.ActivatePixelIntegrationsResponse>;
|
|
31
31
|
private __activatePixel;
|
|
32
32
|
/**
|
|
33
|
-
* Connects an API-key / webhook-secret integration: polar, paddle, dodo, lemon_squeezy, whop, revenuecat, superwall, creem, chargebee, clerk, posthog, segment, affonso, attio, or sparkloop. Credentials are validated, stored encrypted, and never returned. Lemon Squeezy creates a managed signed webhook when webhookSecret is omitted, or uses a caller-managed secret as fallback. Payment providers queue their initial revenue backfill, except RevenueCat and
|
|
33
|
+
* Connects an API-key / webhook-secret integration: polar, paddle, dodo, lemon_squeezy, whop, revenuecat, superwall, adapty, creem, chargebee, clerk, posthog, segment, affonso, attio, or sparkloop. Credentials are validated, stored encrypted, and never returned. Lemon Squeezy creates a managed signed webhook when webhookSecret is omitted, or uses a caller-managed secret as fallback. Payment providers queue their initial revenue backfill, except RevenueCat, Superwall, and Adapty, which are webhook-only; Affonso queues its affiliate backfill; PostHog and Segment can optionally import event history. Attio registers its own webhook when inbound mappings are saved, so it takes no webhookSecret. SparkLoop registers its webhook in SparkLoop during connect and receives partner referrals for one publication (providerAccountId, required only when the account has several). Reconnecting replaces stored credentials. OAuth and app-install providers require the dashboard. Requires the integrations:manage scope.
|
|
34
34
|
*
|
|
35
35
|
* @param {Sequenzy.ConnectIntegrationsRequest} request
|
|
36
36
|
* @param {IntegrationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -80,7 +80,7 @@ export class IntegrationsClient {
|
|
|
80
80
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/integrations/{id}/pixel");
|
|
81
81
|
}
|
|
82
82
|
/**
|
|
83
|
-
* Connects an API-key / webhook-secret integration: polar, paddle, dodo, lemon_squeezy, whop, revenuecat, superwall, creem, chargebee, clerk, posthog, segment, affonso, attio, or sparkloop. Credentials are validated, stored encrypted, and never returned. Lemon Squeezy creates a managed signed webhook when webhookSecret is omitted, or uses a caller-managed secret as fallback. Payment providers queue their initial revenue backfill, except RevenueCat and
|
|
83
|
+
* Connects an API-key / webhook-secret integration: polar, paddle, dodo, lemon_squeezy, whop, revenuecat, superwall, adapty, creem, chargebee, clerk, posthog, segment, affonso, attio, or sparkloop. Credentials are validated, stored encrypted, and never returned. Lemon Squeezy creates a managed signed webhook when webhookSecret is omitted, or uses a caller-managed secret as fallback. Payment providers queue their initial revenue backfill, except RevenueCat, Superwall, and Adapty, which are webhook-only; Affonso queues its affiliate backfill; PostHog and Segment can optionally import event history. Attio registers its own webhook when inbound mappings are saved, so it takes no webhookSecret. SparkLoop registers its webhook in SparkLoop during connect and receives partner referrals for one publication (providerAccountId, required only when the account has several). Reconnecting replaces stored credentials. OAuth and app-install providers require the dashboard. Requires the integrations:manage scope.
|
|
84
84
|
*
|
|
85
85
|
* @param {Sequenzy.ConnectIntegrationsRequest} request
|
|
86
86
|
* @param {IntegrationsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -12,10 +12,10 @@ export interface ConnectIntegrationsRequest {
|
|
|
12
12
|
historyImport?: Sequenzy.ConnectIntegrationsRequestHistoryImport;
|
|
13
13
|
/** Provider to connect. */
|
|
14
14
|
provider: Sequenzy.ConnectIntegrationsRequestProvider;
|
|
15
|
-
/** Provider account id: Paddle seller ID, Dodo business ID, Lemon Squeezy numeric store ID, Whop company ID, Creem store ID, or Chargebee site name. Polar resolves it from the API key. RevenueCat resolves its project ID from the API key; pass it only when the key can access several projects. Superwall
|
|
15
|
+
/** Provider account id: Paddle seller ID, Dodo business ID, Lemon Squeezy numeric store ID, Whop company ID, Creem store ID, or Chargebee site name. Polar resolves it from the API key. RevenueCat resolves its project ID from the API key; pass it only when the key can access several projects. Superwall and Adapty do not use one. SparkLoop: the publication ID (pub_...), required only when the account has several publications. */
|
|
16
16
|
providerAccountId?: string;
|
|
17
17
|
/** PostHog and Segment: event delivery scope. Attio: listMap (Sequenzy list id to Attio list id or slug) and syncCompanyFromDomain. SparkLoop: listIds for new referrals. */
|
|
18
18
|
settings?: Sequenzy.ConnectIntegrationsRequestSettings;
|
|
19
|
-
/** Signing secret of the provider webhook. Optional for lemon_squeezy managed provisioning and for sparkloop, and not used by attio; required for other providers. Lemon Squeezy manual secrets use 16-40 characters. For Chargebee, pass username:password. For RevenueCat, pass at least 16 characters: the authorization header value set on the RevenueCat webhook, or its HMAC signing secret. For Superwall, pass the webhook's whsec_ signing secret, the only credential it needs. For Segment, use 16-153 UTF-8 bytes. For SparkLoop, omit it so Sequenzy authenticates deliveries with a secret in the webhook URL it registers, or pass the account's webhook authentication token to verify the SparkLoop-Token header instead. */
|
|
19
|
+
/** Signing secret of the provider webhook. Optional for lemon_squeezy managed provisioning and for sparkloop, and not used by attio; required for other providers. Lemon Squeezy manual secrets use 16-40 characters. For Chargebee, pass username:password. For RevenueCat, pass at least 16 characters: the authorization header value set on the RevenueCat webhook, or its HMAC signing secret. For Superwall, pass the webhook's whsec_ signing secret, the only credential it needs. For Adapty, pass at least 16 characters: the authorization header value set on the Adapty webhook. For Segment, use 16-153 UTF-8 bytes. For SparkLoop, omit it so Sequenzy authenticates deliveries with a secret in the webhook URL it registers, or pass the account's webhook authentication token to verify the SparkLoop-Token header instead. */
|
|
20
20
|
webhookSecret?: string;
|
|
21
21
|
}
|
|
@@ -7,6 +7,7 @@ export declare const ConnectIntegrationsRequestProvider: {
|
|
|
7
7
|
readonly Whop: "whop";
|
|
8
8
|
readonly Revenuecat: "revenuecat";
|
|
9
9
|
readonly Superwall: "superwall";
|
|
10
|
+
readonly Adapty: "adapty";
|
|
10
11
|
readonly Creem: "creem";
|
|
11
12
|
readonly Chargebee: "chargebee";
|
|
12
13
|
readonly Clerk: "clerk";
|
|
@@ -5,6 +5,8 @@ import type * as Sequenzy from "../index.js";
|
|
|
5
5
|
export interface SequenceKeyDates {
|
|
6
6
|
/** Sorted by time when returned. */
|
|
7
7
|
dates: Sequenzy.SequenceKeyDate[];
|
|
8
|
+
/** How sends timed from these moments are spread out, so a whole audience is not emailed in the same second. Each contact gets their own stable send time within the spread, after the moment for steps at or after it and in the hours leading up to the step's time for steps timed before it, so a "1 hour before Black Friday ends" email never lands after the sale ended. Omit it on update to keep the current spread, and send null to reset it to the default. Responses always include the effective value. */
|
|
9
|
+
sendWindow?: Sequenzy.SequenceKeyDatesSendWindow | null;
|
|
8
10
|
/** IANA timezone the dates are shown and edited in. Required when dates is non-empty. */
|
|
9
11
|
timezone?: string;
|
|
10
12
|
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* How sends timed from these moments are spread out, so a whole audience is not emailed in the same second. Each contact gets their own stable send time within the spread, after the moment for steps at or after it and in the hours leading up to the step's time for steps timed before it, so a "1 hour before Black Friday ends" email never lands after the sale ended. Omit it on update to keep the current spread, and send null to reset it to the default. Responses always include the effective value.
|
|
3
|
+
*/
|
|
4
|
+
export interface SequenceKeyDatesSendWindow {
|
|
5
|
+
/** Spread each email over this many hours. 0 sends everyone at the exact time. */
|
|
6
|
+
spreadOverHours?: number;
|
|
7
|
+
}
|
|
@@ -699,6 +699,7 @@ export * from "./SequenceInboundWebhookFieldMapping.js";
|
|
|
699
699
|
export * from "./SequenceInboundWebhookStatus.js";
|
|
700
700
|
export * from "./SequenceKeyDate.js";
|
|
701
701
|
export * from "./SequenceKeyDates.js";
|
|
702
|
+
export * from "./SequenceKeyDatesSendWindow.js";
|
|
702
703
|
export * from "./SequenceLinearStepInsertionInput.js";
|
|
703
704
|
export * from "./SequenceNode.js";
|
|
704
705
|
export * from "./SequenceNodeUpdateHints.js";
|
|
@@ -699,6 +699,7 @@ export * from "./SequenceInboundWebhookFieldMapping.js";
|
|
|
699
699
|
export * from "./SequenceInboundWebhookStatus.js";
|
|
700
700
|
export * from "./SequenceKeyDate.js";
|
|
701
701
|
export * from "./SequenceKeyDates.js";
|
|
702
|
+
export * from "./SequenceKeyDatesSendWindow.js";
|
|
702
703
|
export * from "./SequenceLinearStepInsertionInput.js";
|
|
703
704
|
export * from "./SequenceNode.js";
|
|
704
705
|
export * from "./SequenceNodeUpdateHints.js";
|
package/dist/esm/serialization/resources/integrations/types/ConnectIntegrationsRequestProvider.d.ts
CHANGED
|
@@ -3,5 +3,5 @@ import * as core from "../../../../core/index.js";
|
|
|
3
3
|
import type * as serializers from "../../../index.js";
|
|
4
4
|
export declare const ConnectIntegrationsRequestProvider: core.serialization.Schema<serializers.ConnectIntegrationsRequestProvider.Raw, Sequenzy.ConnectIntegrationsRequestProvider>;
|
|
5
5
|
export declare namespace ConnectIntegrationsRequestProvider {
|
|
6
|
-
type Raw = "polar" | "paddle" | "dodo" | "lemon_squeezy" | "whop" | "revenuecat" | "superwall" | "creem" | "chargebee" | "clerk" | "posthog" | "segment" | "affonso" | "attio" | "sparkloop";
|
|
6
|
+
type Raw = "polar" | "paddle" | "dodo" | "lemon_squeezy" | "whop" | "revenuecat" | "superwall" | "adapty" | "creem" | "chargebee" | "clerk" | "posthog" | "segment" | "affonso" | "attio" | "sparkloop";
|
|
7
7
|
}
|
|
@@ -2,10 +2,12 @@ import type * as Sequenzy from "../../api/index.js";
|
|
|
2
2
|
import * as core from "../../core/index.js";
|
|
3
3
|
import type * as serializers from "../index.js";
|
|
4
4
|
import { SequenceKeyDate } from "./SequenceKeyDate.js";
|
|
5
|
+
import { SequenceKeyDatesSendWindow } from "./SequenceKeyDatesSendWindow.js";
|
|
5
6
|
export declare const SequenceKeyDates: core.serialization.ObjectSchema<serializers.SequenceKeyDates.Raw, Sequenzy.SequenceKeyDates>;
|
|
6
7
|
export declare namespace SequenceKeyDates {
|
|
7
8
|
interface Raw {
|
|
8
9
|
dates: SequenceKeyDate.Raw[];
|
|
10
|
+
sendWindow?: (SequenceKeyDatesSendWindow.Raw | null | undefined) | null;
|
|
9
11
|
timezone?: string | null;
|
|
10
12
|
}
|
|
11
13
|
}
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
2
|
import * as core from "../../core/index.js";
|
|
3
3
|
import { SequenceKeyDate } from "./SequenceKeyDate.js";
|
|
4
|
+
import { SequenceKeyDatesSendWindow } from "./SequenceKeyDatesSendWindow.js";
|
|
4
5
|
export const SequenceKeyDates = core.serialization.object({
|
|
5
6
|
dates: core.serialization.list(SequenceKeyDate),
|
|
7
|
+
sendWindow: SequenceKeyDatesSendWindow.optionalNullable(),
|
|
6
8
|
timezone: core.serialization.string().optional(),
|
|
7
9
|
});
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type * as Sequenzy from "../../api/index.js";
|
|
2
|
+
import * as core from "../../core/index.js";
|
|
3
|
+
import type * as serializers from "../index.js";
|
|
4
|
+
export declare const SequenceKeyDatesSendWindow: core.serialization.ObjectSchema<serializers.SequenceKeyDatesSendWindow.Raw, Sequenzy.SequenceKeyDatesSendWindow>;
|
|
5
|
+
export declare namespace SequenceKeyDatesSendWindow {
|
|
6
|
+
interface Raw {
|
|
7
|
+
spreadOverHours?: number | null;
|
|
8
|
+
}
|
|
9
|
+
}
|
|
@@ -699,6 +699,7 @@ export * from "./SequenceInboundWebhookFieldMapping.js";
|
|
|
699
699
|
export * from "./SequenceInboundWebhookStatus.js";
|
|
700
700
|
export * from "./SequenceKeyDate.js";
|
|
701
701
|
export * from "./SequenceKeyDates.js";
|
|
702
|
+
export * from "./SequenceKeyDatesSendWindow.js";
|
|
702
703
|
export * from "./SequenceLinearStepInsertionInput.js";
|
|
703
704
|
export * from "./SequenceNode.js";
|
|
704
705
|
export * from "./SequenceNodeUpdateHints.js";
|
|
@@ -699,6 +699,7 @@ export * from "./SequenceInboundWebhookFieldMapping.js";
|
|
|
699
699
|
export * from "./SequenceInboundWebhookStatus.js";
|
|
700
700
|
export * from "./SequenceKeyDate.js";
|
|
701
701
|
export * from "./SequenceKeyDates.js";
|
|
702
|
+
export * from "./SequenceKeyDatesSendWindow.js";
|
|
702
703
|
export * from "./SequenceLinearStepInsertionInput.js";
|
|
703
704
|
export * from "./SequenceNode.js";
|
|
704
705
|
export * from "./SequenceNodeUpdateHints.js";
|