@pushwoosh/rpc-v2-http-api-data 0.2.300 → 0.2.301

package/data.js

@@ -10316,6 +10316,230 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.data_erasure.DataErasureService": {
+        "type": "S",
+        "key": "dataErasure",
+        "methods": {
+            "CreateTask": {
+                "request": "pushwoosh.rpc_v2.data_erasure.CreateDataErasureTaskRequest",
+                "response": "pushwoosh.rpc_v2.data_erasure.CreateDataErasureTaskResponse",
+                "method": "post",
+                "path": "/api/data_erasure/tasks"
+            },
+            "GetTask": {
+                "request": "pushwoosh.rpc_v2.data_erasure.GetDataErasureTaskRequest",
+                "response": "pushwoosh.rpc_v2.data_erasure.GetDataErasureTaskResponse",
+                "method": "get",
+                "path": "/api/data_erasure/tasks/{task_id}"
+            },
+            "ListTasks": {
+                "request": "pushwoosh.rpc_v2.data_erasure.ListDataErasureTasksRequest",
+                "response": "pushwoosh.rpc_v2.data_erasure.ListDataErasureTasksResponse",
+                "method": "get",
+                "path": "/api/data_erasure/tasks"
+            },
+            "ListTaskRows": {
+                "request": "pushwoosh.rpc_v2.data_erasure.ListDataErasureTaskRowsRequest",
+                "response": "pushwoosh.rpc_v2.data_erasure.ListDataErasureTaskRowsResponse",
+                "method": "get",
+                "path": "/api/data_erasure/tasks/{task_id}/rows"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.data_erasure.SubjectIdentifierType": {
+        "type": "E",
+        "values": [
+            "SUBJECT_IDENTIFIER_UNKNOWN",
+            "SUBJECT_IDENTIFIER_USER_ID",
+            "SUBJECT_IDENTIFIER_HWID",
+            "SUBJECT_IDENTIFIER_EMAIL"
+        ]
+    },
+    "pushwoosh.rpc_v2.data_erasure.ErasureTaskStatus": {
+        "type": "E",
+        "values": [
+            "ERASURE_TASK_STATUS_PENDING",
+            "ERASURE_TASK_STATUS_IN_PROGRESS",
+            "ERASURE_TASK_STATUS_DONE",
+            "ERASURE_TASK_STATUS_FAILED"
+        ]
+    },
+    "pushwoosh.rpc_v2.data_erasure.ErasureRowResult": {
+        "type": "E",
+        "values": [
+            "ERASURE_ROW_RESULT_UNKNOWN",
+            "ERASURE_ROW_RESULT_DELETED",
+            "ERASURE_ROW_RESULT_NOT_FOUND",
+            "ERASURE_ROW_RESULT_SKIPPED",
+            "ERASURE_ROW_RESULT_FAILED"
+        ]
+    },
+    "pushwoosh.rpc_v2.data_erasure.CreateDataErasureTaskRequest": {
+        "type": "I",
+        "fields": {
+            "identifierType": {
+                "type": "pushwoosh.rpc_v2.data_erasure.SubjectIdentifierType"
+            },
+            "identifiers": {
+                "type": "string",
+                "array": true
+            },
+            "applicationCodes": {
+                "type": "string",
+                "array": true
+            },
+            "dryRun": {
+                "type": "boolean"
+            },
+            "confirmationDryRunTaskId": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.data_erasure.CreateDataErasureTaskResponse": {
+        "type": "I",
+        "fields": {
+            "taskId": {
+                "type": "number"
+            },
+            "confirmationRequired": {
+                "type": "boolean"
+            },
+            "confirmationThreshold": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.data_erasure.GetDataErasureTaskRequest": {
+        "type": "I",
+        "fields": {
+            "taskId": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.data_erasure.GetDataErasureTaskResponse": {
+        "type": "I",
+        "fields": {
+            "task": {
+                "type": "pushwoosh.rpc_v2.data_erasure.DataErasureTask"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.data_erasure.ListDataErasureTasksRequest": {
+        "type": "I",
+        "fields": {
+            "limit": {
+                "type": "number"
+            },
+            "offset": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.data_erasure.ListDataErasureTasksResponse": {
+        "type": "I",
+        "fields": {
+            "tasks": {
+                "type": "pushwoosh.rpc_v2.data_erasure.DataErasureTask",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.data_erasure.ListDataErasureTaskRowsRequest": {
+        "type": "I",
+        "fields": {
+            "taskId": {
+                "type": "number"
+            },
+            "limit": {
+                "type": "number"
+            },
+            "offset": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.data_erasure.ListDataErasureTaskRowsResponse": {
+        "type": "I",
+        "fields": {
+            "rows": {
+                "type": "pushwoosh.rpc_v2.data_erasure.DataErasureTaskRow",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.data_erasure.DataErasureTask": {
+        "type": "I",
+        "fields": {
+            "taskId": {
+                "type": "number"
+            },
+            "identifierType": {
+                "type": "pushwoosh.rpc_v2.data_erasure.SubjectIdentifierType"
+            },
+            "applicationCodes": {
+                "type": "string",
+                "array": true
+            },
+            "dryRun": {
+                "type": "boolean"
+            },
+            "status": {
+                "type": "pushwoosh.rpc_v2.data_erasure.ErasureTaskStatus"
+            },
+            "totalCount": {
+                "type": "number"
+            },
+            "deletedCount": {
+                "type": "number"
+            },
+            "notFoundCount": {
+                "type": "number"
+            },
+            "failedCount": {
+                "type": "number"
+            },
+            "failReason": {
+                "type": "string"
+            },
+            "initiatorUserId": {
+                "type": "number"
+            },
+            "initiatorTokenId": {
+                "type": "number"
+            },
+            "created": {
+                "type": "Date"
+            },
+            "startedAt": {
+                "type": "Date"
+            },
+            "finishedAt": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.data_erasure.DataErasureTaskRow": {
+        "type": "I",
+        "fields": {
+            "identifierHash": {
+                "type": "string"
+            },
+            "applicationCode": {
+                "type": "string"
+            },
+            "result": {
+                "type": "pushwoosh.rpc_v2.data_erasure.ErasureRowResult"
+            },
+            "detail": {
+                "type": "string"
+            },
+            "created": {
+                "type": "Date"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.deeplinks.DeeplinksService": {
         "type": "S",
         "key": "deeplinks",

package/data_erasure.d.ts

@@ -0,0 +1,94 @@
+import { RpcMethod } from './commonTypes';
+export type DataErasureService_CreateTask = RpcMethod<CreateDataErasureTaskRequest, CreateDataErasureTaskResponse>;
+export type DataErasureService_GetTask = RpcMethod<GetDataErasureTaskRequest, GetDataErasureTaskResponse>;
+export type DataErasureService_ListTasks = RpcMethod<ListDataErasureTasksRequest, ListDataErasureTasksResponse>;
+export type DataErasureService_ListTaskRows = RpcMethod<ListDataErasureTaskRowsRequest, ListDataErasureTaskRowsResponse>;
+/**
+ * DataErasureService is the self-serve door to erasing the personal data of an end
+ * user (GDPR). The erase itself runs as a background task; these methods start it,
+ * follow it and show what it did.
+ */
+export interface DataErasureService {
+    /** Starts erasing the personal data of the listed subjects in the listed applications. Identifiers are user ids, device hwids or email addresses. With dry_run the task only counts what would be erased. Erasure is irreversible: above the threshold the call is refused until it carries the id of a finished dry run of the same scope. */
+    CreateTask: DataErasureService_CreateTask;
+    /** 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. */
+    GetTask: DataErasureService_GetTask;
+    /** Lists data erasure tasks of the account, newest first — the audit journal of who erased what and when. Use to show the operations log or to export it. */
+    ListTasks: DataErasureService_ListTasks;
+    /** 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. */
+    ListTaskRows: DataErasureService_ListTaskRows;
+}
+/** How the subjects of an erasure request are addressed. */
+export type SubjectIdentifierType = 'SUBJECT_IDENTIFIER_UNKNOWN' | 'SUBJECT_IDENTIFIER_USER_ID' | 'SUBJECT_IDENTIFIER_HWID' | 'SUBJECT_IDENTIFIER_EMAIL';
+export type ErasureTaskStatus = 'ERASURE_TASK_STATUS_PENDING' | 'ERASURE_TASK_STATUS_IN_PROGRESS' | 'ERASURE_TASK_STATUS_DONE' | 'ERASURE_TASK_STATUS_FAILED';
+export type ErasureRowResult = 'ERASURE_ROW_RESULT_UNKNOWN' | 'ERASURE_ROW_RESULT_DELETED' | 'ERASURE_ROW_RESULT_NOT_FOUND' | 'ERASURE_ROW_RESULT_SKIPPED' | 'ERASURE_ROW_RESULT_FAILED';
+export type CreateDataErasureTaskRequest = {
+    identifierType?: SubjectIdentifierType;
+    identifiers?: string[];
+    /** Application codes (format XXXXX-XXXXX) the subjects are erased from. */
+    applicationCodes?: string[];
+    /** Counts what would be erased and writes nothing. */
+    dryRun?: boolean;
+    /**
+     * Id of the finished dry run that measured this erase. Required above
+     * confirmation_threshold subjects: nobody erases a volume they have not seen.
+     */
+    confirmationDryRunTaskId?: number;
+};
+export type CreateDataErasureTaskResponse = {
+    taskId: number;
+    /**
+     * Set when the request was refused because it erases more subjects than the
+     * threshold and carried no matching dry run.
+     */
+    confirmationRequired: boolean;
+    confirmationThreshold: number;
+};
+export type GetDataErasureTaskRequest = {
+    taskId?: number;
+};
+export type GetDataErasureTaskResponse = {
+    task: DataErasureTask;
+};
+export type ListDataErasureTasksRequest = {
+    limit?: number;
+    offset?: number;
+};
+export type ListDataErasureTasksResponse = {
+    tasks: DataErasureTask[];
+};
+export type ListDataErasureTaskRowsRequest = {
+    taskId?: number;
+    limit?: number;
+    offset?: number;
+};
+export type ListDataErasureTaskRowsResponse = {
+    rows: DataErasureTaskRow[];
+};
+export type DataErasureTask = {
+    taskId: number;
+    identifierType: SubjectIdentifierType;
+    applicationCodes: string[];
+    dryRun: boolean;
+    status: ErasureTaskStatus;
+    totalCount: number;
+    deletedCount: number;
+    notFoundCount: number;
+    failedCount: number;
+    failReason: string;
+    /** Control panel user who started the task, 0 when it came from an API token. */
+    initiatorUserId: number;
+    /** API token that started the task, 0 when a control panel user did. */
+    initiatorTokenId: number;
+    created: Date;
+    startedAt: Date;
+    finishedAt: Date;
+};
+export type DataErasureTaskRow = {
+    /** sha256 of the identifier: the journal of an erasure must not hold personal data. */
+    identifierHash: string;
+    applicationCode: string;
+    result: ErasureRowResult;
+    detail: string;
+    created: Date;
+};

package/data_erasure.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+/* Autogenerated code */
+export {};

package/index.d.ts

@@ -23,6 +23,7 @@ import { CategoriesService as pushwoosh_rpc_v2_categories_CategoriesService } fr
 import { MessagingService as pushwoosh_channels_messagingApi_v2_MessagingService } from './pushwoosh_channels_messagingApi_v2';
 import { CloudPagesService as pushwoosh_rpc_v2_cloud_pages_CloudPagesService } from './cloud_pages';
 import { CustomerJourneyService as pushwoosh_rpc_v2_customer_journey_CustomerJourneyService } from './customer_journey';
+import { DataErasureService as pushwoosh_rpc_v2_data_erasure_DataErasureService } from './data_erasure';
 import { DeeplinksService as pushwoosh_rpc_v2_deeplinks_DeeplinksService } from './deeplinks';
 import { DeliverabilityCheckerService as pushwoosh_rpc_v2_deliverability_checker_DeliverabilityCheckerService } from './deliverability_checker';
 import { DevicesService as pushwoosh_rpc_v2_devices_DevicesService } from './devices';
@@ -99,6 +100,7 @@ export type API = {
     messaging: pushwoosh_channels_messagingApi_v2_MessagingService;
     cloudPages: pushwoosh_rpc_v2_cloud_pages_CloudPagesService;
     customerJourney: pushwoosh_rpc_v2_customer_journey_CustomerJourneyService;
+    dataErasure: pushwoosh_rpc_v2_data_erasure_DataErasureService;
     deeplinks: pushwoosh_rpc_v2_deeplinks_DeeplinksService;
     deliverabilityChecker: pushwoosh_rpc_v2_deliverability_checker_DeliverabilityCheckerService;
     devices: pushwoosh_rpc_v2_devices_DevicesService;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushwoosh/rpc-v2-http-api-data",
-  "version": "0.2.300",
+  "version": "0.2.301",
   "description": "RPC V2 HTTP API Types and Data",
   "main": "index.js",
   "module": "index.js",