@pushwoosh/rpc-v2-http-api-data 0.2.231 → 0.2.233

package/data.js

@@ -4243,16 +4243,20 @@ export const data = {
         "type": "I",
         "fields": {
             "companyName": {
-                "type": "string"
+                "type": "string",
+                "optional": true
             },
             "address": {
-                "type": "string"
+                "type": "string",
+                "optional": true
             },
             "copyright": {
-                "type": "string"
+                "type": "string",
+                "optional": true
             },
             "unsubscribeLabel": {
-                "type": "string"
+                "type": "string",
+                "optional": true
             },
             "links": {
                 "type": "pushwoosh.aibuilder.v1.NavLink",
@@ -10639,6 +10643,86 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.email_suppressions.EmailSuppressionsService": {
+        "type": "S",
+        "key": "emailSuppressions",
+        "methods": {
+            "GetEmailSuppression": {
+                "request": "pushwoosh.rpc_v2.email_suppressions.GetEmailSuppressionRequest",
+                "response": "pushwoosh.rpc_v2.email_suppressions.GetEmailSuppressionResponse",
+                "method": "get",
+                "path": "/api/email_suppressions/status"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_suppressions.GetEmailSuppressionRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "email": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_suppressions.GetEmailSuppressionResponse": {
+        "type": "I",
+        "fields": {
+            "state": {
+                "type": "pushwoosh.rpc_v2.email_suppressions.EmailSuppressionState"
+            },
+            "suppressions": {
+                "type": "pushwoosh.rpc_v2.email_suppressions.EmailSuppression",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_suppressions.EmailSuppression": {
+        "type": "I",
+        "fields": {
+            "source": {
+                "type": "pushwoosh.rpc_v2.email_suppressions.EmailSuppressionSource"
+            },
+            "occurredAt": {
+                "type": "Date"
+            },
+            "reason": {
+                "type": "string"
+            },
+            "rawReason": {
+                "type": "string"
+            },
+            "smtpCode": {
+                "type": "string"
+            },
+            "diagnosticCode": {
+                "type": "string"
+            },
+            "application": {
+                "type": "string"
+            },
+            "accountWide": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.email_suppressions.EmailSuppressionState": {
+        "type": "E",
+        "values": [
+            "EMAIL_SUPPRESSION_STATE_UNSPECIFIED",
+            "EMAIL_SUPPRESSION_STATE_DELIVERABLE",
+            "EMAIL_SUPPRESSION_STATE_SUPPRESSED"
+        ]
+    },
+    "pushwoosh.rpc_v2.email_suppressions.EmailSuppressionSource": {
+        "type": "E",
+        "values": [
+            "EMAIL_SUPPRESSION_SOURCE_UNSPECIFIED",
+            "EMAIL_SUPPRESSION_SOURCE_SPAM_COMPLAINT",
+            "EMAIL_SUPPRESSION_SOURCE_HARD_BOUNCE"
+        ]
+    },
     "pushwoosh.rpc_v2.accounts.EmailTemplatesService": {
         "type": "S",
         "key": "emailTemplates",

package/email_suppressions.d.ts

@@ -0,0 +1,33 @@
+import { RpcMethod } from './commonTypes';
+export type EmailSuppressionsService_GetEmailSuppression = RpcMethod<GetEmailSuppressionRequest, GetEmailSuppressionResponse>;
+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;
+}
+export type GetEmailSuppressionRequest = {
+    /** Pushwoosh application code (XXXXX-XXXXX). */
+    application?: string;
+    /** Email address to look up; matched case-insensitively. */
+    email?: string;
+};
+export type GetEmailSuppressionResponse = {
+    state: EmailSuppressionState;
+    /** One entry per list the address is on — an address can be both complained and bounced. */
+    suppressions: EmailSuppression[];
+};
+export type EmailSuppression = {
+    source: EmailSuppressionSource;
+    occurredAt: Date;
+    /** Human-readable reason extracted from the provider feedback. */
+    reason: string;
+    /** Provider feedback verbatim, for support and for reasons the parser did not recognise. */
+    rawReason: string;
+    smtpCode: string;
+    diagnosticCode: string;
+    /** Application the suppression was recorded in; empty when that application is gone. */
+    application: string;
+    /** Suppression is enforced for the whole account, not only for the recorded application. */
+    accountWide: boolean;
+};
+export type EmailSuppressionState = 'EMAIL_SUPPRESSION_STATE_UNSPECIFIED' | 'EMAIL_SUPPRESSION_STATE_DELIVERABLE' | 'EMAIL_SUPPRESSION_STATE_SUPPRESSED';
+export type EmailSuppressionSource = 'EMAIL_SUPPRESSION_SOURCE_UNSPECIFIED' | 'EMAIL_SUPPRESSION_SOURCE_SPAM_COMPLAINT' | 'EMAIL_SUPPRESSION_SOURCE_HARD_BOUNCE';

package/email_suppressions.js

@@ -0,0 +1,3 @@
+/* eslint-disable */
+/* Autogenerated code */
+export {};

package/index.d.ts

@@ -26,6 +26,7 @@ import { DeeplinksService as pushwoosh_rpc_v2_deeplinks_DeeplinksService } from
 import { DeliverabilityCheckerService as pushwoosh_rpc_v2_deliverability_checker_DeliverabilityCheckerService } from './deliverability_checker';
 import { DevicesService as pushwoosh_rpc_v2_devices_DevicesService } from './devices';
 import { EmailCategoriesService as pushwoosh_rpc_v2_email_categories_EmailCategoriesService } from './email_categories';
+import { EmailSuppressionsService as pushwoosh_rpc_v2_email_suppressions_EmailSuppressionsService } from './email_suppressions';
 import { EmailTemplatesService as pushwoosh_rpc_v2_accounts_EmailTemplatesService } from './accounts';
 import { EmailsConfigurationsService as pushwoosh_rpc_v2_emails_configurations_EmailsConfigurationsService } from './emails_configurations';
 import { EventsService as pushwoosh_rpc_v2_events_EventsService } from './events';
@@ -96,6 +97,7 @@ export type API = {
     deliverabilityChecker: pushwoosh_rpc_v2_deliverability_checker_DeliverabilityCheckerService;
     devices: pushwoosh_rpc_v2_devices_DevicesService;
     emailCategories: pushwoosh_rpc_v2_email_categories_EmailCategoriesService;
+    emailSuppressions: pushwoosh_rpc_v2_email_suppressions_EmailSuppressionsService;
     emailTemplates: pushwoosh_rpc_v2_accounts_EmailTemplatesService;
     emailsConfigurations: pushwoosh_rpc_v2_emails_configurations_EmailsConfigurationsService;
     events: pushwoosh_rpc_v2_events_EventsService;

package/package.json

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

package/pushwoosh_aibuilder_v1.d.ts

@@ -1398,10 +1398,14 @@ export type AppBadge = {
 };
 /** Reusable brand footer data; never LLM-generated. */
 export type FooterContent = {
-    companyName: string;
-    address: string;
-    copyright: string;
-    unsubscribeLabel: string;
+    /**
+     * Optional because a writer that omits an empty string is the norm, not a
+     * bug: 217 of the 236 stored documents with a footer lack at least one.
+     */
+    companyName?: string;
+    address?: string;
+    copyright?: string;
+    unsubscribeLabel?: string;
     links: NavLink[];
     social: SocialLink[];
     appBadges: AppBadge[];