@pushwoosh/rpc-v2-http-api-data 0.2.299 → 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",
@@ -20831,6 +21055,144 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.live_activity_schemas.liveActivitySchemasService": {
+        "type": "S",
+        "key": "liveActivitySchemas",
+        "methods": {
+            "List": {
+                "request": "pushwoosh.rpc_v2.live_activity_schemas.ListLiveActivitySchemasRequest",
+                "response": "pushwoosh.rpc_v2.live_activity_schemas.ListLiveActivitySchemasResponse",
+                "method": "get",
+                "path": "/api/live_activity_schemas"
+            },
+            "Get": {
+                "request": "pushwoosh.rpc_v2.live_activity_schemas.GetLiveActivitySchemaRequest",
+                "response": "pushwoosh.rpc_v2.live_activity_schemas.GetLiveActivitySchemaResponse",
+                "method": "get",
+                "path": "/api/live_activity_schemas/{attributes_type}/{version}"
+            },
+            "Create": {
+                "request": "pushwoosh.rpc_v2.live_activity_schemas.CreateLiveActivitySchemaRequest",
+                "response": "pushwoosh.rpc_v2.live_activity_schemas.CreateLiveActivitySchemaResponse",
+                "method": "post",
+                "path": "/api/live_activity_schemas"
+            },
+            "Delete": {
+                "request": "pushwoosh.rpc_v2.live_activity_schemas.DeleteLiveActivitySchemaRequest",
+                "response": "pushwoosh.rpc_v2.live_activity_schemas.DeleteLiveActivitySchemaResponse",
+                "method": "delete",
+                "path": "/api/live_activity_schemas/{attributes_type}/{version}"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.live_activity_schemas.LiveActivitySchema": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "attributesType": {
+                "type": "string"
+            },
+            "version": {
+                "type": "number"
+            },
+            "jsonSchema": {
+                "type": "string"
+            },
+            "created": {
+                "type": "Date"
+            },
+            "updated": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.live_activity_schemas.ListLiveActivitySchemasRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "attributesType": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.live_activity_schemas.ListLiveActivitySchemasResponse": {
+        "type": "I",
+        "fields": {
+            "schemas": {
+                "type": "pushwoosh.rpc_v2.live_activity_schemas.LiveActivitySchema",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.live_activity_schemas.GetLiveActivitySchemaRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "attributesType": {
+                "type": "string"
+            },
+            "version": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.live_activity_schemas.GetLiveActivitySchemaResponse": {
+        "type": "I",
+        "fields": {
+            "schema": {
+                "type": "pushwoosh.rpc_v2.live_activity_schemas.LiveActivitySchema"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.live_activity_schemas.CreateLiveActivitySchemaRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "attributesType": {
+                "type": "string"
+            },
+            "jsonSchema": {
+                "type": "string"
+            },
+            "version": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.live_activity_schemas.CreateLiveActivitySchemaResponse": {
+        "type": "I",
+        "fields": {
+            "schema": {
+                "type": "pushwoosh.rpc_v2.live_activity_schemas.LiveActivitySchema"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.live_activity_schemas.DeleteLiveActivitySchemaRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "attributesType": {
+                "type": "string"
+            },
+            "version": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.live_activity_schemas.DeleteLiveActivitySchemaResponse": {
+        "type": "I",
+        "fields": {}
+    },
     "pushwoosh.llm.v1.LlmPolicy": {
         "type": "E",
         "values": [

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';
@@ -46,6 +47,7 @@ import { InternalAlertsService as pushwoosh_rpc_v2_internal_alerts_InternalAlert
 import { IOSCategoriesService as pushwoosh_rpc_v2_ios_categories_IOSCategoriesService } from './ios_categories';
 import { KakaoPresetsService as pushwoosh_rpc_v2_kakao_presets_KakaoPresetsService } from './kakao_presets';
 import { linePresetsService as pushwoosh_rpc_v2_line_presets_linePresetsService } from './line_presets';
+import { liveActivitySchemasService as pushwoosh_rpc_v2_live_activity_schemas_liveActivitySchemasService } from './live_activity_schemas';
 import { MediaFilesService as pushwoosh_rpc_v2_media_files_MediaFilesService } from './media_files';
 import { MessagesService as pushwoosh_rpc_v2_messages_MessagesService } from './messages';
 import { NewsService as pushwoosh_rpc_v2_news_NewsService } from './news';
@@ -98,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;
@@ -121,6 +124,7 @@ export type API = {
     iOSCategories: pushwoosh_rpc_v2_ios_categories_IOSCategoriesService;
     kakaoPresets: pushwoosh_rpc_v2_kakao_presets_KakaoPresetsService;
     linePresets: pushwoosh_rpc_v2_line_presets_linePresetsService;
+    liveActivitySchemas: pushwoosh_rpc_v2_live_activity_schemas_liveActivitySchemasService;
     mediaFiles: pushwoosh_rpc_v2_media_files_MediaFilesService;
     messages: pushwoosh_rpc_v2_messages_MessagesService;
     news: pushwoosh_rpc_v2_news_NewsService;

package/live_activity_schemas.d.ts

@@ -0,0 +1,69 @@
+import { RpcMethod } from './commonTypes';
+export type liveActivitySchemasService_List = RpcMethod<ListLiveActivitySchemasRequest, ListLiveActivitySchemasResponse>;
+export type liveActivitySchemasService_Get = RpcMethod<GetLiveActivitySchemaRequest, GetLiveActivitySchemaResponse>;
+export type liveActivitySchemasService_Create = RpcMethod<CreateLiveActivitySchemaRequest, CreateLiveActivitySchemaResponse>;
+export type liveActivitySchemasService_Delete = RpcMethod<DeleteLiveActivitySchemaRequest, DeleteLiveActivitySchemaResponse>;
+export interface liveActivitySchemasService {
+    /** Lists the Live Activity content-state schemas of one application: every attributes type with its versions, newest first. Use to find which widget types an application declares and what their fields are. */
+    List: liveActivitySchemasService_List;
+    /** Returns one Live Activity schema version: the JSON Schema describing the content-state fields a journey point renders its form from. */
+    Get: liveActivitySchemasService_Get;
+    /** Publishes a new version of a Live Activity schema. A published version is immutable, so a widget change is always a new version; omit version to get the next one. */
+    Create: liveActivitySchemasService_Create;
+    /** Permanently deletes one Live Activity schema version. Journey points built against it keep their saved fields but lose the form hints. */
+    Delete: liveActivitySchemasService_Delete;
+}
+export type LiveActivitySchema = {
+    /** Application code (format XXXXX-XXXXX) the schema belongs to. */
+    application: string;
+    /** Name of the ActivityAttributes type in the customer app, e.g. "FlightAttributes". */
+    attributesType: string;
+    /** Version of this schema; versions are immutable and grow by one. */
+    version: number;
+    /** JSON Schema describing the content-state fields. */
+    jsonSchema: string;
+    created: Date;
+    updated: Date;
+};
+export type ListLiveActivitySchemasRequest = {
+    /** Application code (format XXXXX-XXXXX) whose schemas to list; required. */
+    application?: string;
+    /** Restrict the list to one ActivityAttributes type. */
+    attributesType?: string;
+};
+export type ListLiveActivitySchemasResponse = {
+    schemas: LiveActivitySchema[];
+};
+export type GetLiveActivitySchemaRequest = {
+    /** Application code (format XXXXX-XXXXX); required. */
+    application?: string;
+    /** Name of the ActivityAttributes type; required. */
+    attributesType?: string;
+    /** Schema version; required. */
+    version?: number;
+};
+export type GetLiveActivitySchemaResponse = {
+    schema: LiveActivitySchema;
+};
+export type CreateLiveActivitySchemaRequest = {
+    /** Application code (format XXXXX-XXXXX); required. */
+    application?: string;
+    /** Name of the ActivityAttributes type declared in the app; required. */
+    attributesType?: string;
+    /** JSON Schema of the content-state fields; required, must parse as JSON. */
+    jsonSchema?: string;
+    /** Version to publish; the next free one when omitted. */
+    version?: number;
+};
+export type CreateLiveActivitySchemaResponse = {
+    schema: LiveActivitySchema;
+};
+export type DeleteLiveActivitySchemaRequest = {
+    /** Application code (format XXXXX-XXXXX); required. */
+    application?: string;
+    /** Name of the ActivityAttributes type; required. */
+    attributesType?: string;
+    /** Schema version to delete; required. */
+    version?: number;
+};
+export type DeleteLiveActivitySchemaResponse = {};

package/live_activity_schemas.js

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

package/package.json

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