@pushwoosh/rpc-v2-http-api-data 0.2.512 → 0.2.513

package/applications.d.ts

@@ -13,6 +13,8 @@ export type ApplicationsService_GetAccountGroupPermissions = RpcMethod<GetAccoun
 export type ApplicationsService_SaveAccountGroupPermissions = RpcMethod<SaveAccountGroupPermissionsRequest, SaveAccountGroupPermissionsResponse>;
 export type ApplicationsService_GetDOIConfig = RpcMethod<GetDOIConfigRequest, GetDOIConfigResponse>;
 export type ApplicationsService_SetDOIConfig = RpcMethod<SetDOIConfigRequest, SetDOIConfigResponse>;
+export type ApplicationsService_GetEmailSunsetPolicy = RpcMethod<GetEmailSunsetPolicyRequest, GetEmailSunsetPolicyResponse>;
+export type ApplicationsService_SetEmailSunsetPolicy = RpcMethod<SetEmailSunsetPolicyRequest, SetEmailSunsetPolicyResponse>;
 export interface ApplicationsService {
     /** Returns one Pushwoosh application by its code (format XXXXX-XXXXX) with platforms, subscriber counts, languages and permissions. Use to inspect a single app; use list_applications to browse many. */
     Get: ApplicationsService_Get;
@@ -40,6 +42,10 @@ export interface ApplicationsService {
     GetDOIConfig: ApplicationsService_GetDOIConfig;
     /** Enables or disables double opt-in (DOI) for an application; enabling for the first time clones the confirmation email preset into the account. Use to require email confirmation before subscribing. */
     SetDOIConfig: ApplicationsService_SetDOIConfig;
+    /** Returns the email sunset policy of an application: whether marketing emails skip recipients with no email activity, the inactivity period in days and the activity type. Use before changing it with set_email_sunset_policy. */
+    GetEmailSunsetPolicy: ApplicationsService_GetEmailSunsetPolicy;
+    /** Turns the email sunset policy of an application on or off and sets its period (30, 90, 180, 365 or 730 days) and activity (click, open or both). Enabled without a period or activity, it takes 180 days and both. Transactional emails are never affected. */
+    SetEmailSunsetPolicy: ApplicationsService_SetEmailSunsetPolicy;
 }
 export type ApplicationPlatformSubscribersCount = {
     pushEnabled: number;
@@ -205,3 +211,49 @@ export type SetDOIConfigRequest = {
     enabled?: boolean;
 };
 export type SetDOIConfigResponse = {};
+/** What counts as email activity for the sunset policy. */
+export type EmailSunsetActivityType = 'EMAIL_SUNSET_ACTIVITY_TYPE_UNSPECIFIED' | 'EMAIL_SUNSET_ACTIVITY_TYPE_CLICK' | 'EMAIL_SUNSET_ACTIVITY_TYPE_OPEN' | 'EMAIL_SUNSET_ACTIVITY_TYPE_CLICK_AND_OPEN';
+/** How many marketing emails and users are reached without the sunset policy (total) and with it (sent); skipped is their difference. A user counts as skipped when none of their emails is sent. */
+export type EmailSunsetCounters = {
+    totalEmails: number;
+    totalUsers: number;
+    sentEmails: number;
+    sentUsers: number;
+    skippedEmails: number;
+    skippedUsers: number;
+    /** When the counters were last recounted; unset while a recount is pending. */
+    updatedAt: Date;
+    /** PENDING after the policy is enabled or changed until the recount finishes, DONE once the counters are set. */
+    status: EmailSunsetCountersStatus;
+};
+export type EmailSunsetPolicy = {
+    /** Whether marketing emails skip recipients without activity within the period. */
+    enabled: boolean;
+    /** Inactivity period in days: 30, 90, 180, 365 or 730. */
+    period: number;
+    /** What counts as activity; a recipient without any counts from the First Install tag. */
+    activityType: EmailSunsetActivityType;
+    /** Counters of the whole application, recounted daily while the policy is enabled; only the status while a recount is pending. */
+    counters: EmailSunsetCounters;
+};
+export type EmailSunsetCountersStatus = 'EMAIL_SUNSET_COUNTERS_STATUS_UNSPECIFIED' | 'EMAIL_SUNSET_COUNTERS_STATUS_PENDING' | 'EMAIL_SUNSET_COUNTERS_STATUS_DONE';
+export type GetEmailSunsetPolicyRequest = {
+    /** Application code (format XXXXX-XXXXX) whose email sunset policy to fetch. */
+    code?: string;
+};
+export type GetEmailSunsetPolicyResponse = {
+    policy: EmailSunsetPolicy;
+};
+export type SetEmailSunsetPolicyRequest = {
+    /** Application code (format XXXXX-XXXXX) to configure. */
+    code?: string;
+    /** Whether the policy is on. */
+    enabled?: boolean;
+    /** Inactivity period in days: 30, 90, 180, 365 or 730; 0 keeps the stored value, or 180 when there is none. */
+    period?: number;
+    /** What counts as activity; UNSPECIFIED keeps the stored value, or CLICK_AND_OPEN when there is none. */
+    activityType?: EmailSunsetActivityType;
+};
+export type SetEmailSunsetPolicyResponse = {
+    policy: EmailSunsetPolicy;
+};

package/data.js

@@ -5620,6 +5620,18 @@ export const data = {
                 "response": "pushwoosh.rpc_v2.applications.SetDOIConfigResponse",
                 "method": "patch",
                 "path": "/api/applications/{code}/doi-config"
+            },
+            "GetEmailSunsetPolicy": {
+                "request": "pushwoosh.rpc_v2.applications.GetEmailSunsetPolicyRequest",
+                "response": "pushwoosh.rpc_v2.applications.GetEmailSunsetPolicyResponse",
+                "method": "get",
+                "path": "/api/applications/{code}/email-sunset-policy"
+            },
+            "SetEmailSunsetPolicy": {
+                "request": "pushwoosh.rpc_v2.applications.SetEmailSunsetPolicyRequest",
+                "response": "pushwoosh.rpc_v2.applications.SetEmailSunsetPolicyResponse",
+                "method": "patch",
+                "path": "/api/applications/{code}/email-sunset-policy"
             }
         }
     },
