@pushwoosh/rpc-v2-http-api-data 0.2.346 → 0.2.348

package/data.js

@@ -13983,6 +13983,18 @@ export const data = {
                 "response": "pushwoosh.rpc_v2.emails_configurations.VerifyCustomTrackingDomainResponse",
                 "method": "post",
                 "path": "/api/emails_configurations/custom_tracking_domain:verify"
+            },
+            "DiagnoseDomain": {
+                "request": "pushwoosh.rpc_v2.emails_configurations.DiagnoseDomainRequest",
+                "response": "pushwoosh.rpc_v2.emails_configurations.DiagnoseDomainResponse",
+                "method": "get",
+                "path": "/api/emails_configurations/domains:diagnose"
+            },
+            "RestartDomainVerification": {
+                "request": "pushwoosh.rpc_v2.emails_configurations.RestartDomainVerificationRequest",
+                "response": "pushwoosh.rpc_v2.emails_configurations.RestartDomainVerificationResponse",
+                "method": "post",
+                "path": "/api/emails_configurations/domains:restart_verification"
             }
         }
     },
@@ -14150,6 +14162,103 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.emails_configurations.DiagnoseDomainRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "domain": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.emails_configurations.DomainDiagnosis": {
+        "type": "E",
+        "values": [
+            "DOMAIN_DIAGNOSIS_UNSPECIFIED",
+            "DOMAIN_DIAGNOSIS_VERIFIED",
+            "DOMAIN_DIAGNOSIS_RECORDS_INCOMPLETE",
+            "DOMAIN_DIAGNOSIS_WAITING_PROVIDER",
+            "DOMAIN_DIAGNOSIS_PROVIDER_VERIFICATION_EXPIRED",
+            "DOMAIN_DIAGNOSIS_DOMAIN_NOT_FOUND"
+        ]
+    },
+    "pushwoosh.rpc_v2.emails_configurations.RecordDiagnosis": {
+        "type": "E",
+        "values": [
+            "RECORD_DIAGNOSIS_UNSPECIFIED",
+            "RECORD_DIAGNOSIS_OK",
+            "RECORD_DIAGNOSIS_MISSING",
+            "RECORD_DIAGNOSIS_WRONG_VALUE",
+            "RECORD_DIAGNOSIS_DOUBLE_SUFFIX",
+            "RECORD_DIAGNOSIS_TXT_INSTEAD_OF_CNAME",
+            "RECORD_DIAGNOSIS_RESOLVE_ERROR"
+        ]
+    },
+    "pushwoosh.rpc_v2.emails_configurations.DnsRecordCheck": {
+        "type": "I",
+        "fields": {
+            "type": {
+                "type": "string"
+            },
+            "host": {
+                "type": "string"
+            },
+            "expectedValue": {
+                "type": "string"
+            },
+            "foundValues": {
+                "type": "string",
+                "array": true
+            },
+            "diagnosis": {
+                "type": "pushwoosh.rpc_v2.emails_configurations.RecordDiagnosis"
+            },
+            "required": {
+                "type": "boolean"
+            },
+            "purpose": {
+                "type": "string"
+            },
+            "provider": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.emails_configurations.DiagnoseDomainResponse": {
+        "type": "I",
+        "fields": {
+            "diagnosis": {
+                "type": "pushwoosh.rpc_v2.emails_configurations.DomainDiagnosis"
+            },
+            "records": {
+                "type": "pushwoosh.rpc_v2.emails_configurations.DnsRecordCheck",
+                "array": true
+            },
+            "nameServer": {
+                "type": "string"
+            },
+            "canRestartVerification": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.emails_configurations.RestartDomainVerificationRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "domain": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.emails_configurations.RestartDomainVerificationResponse": {
+        "type": "I",
+        "fields": {}
+    },
     "pushwoosh.rpc.errors.v3.I18NOptions": {
         "type": "I",
         "fields": {

package/emails_configurations.d.ts

@@ -7,6 +7,8 @@ export type EmailsConfigurationsService_GetCustomTrackingDomain = RpcMethod<GetC
 export type EmailsConfigurationsService_UpsertCustomTrackingDomain = RpcMethod<UpsertCustomTrackingDomainRequest, UpsertCustomTrackingDomainResponse>;
 export type EmailsConfigurationsService_DeleteCustomTrackingDomain = RpcMethod<DeleteCustomTrackingDomainRequest, DeleteCustomTrackingDomainResponse>;
 export type EmailsConfigurationsService_VerifyCustomTrackingDomain = RpcMethod<VerifyCustomTrackingDomainRequest, VerifyCustomTrackingDomainResponse>;
+export type EmailsConfigurationsService_DiagnoseDomain = RpcMethod<DiagnoseDomainRequest, DiagnoseDomainResponse>;
+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. */
     GetDomains: EmailsConfigurationsService_GetDomains;
@@ -24,6 +26,10 @@ export interface EmailsConfigurationsService {
     DeleteCustomTrackingDomain: EmailsConfigurationsService_DeleteCustomTrackingDomain;
     /** Checks via a live DNS CNAME lookup whether the given custom tracking domain points at api.pushwoosh.com, returning verified true/false without saving anything. Use before update_custom_tracking_domain to confirm the customer published the CNAME. */
     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;
+    /** 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_CName = {
     name: string;
@@ -93,3 +99,58 @@ export type VerifyCustomTrackingDomainRequest = {
 export type VerifyCustomTrackingDomainResponse = {
     verified: boolean;
 };
+export type DiagnoseDomainRequest = {
+    /** Application code (format XXXXX-XXXXX). */
+    application?: string;
+    /** Sender email domain to check. */
+    domain?: string;
+};
+export type DomainDiagnosis = 'DOMAIN_DIAGNOSIS_UNSPECIFIED'
+/** The provider the sender routes through has verified the domain. */
+ | 'DOMAIN_DIAGNOSIS_VERIFIED'
+/** At least one required record is missing or wrong. */
+ | 'DOMAIN_DIAGNOSIS_RECORDS_INCOMPLETE'
+/** Required records are in place; the provider has not re-checked them yet. */
+ | 'DOMAIN_DIAGNOSIS_WAITING_PROVIDER'
+/** Required records are in place but the provider gave up; RestartDomainVerification fixes it. */
+ | 'DOMAIN_DIAGNOSIS_PROVIDER_VERIFICATION_EXPIRED'
+/** The domain does not resolve at all. */
+ | 'DOMAIN_DIAGNOSIS_DOMAIN_NOT_FOUND';
+export type RecordDiagnosis = 'RECORD_DIAGNOSIS_UNSPECIFIED' | 'RECORD_DIAGNOSIS_OK' | 'RECORD_DIAGNOSIS_MISSING'
+/** The record exists but points elsewhere; see found_values. */
+ | 'RECORD_DIAGNOSIS_WRONG_VALUE'
+/** The record was created as <host>.<domain>: the DNS panel appended the domain again. */
+ | 'RECORD_DIAGNOSIS_DOUBLE_SUFFIX'
+/** A TXT record sits where a CNAME is expected. */
+ | 'RECORD_DIAGNOSIS_TXT_INSTEAD_OF_CNAME'
+/** DNS did not answer; the result is unknown, not negative. */
+ | 'RECORD_DIAGNOSIS_RESOLVE_ERROR';
+export type DnsRecordCheck = {
+    /** CNAME or TXT. */
+    type: string;
+    /** Fully qualified record name. */
+    host: string;
+    expectedValue: string;
+    foundValues: string[];
+    diagnosis: RecordDiagnosis;
+    /** Whether the provider the sender routes through needs this record to verify the domain. */
+    required: boolean;
+    /** dkim, spf or dmarc. */
+    purpose: string;
+    /** amazon, smtp or yandex; empty for SPF and DMARC. */
+    provider: string;
+};
+export type DiagnoseDomainResponse = {
+    diagnosis: DomainDiagnosis;
+    records: DnsRecordCheck[];
+    /** First NS host of the domain's zone, to tell which DNS panel the records belong in. */
+    nameServer: string;
+    canRestartVerification: boolean;
+};
+export type RestartDomainVerificationRequest = {
+    /** Application code (format XXXXX-XXXXX). */
+    application?: string;
+    /** Sender email domain to re-verify. */
+    domain?: string;
+};
+export type RestartDomainVerificationResponse = {};

package/package.json

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