@pushwoosh/rpc-v2-http-api-data 0.2.238 → 0.2.239

package/data.js

@@ -10659,6 +10659,12 @@ export const data = {
                 "method": "post",
                 "path": "/api/email_suppressions:reactivate"
             },
+            "ListEmailSuppressions": {
+                "request": "pushwoosh.rpc_v2.email_suppressions.ListEmailSuppressionsRequest",
+                "response": "pushwoosh.rpc_v2.email_suppressions.ListEmailSuppressionsResponse",
+                "method": "get",
+                "path": "/api/email_suppressions"
+            },
             "ListEmailReactivations": {
                 "request": "pushwoosh.rpc_v2.email_suppressions.ListEmailReactivationsRequest",
                 "response": "pushwoosh.rpc_v2.email_suppressions.ListEmailReactivationsResponse",
@@ -10667,6 +10673,73 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.email_suppressions.ListEmailSuppressionsRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "email": {
+                "type": "string"
+            },
+            "source": {
+                "type": "pushwoosh.rpc_v2.email_suppressions.EmailSuppressionSource"
+            },
+            "dateFrom": {
+                "type": "Date"
+            },
+            "dateTo": {
+                "type": "Date"
+            },
+            "recordedInApplication": {
+                "type": "string"
+            },
+            "limit": {
+                "type": "number"
+            },
+            "offset": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_suppressions.ListEmailSuppressionsResponse": {
+        "type": "I",
+        "fields": {
+            "suppressions": {
+                "type": "pushwoosh.rpc_v2.email_suppressions.EmailSuppressionEntry",
+                "array": true
+            },
+            "total": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_suppressions.EmailSuppressionEntry": {
+        "type": "I",
+        "fields": {
+            "email": {
+                "type": "string"
+            },
+            "source": {
+                "type": "pushwoosh.rpc_v2.email_suppressions.EmailSuppressionSource"
+            },
+            "occurredAt": {
+                "type": "Date"
+            },
+            "reason": {
+                "type": "string"
+            },
+            "smtpCode": {
+                "type": "string"
+            },
+            "diagnosticCode": {
+                "type": "string"
+            },
+            "application": {
+                "type": "string"
+            }
+        }
+    },
     "pushwoosh.rpc_v2.email_suppressions.ReactivateEmailRequest": {
         "type": "I",
         "fields": {

package/email_suppressions.d.ts

@@ -1,15 +1,48 @@
 import { RpcMethod } from './commonTypes';
 export type EmailSuppressionsService_GetEmailSuppression = RpcMethod<GetEmailSuppressionRequest, GetEmailSuppressionResponse>;
 export type EmailSuppressionsService_ReactivateEmail = RpcMethod<ReactivateEmailRequest, ReactivateEmailResponse>;
+export type EmailSuppressionsService_ListEmailSuppressions = RpcMethod<ListEmailSuppressionsRequest, ListEmailSuppressionsResponse>;
 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;
+    /** Lists the account's suppressed email addresses with the source, date and provider reason, newest first. Filter by source, by the date the suppression happened, by the application it was recorded in, or look one exact address up — the support scenario "which list is this address on". */
+    ListEmailSuppressions: EmailSuppressionsService_ListEmailSuppressions;
     /** 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 ListEmailSuppressionsRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX) the caller works from; the list itself is account-wide. */
+    application?: string;
+    /** Exact address filter, matched case-insensitively; empty lists everything. */
+    email?: string;
+    /** Source filter; unspecified returns both lists merged by date. */
+    source?: EmailSuppressionSource;
+    dateFrom?: Date;
+    dateTo?: Date;
+    /** Application code the suppression was recorded in; empty covers the whole account. */
+    recordedInApplication?: string;
+    /** Page size, 50 by default, 500 at most. */
+    limit?: number;
+    offset?: number;
+};
+export type ListEmailSuppressionsResponse = {
+    suppressions: EmailSuppressionEntry[];
+    total: number;
+};
+export type EmailSuppressionEntry = {
+    email: string;
+    source: EmailSuppressionSource;
+    occurredAt: Date;
+    /** Human-readable reason extracted from the provider feedback. */
+    reason: string;
+    smtpCode: string;
+    diagnosticCode: string;
+    /** Application the suppression was recorded in; empty when that application is gone. */
+    application: string;
+};
 export type ReactivateEmailRequest = {
     /** Pushwoosh application code (XXXXX-XXXXX) the reactivation is performed from. */
     application?: string;

package/package.json

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