@pushwoosh/rpc-v2-http-api-data 0.2.312 → 0.2.314
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 +49 -0
- package/data_erasure.d.ts +28 -1
- package/package.json +1 -1
package/data.js
CHANGED
|
@@ -10499,6 +10499,12 @@ export const data = {
|
|
|
10499
10499
|
"response": "pushwoosh.rpc_v2.data_erasure.GetDataErasureTaskReportResponse",
|
|
10500
10500
|
"method": "get",
|
|
10501
10501
|
"path": "/api/data_erasure/tasks/{task_id}/report"
|
|
10502
|
+
},
|
|
10503
|
+
"GetJournalReport": {
|
|
10504
|
+
"request": "pushwoosh.rpc_v2.data_erasure.GetDataErasureJournalReportRequest",
|
|
10505
|
+
"response": "pushwoosh.rpc_v2.data_erasure.GetDataErasureJournalReportResponse",
|
|
10506
|
+
"method": "get",
|
|
10507
|
+
"path": "/api/data_erasure/report"
|
|
10502
10508
|
}
|
|
10503
10509
|
}
|
|
10504
10510
|
},
|
|
@@ -10587,6 +10593,21 @@ export const data = {
|
|
|
10587
10593
|
},
|
|
10588
10594
|
"includeDryRuns": {
|
|
10589
10595
|
"type": "boolean"
|
|
10596
|
+
},
|
|
10597
|
+
"from": {
|
|
10598
|
+
"type": "Date"
|
|
10599
|
+
},
|
|
10600
|
+
"to": {
|
|
10601
|
+
"type": "Date"
|
|
10602
|
+
},
|
|
10603
|
+
"applicationCode": {
|
|
10604
|
+
"type": "string"
|
|
10605
|
+
},
|
|
10606
|
+
"initiatorUserId": {
|
|
10607
|
+
"type": "number"
|
|
10608
|
+
},
|
|
10609
|
+
"initiatorTokenId": {
|
|
10610
|
+
"type": "number"
|
|
10590
10611
|
}
|
|
10591
10612
|
}
|
|
10592
10613
|
},
|
|
@@ -10695,6 +10716,34 @@ export const data = {
|
|
|
10695
10716
|
}
|
|
10696
10717
|
}
|
|
10697
10718
|
},
|
|
10719
|
+
"pushwoosh.rpc_v2.data_erasure.GetDataErasureJournalReportRequest": {
|
|
10720
|
+
"type": "I",
|
|
10721
|
+
"fields": {
|
|
10722
|
+
"from": {
|
|
10723
|
+
"type": "Date"
|
|
10724
|
+
},
|
|
10725
|
+
"to": {
|
|
10726
|
+
"type": "Date"
|
|
10727
|
+
},
|
|
10728
|
+
"includeDryRuns": {
|
|
10729
|
+
"type": "boolean"
|
|
10730
|
+
}
|
|
10731
|
+
}
|
|
10732
|
+
},
|
|
10733
|
+
"pushwoosh.rpc_v2.data_erasure.GetDataErasureJournalReportResponse": {
|
|
10734
|
+
"type": "I",
|
|
10735
|
+
"fields": {
|
|
10736
|
+
"filename": {
|
|
10737
|
+
"type": "string"
|
|
10738
|
+
},
|
|
10739
|
+
"contentType": {
|
|
10740
|
+
"type": "string"
|
|
10741
|
+
},
|
|
10742
|
+
"content": {
|
|
10743
|
+
"type": "string"
|
|
10744
|
+
}
|
|
10745
|
+
}
|
|
10746
|
+
},
|
|
10698
10747
|
"pushwoosh.rpc_v2.data_erasure.DataErasureTaskRow": {
|
|
10699
10748
|
"type": "I",
|
|
10700
10749
|
"fields": {
|
package/data_erasure.d.ts
CHANGED
|
@@ -4,6 +4,7 @@ export type DataErasureService_GetTask = RpcMethod<GetDataErasureTaskRequest, Ge
|
|
|
4
4
|
export type DataErasureService_ListTasks = RpcMethod<ListDataErasureTasksRequest, ListDataErasureTasksResponse>;
|
|
5
5
|
export type DataErasureService_ListTaskRows = RpcMethod<ListDataErasureTaskRowsRequest, ListDataErasureTaskRowsResponse>;
|
|
6
6
|
export type DataErasureService_GetTaskReport = RpcMethod<GetDataErasureTaskReportRequest, GetDataErasureTaskReportResponse>;
|
|
7
|
+
export type DataErasureService_GetJournalReport = RpcMethod<GetDataErasureJournalReportRequest, GetDataErasureJournalReportResponse>;
|
|
7
8
|
/**
|
|
8
9
|
* DataErasureService is the self-serve door to erasing the personal data of an end
|
|
9
10
|
* user (GDPR). The erase itself runs as a background task; these methods start it,
|
|
@@ -14,12 +15,14 @@ export interface DataErasureService {
|
|
|
14
15
|
CreateTask: DataErasureService_CreateTask;
|
|
15
16
|
/** Returns one data erasure task with its status and counters: how many subjects were erased, not found or failed. Use to follow a task started by create_data_erasure_task. */
|
|
16
17
|
GetTask: DataErasureService_GetTask;
|
|
17
|
-
/** Lists the erasures of the account, newest first — the audit journal of who erased what and when. Dry runs are measurements and are left out; pass include_dry_runs to see them next to the erasures they measured. */
|
|
18
|
+
/** Lists the erasures of the account, newest first — the audit journal of who erased what and when, narrowed by period, application or initiator. Dry runs are measurements and are left out; pass include_dry_runs to see them next to the erasures they measured. */
|
|
18
19
|
ListTasks: DataErasureService_ListTasks;
|
|
19
20
|
/** Returns the per-identifier outcome of one task: what was deleted, not found, skipped or failed. Identifiers are reported as hashes, the task never stores them in the clear. */
|
|
20
21
|
ListTaskRows: DataErasureService_ListTaskRows;
|
|
21
22
|
/** Returns the whole report of one task as a CSV file: a row per identifier per application with its outcome. Use it to keep the evidence of an erasure outside Pushwoosh; list_data_erasure_task_rows shows the same rows page by page. */
|
|
22
23
|
GetTaskReport: DataErasureService_GetTaskReport;
|
|
24
|
+
/** Returns every erasure of a period as one CSV file — a row per identifier per application, with the task and its initiator on each row. This is what an account hands to an auditor; dry runs are left out unless include_dry_runs is set, and a period too large to fit one file is refused instead of being cut. */
|
|
25
|
+
GetJournalReport: DataErasureService_GetJournalReport;
|
|
23
26
|
}
|
|
24
27
|
/** How the subjects of an erasure request are addressed. */
|
|
25
28
|
export type SubjectIdentifierType = 'SUBJECT_IDENTIFIER_UNKNOWN' | 'SUBJECT_IDENTIFIER_USER_ID' | 'SUBJECT_IDENTIFIER_HWID' | 'SUBJECT_IDENTIFIER_EMAIL';
|
|
@@ -52,6 +55,16 @@ export type ListDataErasureTasksRequest = {
|
|
|
52
55
|
offset?: number;
|
|
53
56
|
/** Dry runs are measurements, not erasures, and are left out unless asked for. */
|
|
54
57
|
includeDryRuns?: boolean;
|
|
58
|
+
/** Started at or after this moment. */
|
|
59
|
+
from?: Date;
|
|
60
|
+
/** Started before this moment. */
|
|
61
|
+
to?: Date;
|
|
62
|
+
/** Keeps the tasks that cover this application (format XXXXX-XXXXX). */
|
|
63
|
+
applicationCode?: string;
|
|
64
|
+
/** Keeps the tasks a control panel user started; 0 leaves every initiator in. */
|
|
65
|
+
initiatorUserId?: number;
|
|
66
|
+
/** Keeps the tasks an api token started; 0 leaves every initiator in. */
|
|
67
|
+
initiatorTokenId?: number;
|
|
55
68
|
};
|
|
56
69
|
export type ListDataErasureTasksResponse = {
|
|
57
70
|
tasks: DataErasureTask[];
|
|
@@ -96,6 +109,20 @@ export type GetDataErasureTaskReportResponse = {
|
|
|
96
109
|
*/
|
|
97
110
|
content: string;
|
|
98
111
|
};
|
|
112
|
+
export type GetDataErasureJournalReportRequest = {
|
|
113
|
+
/** Erasures started at or after this moment; required. */
|
|
114
|
+
from?: Date;
|
|
115
|
+
/** Erasures started before this moment; now when empty. */
|
|
116
|
+
to?: Date;
|
|
117
|
+
includeDryRuns?: boolean;
|
|
118
|
+
};
|
|
119
|
+
export type GetDataErasureJournalReportResponse = {
|
|
120
|
+
/** Suggested file name, e.g. data-erasure-2026-01-01-2026-04-01.csv. */
|
|
121
|
+
filename: string;
|
|
122
|
+
contentType: string;
|
|
123
|
+
/** The file itself, base64 over http, with the same size guard as the task report. */
|
|
124
|
+
content: string;
|
|
125
|
+
};
|
|
99
126
|
export type DataErasureTaskRow = {
|
|
100
127
|
/** sha256 of the identifier: the journal of an erasure must not hold personal data. */
|
|
101
128
|
identifierHash: string;
|