@pushwoosh/rpc-v2-http-api-data 0.2.418 → 0.2.420

package/accounts.d.ts

@@ -249,6 +249,8 @@ export type EmailTemplatesService_List = RpcMethod<ListEmailTemplatesRequest, Li
 export type EmailTemplatesService_ListLegacyTemplates = RpcMethod<ListLegacyTemplatesRequest, ListLegacyTemplatesResponse>;
 export type EmailTemplatesService_Update = RpcMethod<UpdateEmailTemplateRequest, UpdateEmailTemplateResponse>;
 export type EmailTemplatesService_Delete = RpcMethod<DeleteEmailTemplateRequest, DeleteEmailTemplateResponse>;
+export type EmailTemplatesService_DeleteEmailTemplates = RpcMethod<DeleteEmailTemplatesRequest, DeleteEmailTemplatesResponse>;
+export type EmailTemplatesService_GetEmailTemplatesUsage = RpcMethod<GetEmailTemplatesUsageRequest, GetEmailTemplatesUsageResponse>;
 export type EmailTemplatesService_GetEmailTemplateLabels = RpcMethod<GetEmailTemplateLabelsRequest, GetEmailTemplateLabelsResponse>;
 export type EmailTemplatesService_Test = RpcMethod<TestEmailTemplateRequest, TestEmailTemplateResponse>;
 export type EmailTemplatesService_Migrate = RpcMethod<MigrateRequest, MigrateResponse>;
