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

package/data.js

@@ -18994,6 +18994,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 +19343,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/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.442",
+  "version": "0.2.444",
   "description": "RPC V2 HTTP API Types and Data",
   "main": "index.js",
   "module": "index.js",