@pushwoosh/rpc-v2-http-api-data 0.2.234 → 0.2.236

package/data.js

@@ -10652,6 +10652,108 @@ export const data = {
                 "response": "pushwoosh.rpc_v2.email_suppressions.GetEmailSuppressionResponse",
                 "method": "get",
                 "path": "/api/email_suppressions/status"
+            },
+            "ReactivateEmail": {
+                "request": "pushwoosh.rpc_v2.email_suppressions.ReactivateEmailRequest",
+                "response": "pushwoosh.rpc_v2.email_suppressions.ReactivateEmailResponse",
+                "method": "post",
+                "path": "/api/email_suppressions:reactivate"
+            },
+            "ListEmailReactivations": {
+                "request": "pushwoosh.rpc_v2.email_suppressions.ListEmailReactivationsRequest",
+                "response": "pushwoosh.rpc_v2.email_suppressions.ListEmailReactivationsResponse",
+                "method": "get",
+                "path": "/api/email_suppressions/reactivations"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_suppressions.ReactivateEmailRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "email": {
+                "type": "string"
+            },
+            "reasonComment": {
+                "type": "string"
+            },
+            "consentConfirmed": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_suppressions.ReactivateEmailResponse": {
+        "type": "I",
+        "fields": {
+            "reactivatedSources": {
+                "type": "pushwoosh.rpc_v2.email_suppressions.EmailSuppressionSource",
+                "array": true
+            },
+            "deviceRegistered": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_suppressions.ListEmailReactivationsRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "email": {
+                "type": "string"
+            },
+            "limit": {
+                "type": "number"
+            },
+            "offset": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_suppressions.ListEmailReactivationsResponse": {
+        "type": "I",
+        "fields": {
+            "reactivations": {
+                "type": "pushwoosh.rpc_v2.email_suppressions.EmailReactivation",
+                "array": true
+            },
+            "total": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_suppressions.EmailReactivation": {
+        "type": "I",
+        "fields": {
+            "email": {
+                "type": "string"
+            },
+            "source": {
+                "type": "pushwoosh.rpc_v2.email_suppressions.EmailSuppressionSource"
+            },
+            "createdAt": {
+                "type": "Date"
+            },
+            "comment": {
+                "type": "string"
+            },
+            "consentConfirmed": {
+                "type": "boolean"
+            },
+            "actorType": {
+                "type": "string"
+            },
+            "actorId": {
+                "type": "number"
+            },
+            "channel": {
+                "type": "string"
+            },
+            "application": {
+                "type": "string"
             }
         }
     },

package/email_suppressions.d.ts

@@ -1,9 +1,57 @@
 import { RpcMethod } from './commonTypes';
 export type EmailSuppressionsService_GetEmailSuppression = RpcMethod<GetEmailSuppressionRequest, GetEmailSuppressionResponse>;
+export type EmailSuppressionsService_ReactivateEmail = RpcMethod<ReactivateEmailRequest, ReactivateEmailResponse>;
+export type EmailSuppressionsService_ListEmailReactivations = RpcMethod<ListEmailReactivationsRequest, ListEmailReactivationsResponse>;
 export interface EmailSuppressionsService {
     /** Returns whether an email address is suppressed (spam complaint or hard bounce) for the application's account, with the source, date and the provider's verbatim reason including SMTP and diagnostic codes. Use to explain why emails to a subscriber are not going out while the profile still looks subscribed. */
     GetEmailSuppression: EmailSuppressionsService_GetEmailSuppression;
+    /** Takes an email address off the suppression lists for the account: removes the complaint and hard-bounce records, clears the Bounced Email tag and re-registers the email device when the complaint had unregistered it. Requires the ManageEmailSuppression right, and consent_confirmed for an address suppressed by a spam complaint. */
+    ReactivateEmail: EmailSuppressionsService_ReactivateEmail;
+    /** Returns the journal of suppression removals for the account — who reactivated which address, from which list, with what comment and through which channel. Use to prove to a mailbox provider that returns were deliberate. */
+    ListEmailReactivations: EmailSuppressionsService_ListEmailReactivations;
 }
+export type ReactivateEmailRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX) the reactivation is performed from. */
+    application?: string;
+    /** Email address to reactivate; matched case-insensitively. */
+    email?: string;
+    /** Free-text note stored in the journal, up to 255 characters. */
+    reasonComment?: string;
+    /** Confirms the recipient asked to be mailed again; required when the address is on the complaint list. */
+    consentConfirmed?: boolean;
+};
+export type ReactivateEmailResponse = {
+    /** Lists the address was removed from; empty when it was not suppressed. */
+    reactivatedSources: EmailSuppressionSource[];
+    /** True when the email device was registered again because the complaint had removed it. */
+    deviceRegistered: boolean;
+};
+export type ListEmailReactivationsRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX); the journal itself is account-wide. */
+    application?: string;
+    /** Optional exact address filter, matched case-insensitively. */
+    email?: string;
+    /** Page size, 100 by default, 1000 at most. */
+    limit?: number;
+    offset?: number;
+};
+export type ListEmailReactivationsResponse = {
+    reactivations: EmailReactivation[];
+    total: number;
+};
+export type EmailReactivation = {
+    email: string;
+    source: EmailSuppressionSource;
+    createdAt: Date;
+    comment: string;
+    consentConfirmed: boolean;
+    /** Who did it: account_user or pushwoosh_staff. */
+    actorType: string;
+    actorId: number;
+    /** How it was done: ui, api or service (an internal service-token call). */
+    channel: string;
+    application: string;
+};
 export type GetEmailSuppressionRequest = {
     /** Pushwoosh application code (XXXXX-XXXXX). */
     application?: string;

package/package.json

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