@@ -264,8 +266,12 @@ export interface EmailTemplatesService {
     ListLegacyTemplates: EmailTemplatesService_ListLegacyTemplates;
     /** Updates an existing email template by code, overwriting its name, label, categories, sender info, subjects and editor content. Use to edit a template; supplied fields replace the stored ones. */
     Update: EmailTemplatesService_Update;
-    /** Deletes an email template and its connected preset by code, removing the stored content files. Fails if the template is used in a journey; unlike update_email_template this cannot be undone. */
+    /** Deletes an email template and its connected preset by code, removing the stored content files. Refused while the template is used by a running or paused journey, a double opt-in setting of an application or a subscription form, or an email not sent yet; the error names every user. Unlike update_email_template this cannot be undone. */
     Delete: EmailTemplatesService_Delete;
+    /** Deletes up to 1000 email templates of the account by their preset codes, all or nothing: if any is missing or used by a running or paused journey, a double opt-in setting, a subscription form or an email not sent yet, nothing is deleted and the error names the users. Use get_email_templates_usage first to keep only free ones. */
+    DeleteEmailTemplates: EmailTemplatesService_DeleteEmailTemplates;
+    /** Lists which of the given email templates of the account, up to 1000 preset codes, are used by running or paused journeys, double opt-in settings, subscription forms or emails not sent yet, with those users. Templates missing from the answer are not in use or not found. Use before delete_email_templates. */
+    GetEmailTemplatesUsage: EmailTemplatesService_GetEmailTemplatesUsage;
     /** Returns the distinct label strings used across an application's email templates. Use to populate a label filter for list_email_templates. */
     GetEmailTemplateLabels: EmailTemplatesService_GetEmailTemplateLabels;
     /** Sends a real test email of a template to one email address, rendering it with optional dynamic-content placeholders. If the app has no configured email platform the address must be a registered test device. Use to preview delivery before broadcasting. */
@@ -457,6 +463,43 @@ export type DeleteEmailTemplateRequest = {
     code?: string;
 };
 export type DeleteEmailTemplateResponse = {};
+export type DeleteEmailTemplatesRequest = {
+    /** Preset codes of the email templates to delete. */
+    codes?: string[];
+};
+export type DeleteEmailTemplatesResponse = {};
+export type GetEmailTemplatesUsageRequest = {
+    /** Preset codes of the email templates to check. */
+    codes?: string[];
+};
+export type EmailTemplateUsage_EmailTemplateUser = {
+    code: string;
+    name: string;
+};
+export type EmailTemplateUsage_EmailTemplateJourney = {
+    uuid: string;
+    title: string;
+};
+export type EmailTemplateUsage_EmailTemplateMessage = {
+    code: string;
+    sendDate: Date;
+};
+export type EmailTemplateUsage = {
+    /** Preset code of the email template. */
+    code: string;
+    /** Running or paused journeys sending the template from a Send Email point. */
+    journeys: EmailTemplateUsage_EmailTemplateJourney[];
+    /** Applications whose double opt-in email is the template. */
+    doubleOptInApplications: EmailTemplateUsage_EmailTemplateUser[];
+    /** Subscription forms whose double opt-in email is the template. */
+    subscriptionForms: EmailTemplateUsage_EmailTemplateUser[];
+    /** Emails created but not sent yet that will render the template. */
+    pendingMessages: EmailTemplateUsage_EmailTemplateMessage[];
+};
+export type GetEmailTemplatesUsageResponse = {
+    /** Only the templates that are in use, sorted by preset code. */
+    usages: EmailTemplateUsage[];
+};
 export type GetEmailTemplateLabelsRequest = {
     application?: string;
 };

package/data.js

@@ -13811,6 +13811,18 @@ export const data = {
                 "method": "delete",
                 "path": "/api/email_templates/{code}"
             },
+            "DeleteEmailTemplates": {
+                "request": "pushwoosh.rpc_v2.accounts.DeleteEmailTemplatesRequest",
+                "response": "pushwoosh.rpc_v2.accounts.DeleteEmailTemplatesResponse",
+                "method": "post",
+                "path": "/api/email_templates:delete"
+            },
+            "GetEmailTemplatesUsage": {
+                "request": "pushwoosh.rpc_v2.accounts.GetEmailTemplatesUsageRequest",
+                "response": "pushwoosh.rpc_v2.accounts.GetEmailTemplatesUsageResponse",
+                "method": "post",
+                "path": "/api/email_templates:usage"
+            },
             "GetEmailTemplateLabels": {
                 "request": "pushwoosh.rpc_v2.accounts.GetEmailTemplateLabelsRequest",
                 "response": "pushwoosh.rpc_v2.accounts.GetEmailTemplateLabelsResponse",
@@ -14223,6 +14235,94 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.accounts.DeleteEmailTemplatesRequest": {
+        "type": "I",
+        "fields": {
+            "codes": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.accounts.DeleteEmailTemplatesResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.accounts.GetEmailTemplatesUsageRequest": {
+        "type": "I",
+        "fields": {
+            "codes": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.accounts.EmailTemplateUsage.EmailTemplateUser": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.accounts.EmailTemplateUsage.EmailTemplateJourney": {
+        "type": "I",
+        "fields": {
+            "uuid": {
+                "type": "string"
+            },
+            "title": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.accounts.EmailTemplateUsage.EmailTemplateMessage": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "sendDate": {
+                "type": "Date"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.accounts.EmailTemplateUsage": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "journeys": {
+                "type": "pushwoosh.rpc_v2.accounts.EmailTemplateUsage.EmailTemplateJourney",
+                "array": true
+            },
+            "doubleOptInApplications": {
+                "type": "pushwoosh.rpc_v2.accounts.EmailTemplateUsage.EmailTemplateUser",
+                "array": true
+            },
+            "subscriptionForms": {
+                "type": "pushwoosh.rpc_v2.accounts.EmailTemplateUsage.EmailTemplateUser",
+                "array": true
+            },
+            "pendingMessages": {
+                "type": "pushwoosh.rpc_v2.accounts.EmailTemplateUsage.EmailTemplateMessage",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.accounts.GetEmailTemplatesUsageResponse": {
+        "type": "I",
+        "fields": {
+            "usages": {
+                "type": "pushwoosh.rpc_v2.accounts.EmailTemplateUsage",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.rpc_v2.accounts.GetEmailTemplateLabelsRequest": {
         "type": "I",
         "fields": {
@@ -33610,6 +33710,18 @@ export const data = {
                 "response": "pushwoosh.rpc_v2.rich_medias.GetEventsResponse",
                 "method": "get",
                 "path": "/api/rich-medias/{code}:getEvents"
+            },
+            "DeleteRichMedias": {
+                "request": "pushwoosh.rpc_v2.rich_medias.DeleteRichMediasRequest",
+                "response": "pushwoosh.rpc_v2.rich_medias.DeleteRichMediasResponse",
+                "method": "post",
+                "path": "/api/rich-medias/delete"
+            },
+            "GetRichMediasUsage": {
+                "request": "pushwoosh.rpc_v2.rich_medias.GetRichMediasUsageRequest",
+                "response": "pushwoosh.rpc_v2.rich_medias.GetRichMediasUsageResponse",
+                "method": "post",
+                "path": "/api/rich-medias/usage"
             }
         }
     },
@@ -34470,6 +34582,83 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.rich_medias.DeleteRichMediasRequest": {
+        "type": "I",
+        "fields": {
+            "codes": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.rich_medias.DeleteRichMediasResponse": {
+        "type": "I",
+        "fields": {}
+    },
+    "pushwoosh.rpc_v2.rich_medias.GetRichMediasUsageRequest": {
+        "type": "I",
+        "fields": {
+            "codes": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.rich_medias.RichMediaUsage.RichMediaUser": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.rich_medias.RichMediaUsage.RichMediaJourney": {
+        "type": "I",
+        "fields": {
+            "uuid": {
+                "type": "string"
+            },
+            "title": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.rich_medias.RichMediaUsage": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "inApps": {
+                "type": "pushwoosh.rpc_v2.rich_medias.RichMediaUsage.RichMediaUser",
+                "array": true
+            },
+            "pushPresets": {
+                "type": "pushwoosh.rpc_v2.rich_medias.RichMediaUsage.RichMediaUser",
+                "array": true
+            },
+            "inboxPresets": {
+                "type": "pushwoosh.rpc_v2.rich_medias.RichMediaUsage.RichMediaUser",
+                "array": true
+            },
+            "journeys": {
+                "type": "pushwoosh.rpc_v2.rich_medias.RichMediaUsage.RichMediaJourney",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.rich_medias.GetRichMediasUsageResponse": {
+        "type": "I",
+        "fields": {
+            "usages": {
+                "type": "pushwoosh.rpc_v2.rich_medias.RichMediaUsage",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.rpc_v2.segment_statistics.SegmentStatisticsService": {
         "type": "S",
         "key": "segmentStatistics",

package/package.json

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

package/rich_medias.d.ts

@@ -14,6 +14,8 @@ export type RichMediaService_GetDetailedActionStatistics = RpcMethod<GetDetailed
 export type RichMediaService_GetSendChannels = RpcMethod<GetSendChannelsRequest, GetSendChannelsResponse>;
 export type RichMediaService_GetDevices = RpcMethod<GetDevicesRequest, GetDevicesResponse>;
 export type RichMediaService_GetEvents = RpcMethod<GetEventsRequest, GetEventsResponse>;
+export type RichMediaService_DeleteRichMedias = RpcMethod<DeleteRichMediasRequest, DeleteRichMediasResponse>;
+export type RichMediaService_GetRichMediasUsage = RpcMethod<GetRichMediasUsageRequest, GetRichMediasUsageResponse>;
 export interface RichMediaService {
     /** Creates a new rich media for the account, either block-based (built from an empty template) or from an uploaded base64 zip; the server persists it and returns the generated rich media code. Use for HTML/zip rich media; use create_native_rich_media for SDK-rendered native content. */
     Create: RichMediaService_Create;
@@ -23,7 +25,7 @@ export interface RichMediaService {
     UpdateNative: RichMediaService_UpdateNative;
     /** Duplicates an existing rich media (by code) under a new name, copying its content, and returns the new rich media code. Use to start a new rich media from an existing one without editing the original. */
     Clone: RichMediaService_Clone;
-    /** Permanently deletes a rich media by code, removing its DB record and content files. Rejected if any in-app message still references it; detach those in-apps first. */
+    /** Permanently deletes a rich media by code, removing its DB record and content files. Rejected while an in-app message, a push preset, an App Inbox preset or a running or paused journey still uses it; check get_rich_medias_usage first. */
     Delete: RichMediaService_Delete;
     /** Returns a single rich media by code, including its rendered content (index.html or native-config.json), params, created type and metadata. Use to inspect one rich media; use list_rich_medias to browse. */
     Get: RichMediaService_Get;
@@ -45,6 +47,10 @@ export interface RichMediaService {
     GetDevices: RichMediaService_GetDevices;
     /** Returns per-event triggered and unique-triggered counts fired from within a rich media by code over a date range, by platform. Use to measure custom events emitted by a rich media's content. */
     GetEvents: RichMediaService_GetEvents;
+    /** Permanently deletes several rich medias of the account in one request, up to 1000 codes, like delete_rich_media. All-or-nothing: if any code is not found or is used by an in-app message, a push preset, an App Inbox preset or a running or paused journey, nothing is deleted; check get_rich_medias_usage first. */
+    DeleteRichMedias: RichMediaService_DeleteRichMedias;
+    /** Lists which of the given rich medias of the account, up to 1000 codes, are used by in-app messages, push presets, App Inbox presets or running or paused journeys, with those users. Rich medias missing from the answer are not in use or not found. Use before delete_rich_medias. */
+    GetRichMediasUsage: RichMediaService_GetRichMediasUsage;
 }
 export type ActionType = 'ACTION_TYPE_UNSPECIFIED' | 'ELEMENT_CLICK' | 'FORM_SUBMIT' | 'OPEN' | 'CLOSE';
 export type RichMediaSendChannel = 'RichMediaSendChannel_UNDEFINED' | 'IN_APP' | 'CJ' | 'PUSH';
@@ -412,3 +418,36 @@ export type LocalizationChange = {
     updatedKeys: string[];
     removedKeys: string[];
 };
+export type DeleteRichMediasRequest = {
+    /** Rich media codes to delete. */
+    codes?: string[];
+};
+export type DeleteRichMediasResponse = {};
+export type GetRichMediasUsageRequest = {
+    /** Rich media codes to check. */
+    codes?: string[];
+};
+export type RichMediaUsage_RichMediaUser = {
+    code: string;
+    name: string;
+};
+export type RichMediaUsage_RichMediaJourney = {
+    uuid: string;
+    title: string;
+};
+export type RichMediaUsage = {
+    /** Rich media code. */
+    code: string;
+    /** In-app messages showing the rich media, in any status. */
+    inApps: RichMediaUsage_RichMediaUser[];
+    /** Push presets opening the rich media. */
+    pushPresets: RichMediaUsage_RichMediaUser[];
+    /** App Inbox presets opening the rich media on tap. */
+    inboxPresets: RichMediaUsage_RichMediaUser[];
+    /** Running or paused journeys sending the rich media. */
+    journeys: RichMediaUsage_RichMediaJourney[];
+};
+export type GetRichMediasUsageResponse = {
+    /** Only the rich medias that are in use, sorted by rich media code. */
+    usages: RichMediaUsage[];
+};