@pushwoosh/rpc-v2-http-api-data 0.2.238 → 0.2.240
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 +137 -6
- package/email_suppressions.d.ts +33 -0
- package/package.json +1 -1
- package/pushwoosh_export_messages_v2.d.ts +43 -6
package/data.js
CHANGED
|
@@ -10659,6 +10659,12 @@ export const data = {
|
|
|
10659
10659
|
"method": "post",
|
|
10660
10660
|
"path": "/api/email_suppressions:reactivate"
|
|
10661
10661
|
},
|
|
10662
|
+
"ListEmailSuppressions": {
|
|
10663
|
+
"request": "pushwoosh.rpc_v2.email_suppressions.ListEmailSuppressionsRequest",
|
|
10664
|
+
"response": "pushwoosh.rpc_v2.email_suppressions.ListEmailSuppressionsResponse",
|
|
10665
|
+
"method": "get",
|
|
10666
|
+
"path": "/api/email_suppressions"
|
|
10667
|
+
},
|
|
10662
10668
|
"ListEmailReactivations": {
|
|
10663
10669
|
"request": "pushwoosh.rpc_v2.email_suppressions.ListEmailReactivationsRequest",
|
|
10664
10670
|
"response": "pushwoosh.rpc_v2.email_suppressions.ListEmailReactivationsResponse",
|
|
@@ -10667,6 +10673,73 @@ export const data = {
|
|
|
10667
10673
|
}
|
|
10668
10674
|
}
|
|
10669
10675
|
},
|
|
10676
|
+
"pushwoosh.rpc_v2.email_suppressions.ListEmailSuppressionsRequest": {
|
|
10677
|
+
"type": "I",
|
|
10678
|
+
"fields": {
|
|
10679
|
+
"application": {
|
|
10680
|
+
"type": "string"
|
|
10681
|
+
},
|
|
10682
|
+
"email": {
|
|
10683
|
+
"type": "string"
|
|
10684
|
+
},
|
|
10685
|
+
"source": {
|
|
10686
|
+
"type": "pushwoosh.rpc_v2.email_suppressions.EmailSuppressionSource"
|
|
10687
|
+
},
|
|
10688
|
+
"dateFrom": {
|
|
10689
|
+
"type": "Date"
|
|
10690
|
+
},
|
|
10691
|
+
"dateTo": {
|
|
10692
|
+
"type": "Date"
|
|
10693
|
+
},
|
|
10694
|
+
"recordedInApplication": {
|
|
10695
|
+
"type": "string"
|
|
10696
|
+
},
|
|
10697
|
+
"limit": {
|
|
10698
|
+
"type": "number"
|
|
10699
|
+
},
|
|
10700
|
+
"offset": {
|
|
10701
|
+
"type": "number"
|
|
10702
|
+
}
|
|
10703
|
+
}
|
|
10704
|
+
},
|
|
10705
|
+
"pushwoosh.rpc_v2.email_suppressions.ListEmailSuppressionsResponse": {
|
|
10706
|
+
"type": "I",
|
|
10707
|
+
"fields": {
|
|
10708
|
+
"suppressions": {
|
|
10709
|
+
"type": "pushwoosh.rpc_v2.email_suppressions.EmailSuppressionEntry",
|
|
10710
|
+
"array": true
|
|
10711
|
+
},
|
|
10712
|
+
"total": {
|
|
10713
|
+
"type": "number"
|
|
10714
|
+
}
|
|
10715
|
+
}
|
|
10716
|
+
},
|
|
10717
|
+
"pushwoosh.rpc_v2.email_suppressions.EmailSuppressionEntry": {
|
|
10718
|
+
"type": "I",
|
|
10719
|
+
"fields": {
|
|
10720
|
+
"email": {
|
|
10721
|
+
"type": "string"
|
|
10722
|
+
},
|
|
10723
|
+
"source": {
|
|
10724
|
+
"type": "pushwoosh.rpc_v2.email_suppressions.EmailSuppressionSource"
|
|
10725
|
+
},
|
|
10726
|
+
"occurredAt": {
|
|
10727
|
+
"type": "Date"
|
|
10728
|
+
},
|
|
10729
|
+
"reason": {
|
|
10730
|
+
"type": "string"
|
|
10731
|
+
},
|
|
10732
|
+
"smtpCode": {
|
|
10733
|
+
"type": "string"
|
|
10734
|
+
},
|
|
10735
|
+
"diagnosticCode": {
|
|
10736
|
+
"type": "string"
|
|
10737
|
+
},
|
|
10738
|
+
"application": {
|
|
10739
|
+
"type": "string"
|
|
10740
|
+
}
|
|
10741
|
+
}
|
|
10742
|
+
},
|
|
10670
10743
|
"pushwoosh.rpc_v2.email_suppressions.ReactivateEmailRequest": {
|
|
10671
10744
|
"type": "I",
|
|
10672
10745
|
"fields": {
|
|
@@ -12280,7 +12353,8 @@ export const data = {
|
|
|
12280
12353
|
"TASK_TYPE_EXPORT_MESSAGE_STAGE_RECIPIENTS",
|
|
12281
12354
|
"TASK_TYPE_EXPORT_MESSAGE_CLICKED_RECIPIENTS",
|
|
12282
12355
|
"TASK_TYPE_EXPORT_MESSAGE_UNSUBSCRIBED",
|
|
12283
|
-
"TASK_TYPE_EXPORT_MESSAGE_ERROR_RECIPIENTS"
|
|
12356
|
+
"TASK_TYPE_EXPORT_MESSAGE_ERROR_RECIPIENTS",
|
|
12357
|
+
"TASK_TYPE_EXPORT_EMAIL_SUPPRESSIONS"
|
|
12284
12358
|
]
|
|
12285
12359
|
},
|
|
12286
12360
|
"pushwoosh.export_messages.v2.ExportRequest": {
|
|
@@ -12375,6 +12449,9 @@ export const data = {
|
|
|
12375
12449
|
},
|
|
12376
12450
|
"exportMessageErrorRecipients": {
|
|
12377
12451
|
"type": "pushwoosh.export_messages.v2.ExportMessageErrorRecipientsArgs"
|
|
12452
|
+
},
|
|
12453
|
+
"exportEmailSuppressions": {
|
|
12454
|
+
"type": "pushwoosh.export_messages.v2.ExportEmailSuppressionsArgs"
|
|
12378
12455
|
}
|
|
12379
12456
|
},
|
|
12380
12457
|
"oneofs": {
|
|
@@ -12408,7 +12485,8 @@ export const data = {
|
|
|
12408
12485
|
"exportMessageStageRecipients",
|
|
12409
12486
|
"exportMessageClickedRecipients",
|
|
12410
12487
|
"exportMessageUnsubscribed",
|
|
12411
|
-
"exportMessageErrorRecipients"
|
|
12488
|
+
"exportMessageErrorRecipients",
|
|
12489
|
+
"exportEmailSuppressions"
|
|
12412
12490
|
]
|
|
12413
12491
|
}
|
|
12414
12492
|
}
|
|
@@ -12564,6 +12642,9 @@ export const data = {
|
|
|
12564
12642
|
},
|
|
12565
12643
|
"exportMessageErrorRecipientsResult": {
|
|
12566
12644
|
"type": "pushwoosh.export_messages.v2.ExportMessageErrorRecipientsResult"
|
|
12645
|
+
},
|
|
12646
|
+
"exportEmailSuppressionsResult": {
|
|
12647
|
+
"type": "pushwoosh.export_messages.v2.ExportEmailSuppressionsResult"
|
|
12567
12648
|
}
|
|
12568
12649
|
},
|
|
12569
12650
|
"oneofs": {
|
|
@@ -12598,7 +12679,8 @@ export const data = {
|
|
|
12598
12679
|
"exportMessageStageRecipientsResult",
|
|
12599
12680
|
"exportMessageClickedRecipientsResult",
|
|
12600
12681
|
"exportMessageUnsubscribedResult",
|
|
12601
|
-
"exportMessageErrorRecipientsResult"
|
|
12682
|
+
"exportMessageErrorRecipientsResult",
|
|
12683
|
+
"exportEmailSuppressionsResult"
|
|
12602
12684
|
]
|
|
12603
12685
|
}
|
|
12604
12686
|
}
|
|
@@ -12738,6 +12820,9 @@ export const data = {
|
|
|
12738
12820
|
"exportMessageErrorRecipients": {
|
|
12739
12821
|
"type": "pushwoosh.export_messages.v2.ExportMessageErrorRecipientsArgs"
|
|
12740
12822
|
},
|
|
12823
|
+
"exportEmailSuppressions": {
|
|
12824
|
+
"type": "pushwoosh.export_messages.v2.ExportEmailSuppressionsArgs"
|
|
12825
|
+
},
|
|
12741
12826
|
"failedTask": {
|
|
12742
12827
|
"type": "pushwoosh.export_messages.v2.TaskFailed"
|
|
12743
12828
|
},
|
|
@@ -12818,6 +12903,9 @@ export const data = {
|
|
|
12818
12903
|
},
|
|
12819
12904
|
"exportMessageErrorRecipientsResult": {
|
|
12820
12905
|
"type": "pushwoosh.export_messages.v2.ExportMessageErrorRecipientsResult"
|
|
12906
|
+
},
|
|
12907
|
+
"exportEmailSuppressionsResult": {
|
|
12908
|
+
"type": "pushwoosh.export_messages.v2.ExportEmailSuppressionsResult"
|
|
12821
12909
|
}
|
|
12822
12910
|
},
|
|
12823
12911
|
"oneofs": {
|
|
@@ -12848,7 +12936,8 @@ export const data = {
|
|
|
12848
12936
|
"exportMessageStageRecipients",
|
|
12849
12937
|
"exportMessageClickedRecipients",
|
|
12850
12938
|
"exportMessageUnsubscribed",
|
|
12851
|
-
"exportMessageErrorRecipients"
|
|
12939
|
+
"exportMessageErrorRecipients",
|
|
12940
|
+
"exportEmailSuppressions"
|
|
12852
12941
|
]
|
|
12853
12942
|
},
|
|
12854
12943
|
"result": {
|
|
@@ -12879,7 +12968,8 @@ export const data = {
|
|
|
12879
12968
|
"exportMessageStageRecipientsResult",
|
|
12880
12969
|
"exportMessageClickedRecipientsResult",
|
|
12881
12970
|
"exportMessageUnsubscribedResult",
|
|
12882
|
-
"exportMessageErrorRecipientsResult"
|
|
12971
|
+
"exportMessageErrorRecipientsResult",
|
|
12972
|
+
"exportEmailSuppressionsResult"
|
|
12883
12973
|
]
|
|
12884
12974
|
}
|
|
12885
12975
|
}
|
|
@@ -12984,7 +13074,9 @@ export const data = {
|
|
|
12984
13074
|
"PUSH_ON_EVENT",
|
|
12985
13075
|
"RSS",
|
|
12986
13076
|
"SYSTEM",
|
|
12987
|
-
"TWITTER"
|
|
13077
|
+
"TWITTER",
|
|
13078
|
+
"WHATSAPP_API",
|
|
13079
|
+
"SMS_API"
|
|
12988
13080
|
]
|
|
12989
13081
|
},
|
|
12990
13082
|
"pushwoosh.export_messages.v2.MessageStatus": {
|
|
@@ -13846,6 +13938,45 @@ export const data = {
|
|
|
13846
13938
|
}
|
|
13847
13939
|
}
|
|
13848
13940
|
},
|
|
13941
|
+
"pushwoosh.export_messages.v2.ExportEmailSuppressionsArgs.Source": {
|
|
13942
|
+
"type": "E",
|
|
13943
|
+
"values": [
|
|
13944
|
+
"any",
|
|
13945
|
+
"spam_complaint",
|
|
13946
|
+
"hard_bounce"
|
|
13947
|
+
]
|
|
13948
|
+
},
|
|
13949
|
+
"pushwoosh.export_messages.v2.ExportEmailSuppressionsArgs": {
|
|
13950
|
+
"type": "I",
|
|
13951
|
+
"fields": {
|
|
13952
|
+
"application": {
|
|
13953
|
+
"type": "string"
|
|
13954
|
+
},
|
|
13955
|
+
"email": {
|
|
13956
|
+
"type": "string"
|
|
13957
|
+
},
|
|
13958
|
+
"source": {
|
|
13959
|
+
"type": "pushwoosh.export_messages.v2.ExportEmailSuppressionsArgs.Source"
|
|
13960
|
+
},
|
|
13961
|
+
"dateFrom": {
|
|
13962
|
+
"type": "Date"
|
|
13963
|
+
},
|
|
13964
|
+
"dateTo": {
|
|
13965
|
+
"type": "Date"
|
|
13966
|
+
},
|
|
13967
|
+
"recordedInApplication": {
|
|
13968
|
+
"type": "string"
|
|
13969
|
+
}
|
|
13970
|
+
}
|
|
13971
|
+
},
|
|
13972
|
+
"pushwoosh.export_messages.v2.ExportEmailSuppressionsResult": {
|
|
13973
|
+
"type": "I",
|
|
13974
|
+
"fields": {
|
|
13975
|
+
"file": {
|
|
13976
|
+
"type": "string"
|
|
13977
|
+
}
|
|
13978
|
+
}
|
|
13979
|
+
},
|
|
13849
13980
|
"pushwoosh.export_messages.v2.ExportMessageErrorRecipientsArgs": {
|
|
13850
13981
|
"type": "I",
|
|
13851
13982
|
"fields": {
|
package/email_suppressions.d.ts
CHANGED
|
@@ -1,15 +1,48 @@
|
|
|
1
1
|
import { RpcMethod } from './commonTypes';
|
|
2
2
|
export type EmailSuppressionsService_GetEmailSuppression = RpcMethod<GetEmailSuppressionRequest, GetEmailSuppressionResponse>;
|
|
3
3
|
export type EmailSuppressionsService_ReactivateEmail = RpcMethod<ReactivateEmailRequest, ReactivateEmailResponse>;
|
|
4
|
+
export type EmailSuppressionsService_ListEmailSuppressions = RpcMethod<ListEmailSuppressionsRequest, ListEmailSuppressionsResponse>;
|
|
4
5
|
export type EmailSuppressionsService_ListEmailReactivations = RpcMethod<ListEmailReactivationsRequest, ListEmailReactivationsResponse>;
|
|
5
6
|
export interface EmailSuppressionsService {
|
|
6
7
|
/** Returns whether an email address is suppressed (spam complaint or hard bounce) for the application's account, with the source, date and the provider's verbatim reason including SMTP and diagnostic codes. Use to explain why emails to a subscriber are not going out while the profile still looks subscribed. */
|
|
7
8
|
GetEmailSuppression: EmailSuppressionsService_GetEmailSuppression;
|
|
8
9
|
/** Takes an email address off the suppression lists for the account: removes the complaint and hard-bounce records, clears the Bounced Email tag and re-registers the email device when the complaint had unregistered it. Requires the ManageEmailSuppression right, and consent_confirmed for an address suppressed by a spam complaint. */
|
|
9
10
|
ReactivateEmail: EmailSuppressionsService_ReactivateEmail;
|
|
11
|
+
/** Lists the account's suppressed email addresses with the source, date and provider reason, newest first. Filter by source, by the date the suppression happened, by the application it was recorded in, or look one exact address up — the support scenario "which list is this address on". */
|
|
12
|
+
ListEmailSuppressions: EmailSuppressionsService_ListEmailSuppressions;
|
|
10
13
|
/** Returns the journal of suppression removals for the account — who reactivated which address, from which list, with what comment and through which channel. Use to prove to a mailbox provider that returns were deliberate. */
|
|
11
14
|
ListEmailReactivations: EmailSuppressionsService_ListEmailReactivations;
|
|
12
15
|
}
|
|
16
|
+
export type ListEmailSuppressionsRequest = {
|
|
17
|
+
/** Pushwoosh application code (XXXXX-XXXXX) the caller works from; the list itself is account-wide. */
|
|
18
|
+
application?: string;
|
|
19
|
+
/** Exact address filter, matched case-insensitively; empty lists everything. */
|
|
20
|
+
email?: string;
|
|
21
|
+
/** Source filter; unspecified returns both lists merged by date. */
|
|
22
|
+
source?: EmailSuppressionSource;
|
|
23
|
+
dateFrom?: Date;
|
|
24
|
+
dateTo?: Date;
|
|
25
|
+
/** Application code the suppression was recorded in; empty covers the whole account. */
|
|
26
|
+
recordedInApplication?: string;
|
|
27
|
+
/** Page size, 50 by default, 500 at most. */
|
|
28
|
+
limit?: number;
|
|
29
|
+
offset?: number;
|
|
30
|
+
};
|
|
31
|
+
export type ListEmailSuppressionsResponse = {
|
|
32
|
+
suppressions: EmailSuppressionEntry[];
|
|
33
|
+
total: number;
|
|
34
|
+
};
|
|
35
|
+
export type EmailSuppressionEntry = {
|
|
36
|
+
email: string;
|
|
37
|
+
source: EmailSuppressionSource;
|
|
38
|
+
occurredAt: Date;
|
|
39
|
+
/** Human-readable reason extracted from the provider feedback. */
|
|
40
|
+
reason: string;
|
|
41
|
+
smtpCode: string;
|
|
42
|
+
diagnosticCode: string;
|
|
43
|
+
/** Application the suppression was recorded in; empty when that application is gone. */
|
|
44
|
+
application: string;
|
|
45
|
+
};
|
|
13
46
|
export type ReactivateEmailRequest = {
|
|
14
47
|
/** Pushwoosh application code (XXXXX-XXXXX) the reactivation is performed from. */
|
|
15
48
|
application?: string;
|
package/package.json
CHANGED
|
@@ -6,7 +6,7 @@ export type TaskType = 'TASK_TYPE_UNSPECIFIED' | 'TASK_TYPE_FAILED' | 'TASK_TYPE
|
|
|
6
6
|
/** deprecated */
|
|
7
7
|
| 'TASK_TYPE_EXPORT_APPLY_SEGMENT_TO_MESSAGE' | 'TASK_TYPE_CALCULATE_RETENTION'
|
|
8
8
|
/** deprecated */
|
|
9
|
-
| 'TASK_TYPE_APPLY_SEGMENT_TO_METRIC' | 'TASK_TYPE_EXPORT_RICH_MEDIA_RECIPIENTS' | 'TASK_TYPE_EXPORT_BOUNCED_EMAILS' | 'TASK_TYPE_EXPORT_JOURNEYS_HISTORY' | 'TASK_TYPE_EXPORT_JOURNEY_POINT_USERS' | 'TASK_TYPE_EXPORT_MESSAGE_RECIPIENTS' | 'TASK_TYPE_EXPORT_MESSAGE_CLICKS_DEVICES' | 'TASK_TYPE_EXPORT_MESSAGE_EVENT_TRIGGERED_DEVICES' | 'TASK_TYPE_EXPORT_MESSAGE_ERROR_DEVICES' | 'TASK_TYPE_CREATE_SEGMENT_FROM_MESSAGE' | 'TASK_TYPE_UPDATE_SEGMENT_INSIGHTS_LIST' | 'TASK_TYPE_EXPORT_JOURNEY_USERS_LIST' | 'TASK_TYPE_EXPORT_JOURNEY_POINTS_STATISTICS' | 'TASK_TYPE_EXPORT_JOURNEY_GOAL_USERS' | 'TASK_TYPE_EXPORT_CONTROL_GROUP' | 'TASK_TYPE_EXPORT_SUBSCRIPTION_FORM_SUBSCRIBED_USERS' | 'TASK_TYPE_EXPORT_UNIFIED_MESSAGES' | 'TASK_TYPE_EXPORT_MESSAGE_AUDIENCE' | 'TASK_TYPE_EXPORT_MESSAGE_STAGE_RECIPIENTS' | 'TASK_TYPE_EXPORT_MESSAGE_CLICKED_RECIPIENTS' | 'TASK_TYPE_EXPORT_MESSAGE_UNSUBSCRIBED' | 'TASK_TYPE_EXPORT_MESSAGE_ERROR_RECIPIENTS';
|
|
9
|
+
| 'TASK_TYPE_APPLY_SEGMENT_TO_METRIC' | 'TASK_TYPE_EXPORT_RICH_MEDIA_RECIPIENTS' | 'TASK_TYPE_EXPORT_BOUNCED_EMAILS' | 'TASK_TYPE_EXPORT_JOURNEYS_HISTORY' | 'TASK_TYPE_EXPORT_JOURNEY_POINT_USERS' | 'TASK_TYPE_EXPORT_MESSAGE_RECIPIENTS' | 'TASK_TYPE_EXPORT_MESSAGE_CLICKS_DEVICES' | 'TASK_TYPE_EXPORT_MESSAGE_EVENT_TRIGGERED_DEVICES' | 'TASK_TYPE_EXPORT_MESSAGE_ERROR_DEVICES' | 'TASK_TYPE_CREATE_SEGMENT_FROM_MESSAGE' | 'TASK_TYPE_UPDATE_SEGMENT_INSIGHTS_LIST' | 'TASK_TYPE_EXPORT_JOURNEY_USERS_LIST' | 'TASK_TYPE_EXPORT_JOURNEY_POINTS_STATISTICS' | 'TASK_TYPE_EXPORT_JOURNEY_GOAL_USERS' | 'TASK_TYPE_EXPORT_CONTROL_GROUP' | 'TASK_TYPE_EXPORT_SUBSCRIPTION_FORM_SUBSCRIBED_USERS' | 'TASK_TYPE_EXPORT_UNIFIED_MESSAGES' | 'TASK_TYPE_EXPORT_MESSAGE_AUDIENCE' | 'TASK_TYPE_EXPORT_MESSAGE_STAGE_RECIPIENTS' | 'TASK_TYPE_EXPORT_MESSAGE_CLICKED_RECIPIENTS' | 'TASK_TYPE_EXPORT_MESSAGE_UNSUBSCRIBED' | 'TASK_TYPE_EXPORT_MESSAGE_ERROR_RECIPIENTS' | 'TASK_TYPE_EXPORT_EMAIL_SUPPRESSIONS';
|
|
10
10
|
export type ExportRequest_args_trackingLogCsv = {
|
|
11
11
|
type: 'trackingLogCsv';
|
|
12
12
|
data: TrackingLogCSVArgs;
|
|
@@ -123,7 +123,11 @@ export type ExportRequest_args_exportMessageErrorRecipients = {
|
|
|
123
123
|
type: 'exportMessageErrorRecipients';
|
|
124
124
|
data: ExportMessageErrorRecipientsArgs;
|
|
125
125
|
};
|
|
126
|
-
export type
|
|
126
|
+
export type ExportRequest_args_exportEmailSuppressions = {
|
|
127
|
+
type: 'exportEmailSuppressions';
|
|
128
|
+
data: ExportEmailSuppressionsArgs;
|
|
129
|
+
};
|
|
130
|
+
export type ExportRequest_args = ExportRequest_args_trackingLogCsv | ExportRequest_args_exportMessagesV2 | ExportRequest_args_exportUnregisteredDevices | ExportRequest_args_exportRichMediaFormValues | ExportRequest_args_applySegmentToMessage | ExportRequest_args_exportApplySegmentToMessage | ExportRequest_args_calculateRetention | ExportRequest_args_applySegmentToMetric | ExportRequest_args_exportRichMediaRecipients | ExportRequest_args_exportBouncedEmails | ExportRequest_args_exportJourneysHistory | ExportRequest_args_exportJourneyPointUsers | ExportRequest_args_exportMessageRecipients | ExportRequest_args_exportMessageClicksDevices | ExportRequest_args_exportMessageEventTriggeredDevices | ExportRequest_args_exportMessageErrorDevices | ExportRequest_args_createSegmentFromMessage | ExportRequest_args_updateSegmentInsightsList | ExportRequest_args_exportJourneyUsersList | ExportRequest_args_exportJourneyPointsStatistics | ExportRequest_args_exportJourneyGoalUsers | ExportRequest_args_exportControlGroup | ExportRequest_args_exportSubscriptionFormSubscribedUsers | ExportRequest_args_exportUnifiedMessages | ExportRequest_args_exportMessageAudience | ExportRequest_args_exportMessageStageRecipients | ExportRequest_args_exportMessageClickedRecipients | ExportRequest_args_exportMessageUnsubscribed | ExportRequest_args_exportMessageErrorRecipients | ExportRequest_args_exportEmailSuppressions;
|
|
127
131
|
export type ExportRequest = {
|
|
128
132
|
type?: TaskType;
|
|
129
133
|
args: ExportRequest_args;
|
|
@@ -266,7 +270,11 @@ export type ResultResponse_result_exportMessageErrorRecipientsResult = {
|
|
|
266
270
|
type: 'exportMessageErrorRecipientsResult';
|
|
267
271
|
data: ExportMessageErrorRecipientsResult;
|
|
268
272
|
};
|
|
269
|
-
export type
|
|
273
|
+
export type ResultResponse_result_exportEmailSuppressionsResult = {
|
|
274
|
+
type: 'exportEmailSuppressionsResult';
|
|
275
|
+
data: ExportEmailSuppressionsResult;
|
|
276
|
+
};
|
|
277
|
+
export type ResultResponse_result = ResultResponse_result_failedTask | ResultResponse_result_trackingLogResult | ResultResponse_result_exportMessagesV2Result | ResultResponse_result_exportUnregisteredDevicesResult | ResultResponse_result_exportRichMediaFormValuesResult | ResultResponse_result_applySegmentToMessageResult | ResultResponse_result_exportApplySegmentToMessageResult | ResultResponse_result_calculateRetentionResult | ResultResponse_result_applySegmentToMetricResult | ResultResponse_result_exportRichMediaRecipientsResult | ResultResponse_result_exportBouncedEmailsResult | ResultResponse_result_exportJourneysHistoryResult | ResultResponse_result_exportJourneyPointUsersResult | ResultResponse_result_exportMessageRecipientsResult | ResultResponse_result_exportMessageClicksDevicesResult | ResultResponse_result_exportMessageEventTriggeredDevicesResult | ResultResponse_result_exportMessageErrorDevicesResult | ResultResponse_result_createSegmentFromMessageResult | ResultResponse_result_updateSegmentInsightsListResult | ResultResponse_result_exportJourneyUsersListResult | ResultResponse_result_exportJourneyPointsStatisticsResult | ResultResponse_result_exportJourneyGoalUsersResult | ResultResponse_result_exportControlGroupResult | ResultResponse_result_exportSubscriptionFormSubscribedUsersResult | ResultResponse_result_exportUnifiedMessagesResult | ResultResponse_result_exportMessageAudienceResult | ResultResponse_result_exportMessageStageRecipientsResult | ResultResponse_result_exportMessageClickedRecipientsResult | ResultResponse_result_exportMessageUnsubscribedResult | ResultResponse_result_exportMessageErrorRecipientsResult | ResultResponse_result_exportEmailSuppressionsResult;
|
|
270
278
|
export type ResultResponse = {
|
|
271
279
|
type: TaskType;
|
|
272
280
|
result: ResultResponse_result;
|
|
@@ -393,7 +401,11 @@ export type TaskInfo_args_exportMessageErrorRecipients = {
|
|
|
393
401
|
type: 'exportMessageErrorRecipients';
|
|
394
402
|
data: ExportMessageErrorRecipientsArgs;
|
|
395
403
|
};
|
|
396
|
-
export type
|
|
404
|
+
export type TaskInfo_args_exportEmailSuppressions = {
|
|
405
|
+
type: 'exportEmailSuppressions';
|
|
406
|
+
data: ExportEmailSuppressionsArgs;
|
|
407
|
+
};
|
|
408
|
+
export type TaskInfo_args = TaskInfo_args_trackingLogCsv | TaskInfo_args_exportMessagesV2 | TaskInfo_args_exportUnregisteredDevices | TaskInfo_args_exportRichMediaFormValues | TaskInfo_args_applySegmentToMessage | TaskInfo_args_exportRichMediaRecipients | TaskInfo_args_exportJourneysHistory | TaskInfo_args_exportMessageRecipients | TaskInfo_args_exportMessageClicksDevices | TaskInfo_args_exportMessageEventTriggeredDevices | TaskInfo_args_exportMessageErrorsDevices | TaskInfo_args_createSegmentFromMessage | TaskInfo_args_updateSegmentInsightsList | TaskInfo_args_exportBouncedEmails | TaskInfo_args_exportJourneyUsersList | TaskInfo_args_exportJourneyPointsStatistics | TaskInfo_args_exportJourneyGoalUsers | TaskInfo_args_exportJourneyPointUsers | TaskInfo_args_exportControlGroup | TaskInfo_args_exportSubscriptionFormSubscribedUsers | TaskInfo_args_exportUnifiedMessages | TaskInfo_args_exportMessageAudience | TaskInfo_args_exportMessageStageRecipients | TaskInfo_args_exportMessageClickedRecipients | TaskInfo_args_exportMessageUnsubscribed | TaskInfo_args_exportMessageErrorRecipients | TaskInfo_args_exportEmailSuppressions;
|
|
397
409
|
export type TaskInfo_result_failedTask = {
|
|
398
410
|
type: 'failedTask';
|
|
399
411
|
data: TaskFailed;
|
|
@@ -502,7 +514,11 @@ export type TaskInfo_result_exportMessageErrorRecipientsResult = {
|
|
|
502
514
|
type: 'exportMessageErrorRecipientsResult';
|
|
503
515
|
data: ExportMessageErrorRecipientsResult;
|
|
504
516
|
};
|
|
505
|
-
export type
|
|
517
|
+
export type TaskInfo_result_exportEmailSuppressionsResult = {
|
|
518
|
+
type: 'exportEmailSuppressionsResult';
|
|
519
|
+
data: ExportEmailSuppressionsResult;
|
|
520
|
+
};
|
|
521
|
+
export type TaskInfo_result = TaskInfo_result_failedTask | TaskInfo_result_trackingLogResult | TaskInfo_result_exportMessagesV2Result | TaskInfo_result_exportUnregisteredDevicesResult | TaskInfo_result_exportRichMediaFormValuesResult | TaskInfo_result_applySegmentToMessageResult | TaskInfo_result_exportRichMediaRecipientsResult | TaskInfo_result_exportJourneysHistoryResult | TaskInfo_result_exportMessageRecipientsResult | TaskInfo_result_exportMessageClicksDevicesResult | TaskInfo_result_exportMessageEventTriggeredDevicesResult | TaskInfo_result_exportMessageErrorsDevicesResult | TaskInfo_result_createSegmentFromMessageResult | TaskInfo_result_updateSegmentInsightsListResult | TaskInfo_result_exportBouncedEmailsResult | TaskInfo_result_exportJourneyUsersListResult | TaskInfo_result_exportJourneyPointsStatisticsResult | TaskInfo_result_exportJourneyGoalUsersResult | TaskInfo_result_exportJourneyPointUsersResult | TaskInfo_result_exportControlGroupResult | TaskInfo_result_exportSubscriptionFormSubscribedUsersResult | TaskInfo_result_exportUnifiedMessagesResult | TaskInfo_result_exportMessageAudienceResult | TaskInfo_result_exportMessageStageRecipientsResult | TaskInfo_result_exportMessageClickedRecipientsResult | TaskInfo_result_exportMessageUnsubscribedResult | TaskInfo_result_exportMessageErrorRecipientsResult | TaskInfo_result_exportEmailSuppressionsResult;
|
|
506
522
|
export type TaskInfo = {
|
|
507
523
|
id: number;
|
|
508
524
|
timestamp: string;
|
|
@@ -537,7 +553,9 @@ export type Source = 'SOURCE_UNSPECIFIED'
|
|
|
537
553
|
/** deprecated */
|
|
538
554
|
| 'AB_EXPERIMENT' | 'AB_TEST' | 'API' | 'AUTO_PUSH' | 'CP' | 'CSV' | 'CUSTOMER_JOURNEY' | 'EMAIL_API' | 'EMAIL_CP' | 'GEO_ZONE' | 'PUSH_ON_EVENT' | 'RSS' | 'SYSTEM'
|
|
539
555
|
/** deprecated */
|
|
540
|
-
| 'TWITTER'
|
|
556
|
+
| 'TWITTER'
|
|
557
|
+
/** 15 and 16 are skipped on purpose: numbering mirrors statistics-api's type.Source. */
|
|
558
|
+
| 'WHATSAPP_API' | 'SMS_API';
|
|
541
559
|
export type MessageStatus = 'MESSAGE_STATUS_UNSPECIFIED' | 'MESSAGE_STATUS_CANCELED' | 'MESSAGE_STATUS_CREATING' | 'MESSAGE_STATUS_DONE' | 'MESSAGE_STATUS_FAIL' | 'MESSAGE_STATUS_PENDING' | 'MESSAGE_STATUS_PROCESSING' | 'MESSAGE_STATUS_WAITING';
|
|
542
560
|
export type MessageType = 'MESSAGE_TYPE_UNSPECIFIED' | 'MARKETING' | 'TRANSACTIONAL';
|
|
543
561
|
export type ApplySegmentExportType = 'APPLY_SEGMENT_EXPORT_TYPE_UNSPECIFIED' | 'ALL' | 'OPEN' | 'NOT_OPEN';
|
|
@@ -874,6 +892,25 @@ export type ExportMessageUnsubscribedResult = {
|
|
|
874
892
|
file: string;
|
|
875
893
|
fileUrl: string;
|
|
876
894
|
};
|
|
895
|
+
export type ExportEmailSuppressionsArgs_Source = 'any' | 'spam_complaint' | 'hard_bounce';
|
|
896
|
+
/**
|
|
897
|
+
* ExportEmailSuppressionsArgs exports the account's suppression lists (spam complaints
|
|
898
|
+
* and hard bounces), the same rows the Control Panel section shows.
|
|
899
|
+
*/
|
|
900
|
+
export type ExportEmailSuppressionsArgs = {
|
|
901
|
+
/** Application the export is requested from; the lists themselves are account-wide. */
|
|
902
|
+
application: string;
|
|
903
|
+
/** Exact address filter, matched case-insensitively; empty exports everything. */
|
|
904
|
+
email: string;
|
|
905
|
+
source: ExportEmailSuppressionsArgs_Source;
|
|
906
|
+
dateFrom: Date;
|
|
907
|
+
dateTo: Date;
|
|
908
|
+
/** Application code the suppression was recorded in; empty covers the whole account. */
|
|
909
|
+
recordedInApplication: string;
|
|
910
|
+
};
|
|
911
|
+
export type ExportEmailSuppressionsResult = {
|
|
912
|
+
file: string;
|
|
913
|
+
};
|
|
877
914
|
/**
|
|
878
915
|
* Recipients behind one error row of the statistics screen — same subject as the older
|
|
879
916
|
* error export, plus the platform and transactional message_code filtering it lacks.
|