UNPKG

2.85 kBTypeScriptView Raw
1import { FilteringParameters } from "../client/FilteringParameters";
2export declare enum OutboundMessageStatus {
3 Queued = "queued",
4 Sent = "sent",
5 Processed = "processed"
6}
7export declare enum InboundMessageStatus {
8 Queued = "queued",
9 Sent = "sent",
10 Processed = "processed",
11 Blocked = "blocked",
12 Failed = "failed",
13 Scheduled = "scheduled"
14}
15/**
16 * Describes filtering parameters that can be used when retrieving outbound messages.
17 * When pagination parameters are not specified, default values are set.
18 */
19export declare class OutboundMessagesFilteringParameters extends FilteringParameters {
20 recipient?: string;
21 fromEmail?: string;
22 tag?: string;
23 status?: OutboundMessageStatus;
24 fromDate?: string;
25 toDate?: string;
26 subject?: string;
27 messageStream?: string;
28 [key: string]: any;
29 constructor(count?: number, offset?: number, recipient?: string, fromEmail?: string, tag?: string, status?: OutboundMessageStatus, fromDate?: string, toDate?: string, subject?: string, messageStream?: string);
30}
31/**
32 * Describes filtering parameters that can be used when retrieving inbound messages.
33 * When pagination parameters are not specified, default values are set.
34 */
35export declare class InboundMessagesFilteringParameters extends FilteringParameters {
36 mailboxHash?: string;
37 recipient?: string;
38 fromEmail?: string;
39 tag?: string;
40 status?: InboundMessageStatus;
41 fromDate?: string;
42 toDate?: string;
43 subject?: string;
44 constructor(count?: number, offset?: number, mailboxHash?: string, recipient?: string, fromEmail?: string, tag?: string, status?: InboundMessageStatus, fromDate?: string, toDate?: string, subject?: string);
45}
46/**
47 * Describes filtering parameters that can be used when retrieving tracked outbound messages.
48 * When pagination parameters are not specified, default values are set.
49 */
50export declare class OutboundMessageTrackingFilteringParameters extends FilteringParameters {
51 recipient?: string;
52 tag?: string;
53 client_name?: string;
54 client_company?: string;
55 client_family?: string;
56 os_name?: string;
57 os_family?: string;
58 os_company?: string;
59 platform?: string;
60 country?: string;
61 region?: string;
62 city?: string;
63 messageStream?: string;
64 constructor(count?: number, offset?: number, recipient?: string, tag?: string, client_name?: string, client_company?: string, client_family?: string, os_name?: string, os_family?: string, os_company?: string, platform?: string, country?: string, region?: string, city?: string, messageStream?: string);
65}
66export declare class OutboundMessageOpensFilteringParameters extends OutboundMessageTrackingFilteringParameters {
67}
68export declare class OutboundMessageClicksFilteringParameters extends OutboundMessageTrackingFilteringParameters {
69}