@pushwoosh/rpc-v2-http-api-data 0.2.307 → 0.2.309

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 CHANGED
@@ -10493,6 +10493,12 @@ export const data = {
10493
10493
  "response": "pushwoosh.rpc_v2.data_erasure.ListDataErasureTaskRowsResponse",
10494
10494
  "method": "get",
10495
10495
  "path": "/api/data_erasure/tasks/{task_id}/rows"
10496
+ },
10497
+ "GetTaskReport": {
10498
+ "request": "pushwoosh.rpc_v2.data_erasure.GetDataErasureTaskReportRequest",
10499
+ "response": "pushwoosh.rpc_v2.data_erasure.GetDataErasureTaskReportResponse",
10500
+ "method": "get",
10501
+ "path": "/api/data_erasure/tasks/{task_id}/report"
10496
10502
  }
10497
10503
  }
10498
10504
  },
@@ -10664,6 +10670,28 @@ export const data = {
10664
10670
  }
10665
10671
  }
10666
10672
  },
10673
+ "pushwoosh.rpc_v2.data_erasure.GetDataErasureTaskReportRequest": {
10674
+ "type": "I",
10675
+ "fields": {
10676
+ "taskId": {
10677
+ "type": "number"
10678
+ }
10679
+ }
10680
+ },
10681
+ "pushwoosh.rpc_v2.data_erasure.GetDataErasureTaskReportResponse": {
10682
+ "type": "I",
10683
+ "fields": {
10684
+ "filename": {
10685
+ "type": "string"
10686
+ },
10687
+ "contentType": {
10688
+ "type": "string"
10689
+ },
10690
+ "content": {
10691
+ "type": "string"
10692
+ }
10693
+ }
10694
+ },
10667
10695
  "pushwoosh.rpc_v2.data_erasure.DataErasureTaskRow": {
10668
10696
  "type": "I",
10669
10697
  "fields": {
@@ -20284,6 +20312,18 @@ export const data = {
20284
20312
  "fields": {
20285
20313
  "configuration": {
20286
20314
  "type": "pushwoosh.rpc_v2.integrations.FlightStatusConfiguration"
20315
+ },
20316
+ "configured": {
20317
+ "type": "boolean"
20318
+ },
20319
+ "activeSubscriptions": {
20320
+ "type": "number"
20321
+ },
20322
+ "providerReachable": {
20323
+ "type": "boolean"
20324
+ },
20325
+ "providerError": {
20326
+ "type": "string"
20287
20327
  }
20288
20328
  }
20289
20329
  },
package/data_erasure.d.ts CHANGED
@@ -3,6 +3,7 @@ export type DataErasureService_CreateTask = RpcMethod<CreateDataErasureTaskReque
3
3
  export type DataErasureService_GetTask = RpcMethod<GetDataErasureTaskRequest, GetDataErasureTaskResponse>;
4
4
  export type DataErasureService_ListTasks = RpcMethod<ListDataErasureTasksRequest, ListDataErasureTasksResponse>;
5
5
  export type DataErasureService_ListTaskRows = RpcMethod<ListDataErasureTaskRowsRequest, ListDataErasureTaskRowsResponse>;
6
+ export type DataErasureService_GetTaskReport = RpcMethod<GetDataErasureTaskReportRequest, GetDataErasureTaskReportResponse>;
6
7
  /**
7
8
  * DataErasureService is the self-serve door to erasing the personal data of an end
8
9
  * user (GDPR). The erase itself runs as a background task; these methods start it,
@@ -17,6 +18,8 @@ export interface DataErasureService {
17
18
  ListTasks: DataErasureService_ListTasks;
18
19
  /** 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. */
19
20
  ListTaskRows: DataErasureService_ListTaskRows;
21
+ /** 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
+ GetTaskReport: DataErasureService_GetTaskReport;
20
23
  }
21
24
  /** How the subjects of an erasure request are addressed. */
22
25
  export type SubjectIdentifierType = 'SUBJECT_IDENTIFIER_UNKNOWN' | 'SUBJECT_IDENTIFIER_USER_ID' | 'SUBJECT_IDENTIFIER_HWID' | 'SUBJECT_IDENTIFIER_EMAIL';
@@ -78,6 +81,19 @@ export type DataErasureTask = {
78
81
  startedAt: Date;
79
82
  finishedAt: Date;
80
83
  };
84
+ export type GetDataErasureTaskReportRequest = {
85
+ taskId?: number;
86
+ };
87
+ export type GetDataErasureTaskReportResponse = {
88
+ /** Suggested file name, e.g. data-erasure-task-42.csv. */
89
+ filename: string;
90
+ contentType: string;
91
+ /**
92
+ * The file itself, base64 over http; the render refuses a report whose encoded
93
+ * body would pass maxResponseBodyBytes.
94
+ */
95
+ content: string;
96
+ };
81
97
  export type DataErasureTaskRow = {
82
98
  /** sha256 of the identifier: the journal of an erasure must not hold personal data. */
83
99
  identifierHash: string;
package/integrations.d.ts CHANGED
@@ -657,6 +657,15 @@ export type GetFlightStatusConfigurationRequest = {
657
657
  };
658
658
  export type GetFlightStatusConfigurationResponse = {
659
659
  configuration: FlightStatusConfiguration;
660
+ /** Everything the settings card renders besides the key itself. */
661
+ configured: boolean;
662
+ activeSubscriptions: number;
663
+ providerReachable: boolean;
664
+ /**
665
+ * provider_error is a fixed line chosen by the connector, never the vendor's
666
+ * own body: the key is refused, out of credits, rate limited or unavailable.
667
+ */
668
+ providerError: string;
660
669
  };
661
670
  export type CreateFlightStatusConfigurationRequest = {
662
671
  application?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pushwoosh/rpc-v2-http-api-data",
3
- "version": "0.2.307",
3
+ "version": "0.2.309",
4
4
  "description": "RPC V2 HTTP API Types and Data",
5
5
  "main": "index.js",
6
6
  "module": "index.js",