@pushwoosh/rpc-v2-http-api-data 0.2.443 → 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": {
@@ -18994,6 +19091,24 @@ export const data = {
                 "method": "delete",
                 "path": "/api/v2/filters/{filter}"
             },
+            "DeleteFilters": {
+                "request": "pushwoosh.rpc_v2.filters.DeleteFiltersRequest",
+                "response": "pushwoosh.rpc_v2.filters.DeleteFiltersResponse",
+                "method": "post",
+                "path": "/api/filters:delete"
+            },
+            "GetFiltersUsage": {
+                "request": "pushwoosh.rpc_v2.filters.GetFiltersUsageRequest",
+                "response": "pushwoosh.rpc_v2.filters.GetFiltersUsageResponse",
+                "method": "post",
+                "path": "/api/filters:usage"
+            },
+            "CompileFilters": {
+                "request": "pushwoosh.rpc_v2.filters.CompileFiltersRequest",
+                "response": "pushwoosh.rpc_v2.filters.CompileFiltersResponse",
+                "method": "post",
+                "path": "/api/filters:compile"
+            },
             "GetCountryCities": {
                 "request": "pushwoosh.rpc_v2.filters.GetCountryCitiesRequest",
                 "response": "pushwoosh.rpc_v2.filters.GetCountryCitiesResponse",
@@ -19325,6 +19440,132 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.filters.DeleteFiltersRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "codes": {
+                "type": "string",
+                "array": true
+            },
+            "stopCampaigns": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.filters.DeleteFiltersResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.filters.GetFiltersUsageRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "codes": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.filters.FilterUser.Kind": {
+        "type": "E",
+        "values": [
+            "KIND_UNSPECIFIED",
+            "KIND_PRESET",
+            "KIND_POPUP",
+            "KIND_NEWS_CAMPAIGN",
+            "KIND_RSS_FEED",
+            "KIND_FEATURE_FLAG",
+            "KIND_EXTERNAL_SEGMENT",
+            "KIND_SEGMENT",
+            "KIND_DASHBOARD_WIDGET",
+            "KIND_JOURNEY",
+            "KIND_MESSAGE",
+            "KIND_IN_APP"
+        ]
+    },
+    "pushwoosh.rpc_v2.filters.FilterUser": {
+        "type": "I",
+        "fields": {
+            "kind": {
+                "type": "pushwoosh.rpc_v2.filters.FilterUser.Kind"
+            },
+            "code": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.filters.FilterUsage": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "blockers": {
+                "type": "pushwoosh.rpc_v2.filters.FilterUser",
+                "array": true
+            },
+            "stops": {
+                "type": "pushwoosh.rpc_v2.filters.FilterUser",
+                "array": true
+            },
+            "detaches": {
+                "type": "pushwoosh.rpc_v2.filters.FilterUser",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.filters.GetFiltersUsageResponse": {
+        "type": "I",
+        "fields": {
+            "usages": {
+                "type": "pushwoosh.rpc_v2.filters.FilterUsage",
+                "array": true
+            },
+            "campaigns": {
+                "type": "pushwoosh.rpc_v2.filters.GetFilterUsageResponse"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.filters.CompileFiltersRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "codes": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.filters.CompileFiltersResponse": {
+        "type": "I",
+        "fields": {
+            "started": {
+                "type": "string",
+                "array": true
+            },
+            "running": {
+                "type": "string",
+                "array": true
+            },
+            "deferred": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.rpc_v2.filters.GetCountryCitiesRequest": {
         "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/filters.d.ts

@@ -7,6 +7,9 @@ export type FiltersService_Clone = RpcMethod<CloneFilterRequest, CloneFilterResp
 export type FiltersService_Update = RpcMethod<UpdateFilterRequest, UpdateFilterResponse>;
 export type FiltersService_Delete = RpcMethod<DeleteFilterRequest, DeleteFilterResponse>;
 export type FiltersService_DeleteV2 = RpcMethod<DeleteFilterRequest, DeleteFilterResponse>;
+export type FiltersService_DeleteFilters = RpcMethod<DeleteFiltersRequest, DeleteFiltersResponse>;
+export type FiltersService_GetFiltersUsage = RpcMethod<GetFiltersUsageRequest, GetFiltersUsageResponse>;
+export type FiltersService_CompileFilters = RpcMethod<CompileFiltersRequest, CompileFiltersResponse>;
 export type FiltersService_GetCountryCities = RpcMethod<GetCountryCitiesRequest, GetCountryCitiesResponse>;
 export type FiltersService_GetCitiesByHashes = RpcMethod<GetCitiesByHashesRequest, GetCitiesByHashesResponse>;
 export type FiltersService_CompileFilter = RpcMethod<CompileFilterRequest, CompileFilterResponse>;
@@ -28,8 +31,14 @@ export interface FiltersService {
     Update: FiltersService_Update;
     /** Deletes a segment (filter) by filter code after verifying it is not used by any campaign, journey, preset, in-app or popup. Blocks instead of deleting if the filter is still in use; delete_filter_v2 auto-detaches journey/in-app usage first. */
     Delete: FiltersService_Delete;
-    /** Deletes a segment (filter) by filter code, first detaching it from journey split points and moving in-app messages that use it to draft. Use instead of delete_filter to force-remove a filter referenced by journeys or in-apps; still blocked by other filters or web popups using it. */
+    /** Deletes a segment (filter) by filter code, first pausing the running journeys that use it, cancelling its unsent messages, moving its active in-apps to draft and detaching it from journey points. Blocked by the same users as delete_filters; the error names them all. */
     DeleteV2: FiltersService_DeleteV2;
+    /** Deletes up to 100 segments, all or nothing. A segment used by a preset, popup, news campaign, RSS feed, feature flag, external segment, dashboard widget or another segment blocks the whole batch. With stop_campaigns the running journeys using a segment are paused, its unsent messages cancelled and its active in-apps moved to draft first; a failed stop deletes nothing. Check get_filters_usage first. */
+    DeleteFilters: FiltersService_DeleteFilters;
+    /** Lists, for up to 100 segments, what blocks deleting each of them and which campaigns a delete with stop_campaigns would stop or detach. Segments missing from the answer are free or not found. */
+    GetFiltersUsage: FiltersService_GetFiltersUsage;
+    /** Starts recalculating the size of up to 100 segments. A segment already being calculated is not queued again, and at most 20 new calculations start per call; the rest come back as deferred to retry later. */
+    CompileFilters: FiltersService_CompileFilters;
     /** Returns cities (name, coordinates, subscriber count) matching a search string, from the account's City tag values enriched with geo data. Used by the Geo segment-filter builder to pick cities to target. */
     GetCountryCities: FiltersService_GetCountryCities;
     /** Resolves a list of city hashes (country code, city name) to their coordinates and names. Use to hydrate cities already selected in a geo filter, e.g. after get_filter_country_cities. */
@@ -179,6 +188,60 @@ export type DeleteFilterRequest = {
     filter?: string;
 };
 export type DeleteFilterResponse = {};
+export type DeleteFiltersRequest = {
+    /** required when account has ApplicationSpecificFilters restriction, otherwise optional */
+    application?: string;
+    /** Codes of the segments to delete. */
+    codes?: string[];
+    /** Stop the campaigns using the segments: pause running journeys, cancel unsent messages, move active in-apps to draft. */
+    stopCampaigns?: boolean;
+};
+export type DeleteFiltersResponse = {};
+export type GetFiltersUsageRequest = {
+    /** required when account has ApplicationSpecificFilters restriction, otherwise optional */
+    application?: string;
+    /** Codes of the segments to check. */
+    codes?: string[];
+};
+export type FilterUser_Kind = 'KIND_UNSPECIFIED' | 'KIND_PRESET' | 'KIND_POPUP' | 'KIND_NEWS_CAMPAIGN' | 'KIND_RSS_FEED' | 'KIND_FEATURE_FLAG' | 'KIND_EXTERNAL_SEGMENT' | 'KIND_SEGMENT' | 'KIND_DASHBOARD_WIDGET' | 'KIND_JOURNEY' | 'KIND_MESSAGE' | 'KIND_IN_APP';
+export type FilterUser = {
+    kind: FilterUser_Kind;
+    /** The user's own identifier: uuid for a journey, key for a feature flag, code for every other kind. */
+    code: string;
+    name: string;
+};
+export type FilterUsage = {
+    code: string;
+    name: string;
+    /** Users that cannot be stopped or detached: the segment is not deleted while they exist. */
+    blockers: FilterUser[];
+    /** Running journeys to pause, unsent messages to cancel and active in-apps to move to draft. */
+    stops: FilterUser[];
+    /** Paused and draft journeys that only lose the segment in their points. */
+    detaches: FilterUser[];
+};
+export type GetFiltersUsageResponse = {
+    /** Only the segments that have a user, sorted by code. */
+    usages: FilterUsage[];
+    /**
+     * Campaigns a delete with stop_campaigns would stop or detach, merged over the segments without blockers;
+     * the same shape as GetFilterUsage, each campaign listed once.
+     */
+    campaigns: GetFilterUsageResponse;
+};
+export type CompileFiltersRequest = {
+    application?: string;
+    /** Codes of the segments to recalculate. */
+    codes?: string[];
+};
+export type CompileFiltersResponse = {
+    /** Calculations started by this call. */
+    started: string[];
+    /** Segments already being calculated, left as they are. */
+    running: string[];
+    /** Segments over the per-call limit, not started: ask again later. */
+    deferred: string[];
+};
 /** returns cities and their coordinates for the given country based on existing tag (City) values */
 export type GetCountryCitiesRequest = {
     /** required when account has ApplicationSpecificFilters restriction, otherwise optional */

package/package.json

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