@@ -6025,6 +6037,110 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.applications.EmailSunsetActivityType": {
+        "type": "E",
+        "values": [
+            "EMAIL_SUNSET_ACTIVITY_TYPE_UNSPECIFIED",
+            "EMAIL_SUNSET_ACTIVITY_TYPE_CLICK",
+            "EMAIL_SUNSET_ACTIVITY_TYPE_OPEN",
+            "EMAIL_SUNSET_ACTIVITY_TYPE_CLICK_AND_OPEN"
+        ]
+    },
+    "pushwoosh.rpc_v2.applications.EmailSunsetCounters": {
+        "type": "I",
+        "fields": {
+            "totalEmails": {
+                "type": "number"
+            },
+            "totalUsers": {
+                "type": "number"
+            },
+            "sentEmails": {
+                "type": "number"
+            },
+            "sentUsers": {
+                "type": "number"
+            },
+            "skippedEmails": {
+                "type": "number"
+            },
+            "skippedUsers": {
+                "type": "number"
+            },
+            "updatedAt": {
+                "type": "Date"
+            },
+            "status": {
+                "type": "pushwoosh.rpc_v2.applications.EmailSunsetCountersStatus"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications.EmailSunsetPolicy": {
+        "type": "I",
+        "fields": {
+            "enabled": {
+                "type": "boolean"
+            },
+            "period": {
+                "type": "number"
+            },
+            "activityType": {
+                "type": "pushwoosh.rpc_v2.applications.EmailSunsetActivityType"
+            },
+            "counters": {
+                "type": "pushwoosh.rpc_v2.applications.EmailSunsetCounters"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications.EmailSunsetCountersStatus": {
+        "type": "E",
+        "values": [
+            "EMAIL_SUNSET_COUNTERS_STATUS_UNSPECIFIED",
+            "EMAIL_SUNSET_COUNTERS_STATUS_PENDING",
+            "EMAIL_SUNSET_COUNTERS_STATUS_DONE"
+        ]
+    },
+    "pushwoosh.rpc_v2.applications.GetEmailSunsetPolicyRequest": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications.GetEmailSunsetPolicyResponse": {
+        "type": "I",
+        "fields": {
+            "policy": {
+                "type": "pushwoosh.rpc_v2.applications.EmailSunsetPolicy"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications.SetEmailSunsetPolicyRequest": {
+        "type": "I",
+        "fields": {
+            "code": {
+                "type": "string"
+            },
+            "enabled": {
+                "type": "boolean"
+            },
+            "period": {
+                "type": "number"
+            },
+            "activityType": {
+                "type": "pushwoosh.rpc_v2.applications.EmailSunsetActivityType"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.applications.SetEmailSunsetPolicyResponse": {
+        "type": "I",
+        "fields": {
+            "policy": {
+                "type": "pushwoosh.rpc_v2.applications.EmailSunsetPolicy"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.applications.email_froms.ApplicationEmailFromsService": {
         "type": "S",
         "key": "applicationEmailFroms",

package/package.json

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