@pushwoosh/rpc-v2-http-api-data 0.2.220 → 0.2.222
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/data.js +3 -0
- package/deliverability_checker.d.ts +5 -3
- package/package.json +1 -1
package/data.js
CHANGED
|
@@ -2,20 +2,22 @@ import { RpcMethod } from './commonTypes';
|
|
|
2
2
|
export type DeliverabilityCheckerService_CreateSandboxCheck = RpcMethod<CreateSandboxCheckRequest, CreateSandboxCheckResponse>;
|
|
3
3
|
export type DeliverabilityCheckerService_GetSandboxResult = RpcMethod<GetSandboxResultRequest, GetSandboxResultResponse>;
|
|
4
4
|
export interface DeliverabilityCheckerService {
|
|
5
|
-
/** Starts an email deliverability sandbox check: sends the email preset (preset code) as a real test email to
|
|
5
|
+
/** Starts an email deliverability sandbox check: sends the email preset (preset code) as a real test email to the given address and runs compliance and content checks. Returns a message code to poll with get_deliverability_result; run before a broadcast to catch spam-score, broken-link and unsubscribe issues. */
|
|
6
6
|
CreateSandboxCheck: DeliverabilityCheckerService_CreateSandboxCheck;
|
|
7
7
|
/** Returns the state and, when finished, the delivery result and deliverability report (spam score, broken links, unsubscribe health) for a sandbox check by message code. Poll after create_deliverability_check until state is SANDBOX_DONE or SANDBOX_FAILED. */
|
|
8
8
|
GetSandboxResult: DeliverabilityCheckerService_GetSandboxResult;
|
|
9
9
|
}
|
|
10
10
|
export type CreateSandboxCheckRequest = {
|
|
11
|
-
/** Pushwoosh application code (XXXXX-XXXXX) that owns the preset
|
|
11
|
+
/** Pushwoosh application code (XXXXX-XXXXX) that owns the preset. */
|
|
12
12
|
applicationCode?: string;
|
|
13
13
|
/** Email preset code whose content is checked; required. */
|
|
14
14
|
presetCode?: string;
|
|
15
|
-
/**
|
|
15
|
+
/** Deprecated: use recipient_email. A plain address here is still accepted. */
|
|
16
16
|
testDeviceHwid?: string;
|
|
17
17
|
/** Optional from / reply-to / subject overrides applied to the preset before sending. */
|
|
18
18
|
overrides?: EmailOverrides;
|
|
19
|
+
/** Address that receives the sandbox test email; any valid address, no test device needed. Required. */
|
|
20
|
+
recipientEmail?: string;
|
|
19
21
|
};
|
|
20
22
|
export type EmailOverrides = {
|
|
21
23
|
from: EmailAddress;
|