@pushwoosh/rpc-v2-http-api-data 0.2.448 → 0.2.449

package/data.js

@@ -14578,6 +14578,18 @@ export const data = {
                 "method": "get",
                 "path": "/api/emails_configurations/domains:diagnose"
             },
+            "ConnectPostmaster": {
+                "request": "pushwoosh.rpc_v2.emails_configurations.ConnectPostmasterRequest",
+                "response": "pushwoosh.rpc_v2.emails_configurations.ConnectPostmasterResponse",
+                "method": "post",
+                "path": "/api/emails_configurations/domains:connect_postmaster"
+            },
+            "DisconnectPostmaster": {
+                "request": "pushwoosh.rpc_v2.emails_configurations.DisconnectPostmasterRequest",
+                "response": "pushwoosh.rpc_v2.emails_configurations.DisconnectPostmasterResponse",
+                "method": "post",
+                "path": "/api/emails_configurations/domains:disconnect_postmaster"
+            },
             "RestartDomainVerification": {
                 "request": "pushwoosh.rpc_v2.emails_configurations.RestartDomainVerificationRequest",
                 "response": "pushwoosh.rpc_v2.emails_configurations.RestartDomainVerificationResponse",
@@ -14586,6 +14598,35 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.emails_configurations.Domain.PostmasterCompliance": {
+        "type": "I",
+        "fields": {
+            "requirement": {
+                "type": "string"
+            },
+            "status": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.emails_configurations.Domain.Postmaster": {
+        "type": "I",
+        "fields": {
+            "status": {
+                "type": "string"
+            },
+            "verificationRecord": {
+                "type": "string"
+            },
+            "statusChangedAt": {
+                "type": "string"
+            },
+            "compliance": {
+                "type": "pushwoosh.rpc_v2.emails_configurations.Domain.PostmasterCompliance",
+                "array": true
+            }
+        }
+    },
     "pushwoosh.rpc_v2.emails_configurations.Domain.CName": {
         "type": "I",
         "fields": {
@@ -14626,6 +14667,9 @@ export const data = {
             "cnamesYandex": {
                 "type": "pushwoosh.rpc_v2.emails_configurations.Domain.CName",
                 "array": true
+            },
+            "postmaster": {
+                "type": "pushwoosh.rpc_v2.emails_configurations.Domain.Postmaster"
             }
         }
     },
@@ -14658,6 +14702,9 @@ export const data = {
             "emailDomains": {
                 "type": "pushwoosh.rpc_v2.emails_configurations.Domain",
                 "array": true
+            },
+            "postmasterAvailable": {
+                "type": "boolean"
             }
         }
     },
@@ -14848,6 +14895,40 @@ export const data = {
         "type": "I",
         "fields": {}
     },
+    "pushwoosh.rpc_v2.emails_configurations.ConnectPostmasterRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "domain": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.emails_configurations.ConnectPostmasterResponse": {
+        "type": "I",
+        "fields": {
+            "postmaster": {
+                "type": "pushwoosh.rpc_v2.emails_configurations.Domain.Postmaster"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.emails_configurations.DisconnectPostmasterRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "domain": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.emails_configurations.DisconnectPostmasterResponse": {
+        "type": "I",
+        "fields": {}
+    },
     "pushwoosh.rpc.errors.v3.I18NOptions": {
         "type": "I",
         "fields": {

package/emails_configurations.d.ts

@@ -8,6 +8,8 @@ export type EmailsConfigurationsService_UpsertCustomTrackingDomain = RpcMethod<U
 export type EmailsConfigurationsService_DeleteCustomTrackingDomain = RpcMethod<DeleteCustomTrackingDomainRequest, DeleteCustomTrackingDomainResponse>;
 export type EmailsConfigurationsService_VerifyCustomTrackingDomain = RpcMethod<VerifyCustomTrackingDomainRequest, VerifyCustomTrackingDomainResponse>;
 export type EmailsConfigurationsService_DiagnoseDomain = RpcMethod<DiagnoseDomainRequest, DiagnoseDomainResponse>;
+export type EmailsConfigurationsService_ConnectPostmaster = RpcMethod<ConnectPostmasterRequest, ConnectPostmasterResponse>;
+export type EmailsConfigurationsService_DisconnectPostmaster = RpcMethod<DisconnectPostmasterRequest, DisconnectPostmasterResponse>;
 export type EmailsConfigurationsService_RestartDomainVerification = RpcMethod<RestartDomainVerificationRequest, RestartDomainVerificationResponse>;
 export interface EmailsConfigurationsService {
     /** Lists the sender email domains configured for an application's account (format XXXXX-XXXXX) with their DKIM/SPF/DMARC statuses and the DNS CNAME records to add. Use to show email sender-domain setup; covers both Amazon SES and SMTP-service domains. */
@@ -28,9 +30,30 @@ export interface EmailsConfigurationsService {
     VerifyCustomTrackingDomain: EmailsConfigurationsService_VerifyCustomTrackingDomain;
     /** Checks live DNS for every record a sender email domain needs (DKIM CNAMEs, SPF, DMARC) and explains what is missing or mistyped, e.g. a record created with the domain appended twice. Read-only; use when a domain stays unverified. */
     DiagnoseDomain: EmailsConfigurationsService_DiagnoseDomain;
+    /** Connects a sender email domain to Gmail Postmaster and returns the TXT record the customer publishes at the domain apex. Verification then runs on its own (hourly for 72 hours, then daily for 30 days) and on update_email_domain_statuses; once verified, Gmail spam rate and delivery errors of the whole domain appear on Home → Email. Calling it again after a failed verification restarts it. */
+    ConnectPostmaster: EmailsConfigurationsService_ConnectPostmaster;
+    /** Disconnects a sender email domain from Gmail Postmaster; its Gmail stats stop being collected. The customer can remove the TXT record afterwards. */
+    DisconnectPostmaster: EmailsConfigurationsService_DisconnectPostmaster;
     /** Restarts Amazon SES DKIM verification for a sender email domain that SES gave up on (it stops checking 72 hours after the domain is added). DNS records stay the same; the SMTP selector is not touched. */
     RestartDomainVerification: EmailsConfigurationsService_RestartDomainVerification;
 }
+export type Domain_PostmasterCompliance = {
+    /** dmarc_alignment, one_click_unsubscribe or honor_unsubscribe: the Gmail requirements our DNS checks do not cover. */
+    requirement: string;
+    /** compliant or needs_work. */
+    status: string;
+};
+/** Gmail Postmaster connection of the domain. */
+export type Domain_Postmaster = {
+    /** not_connected, pending, verified or failed (gave up after 30 days without the TXT record). */
+    status: string;
+    /** TXT record value for the domain apex, google-site-verification=...; empty when not connected. */
+    verificationRecord: string;
+    /** RFC 3339 time the status last changed. */
+    statusChangedAt: string;
+    /** Filled once the domain is verified and Gmail has assessed it. */
+    compliance: Domain_PostmasterCompliance[];
+};
 export type Domain_CName = {
     name: string;
     value: string;
@@ -44,6 +67,7 @@ export type Domain = {
     cnamesAmazon: Domain_CName[];
     cnames: Domain_CName[];
     cnamesYandex: Domain_CName[];
+    postmaster: Domain_Postmaster;
 };
 export type AddDomainRequest = {
     /** Sender email domain to register (e.g. mail.example.com). */
@@ -58,6 +82,8 @@ export type GetDomainsRequest = {
 };
 export type GetDomainsResponse = {
     emailDomains: Domain[];
+    /** Whether Gmail Postmaster can be connected in this installation. */
+    postmasterAvailable: boolean;
 };
 export type UpdateDomainStatusesRequest = {
     /** Application code (format XXXXX-XXXXX). */
@@ -137,7 +163,7 @@ export type DnsRecordCheck = {
     diagnosis: RecordDiagnosis;
     /** Whether the provider the sender routes through needs this record to verify the domain. */
     required: boolean;
-    /** dkim, spf or dmarc. */
+    /** dkim, spf, dmarc or postmaster. */
     purpose: string;
     /** amazon, smtp or yandex; empty for SPF and DMARC. */
     provider: string;
@@ -156,3 +182,19 @@ export type RestartDomainVerificationRequest = {
     domain?: string;
 };
 export type RestartDomainVerificationResponse = {};
+export type ConnectPostmasterRequest = {
+    /** Application code (format XXXXX-XXXXX). */
+    application?: string;
+    /** Sender email domain of the account. */
+    domain?: string;
+};
+export type ConnectPostmasterResponse = {
+    postmaster: Domain_Postmaster;
+};
+export type DisconnectPostmasterRequest = {
+    /** Application code (format XXXXX-XXXXX). */
+    application?: string;
+    /** Sender email domain of the account. */
+    domain?: string;
+};
+export type DisconnectPostmasterResponse = {};

package/package.json

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