@pushwoosh/rpc-v2-http-api-data 0.1.415 → 0.1.418

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/index.d.ts CHANGED
@@ -4,7 +4,8 @@ import { AccountsService as pushwoosh_rpc_v2_accounts_AccountsService } from './
4
4
  import { GetAuthInfoService as pushwoosh_rpc_v2_accounts_get_auth_info_GetAuthInfoService } from './accounts_get_auth_info';
5
5
  import { ApiTokensService as pushwoosh_rpc_v2_api_tokens_ApiTokensService } from './api_tokens';
6
6
  import { ApplicationsService as pushwoosh_rpc_v2_applications_ApplicationsService } from './applications';
7
- import { EmailFromService as pushwoosh_rpc_v2_applications_EmailFromService } from './applications';
7
+ import { ApplicationEmailFromsService as pushwoosh_rpc_v2_applications_email_froms_ApplicationEmailFromsService } from './applications_email_froms';
8
+ import { ApplicationSoundsService as pushwoosh_rpc_v2_applications_sounds_ApplicationSoundsService } from './applications_sounds';
8
9
  import { ApplicationsConfigurationsService as pushwoosh_rpc_v2_applications_configurations_ApplicationsConfigurationsService } from './applications_configurations';
9
10
  import { ApplicationsGroupsService as pushwoosh_rpc_v2_applications_groups_ApplicationsGroupsService } from './applications_groups';
10
11
  import { ApplicationsInfoService as pushwoosh_rpc_v2_applications_info_ApplicationsInfoService } from './applications_info';
