@pushwoosh/rpc-v2-http-api-data 0.2.289 → 0.2.291
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/api_tokens.d.ts +54 -0
- package/data.js +145 -5
- package/package.json +1 -1
- package/pushwoosh_export_messages_v2.d.ts +40 -5
package/api_tokens.d.ts
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { RpcMethod } from './commonTypes';
|
|
2
2
|
export type ApiTokensService_Create = RpcMethod<CreateApiTokenRequest, CreateApiTokenResponse>;
|
|
3
3
|
export type ApiTokensService_Get = RpcMethod<GetApiTokenRequest, GetApiTokenResponse>;
|
|
4
|
+
export type ApiTokensService_GetUsage = RpcMethod<GetApiTokenUsageRequest, GetApiTokenUsageResponse>;
|
|
5
|
+
export type ApiTokensService_GetUsageSummary = RpcMethod<GetApiTokenUsageSummaryRequest, GetApiTokenUsageSummaryResponse>;
|
|
4
6
|
export type ApiTokensService_List = RpcMethod<ListApiTokensRequest, ListApiTokensResponse>;
|
|
5
7
|
export type ApiTokensService_Update = RpcMethod<UpdateApiTokenRequest, UpdateApiTokenResponse>;
|
|
6
8
|
export type ApiTokensService_Delete = RpcMethod<DeleteApiTokenRequest, DeleteApiTokenResponse>;
|
|
@@ -13,6 +15,10 @@ export interface ApiTokensService {
|
|
|
13
15
|
Create: ApiTokensService_Create;
|
|
14
16
|
/** Returns one API token by its token code, including type and the resolved application/group restrictions. Use after list_api_tokens to inspect a single token's scope. */
|
|
15
17
|
Get: ApiTokensService_Get;
|
|
18
|
+
/** Returns the calls made with one API token: time, caller address, API method, application, message code and outcome. Use to answer "who sent this message and from where", including transactional sends that never reach message history. */
|
|
19
|
+
GetUsage: ApiTokensService_GetUsage;
|
|
20
|
+
/** Returns the token card summary: when and from where the token was last used, and how many calls it was refused over the last 7 and 30 days. */
|
|
21
|
+
GetUsageSummary: ApiTokensService_GetUsageSummary;
|
|
16
22
|
/** Lists the account's API tokens with paging, ordering and optional name search. Use to browse issued tokens or find a token code before get/update/delete. */
|
|
17
23
|
List: ApiTokensService_List;
|
|
18
24
|
/** Updates an API token's name and/or restriction scope by token code, overwriting the stored restrictions. Use to rename a token or change which applications, groups and modify rights it carries. */
|
|
@@ -191,3 +197,51 @@ export type GrantDeviceDataModificationRightAllRequest = {
|
|
|
191
197
|
selectAll?: boolean;
|
|
192
198
|
};
|
|
193
199
|
export type GrantDeviceDataModificationRightAllResponse = {};
|
|
200
|
+
/** One recorded call made with an API token. */
|
|
201
|
+
export type ApiTokenUsage = {
|
|
202
|
+
/** When the call happened. */
|
|
203
|
+
timestamp: Date;
|
|
204
|
+
/** Address the call came from, as our edge resolved it. */
|
|
205
|
+
clientIp: string;
|
|
206
|
+
/** API method that was called, e.g. /json/1.3/createMessage. */
|
|
207
|
+
method: string;
|
|
208
|
+
/** Application the call touched, empty when the method is not application-scoped. */
|
|
209
|
+
applicationCode: string;
|
|
210
|
+
/** Public message code of the send; the key to find transactional sends, which have no message id. */
|
|
211
|
+
messageCode: string;
|
|
212
|
+
/** Number of recipients the send reached; filled by the completion row, zero on the request row. */
|
|
213
|
+
audienceSize: number;
|
|
214
|
+
/** Outcome: ok, denied_ip, denied_acl or completed. */
|
|
215
|
+
result: string;
|
|
216
|
+
/** Origin the call was made via, e.g. api, live activity api. */
|
|
217
|
+
createdVia: string;
|
|
218
|
+
};
|
|
219
|
+
export type GetApiTokenUsageRequest = {
|
|
220
|
+
/** API token code. */
|
|
221
|
+
code?: string;
|
|
222
|
+
/** Start of the time window (inclusive); omit for no lower bound. */
|
|
223
|
+
startTime?: Date;
|
|
224
|
+
/** End of the time window (inclusive); omit for no upper bound. */
|
|
225
|
+
endTime?: Date;
|
|
226
|
+
/** Outcome to filter by: ok, denied_ip, denied_acl or completed; e.g. denied_ip lists calls refused by address only. */
|
|
227
|
+
result?: string;
|
|
228
|
+
/** Page number, starting from 1. */
|
|
229
|
+
page?: number;
|
|
230
|
+
/** Rows per page; defaults to 50. */
|
|
231
|
+
perPage?: number;
|
|
232
|
+
};
|
|
233
|
+
export type GetApiTokenUsageResponse = {
|
|
234
|
+
usage: ApiTokenUsage[];
|
|
235
|
+
};
|
|
236
|
+
export type GetApiTokenUsageSummaryRequest = {
|
|
237
|
+
/** API token code. */
|
|
238
|
+
code?: string;
|
|
239
|
+
};
|
|
240
|
+
export type GetApiTokenUsageSummaryResponse = {
|
|
241
|
+
/** Last recorded call, absent when the token has not been used within the journal retention. */
|
|
242
|
+
lastUsed: ApiTokenUsage;
|
|
243
|
+
/** Calls the token was refused over the last 7 days: both denied_ip (caller address is not on the token allowlist) and denied_acl (token has no rights on the application). */
|
|
244
|
+
deniedLast_7Days: number;
|
|
245
|
+
/** The same count over the last 30 days. */
|
|
246
|
+
deniedLast_30Days: number;
|
|
247
|
+
};
|
package/data.js
CHANGED
|
@@ -4517,6 +4517,18 @@ export const data = {
|
|
|
4517
4517
|
"method": "get",
|
|
4518
4518
|
"path": "/api/api_tokens/{code}"
|
|
4519
4519
|
},
|
|
4520
|
+
"GetUsage": {
|
|
4521
|
+
"request": "pushwoosh.rpc_v2.api_tokens.GetApiTokenUsageRequest",
|
|
4522
|
+
"response": "pushwoosh.rpc_v2.api_tokens.GetApiTokenUsageResponse",
|
|
4523
|
+
"method": "get",
|
|
4524
|
+
"path": "/api/api_tokens/{code}/usage"
|
|
4525
|
+
},
|
|
4526
|
+
"GetUsageSummary": {
|
|
4527
|
+
"request": "pushwoosh.rpc_v2.api_tokens.GetApiTokenUsageSummaryRequest",
|
|
4528
|
+
"response": "pushwoosh.rpc_v2.api_tokens.GetApiTokenUsageSummaryResponse",
|
|
4529
|
+
"method": "get",
|
|
4530
|
+
"path": "/api/api_tokens/{code}/usage/summary"
|
|
4531
|
+
},
|
|
4520
4532
|
"List": {
|
|
4521
4533
|
"request": "pushwoosh.rpc_v2.api_tokens.ListApiTokensRequest",
|
|
4522
4534
|
"response": "pushwoosh.rpc_v2.api_tokens.ListApiTokensResponse",
|
|
@@ -4908,6 +4920,89 @@ export const data = {
|
|
|
4908
4920
|
"type": "I",
|
|
4909
4921
|
"fields": {}
|
|
4910
4922
|
},
|
|
4923
|
+
"pushwoosh.rpc_v2.api_tokens.ApiTokenUsage": {
|
|
4924
|
+
"type": "I",
|
|
4925
|
+
"fields": {
|
|
4926
|
+
"timestamp": {
|
|
4927
|
+
"type": "Date"
|
|
4928
|
+
},
|
|
4929
|
+
"clientIp": {
|
|
4930
|
+
"type": "string"
|
|
4931
|
+
},
|
|
4932
|
+
"method": {
|
|
4933
|
+
"type": "string"
|
|
4934
|
+
},
|
|
4935
|
+
"applicationCode": {
|
|
4936
|
+
"type": "string"
|
|
4937
|
+
},
|
|
4938
|
+
"messageCode": {
|
|
4939
|
+
"type": "string"
|
|
4940
|
+
},
|
|
4941
|
+
"audienceSize": {
|
|
4942
|
+
"type": "number"
|
|
4943
|
+
},
|
|
4944
|
+
"result": {
|
|
4945
|
+
"type": "string"
|
|
4946
|
+
},
|
|
4947
|
+
"createdVia": {
|
|
4948
|
+
"type": "string"
|
|
4949
|
+
}
|
|
4950
|
+
}
|
|
4951
|
+
},
|
|
4952
|
+
"pushwoosh.rpc_v2.api_tokens.GetApiTokenUsageRequest": {
|
|
4953
|
+
"type": "I",
|
|
4954
|
+
"fields": {
|
|
4955
|
+
"code": {
|
|
4956
|
+
"type": "string"
|
|
4957
|
+
},
|
|
4958
|
+
"startTime": {
|
|
4959
|
+
"type": "Date"
|
|
4960
|
+
},
|
|
4961
|
+
"endTime": {
|
|
4962
|
+
"type": "Date"
|
|
4963
|
+
},
|
|
4964
|
+
"result": {
|
|
4965
|
+
"type": "string"
|
|
4966
|
+
},
|
|
4967
|
+
"page": {
|
|
4968
|
+
"type": "number"
|
|
4969
|
+
},
|
|
4970
|
+
"perPage": {
|
|
4971
|
+
"type": "number"
|
|
4972
|
+
}
|
|
4973
|
+
}
|
|
4974
|
+
},
|
|
4975
|
+
"pushwoosh.rpc_v2.api_tokens.GetApiTokenUsageResponse": {
|
|
4976
|
+
"type": "I",
|
|
4977
|
+
"fields": {
|
|
4978
|
+
"usage": {
|
|
4979
|
+
"type": "pushwoosh.rpc_v2.api_tokens.ApiTokenUsage",
|
|
4980
|
+
"array": true
|
|
4981
|
+
}
|
|
4982
|
+
}
|
|
4983
|
+
},
|
|
4984
|
+
"pushwoosh.rpc_v2.api_tokens.GetApiTokenUsageSummaryRequest": {
|
|
4985
|
+
"type": "I",
|
|
4986
|
+
"fields": {
|
|
4987
|
+
"code": {
|
|
4988
|
+
"type": "string"
|
|
4989
|
+
}
|
|
4990
|
+
}
|
|
4991
|
+
},
|
|
4992
|
+
"pushwoosh.rpc_v2.api_tokens.GetApiTokenUsageSummaryResponse": {
|
|
4993
|
+
"type": "I",
|
|
4994
|
+
"fields": {
|
|
4995
|
+
"lastUsed": {
|
|
4996
|
+
"type": "pushwoosh.rpc_v2.api_tokens.ApiTokenUsage"
|
|
4997
|
+
},
|
|
4998
|
+
"deniedLast_7Days": {
|
|
4999
|
+
"type": "number"
|
|
5000
|
+
},
|
|
5001
|
+
"deniedLast_30Days": {
|
|
5002
|
+
"type": "number"
|
|
5003
|
+
}
|
|
5004
|
+
}
|
|
5005
|
+
},
|
|
4911
5006
|
"pushwoosh.rpc_v2.app_inbox_presets.appInboxPresetsService": {
|
|
4912
5007
|
"type": "S",
|
|
4913
5008
|
"key": "appInboxPresets",
|
|
@@ -13340,7 +13435,8 @@ export const data = {
|
|
|
13340
13435
|
"TASK_TYPE_EXPORT_MESSAGE_CLICKED_RECIPIENTS",
|
|
13341
13436
|
"TASK_TYPE_EXPORT_MESSAGE_UNSUBSCRIBED",
|
|
13342
13437
|
"TASK_TYPE_EXPORT_MESSAGE_ERROR_RECIPIENTS",
|
|
13343
|
-
"TASK_TYPE_EXPORT_EMAIL_SUPPRESSIONS"
|
|
13438
|
+
"TASK_TYPE_EXPORT_EMAIL_SUPPRESSIONS",
|
|
13439
|
+
"TASK_TYPE_EXPORT_API_TOKEN_USAGE"
|
|
13344
13440
|
]
|
|
13345
13441
|
},
|
|
13346
13442
|
"pushwoosh.export_messages.v2.ExportRequest": {
|
|
@@ -13438,6 +13534,9 @@ export const data = {
|
|
|
13438
13534
|
},
|
|
13439
13535
|
"exportEmailSuppressions": {
|
|
13440
13536
|
"type": "pushwoosh.export_messages.v2.ExportEmailSuppressionsArgs"
|
|
13537
|
+
},
|
|
13538
|
+
"exportApiTokenUsage": {
|
|
13539
|
+
"type": "pushwoosh.export_messages.v2.ExportApiTokenUsageArgs"
|
|
13441
13540
|
}
|
|
13442
13541
|
},
|
|
13443
13542
|
"oneofs": {
|
|
@@ -13472,7 +13571,8 @@ export const data = {
|
|
|
13472
13571
|
"exportMessageClickedRecipients",
|
|
13473
13572
|
"exportMessageUnsubscribed",
|
|
13474
13573
|
"exportMessageErrorRecipients",
|
|
13475
|
-
"exportEmailSuppressions"
|
|
13574
|
+
"exportEmailSuppressions",
|
|
13575
|
+
"exportApiTokenUsage"
|
|
13476
13576
|
]
|
|
13477
13577
|
}
|
|
13478
13578
|
}
|
|
@@ -13631,6 +13731,9 @@ export const data = {
|
|
|
13631
13731
|
},
|
|
13632
13732
|
"exportEmailSuppressionsResult": {
|
|
13633
13733
|
"type": "pushwoosh.export_messages.v2.ExportEmailSuppressionsResult"
|
|
13734
|
+
},
|
|
13735
|
+
"exportApiTokenUsageResult": {
|
|
13736
|
+
"type": "pushwoosh.export_messages.v2.ExportApiTokenUsageResult"
|
|
13634
13737
|
}
|
|
13635
13738
|
},
|
|
13636
13739
|
"oneofs": {
|
|
@@ -13666,7 +13769,8 @@ export const data = {
|
|
|
13666
13769
|
"exportMessageClickedRecipientsResult",
|
|
13667
13770
|
"exportMessageUnsubscribedResult",
|
|
13668
13771
|
"exportMessageErrorRecipientsResult",
|
|
13669
|
-
"exportEmailSuppressionsResult"
|
|
13772
|
+
"exportEmailSuppressionsResult",
|
|
13773
|
+
"exportApiTokenUsageResult"
|
|
13670
13774
|
]
|
|
13671
13775
|
}
|
|
13672
13776
|
}
|
|
@@ -13809,6 +13913,9 @@ export const data = {
|
|
|
13809
13913
|
"exportEmailSuppressions": {
|
|
13810
13914
|
"type": "pushwoosh.export_messages.v2.ExportEmailSuppressionsArgs"
|
|
13811
13915
|
},
|
|
13916
|
+
"exportApiTokenUsage": {
|
|
13917
|
+
"type": "pushwoosh.export_messages.v2.ExportApiTokenUsageArgs"
|
|
13918
|
+
},
|
|
13812
13919
|
"failedTask": {
|
|
13813
13920
|
"type": "pushwoosh.export_messages.v2.TaskFailed"
|
|
13814
13921
|
},
|
|
@@ -13892,6 +13999,9 @@ export const data = {
|
|
|
13892
13999
|
},
|
|
13893
14000
|
"exportEmailSuppressionsResult": {
|
|
13894
14001
|
"type": "pushwoosh.export_messages.v2.ExportEmailSuppressionsResult"
|
|
14002
|
+
},
|
|
14003
|
+
"exportApiTokenUsageResult": {
|
|
14004
|
+
"type": "pushwoosh.export_messages.v2.ExportApiTokenUsageResult"
|
|
13895
14005
|
}
|
|
13896
14006
|
},
|
|
13897
14007
|
"oneofs": {
|
|
@@ -13923,7 +14033,8 @@ export const data = {
|
|
|
13923
14033
|
"exportMessageClickedRecipients",
|
|
13924
14034
|
"exportMessageUnsubscribed",
|
|
13925
14035
|
"exportMessageErrorRecipients",
|
|
13926
|
-
"exportEmailSuppressions"
|
|
14036
|
+
"exportEmailSuppressions",
|
|
14037
|
+
"exportApiTokenUsage"
|
|
13927
14038
|
]
|
|
13928
14039
|
},
|
|
13929
14040
|
"result": {
|
|
@@ -13955,7 +14066,8 @@ export const data = {
|
|
|
13955
14066
|
"exportMessageClickedRecipientsResult",
|
|
13956
14067
|
"exportMessageUnsubscribedResult",
|
|
13957
14068
|
"exportMessageErrorRecipientsResult",
|
|
13958
|
-
"exportEmailSuppressionsResult"
|
|
14069
|
+
"exportEmailSuppressionsResult",
|
|
14070
|
+
"exportApiTokenUsageResult"
|
|
13959
14071
|
]
|
|
13960
14072
|
}
|
|
13961
14073
|
}
|
|
@@ -14966,6 +15078,34 @@ export const data = {
|
|
|
14966
15078
|
}
|
|
14967
15079
|
}
|
|
14968
15080
|
},
|
|
15081
|
+
"pushwoosh.export_messages.v2.ExportApiTokenUsageArgs": {
|
|
15082
|
+
"type": "I",
|
|
15083
|
+
"fields": {
|
|
15084
|
+
"tokenCode": {
|
|
15085
|
+
"type": "string"
|
|
15086
|
+
},
|
|
15087
|
+
"applicationCode": {
|
|
15088
|
+
"type": "string"
|
|
15089
|
+
},
|
|
15090
|
+
"dateFrom": {
|
|
15091
|
+
"type": "string"
|
|
15092
|
+
},
|
|
15093
|
+
"dateTo": {
|
|
15094
|
+
"type": "string"
|
|
15095
|
+
},
|
|
15096
|
+
"result": {
|
|
15097
|
+
"type": "string"
|
|
15098
|
+
}
|
|
15099
|
+
}
|
|
15100
|
+
},
|
|
15101
|
+
"pushwoosh.export_messages.v2.ExportApiTokenUsageResult": {
|
|
15102
|
+
"type": "I",
|
|
15103
|
+
"fields": {
|
|
15104
|
+
"file": {
|
|
15105
|
+
"type": "string"
|
|
15106
|
+
}
|
|
15107
|
+
}
|
|
15108
|
+
},
|
|
14969
15109
|
"pushwoosh.export_messages.v2.ExportMessageErrorRecipientsArgs": {
|
|
14970
15110
|
"type": "I",
|
|
14971
15111
|
"fields": {
|
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' | 'TASK_TYPE_EXPORT_EMAIL_SUPPRESSIONS';
|
|
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' | 'TASK_TYPE_EXPORT_API_TOKEN_USAGE';
|
|
10
10
|
export type ExportRequest_args_trackingLogCsv = {
|
|
11
11
|
type: 'trackingLogCsv';
|
|
12
12
|
data: TrackingLogCSVArgs;
|
|
@@ -127,7 +127,11 @@ export type ExportRequest_args_exportEmailSuppressions = {
|
|
|
127
127
|
type: 'exportEmailSuppressions';
|
|
128
128
|
data: ExportEmailSuppressionsArgs;
|
|
129
129
|
};
|
|
130
|
-
export type
|
|
130
|
+
export type ExportRequest_args_exportApiTokenUsage = {
|
|
131
|
+
type: 'exportApiTokenUsage';
|
|
132
|
+
data: ExportApiTokenUsageArgs;
|
|
133
|
+
};
|
|
134
|
+
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 | ExportRequest_args_exportApiTokenUsage;
|
|
131
135
|
export type ExportRequest = {
|
|
132
136
|
type?: TaskType;
|
|
133
137
|
args: ExportRequest_args;
|
|
@@ -274,7 +278,11 @@ export type ResultResponse_result_exportEmailSuppressionsResult = {
|
|
|
274
278
|
type: 'exportEmailSuppressionsResult';
|
|
275
279
|
data: ExportEmailSuppressionsResult;
|
|
276
280
|
};
|
|
277
|
-
export type
|
|
281
|
+
export type ResultResponse_result_exportApiTokenUsageResult = {
|
|
282
|
+
type: 'exportApiTokenUsageResult';
|
|
283
|
+
data: ExportApiTokenUsageResult;
|
|
284
|
+
};
|
|
285
|
+
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 | ResultResponse_result_exportApiTokenUsageResult;
|
|
278
286
|
export type ResultResponse = {
|
|
279
287
|
type: TaskType;
|
|
280
288
|
result: ResultResponse_result;
|
|
@@ -405,7 +413,11 @@ export type TaskInfo_args_exportEmailSuppressions = {
|
|
|
405
413
|
type: 'exportEmailSuppressions';
|
|
406
414
|
data: ExportEmailSuppressionsArgs;
|
|
407
415
|
};
|
|
408
|
-
export type
|
|
416
|
+
export type TaskInfo_args_exportApiTokenUsage = {
|
|
417
|
+
type: 'exportApiTokenUsage';
|
|
418
|
+
data: ExportApiTokenUsageArgs;
|
|
419
|
+
};
|
|
420
|
+
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 | TaskInfo_args_exportApiTokenUsage;
|
|
409
421
|
export type TaskInfo_result_failedTask = {
|
|
410
422
|
type: 'failedTask';
|
|
411
423
|
data: TaskFailed;
|
|
@@ -518,7 +530,11 @@ export type TaskInfo_result_exportEmailSuppressionsResult = {
|
|
|
518
530
|
type: 'exportEmailSuppressionsResult';
|
|
519
531
|
data: ExportEmailSuppressionsResult;
|
|
520
532
|
};
|
|
521
|
-
export type
|
|
533
|
+
export type TaskInfo_result_exportApiTokenUsageResult = {
|
|
534
|
+
type: 'exportApiTokenUsageResult';
|
|
535
|
+
data: ExportApiTokenUsageResult;
|
|
536
|
+
};
|
|
537
|
+
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 | TaskInfo_result_exportApiTokenUsageResult;
|
|
522
538
|
export type TaskInfo = {
|
|
523
539
|
id: number;
|
|
524
540
|
timestamp: string;
|
|
@@ -913,6 +929,25 @@ export type ExportEmailSuppressionsResult = {
|
|
|
913
929
|
/** Ready-to-use download URL for `file`; empty when the service has no base URL configured. */
|
|
914
930
|
fileUrl: string;
|
|
915
931
|
};
|
|
932
|
+
/**
|
|
933
|
+
* ExportApiTokenUsageArgs exports the API-token journal: which token made which call, from
|
|
934
|
+
* which address and what came of it. Answers "who sent this message" without support.
|
|
935
|
+
*/
|
|
936
|
+
export type ExportApiTokenUsageArgs = {
|
|
937
|
+
/** Public code of one API token; empty exports every token of the account. */
|
|
938
|
+
tokenCode: string;
|
|
939
|
+
/** Application code to narrow the export to one project. */
|
|
940
|
+
applicationCode: string;
|
|
941
|
+
/** Window start, "2006-01-02" or "2006-01-02 15:04:05". */
|
|
942
|
+
dateFrom: string;
|
|
943
|
+
/** Window end, same format. */
|
|
944
|
+
dateTo: string;
|
|
945
|
+
/** Outcome to export: ok, denied_ip, denied_acl or completed; empty exports all of them. */
|
|
946
|
+
result: string;
|
|
947
|
+
};
|
|
948
|
+
export type ExportApiTokenUsageResult = {
|
|
949
|
+
file: string;
|
|
950
|
+
};
|
|
916
951
|
/**
|
|
917
952
|
* Recipients behind one error row of the statistics screen — same subject as the older
|
|
918
953
|
* error export, plus the platform and transactional message_code filtering it lacks.
|