@pushwoosh/rpc-v2-http-api-data 0.2.435 → 0.2.436

package/data.js

@@ -37148,6 +37148,18 @@ export const data = {
                 "method": "delete",
                 "path": "/api/tags/{name}"
             },
+            "DeleteTags": {
+                "request": "pushwoosh.rpc_v2.tags.DeleteTagsRequest",
+                "response": "pushwoosh.rpc_v2.tags.DeleteTagsResponse",
+                "method": "post",
+                "path": "/api/tags:delete"
+            },
+            "GetTagsUsage": {
+                "request": "pushwoosh.rpc_v2.tags.GetTagsUsageRequest",
+                "response": "pushwoosh.rpc_v2.tags.GetTagsUsageResponse",
+                "method": "post",
+                "path": "/api/tags:usage"
+            },
             "List": {
                 "request": "pushwoosh.rpc_v2.tags.ListTagsRequest",
                 "response": "pushwoosh.rpc_v2.tags.ListTagsResponse",
@@ -37244,6 +37256,87 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.tags.DeleteTagsRequest": {
+        "type": "I",
+        "fields": {
+            "names": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.tags.DeleteTagsResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.tags.GetTagsUsageRequest": {
+        "type": "I",
+        "fields": {
+            "names": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.tags.TagUser.Kind": {
+        "type": "E",
+        "values": [
+            "KIND_UNSPECIFIED",
+            "KIND_SEGMENT",
+            "KIND_IN_APP",
+            "KIND_POPUP_FORM",
+            "KIND_JOURNEY",
+            "KIND_MESSAGE",
+            "KIND_INBOUND_WEBHOOK",
+            "KIND_CONTROL_GROUP",
+            "KIND_PUSH_PRESET",
+            "KIND_SMS_PRESET",
+            "KIND_INBOX_PRESET",
+            "KIND_EMAIL_TEMPLATE",
+            "KIND_RICH_MEDIA"
+        ]
+    },
+    "pushwoosh.rpc_v2.tags.TagUser": {
+        "type": "I",
+        "fields": {
+            "kind": {
+                "type": "pushwoosh.rpc_v2.tags.TagUser.Kind"
+            },
+            "code": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            },
+            "warning": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.tags.TagUsage": {
+        "type": "I",
+        "fields": {
+            "name": {
+                "type": "string"
+            },
+            "users": {
+                "type": "pushwoosh.rpc_v2.tags.TagUser",
+                "array": true
+            },
+            "protected": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.tags.GetTagsUsageResponse": {
+        "type": "I",
+        "fields": {
+            "usages": {
+                "type": "pushwoosh.rpc_v2.tags.TagUsage",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.rpc_v2.tags.ListTagsRequest.OrderBy": {
         "type": "E",
         "values": [

package/package.json

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

package/tags.d.ts

@@ -2,6 +2,8 @@ import { RpcMethod } from './commonTypes';
 export type TagsService_Get = RpcMethod<GetTagRequest, Tag>;
 export type TagsService_Create = RpcMethod<CreateTagRequest, CreateTagResponse>;
 export type TagsService_Delete = RpcMethod<DeleteTagRequest, DeleteTagResponse>;
+export type TagsService_DeleteTags = RpcMethod<DeleteTagsRequest, DeleteTagsResponse>;
+export type TagsService_GetTagsUsage = RpcMethod<GetTagsUsageRequest, GetTagsUsageResponse>;
 export type TagsService_List = RpcMethod<ListTagsRequest, ListTagsResponse>;
 export type TagsService_GetTagValues = RpcMethod<GetTagValuesRequest, GetTagValuesResponse>;
 export type TagsService_GetTagUsage = RpcMethod<GetTagUsageRequest, GetTagUsageResponse>;
@@ -10,13 +12,17 @@ export interface TagsService {
     Get: TagsService_Get;
     /** Creates a new account tag with the given name and value type. Fails if a tag of that name already exists; timezone-typed tags cannot be created here. */
     Create: TagsService_Create;
-    /** Permanently deletes an account tag by name. Refuses to delete system or reserved tags, or tags still referenced by any segment, in-app or journey; check get_tag_usage first. */
+    /** Permanently deletes an account tag by name. Refuses to delete system, reserved, consent or RFM tags, and tags still used (see get_tags_usage); the error names every user. */
     Delete: TagsService_Delete;
+    /** Permanently deletes up to 1000 account tags by name, all or nothing: if any tag is missing, protected or still used, nothing is deleted and the error names the users. Check get_tags_usage first. */
+    DeleteTags: TagsService_DeleteTags;
+    /** Lists which of up to 1000 account tags are used, and by what: segments, in-apps, popup forms, running or paused journeys, pending messages, inbound webhooks, control groups and content placeholders. A user marked warning does not stop the delete. Tags missing from the answer are not used or not found. */
+    GetTagsUsage: TagsService_GetTagsUsage;
     /** Lists the account's tags, newest or name-ordered, with paging, name substring search and an optional type filter. Use to browse tags or find a tag name before fetching values or usage. */
     List: TagsService_List;
     /** Returns the distinct stored values of a tag in an application with per-value subscriber counts, filtered by substring and paged. Use to see which values a string/list tag actually holds; integer and price tags return no values. */
     GetTagValues: TagsService_GetTagValues;
-    /** Returns the segments, in-apps and journeys that reference a tag by name. Use to find what would break before deleting or editing a tag. */
+    /** Returns only the segments, in-apps and running or paused journeys that use a tag. For every user of a tag (messages, webhooks, control groups, content) use get_tags_usage. */
     GetTagUsage: TagsService_GetTagUsage;
 }
 export type GetTagRequest = {
@@ -47,6 +53,34 @@ export type DeleteTagRequest = {
     name?: string;
 };
 export type DeleteTagResponse = {};
+export type DeleteTagsRequest = {
+    /** Names of the tags to delete. */
+    names?: string[];
+};
+export type DeleteTagsResponse = {};
+export type GetTagsUsageRequest = {
+    /** Names of the tags to check. */
+    names?: string[];
+};
+export type TagUser_Kind = 'KIND_UNSPECIFIED' | 'KIND_SEGMENT' | 'KIND_IN_APP' | 'KIND_POPUP_FORM' | 'KIND_JOURNEY' | 'KIND_MESSAGE' | 'KIND_INBOUND_WEBHOOK' | 'KIND_CONTROL_GROUP' | 'KIND_PUSH_PRESET' | 'KIND_SMS_PRESET' | 'KIND_INBOX_PRESET' | 'KIND_EMAIL_TEMPLATE' | 'KIND_RICH_MEDIA';
+export type TagUser = {
+    kind: TagUser_Kind;
+    /** The user's own identifier: uuid for a journey and an inbound webhook, code for every other kind. */
+    code: string;
+    name: string;
+    /** Set for a placeholder with a default value, or one the device fills in: the tag can still be deleted. */
+    warning: boolean;
+};
+export type TagUsage = {
+    name: string;
+    users: TagUser[];
+    /** The platform itself writes or reads this tag (system, reserved, consent, RFM): it is never deleted. */
+    protected: boolean;
+};
+export type GetTagsUsageResponse = {
+    /** Only the tags that are used or protected, sorted by name. */
+    usages: TagUsage[];
+};
 export type ListTagsRequest_OrderBy = 'NAME' | 'CREATED';
 export type ListTagsRequest_OrderDirection = 'ASC' | 'DESC';
 export type ListTagsRequest = {