@@ -46,7 +47,8 @@ export type API = {
46
47
  getAuthInfo: pushwoosh_rpc_v2_accounts_get_auth_info_GetAuthInfoService;
47
48
  apiTokens: pushwoosh_rpc_v2_api_tokens_ApiTokensService;
48
49
  applications: pushwoosh_rpc_v2_applications_ApplicationsService;
49
- emailFrom: pushwoosh_rpc_v2_applications_EmailFromService;
50
+ applicationEmailFroms: pushwoosh_rpc_v2_applications_email_froms_ApplicationEmailFromsService;
51
+ applicationSounds: pushwoosh_rpc_v2_applications_sounds_ApplicationSoundsService;
50
52
  applicationsConfigurations: pushwoosh_rpc_v2_applications_configurations_ApplicationsConfigurationsService;
51
53
  applicationsGroups: pushwoosh_rpc_v2_applications_groups_ApplicationsGroupsService;
52
54
  applicationsInfo: pushwoosh_rpc_v2_applications_info_ApplicationsInfoService;
package/messages.d.ts CHANGED
@@ -128,11 +128,13 @@ export type GetDeliveryReportRequest = {
128
128
  messageCode?: string;
129
129
  campaign?: string;
130
130
  };
131
+ export type GetDeliveryReportResponse_MailboxErrorType = 'all' | 'complaints' | 'soft_bounces' | 'hard_bounces';
131
132
  export type GetDeliveryReportResponse_DeliveryReport_ReportError = {
132
133
  error: string;
133
134
  tooltip: string;
134
135
  count: number;
135
136
  statusCode: number;
137
+ mailboxErrorType: GetDeliveryReportResponse_MailboxErrorType;
136
138
  };
137
139
  export type GetDeliveryReportResponse_DeliveryReport = {
138
140
  platform: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-v2-http-api-data",
3
- "version": "0.1.415",
3
+ "version": "0.1.418",
4
4
  "description": "RPC V2 HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",
@@ -168,9 +168,11 @@ export type ResultResponse = {
168
168
  };
169
169
  export type GetLastTasksRequest = {
170
170
  type?: TaskType;
171
+ types?: TaskType[];
171
172
  application?: string;
172
173
  limit?: number;
173
174
  messageId?: number;
175
+ campaign?: string;
174
176
  };
175
177
  export type TaskInfo_args_trackingLogCsv = {
176
178
  type: 'trackingLogCsv';
@@ -200,7 +202,27 @@ export type TaskInfo_args_exportJourneysHistory = {
200
202
  type: 'exportJourneysHistory';
201
203
  data: ExportJourneysHistoryArgs;
202
204
  };
203
- 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;
205
+ export type TaskInfo_args_exportMessageRecipients = {
206
+ type: 'exportMessageRecipients';
207
+ data: ExportMessageRecipientsArgs;
208
+ };
209
+ export type TaskInfo_args_exportMessageClicksDevices = {
210
+ type: 'exportMessageClicksDevices';
211
+ data: ExportMessageClicksDevicesArgs;
212
+ };
213
+ export type TaskInfo_args_exportMessageEventTriggeredDevices = {
214
+ type: 'exportMessageEventTriggeredDevices';
215
+ data: ExportMessageEventTriggeredDevicesArgs;
216
+ };
217
+ export type TaskInfo_args_exportMessageErrorsDevices = {
218
+ type: 'exportMessageErrorsDevices';
219
+ data: ExportMessageErrorsDevicesArgs;
220
+ };
221
+ export type TaskInfo_args_createSegmentFromMessage = {
222
+ type: 'createSegmentFromMessage';
223
+ data: CreateSegmentFromMessageArgs;
224
+ };
225
+ 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;
204
226
  export type TaskInfo_result_failedTask = {
205
227
  type: 'failedTask';
206
228
  data: TaskFailed;
@@ -233,7 +255,27 @@ export type TaskInfo_result_exportJourneysHistoryResult = {
233
255
  type: 'exportJourneysHistoryResult';
234
256
  data: ExportJourneysHistoryResult;
235
257
  };
236
- 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;
258
+ export type TaskInfo_result_exportMessageRecipientsResult = {
259
+ type: 'exportMessageRecipientsResult';
260
+ data: ExportMessageRecipientsResult;
261
+ };
262
+ export type TaskInfo_result_exportMessageClicksDevicesResult = {
263
+ type: 'exportMessageClicksDevicesResult';
264
+ data: ExportMessageClicksDevicesResult;
265
+ };
266
+ export type TaskInfo_result_exportMessageEventTriggeredDevicesResult = {
267
+ type: 'exportMessageEventTriggeredDevicesResult';
268
+ data: ExportMessageEventTriggeredDevicesResult;
269
+ };
270
+ export type TaskInfo_result_exportMessageErrorsDevicesResult = {
271
+ type: 'exportMessageErrorsDevicesResult';
272
+ data: ExportMessageErrorsDevicesResult;
273
+ };
274
+ export type TaskInfo_result_createSegmentFromMessageResult = {
275
+ type: 'createSegmentFromMessageResult';
276
+ data: CreateSegmentFromMessageResult;
277
+ };
278
+ 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;
237
279
  export type TaskInfo = {
238
280
  id: number;
239
281
  timestamp: string;
@@ -480,11 +522,13 @@ export type CreateSegmentFromMessageArgs = {
480
522
  linkTemplate: string;
481
523
  event: string;
482
524
  application: string;
525
+ name: string;
483
526
  type: CreateSegmentFromMessageArgs_Type;
484
527
  emailErrorType: CreateSegmentFromMessageArgs_EmailErrorType;
485
528
  dateFrom: Date;
486
529
  dateTo: Date;
487
530
  };
488
531
  export type CreateSegmentFromMessageResult = {
489
- segment: string;
532
+ segmentCode: string;
533
+ segmentName: string;
490
534
  };
@@ -1,490 +0,0 @@
1
- export type ExportRequest_args_trackingLogCsv = {
2
- type: 'trackingLogCsv';
3
- data: TrackingLogCSVArgs;
4
- };
5
- export type ExportRequest_args_exportMessagesV2 = {
6
- type: 'exportMessagesV2';
7
- data: ExportMessagesV2Args;
8
- };
9
- export type ExportRequest_args_exportUnregisteredDevices = {
10
- type: 'exportUnregisteredDevices';
11
- data: ExportUnregisteredDevicesArgs;
12
- };
13
- export type ExportRequest_args_exportRichMediaFormValues = {
14
- type: 'exportRichMediaFormValues';
15
- data: ExportRichMediaFormValuesArgs;
16
- };
17
- export type ExportRequest_args_applySegmentToMessage = {
18
- type: 'applySegmentToMessage';
19
- data: ApplySegmentToMessageArgs;
20
- };
21
- export type ExportRequest_args_exportApplySegmentToMessage = {
22
- type: 'exportApplySegmentToMessage';
23
- data: ExportApplySegmentToMessageArgs;
24
- };
25
- export type ExportRequest_args_calculateRetention = {
26
- type: 'calculateRetention';
27
- data: CalculateRetentionArgs;
28
- };
29
- export type ExportRequest_args_applySegmentToMetric = {
30
- type: 'applySegmentToMetric';
31
- data: ApplySegmentToMetricArgs;
32
- };
33
- export type ExportRequest_args_exportRichMediaRecipients = {
34
- type: 'exportRichMediaRecipients';
35
- data: ExportRichMediaRecipientsArgs;
36
- };
37
- export type ExportRequest_args_exportBouncedEmails = {
38
- type: 'exportBouncedEmails';
39
- data: ExportBouncedEmailsArgs;
40
- };
41
- export type ExportRequest_args_exportJourneysHistory = {
42
- type: 'exportJourneysHistory';
43
- data: ExportJourneysHistoryArgs;
44
- };
45
- export type ExportRequest_args_exportJourneyPointUsers = {
46
- type: 'exportJourneyPointUsers';
47
- data: ExportJourneyPointUsersArgs;
48
- };
49
- export type ExportRequest_args_exportMessageRecipients = {
50
- type: 'exportMessageRecipients';
51
- data: ExportMessageRecipientsArgs;
52
- };
53
- export type ExportRequest_args_exportMessageClicksDevices = {
54
- type: 'exportMessageClicksDevices';
55
- data: ExportMessageClicksDevicesArgs;
56
- };
57
- export type ExportRequest_args_exportMessageEventTriggeredDevices = {
58
- type: 'exportMessageEventTriggeredDevices';
59
- data: ExportMessageEventTriggeredDevicesArgs;
60
- };
61
- export type ExportRequest_args_exportMessageErrorDevices = {
62
- type: 'exportMessageErrorDevices';
63
- data: ExportMessageErrorsDevicesArgs;
64
- };
65
- export type ExportRequest_args_createSegmentFromMessage = {
66
- type: 'createSegmentFromMessage';
67
- data: CreateSegmentFromMessageArgs;
68
- };
69
- 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;
70
- export type ExportRequest = {
71
- type: TaskType;
72
- args: ExportRequest_args;
73
- };
74
- export type ExportResponse = {
75
- uid: number;
76
- };
77
- export type DeleteRequest = {
78
- uid: number;
79
- };
80
- export type DeleteResponse = {};
81
- export type StatusRequest = {
82
- uid: number;
83
- };
84
- export type Status = 'STATUS_UNSPECIFIED' | 'STATUS_PENDING' | 'STATUS_SUCCESS' | 'STATUS_FAILED';
85
- export type StatusResponse = {
86
- status: Status;
87
- progress: number;
88
- };
89
- export type ResultRequest = {
90
- uid: number;
91
- };
92
- export type ResultResponse_result_failedTask = {
93
- type: 'failedTask';
94
- data: TaskFailed;
95
- };
96
- export type ResultResponse_result_trackingLogResult = {
97
- type: 'trackingLogResult';
98
- data: TrackingLogCSVResult;
99
- };
100
- export type ResultResponse_result_exportMessagesV2Result = {
101
- type: 'exportMessagesV2Result';
102
- data: ExportMessagesV2Result;
103
- };
104
- export type ResultResponse_result_exportUnregisteredDevicesResult = {
105
- type: 'exportUnregisteredDevicesResult';
106
- data: ExportUnregisteredDevicesResult;
107
- };
108
- export type ResultResponse_result_exportRichMediaFormValuesResult = {
109
- type: 'exportRichMediaFormValuesResult';
110
- data: ExportRichMediaFormValuesResult;
111
- };
112
- export type ResultResponse_result_applySegmentToMessageResult = {
113
- type: 'applySegmentToMessageResult';
114
- data: ApplySegmentToMessageResult;
115
- };
116
- export type ResultResponse_result_exportApplySegmentToMessageResult = {
117
- type: 'exportApplySegmentToMessageResult';
118
- data: ExportApplySegmentToMessageResult;
119
- };
120
- export type ResultResponse_result_calculateRetentionResult = {
121
- type: 'calculateRetentionResult';
122
- data: CalculateRetentionResult;
123
- };
124
- export type ResultResponse_result_applySegmentToMetricResult = {
125
- type: 'applySegmentToMetricResult';
126
- data: ApplySegmentToMetricResult;
127
- };
128
- export type ResultResponse_result_exportRichMediaRecipientsResult = {
129
- type: 'exportRichMediaRecipientsResult';
130
- data: ExportRichMediaRecipientsResult;
131
- };
132
- export type ResultResponse_result_exportBouncedEmailsResult = {
133
- type: 'exportBouncedEmailsResult';
134
- data: ExportBouncedEmailsResult;
135
- };
136
- export type ResultResponse_result_exportJourneysHistoryResult = {
137
- type: 'exportJourneysHistoryResult';
138
- data: ExportJourneysHistoryResult;
139
- };
140
- export type ResultResponse_result_exportJourneyPointUsersResult = {
141
- type: 'exportJourneyPointUsersResult';
142
- data: ExportJourneyPointUsersResult;
143
- };
144
- export type ResultResponse_result_exportMessageRecipientsResult = {
145
- type: 'exportMessageRecipientsResult';
146
- data: ExportMessageRecipientsResult;
147
- };
148
- export type ResultResponse_result_exportMessageClicksDevicesResult = {
149
- type: 'exportMessageClicksDevicesResult';
150
- data: ExportMessageClicksDevicesResult;
151
- };
152
- export type ResultResponse_result_exportMessageEventTriggeredDevicesResult = {
153
- type: 'exportMessageEventTriggeredDevicesResult';
154
- data: ExportMessageEventTriggeredDevicesResult;
155
- };
156
- export type ResultResponse_result_exportMessageErrorDevicesResult = {
157
- type: 'exportMessageErrorDevicesResult';
158
- data: ExportMessageErrorsDevicesResult;
159
- };
160
- export type ResultResponse_result_createSegmentFromMessageResult = {
161
- type: 'createSegmentFromMessageResult';
162
- data: CreateSegmentFromMessageResult;
163
- };
164
- 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;
165
- export type ResultResponse = {
166
- type: TaskType;
167
- result: ResultResponse_result;
168
- };
169
- export type GetLastTasksRequest = {
170
- type: TaskType;
171
- application: string;
172
- limit: number;
173
- messageId: number;
174
- };
175
- export type TaskInfo_args_trackingLogCsv = {
176
- type: 'trackingLogCsv';
177
- data: TrackingLogCSVArgs;
178
- };
179
- export type TaskInfo_args_exportMessagesV2 = {
180
- type: 'exportMessagesV2';
181
- data: ExportMessagesV2Args;
182
- };
183
- export type TaskInfo_args_exportUnregisteredDevices = {
184
- type: 'exportUnregisteredDevices';
185
- data: ExportUnregisteredDevicesArgs;
186
- };
187
- export type TaskInfo_args_exportRichMediaFormValues = {
188
- type: 'exportRichMediaFormValues';
189
- data: ExportRichMediaFormValuesArgs;
190
- };
191
- export type TaskInfo_args_applySegmentToMessage = {
192
- type: 'applySegmentToMessage';
193
- data: ApplySegmentToMessageArgs;
194
- };
195
- export type TaskInfo_args_exportRichMediaRecipients = {
196
- type: 'exportRichMediaRecipients';
197
- data: ExportRichMediaRecipientsArgs;
198
- };
199
- export type TaskInfo_args_exportJourneysHistory = {
200
- type: 'exportJourneysHistory';
201
- data: ExportJourneysHistoryArgs;
202
- };
203
- 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;
204
- export type TaskInfo_result_failedTask = {
205
- type: 'failedTask';
206
- data: TaskFailed;
207
- };
208
- export type TaskInfo_result_trackingLogResult = {
209
- type: 'trackingLogResult';
210
- data: TrackingLogCSVResult;
211
- };
212
- export type TaskInfo_result_exportMessagesV2Result = {
213
- type: 'exportMessagesV2Result';
214
- data: ExportMessagesV2Result;
215
- };
216
- export type TaskInfo_result_exportUnregisteredDevicesResult = {
217
- type: 'exportUnregisteredDevicesResult';
218
- data: ExportUnregisteredDevicesResult;
219
- };
220
- export type TaskInfo_result_exportRichMediaFormValuesResult = {
221
- type: 'exportRichMediaFormValuesResult';
222
- data: ExportRichMediaFormValuesResult;
223
- };
224
- export type TaskInfo_result_applySegmentToMessageResult = {
225
- type: 'applySegmentToMessageResult';
226
- data: ApplySegmentToMessageResult;
227
- };
228
- export type TaskInfo_result_exportRichMediaRecipientsResult = {
229
- type: 'exportRichMediaRecipientsResult';
230
- data: ExportRichMediaRecipientsResult;
231
- };
232
- export type TaskInfo_result_exportJourneysHistoryResult = {
233
- type: 'exportJourneysHistoryResult';
234
- data: ExportJourneysHistoryResult;
235
- };
236
- 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;
237
- export type TaskInfo = {
238
- id: number;
239
- timestamp: string;
240
- status: Status;
241
- exportSegment: Record<string, string>;
242
- args: TaskInfo_args;
243
- result: TaskInfo_result;
244
- };
245
- export type GetLastTasksResponse = {
246
- tasks: TaskInfo[];
247
- };
248
- export type TaskType = 'TASK_TYPE_UNSPECIFIED' | 'TASK_TYPE_FAILED' | 'TASK_TYPE_TRACKING_LOG_CSV' | 'TASK_TYPE_EXPORT_MESSAGES' | 'TASK_TYPE_EXPORT_MESSAGES_V2' | 'TASK_TYPE_EXPORT_UNREGISTERED_DEVICES' | 'TASK_TYPE_EXPORT_RICH_MEDIA_FORM_VALUES' | 'TASK_TYPE_APPLY_SEGMENT_TO_MESSAGE' | 'TASK_TYPE_EXPORT_APPLY_SEGMENT_TO_MESSAGE' | 'TASK_TYPE_CALCULATE_RETENTION' | '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';
249
- export type TaskFailed = {};
250
- export type TrackingLogCSVArgs = {
251
- messageId: number;
252
- messageCode: string;
253
- campaignCode: string;
254
- hwid: string;
255
- dateFrom: string;
256
- dateTo: string;
257
- userId: string;
258
- applicationCode: string;
259
- limit: number;
260
- };
261
- export type TrackingLogCSVResult = {
262
- file: string;
263
- };
264
- export type ExportMessageProperty = 'EXPORT_MESSAGE_PROPERTY_UNSPECIFIED' | 'EXPORT_MESSAGE_PROPERTY_ID' | 'EXPORT_MESSAGE_PROPERTY_TIMESTAMP' | 'EXPORT_MESSAGE_PROPERTY_CONTENT' | 'EXPORT_MESSAGE_PROPERTY_TITLE' | 'EXPORT_MESSAGE_PROPERTY_APPLICATIONS' | 'EXPORT_MESSAGE_PROPERTY_STATUS' | 'EXPORT_MESSAGE_PROPERTY_PLATFORMS' | 'EXPORT_MESSAGE_PROPERTY_SOURCE' | 'EXPORT_MESSAGE_PROPERTY_FILTER' | 'EXPORT_MESSAGE_PROPERTY_SUBSCRIPTION_SEGMENTS' | 'EXPORT_MESSAGE_PROPERTY_SENT' | 'EXPORT_MESSAGE_PROPERTY_OPENED' | 'EXPORT_MESSAGE_PROPERTY_ERRORS' | 'EXPORT_MESSAGE_PROPERTY_RECIPIENTS';
265
- export type Source = 'SOURCE_UNSPECIFIED' | 'AB_EXPERIMENT' | 'AB_TEST' | 'API' | 'AUTO_PUSH' | 'CP' | 'CSV' | 'CUSTOMER_JOURNEY' | 'EMAIL_API' | 'EMAIL_CP' | 'GEO_ZONE' | 'PUSH_ON_EVENT' | 'RSS' | 'SYSTEM' | 'TWITTER';
266
- 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';
267
- export type ApplySegmentExportType = 'APPLY_SEGMENT_EXPORT_TYPE_UNSPECIFIED' | 'ALL' | 'OPEN' | 'NOT_OPEN';
268
- export type DateRange = {
269
- dateFrom: string;
270
- dateTo: string;
271
- };
272
- export type GetMessageHistoryFilters = {
273
- statuses: MessageStatus[];
274
- platforms: number[];
275
- sentDate: DateRange;
276
- createdDate: DateRange;
277
- createdVia: Source[];
278
- segments: string[];
279
- campaigns: string[];
280
- messageId: number;
281
- messageCode: string;
282
- };
283
- export type ExportMessagesV2Args = {
284
- search: string;
285
- applicationCode: string;
286
- appGroupCode: string;
287
- filters: GetMessageHistoryFilters;
288
- properties: ExportMessageProperty[];
289
- };
290
- export type ExportMessagesV2Result = {
291
- file: string;
292
- };
293
- export type ExportUnregisteredDevicesArgs = {
294
- applicationCode: string;
295
- timestampFrom: string;
296
- timestampTo: string;
297
- };
298
- export type ExportUnregisteredDevicesResult = {
299
- file: string;
300
- };
301
- export type ExportRichMediaFormValuesArgs = {
302
- applicationCode: string;
303
- richMediaCode: string;
304
- elementId: string;
305
- };
306
- export type ExportRichMediaFormValuesResult = {
307
- file: string;
308
- };
309
- export type ApplySegmentToMessageArgs = {
310
- application: string;
311
- filter: string;
312
- messageId: number;
313
- };
314
- export type MessageMetric = {
315
- sends: number;
316
- opens: number;
317
- ctr: number;
318
- platform: number;
319
- };
320
- export type ApplySegmentToMessageResult = {
321
- metrics: MessageMetric[];
322
- };
323
- export type ApplySegmentToMessageLastTaskParams = {
324
- messageId: number;
325
- };
326
- export type ExportApplySegmentToMessageArgs = {
327
- application: string;
328
- filter: string;
329
- messageId: number;
330
- };
331
- export type ExportApplySegmentToMessageResult = {
332
- file: string;
333
- };
334
- export type CalculateRetentionArgs = {
335
- application: string;
336
- dateFrom: Date;
337
- dateTo: Date;
338
- initialEvent: string;
339
- targetEvent: string;
340
- };
341
- export type CalculateRetentionResult_Row = {
342
- cells: number[];
343
- };
344
- export type CalculateRetentionResult = {
345
- dates: Date[];
346
- initialEventTriggered: number[];
347
- rowsCount: CalculateRetentionResult_Row[];
348
- rowsPercent: CalculateRetentionResult_Row[];
349
- linearChartData: number[];
350
- };
351
- export type ExportRichMediaRecipientsArgs_RichMediaSendChannel = 'RichMediaSendChannel_UNDEFINED' | 'IN_APP' | 'CJ' | 'PUSH';
352
- export type ExportRichMediaRecipientsArgs_RichMediaFilters = {
353
- dateFrom: Date;
354
- dateTo: Date;
355
- sendChannels: ExportRichMediaRecipientsArgs_RichMediaSendChannel[];
356
- platforms: number[];
357
- messageCode: string;
358
- campaignCode: string;
359
- inAppCode: string;
360
- };
361
- export type ExportRichMediaRecipientsArgs = {
362
- applicationCode: string;
363
- richMediaCode: string;
364
- filters: ExportRichMediaRecipientsArgs_RichMediaFilters;
365
- };
366
- export type ExportRichMediaRecipientsResult = {
367
- file: string;
368
- };
369
- export type SegmentMetricType = 'SegmentMetricType_UNKNOWN' | 'EventTriggeredTimeseries';
370
- export type ApplySegmentToMetricArgs = {
371
- application: string;
372
- filter: string;
373
- event: string;
374
- metricType: SegmentMetricType;
375
- dateFrom: string;
376
- dateTo: string;
377
- };
378
- export type TimeseriesRow = {
379
- timestamp: string;
380
- platform: number;
381
- value: number;
382
- };
383
- export type ApplySegmentToMetricResult_EventTriggeredTimeseries = {
384
- rows: TimeseriesRow[];
385
- };
386
- export type ApplySegmentToMetricResult_result_eventTriggeredTimeseries = {
387
- type: 'eventTriggeredTimeseries';
388
- data: ApplySegmentToMetricResult_EventTriggeredTimeseries;
389
- };
390
- export type ApplySegmentToMetricResult_result = ApplySegmentToMetricResult_result_eventTriggeredTimeseries;
391
- export type ApplySegmentToMetricResult = {
392
- file: string;
393
- result: ApplySegmentToMetricResult_result;
394
- };
395
- export type ExportBouncedEmailsArgs_Type = 'all' | 'complaints' | 'soft_bounces' | 'hard_bounces';
396
- export type ExportBouncedEmailsArgs = {
397
- messageId: number;
398
- campaign: string;
399
- application: string;
400
- type: ExportBouncedEmailsArgs_Type;
401
- dateFrom: Date;
402
- dateTo: Date;
403
- };
404
- export type ExportBouncedEmailsResult = {
405
- file: string;
406
- };
407
- export type ExportJourneysHistoryArgs = {
408
- application: string;
409
- filterTitle: string;
410
- categories: string[];
411
- statuses: number[];
412
- campaignTypes: number[];
413
- dateFrom: Date;
414
- dateTo: Date;
415
- };
416
- export type ExportJourneysHistoryResult = {
417
- file: string;
418
- };
419
- export type ExportJourneyPointUsersArgs = {
420
- journeyUuid: string;
421
- pointUuid: string;
422
- dateFrom: Date;
423
- dateTo: Date;
424
- };
425
- export type ExportJourneyPointUsersResult = {
426
- file: string;
427
- };
428
- export type ExportMessageRecipientsArgs_Type = 'sends' | 'deliveries' | 'opens';
429
- export type ExportMessageRecipientsArgs = {
430
- messageId: number;
431
- campaign: string;
432
- application: string;
433
- type: ExportMessageRecipientsArgs_Type;
434
- dateFrom: Date;
435
- dateTo: Date;
436
- };
437
- export type ExportMessageRecipientsResult = {
438
- file: string;
439
- };
440
- export type ExportMessageClicksDevicesArgs = {
441
- messageId: number;
442
- campaign: string;
443
- linkTemplate: string;
444
- application: string;
445
- dateFrom: Date;
446
- dateTo: Date;
447
- };
448
- export type ExportMessageClicksDevicesResult = {
449
- file: string;
450
- };
451
- export type ExportMessageEventTriggeredDevicesArgs = {
452
- messageId: number;
453
- campaign: string;
454
- event: string;
455
- application: string;
456
- dateFrom: Date;
457
- dateTo: Date;
458
- };
459
- export type ExportMessageEventTriggeredDevicesResult = {
460
- file: string;
461
- };
462
- export type ExportMessageErrorsDevicesArgs = {
463
- messageId: number;
464
- campaign: string;
465
- statusCode: number;
466
- application: string;
467
- platform: number;
468
- dateFrom: Date;
469
- dateTo: Date;
470
- };
471
- export type ExportMessageErrorsDevicesResult = {
472
- file: string;
473
- };
474
- export type CreateSegmentFromMessageArgs_Type = 'send_devices' | 'delivered_devices' | 'opened_devices' | 'link_clicked_devices' | 'event_triggered_devices' | 'send_with_error_devices' | 'send_with_email_error_devices';
475
- export type CreateSegmentFromMessageArgs_EmailErrorType = 'complaints' | 'soft_bounces' | 'hard_bounces';
476
- export type CreateSegmentFromMessageArgs = {
477
- messageId: number;
478
- campaign: string;
479
- statusCode: number;
480
- linkTemplate: string;
481
- event: string;
482
- application: string;
483
- type: CreateSegmentFromMessageArgs_Type;
484
- emailErrorType: CreateSegmentFromMessageArgs_EmailErrorType;
485
- dateFrom: Date;
486
- dateTo: Date;
487
- };
488
- export type CreateSegmentFromMessageResult = {
489
- segment: string;
490
- };