@pushwoosh/rpc-v2-http-api-data 0.2.419 → 0.2.421

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": {

package/events.d.ts

@@ -40,7 +40,7 @@ export interface EventsService {
     DismissRevenueSuggestions: EventsService_DismissRevenueSuggestions;
     /** Returns the events counted as conversions on the Conversions board, PW_Conversion first, each with its revenue attributes when it tracks revenue. */
     GetConversionEvents: EventsService_GetConversionEvents;
-    /** Replaces the list of events counted as conversions on the Conversions board. Events left out of the request stop counting; PW_Conversion is always kept. Revenue attributes of an event are set through Update (revenue_mapping). A newly listed event is scheduled for a history recalculation. */
+    /** Replaces the list of events counted as conversions on the Conversions board. Events left out of the request stop counting; PW_Conversion is always kept. Each event's revenue_mapping is saved in the same call: unset leaves its revenue attributes as they are, empty makes it a conversion without revenue. A newly listed event or changed revenue attributes schedule a history recalculation. */
     SaveConversionEvents: EventsService_SaveConversionEvents;
 }
 export type GetEventRequest = {
@@ -285,7 +285,7 @@ export type GetRevenueStatisticsResponse = {
 export type ConversionEvent = {
     /** Name of the application's event that counts as a conversion. */
     name: string;
-    /** Where the event keeps its amount and currency; unset for an event counted without revenue. */
+    /** Where the event keeps its amount and currency; unset for an event counted without revenue. In SaveConversionEvents unset leaves the stored attributes as they are and empty clears them. */
     revenueMapping: RevenueMapping;
     /** PW_Conversion: always listed, always tracks revenue, cannot be removed. */
     isDefault: boolean;

package/package.json

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