@pushwoosh/rpc-v2-http-api-data 0.2.444 → 0.2.445

package/data.js

@@ -14909,6 +14909,18 @@ export const data = {
                 "method": "delete",
                 "path": "/api/events/{name}"
             },
+            "DeleteEvents": {
+                "request": "pushwoosh.rpc_v2.events.DeleteEventsRequest",
+                "response": "pushwoosh.rpc_v2.events.DeleteEventsResponse",
+                "method": "post",
+                "path": "/api/events:delete"
+            },
+            "GetEventsUsage": {
+                "request": "pushwoosh.rpc_v2.events.GetEventsUsageRequest",
+                "response": "pushwoosh.rpc_v2.events.GetEventsUsageResponse",
+                "method": "post",
+                "path": "/api/events:usage"
+            },
             "GetAttributeValues": {
                 "request": "pushwoosh.rpc_v2.events.GetAttributeValuesRequest",
                 "response": "pushwoosh.rpc_v2.events.GetAttributeValuesResponse",
@@ -15189,6 +15201,91 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.events.DeleteEventsRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "names": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.events.DeleteEventsResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.events.GetEventsUsageRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "names": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.events.EventUser.Kind": {
+        "type": "E",
+        "values": [
+            "KIND_UNSPECIFIED",
+            "KIND_SYSTEM",
+            "KIND_JOURNEY",
+            "KIND_SEGMENT",
+            "KIND_IN_APP",
+            "KIND_INBOUND_WEBHOOK",
+            "KIND_RFM",
+            "KIND_DASHBOARD_WIDGET",
+            "KIND_GEOZONE",
+            "KIND_CONVERSION"
+        ]
+    },
+    "pushwoosh.rpc_v2.events.EventUser": {
+        "type": "I",
+        "fields": {
+            "kind": {
+                "type": "pushwoosh.rpc_v2.events.EventUser.Kind"
+            },
+            "code": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "status": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.events.EventUsage": {
+        "type": "I",
+        "fields": {
+            "name": {
+                "type": "string"
+            },
+            "blockers": {
+                "type": "pushwoosh.rpc_v2.events.EventUser",
+                "array": true
+            },
+            "deletes": {
+                "type": "pushwoosh.rpc_v2.events.EventUser",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.events.GetEventsUsageResponse": {
+        "type": "I",
+        "fields": {
+            "usages": {
+                "type": "pushwoosh.rpc_v2.events.EventUsage",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.rpc_v2.events.GetAttributeValuesRequest": {
         "type": "I",
         "fields": {

package/events.d.ts

@@ -4,6 +4,8 @@ export type EventsService_List = RpcMethod<ListEventsRequest, ListEventsResponse
 export type EventsService_Create = RpcMethod<CreateEventRequest, CreateEventResponse>;
 export type EventsService_Update = RpcMethod<UpdateEventRequest, UpdateEventResponse>;
 export type EventsService_Delete = RpcMethod<DeleteEventRequest, DeleteEventResponse>;
+export type EventsService_DeleteEvents = RpcMethod<DeleteEventsRequest, DeleteEventsResponse>;
+export type EventsService_GetEventsUsage = RpcMethod<GetEventsUsageRequest, GetEventsUsageResponse>;
 export type EventsService_GetAttributeValues = RpcMethod<GetAttributeValuesRequest, GetAttributeValuesResponse>;
 export type EventsService_GetTriggeredCount = RpcMethod<GetTriggeredCountRequest, GetTriggeredCountResponse>;
 export type EventsService_GetDetailedStatistics = RpcMethod<GetDetailedStatisticsRequest, GetDetailedStatisticsResponse>;
@@ -22,8 +24,12 @@ export interface EventsService {
     Create: EventsService_Create;
     /** Overwrites a custom event's description, attribute set and revenue mapping (the name is immutable). Fully replaces the attribute list, so resend every attribute you want to keep. */
     Update: EventsService_Update;
-    /** Deletes a custom event and its attributes from an application. Fails if the event is still referenced by a filter/segment or in-app trigger; not undoable. */
+    /** Deletes a custom event and its attributes from an application, with the checks of delete_events: a system event, a journey, segment, in-app, inbound webhook, RFM config, dashboard widget or geozone using it refuses the delete; its conversion settings go with it. Not undoable. */
     Delete: EventsService_Delete;
+    /** Deletes up to 100 custom events of an application, all or nothing. A system event, or one used by a draft, running or paused journey, a segment, an in-app, an inbound webhook, an RFM config, a dashboard widget or a geozone, blocks the whole batch. Conversion settings and revenue mappings are deleted with their events. Check get_events_usage first. */
+    DeleteEvents: EventsService_DeleteEvents;
+    /** Lists, for up to 100 custom events of an application, what blocks deleting each of them and what is deleted with it. Events missing from the answer are free or not found. */
+    GetEventsUsage: EventsService_GetEventsUsage;
     /** Returns distinct recorded values of one attribute of a custom event, with paging and a value search. Use to populate attribute-value pickers when building event-based filters. */
     GetAttributeValues: EventsService_GetAttributeValues;
     /** Returns all-time total and unique triggered counts for the named custom events in an application. Use for a quick per-event volume check; for a time series use get_event_detailed_statistics. */
@@ -135,6 +141,44 @@ export type DeleteEventRequest = {
     application?: string;
 };
 export type DeleteEventResponse = {};
+export type DeleteEventsRequest = {
+    /** Application code (format XXXXX-XXXXX) the events belong to. */
+    application?: string;
+    /** Names of the custom events to delete, at most 100. */
+    names?: string[];
+};
+export type DeleteEventsResponse = {};
+export type GetEventsUsageRequest = {
+    /** Application code (format XXXXX-XXXXX) the events belong to. */
+    application?: string;
+    /** Names of the custom events to check, at most 100. */
+    names?: string[];
+};
+export type EventUser_Kind = 'KIND_UNSPECIFIED'
+/** The event is built into the platform. */
+ | 'KIND_SYSTEM' | 'KIND_JOURNEY' | 'KIND_SEGMENT' | 'KIND_IN_APP' | 'KIND_INBOUND_WEBHOOK' | 'KIND_RFM' | 'KIND_DASHBOARD_WIDGET' | 'KIND_GEOZONE'
+/** Conversion settings and revenue mapping of the event itself. */
+ | 'KIND_CONVERSION';
+/** EventUser is something that uses an event. */
+export type EventUser = {
+    kind: EventUser_Kind;
+    /** Code, uuid or id of the user, as its own page addresses it. */
+    code: string;
+    name: string;
+    /** Current status of the user where it has one, in lower case (e.g. running, draft, active). */
+    status: string;
+};
+export type EventUsage = {
+    name: string;
+    /** What refuses the delete of this event. */
+    blockers: EventUser[];
+    /** What is deleted together with the event. */
+    deletes: EventUser[];
+};
+export type GetEventsUsageResponse = {
+    /** Only the events that have a user, sorted by name. */
+    usages: EventUsage[];
+};
 export type GetAttributeValuesRequest = {
     /** Application code (format XXXXX-XXXXX) the event belongs to. */
     application?: string;

package/package.json

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