@pushwoosh/rpc-v2-http-api-data 0.1.990 → 0.1.992

package/data.js

@@ -6280,6 +6280,512 @@ export const data = {
             }
         }
     },
+    "pushwoosh.rpc_v2.deliverability_checker.DeliverabilityCheckerService": {
+        "type": "S",
+        "key": "deliverabilityChecker",
+        "methods": {
+            "CheckDeliverability": {
+                "request": "pushwoosh.rpc_v2.deliverability_checker.CheckDeliverabilityRequest",
+                "response": "pushwoosh.rpc_v2.deliverability_checker.DeliverabilityReport",
+                "method": "post",
+                "path": "/api/deliverability_checker:check"
+            },
+            "CreateSandboxCheck": {
+                "request": "pushwoosh.rpc_v2.deliverability_checker.CreateSandboxCheckRequest",
+                "response": "pushwoosh.rpc_v2.deliverability_checker.CreateSandboxCheckResponse",
+                "method": "post",
+                "path": "/api/deliverability_checker:sandbox"
+            },
+            "GetSandboxResult": {
+                "request": "pushwoosh.rpc_v2.deliverability_checker.GetSandboxResultRequest",
+                "response": "pushwoosh.rpc_v2.deliverability_checker.GetSandboxResultResponse",
+                "method": "get",
+                "path": "/api/deliverability_checker:sandbox/{message_code}"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.CheckDeliverabilityRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "presetCode": {
+                "type": "string"
+            },
+            "testDeviceHwid": {
+                "type": "string"
+            },
+            "overrides": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.EmailOverrides"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.CreateSandboxCheckRequest": {
+        "type": "I",
+        "fields": {
+            "applicationCode": {
+                "type": "string"
+            },
+            "presetCode": {
+                "type": "string"
+            },
+            "testDeviceHwid": {
+                "type": "string"
+            },
+            "overrides": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.EmailOverrides"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.EmailOverrides": {
+        "type": "I",
+        "fields": {
+            "from": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.EmailAddress"
+            },
+            "replyTo": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.EmailAddress"
+            },
+            "subjects": {
+                "type": "string",
+                "mapKeyType": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.EmailAddress": {
+        "type": "I",
+        "fields": {
+            "name": {
+                "type": "string"
+            },
+            "email": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.CreateSandboxCheckResponse": {
+        "type": "I",
+        "fields": {
+            "messageCode": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.GetSandboxResultRequest": {
+        "type": "I",
+        "fields": {
+            "messageCode": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.GetSandboxResultResponse": {
+        "type": "I",
+        "fields": {
+            "state": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.SandboxState"
+            },
+            "recipient": {
+                "type": "string"
+            },
+            "delivery": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.DeliveryResult"
+            },
+            "report": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.DeliverabilityReport"
+            },
+            "errorMessage": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.SandboxState": {
+        "type": "E",
+        "values": [
+            "SANDBOX_STATE_UNSPECIFIED",
+            "SANDBOX_PENDING",
+            "SANDBOX_DONE",
+            "SANDBOX_FAILED",
+            "SANDBOX_NOT_FOUND"
+        ]
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.DeliveryResult": {
+        "type": "I",
+        "fields": {
+            "delivered": {
+                "type": "boolean"
+            },
+            "smtpStatus": {
+                "type": "number"
+            },
+            "smtpMessage": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.DeliverabilityReport": {
+        "type": "I",
+        "fields": {
+            "groups": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.CheckGroup",
+                "array": true
+            },
+            "summary": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.Summary"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.Summary": {
+        "type": "I",
+        "fields": {
+            "level": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.Level"
+            },
+            "errors": {
+                "type": "number"
+            },
+            "warnings": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.CheckGroup": {
+        "type": "I",
+        "fields": {
+            "groupId": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.GroupId"
+            },
+            "level": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.Level"
+            },
+            "checks": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.Check",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.GroupId": {
+        "type": "E",
+        "values": [
+            "GROUP_ID_UNSPECIFIED",
+            "GROUP_ID_COMPLIANCE",
+            "GROUP_ID_CONTENT",
+            "GROUP_ID_INBOX"
+        ]
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.Check": {
+        "type": "I",
+        "fields": {
+            "ruleId": {
+                "type": "string"
+            },
+            "level": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.Level"
+            },
+            "status": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.CheckStatus"
+            },
+            "message": {
+                "type": "string"
+            },
+            "preliminary": {
+                "type": "boolean"
+            },
+            "size": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.SizeDetails"
+            },
+            "listUnsubscribe": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.ListUnsubscribeDetails"
+            },
+            "unsubscribeUrlHealth": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.UnsubscribeUrlHealthDetails"
+            },
+            "visibleUnsubscribeLink": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.VisibleUnsubLinkDetails"
+            },
+            "physicalAddress": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.PhysicalAddressDetails"
+            },
+            "brokenLinks": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.BrokenLinksDetails"
+            },
+            "safeBrowsing": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.SafeBrowsingDetails"
+            },
+            "trackerConsistency": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.TrackerConsistencyDetails"
+            },
+            "spamScore": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.SpamScoreDetails"
+            },
+            "deliveryResponse": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.DeliveryResponseDetails"
+            },
+            "dkimSignature": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.DkimSignatureDetails"
+            },
+            "sendingIpAndPool": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.SendingIpPoolDetails"
+            }
+        },
+        "oneofs": {
+            "details": {
+                "oneof": [
+                    "size",
+                    "listUnsubscribe",
+                    "unsubscribeUrlHealth",
+                    "visibleUnsubscribeLink",
+                    "physicalAddress",
+                    "brokenLinks",
+                    "safeBrowsing",
+                    "trackerConsistency",
+                    "spamScore",
+                    "deliveryResponse",
+                    "dkimSignature",
+                    "sendingIpAndPool"
+                ]
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.SizeDetails": {
+        "type": "I",
+        "fields": {
+            "actualBytes": {
+                "type": "number"
+            },
+            "limitWarning": {
+                "type": "number"
+            },
+            "limitError": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.ListUnsubscribeDetails": {
+        "type": "I",
+        "fields": {
+            "missingHeader": {
+                "type": "boolean"
+            },
+            "missingHttps": {
+                "type": "boolean"
+            },
+            "missingPostOneClick": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.UnsubscribeUrlHealthDetails": {
+        "type": "I",
+        "fields": {
+            "url": {
+                "type": "string"
+            },
+            "statusCode": {
+                "type": "number"
+            },
+            "timeout": {
+                "type": "boolean"
+            },
+            "reason": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.VisibleUnsubLinkDetails": {
+        "type": "I",
+        "fields": {
+            "found": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.PhysicalAddressDetails": {
+        "type": "I",
+        "fields": {
+            "found": {
+                "type": "boolean"
+            },
+            "matchedPattern": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.BrokenLinksDetails": {
+        "type": "I",
+        "fields": {
+            "items": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.BrokenLinkItem",
+                "array": true
+            },
+            "timeouts": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.BrokenLinkItem": {
+        "type": "I",
+        "fields": {
+            "url": {
+                "type": "string"
+            },
+            "reason": {
+                "type": "string"
+            },
+            "statusCode": {
+                "type": "number"
+            },
+            "redirects": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.SafeBrowsingDetails": {
+        "type": "I",
+        "fields": {
+            "items": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.SafeBrowsingItem",
+                "array": true
+            },
+            "malwareCheckStatus": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.SafeBrowsingItem": {
+        "type": "I",
+        "fields": {
+            "url": {
+                "type": "string"
+            },
+            "category": {
+                "type": "string"
+            },
+            "source": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.TrackerConsistencyDetails": {
+        "type": "I",
+        "fields": {
+            "unwrappedCount": {
+                "type": "number"
+            },
+            "totalCount": {
+                "type": "number"
+            },
+            "unwrappedUrls": {
+                "type": "string",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.SpamScoreDetails": {
+        "type": "I",
+        "fields": {
+            "score": {
+                "type": "number"
+            },
+            "action": {
+                "type": "string"
+            },
+            "breakdown": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.SpamScoreSymbol",
+                "array": true
+            },
+            "disclaimer": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.SpamScoreSymbol": {
+        "type": "I",
+        "fields": {
+            "rule": {
+                "type": "string"
+            },
+            "weight": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.DeliveryResponseDetails": {
+        "type": "I",
+        "fields": {
+            "attempts": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.DeliveryAttempt",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.DeliveryAttempt": {
+        "type": "I",
+        "fields": {
+            "recipientDomain": {
+                "type": "string"
+            },
+            "smtpStatus": {
+                "type": "number"
+            },
+            "smtpMessage": {
+                "type": "string"
+            },
+            "level": {
+                "type": "pushwoosh.rpc_v2.deliverability_checker.Level"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.DkimSignatureDetails": {
+        "type": "I",
+        "fields": {
+            "valid": {
+                "type": "boolean"
+            },
+            "domain": {
+                "type": "string"
+            },
+            "selector": {
+                "type": "string"
+            },
+            "algorithm": {
+                "type": "string"
+            },
+            "reason": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.SendingIpPoolDetails": {
+        "type": "I",
+        "fields": {
+            "ip": {
+                "type": "string"
+            },
+            "poolName": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.Level": {
+        "type": "E",
+        "values": [
+            "UNSPECIFIED",
+            "INFO",
+            "WARNING",
+            "ERROR"
+        ]
+    },
+    "pushwoosh.rpc_v2.deliverability_checker.CheckStatus": {
+        "type": "E",
+        "values": [
+            "CHECK_STATUS_UNSPECIFIED",
+            "CHECK_STATUS_OK",
+            "CHECK_STATUS_UNAVAILABLE",
+            "CHECK_STATUS_TIMEOUT"
+        ]
+    },
     "pushwoosh.rpc_v2.devices.DevicesService": {
         "type": "S",
         "key": "devices",

package/deliverability_checker.d.ts

@@ -0,0 +1,202 @@
+import { RpcMethod } from './commonTypes';
+export type DeliverabilityCheckerService_CheckDeliverability = RpcMethod<CheckDeliverabilityRequest, DeliverabilityReport>;
+export type DeliverabilityCheckerService_CreateSandboxCheck = RpcMethod<CreateSandboxCheckRequest, CreateSandboxCheckResponse>;
+export type DeliverabilityCheckerService_GetSandboxResult = RpcMethod<GetSandboxResultRequest, GetSandboxResultResponse>;
+export interface DeliverabilityCheckerService {
+    CheckDeliverability: DeliverabilityCheckerService_CheckDeliverability;
+    CreateSandboxCheck: DeliverabilityCheckerService_CreateSandboxCheck;
+    GetSandboxResult: DeliverabilityCheckerService_GetSandboxResult;
+}
+export type CheckDeliverabilityRequest = {
+    applicationCode?: string;
+    presetCode?: string;
+    testDeviceHwid?: string;
+    overrides?: EmailOverrides;
+};
+export type CreateSandboxCheckRequest = {
+    applicationCode?: string;
+    presetCode?: string;
+    testDeviceHwid?: string;
+    overrides?: EmailOverrides;
+};
+export type EmailOverrides = {
+    from: EmailAddress;
+    replyTo: EmailAddress;
+    subjects: Record<string, string>;
+};
+export type EmailAddress = {
+    name: string;
+    email: string;
+};
+export type CreateSandboxCheckResponse = {
+    messageCode: string;
+};
+export type GetSandboxResultRequest = {
+    messageCode?: string;
+};
+export type GetSandboxResultResponse = {
+    state: SandboxState;
+    recipient: string;
+    /** Populated when state == SANDBOX_DONE. */
+    delivery: DeliveryResult;
+    report: DeliverabilityReport;
+    /** Populated when state == SANDBOX_FAILED. */
+    errorMessage: string;
+};
+export type SandboxState = 'SANDBOX_STATE_UNSPECIFIED' | 'SANDBOX_PENDING' | 'SANDBOX_DONE' | 'SANDBOX_FAILED' | 'SANDBOX_NOT_FOUND';
+export type DeliveryResult = {
+    delivered: boolean;
+    smtpStatus: number;
+    smtpMessage: string;
+};
+export type DeliverabilityReport = {
+    groups: CheckGroup[];
+    summary: Summary;
+};
+export type Summary = {
+    level: Level;
+    errors: number;
+    warnings: number;
+};
+export type CheckGroup = {
+    groupId: GroupId;
+    level: Level;
+    checks: Check[];
+};
+export type GroupId = 'GROUP_ID_UNSPECIFIED' | 'GROUP_ID_COMPLIANCE' | 'GROUP_ID_CONTENT' | 'GROUP_ID_INBOX';
+export type Check_details_size = {
+    type: 'size';
+    data: SizeDetails;
+};
+export type Check_details_listUnsubscribe = {
+    type: 'listUnsubscribe';
+    data: ListUnsubscribeDetails;
+};
+export type Check_details_unsubscribeUrlHealth = {
+    type: 'unsubscribeUrlHealth';
+    data: UnsubscribeUrlHealthDetails;
+};
+export type Check_details_visibleUnsubscribeLink = {
+    type: 'visibleUnsubscribeLink';
+    data: VisibleUnsubLinkDetails;
+};
+export type Check_details_physicalAddress = {
+    type: 'physicalAddress';
+    data: PhysicalAddressDetails;
+};
+export type Check_details_brokenLinks = {
+    type: 'brokenLinks';
+    data: BrokenLinksDetails;
+};
+export type Check_details_safeBrowsing = {
+    type: 'safeBrowsing';
+    data: SafeBrowsingDetails;
+};
+export type Check_details_trackerConsistency = {
+    type: 'trackerConsistency';
+    data: TrackerConsistencyDetails;
+};
+export type Check_details_spamScore = {
+    type: 'spamScore';
+    data: SpamScoreDetails;
+};
+export type Check_details_deliveryResponse = {
+    type: 'deliveryResponse';
+    data: DeliveryResponseDetails;
+};
+export type Check_details_dkimSignature = {
+    type: 'dkimSignature';
+    data: DkimSignatureDetails;
+};
+export type Check_details_sendingIpAndPool = {
+    type: 'sendingIpAndPool';
+    data: SendingIpPoolDetails;
+};
+export type Check_details = Check_details_size | Check_details_listUnsubscribe | Check_details_unsubscribeUrlHealth | Check_details_visibleUnsubscribeLink | Check_details_physicalAddress | Check_details_brokenLinks | Check_details_safeBrowsing | Check_details_trackerConsistency | Check_details_spamScore | Check_details_deliveryResponse | Check_details_dkimSignature | Check_details_sendingIpAndPool;
+export type Check = {
+    ruleId: string;
+    level: Level;
+    status: CheckStatus;
+    message: string;
+    preliminary: boolean;
+    details: Check_details;
+};
+export type SizeDetails = {
+    actualBytes: number;
+    limitWarning: number;
+    limitError: number;
+};
+export type ListUnsubscribeDetails = {
+    missingHeader: boolean;
+    missingHttps: boolean;
+    missingPostOneClick: boolean;
+};
+export type UnsubscribeUrlHealthDetails = {
+    url: string;
+    statusCode: number;
+    timeout: boolean;
+    reason: string;
+};
+export type VisibleUnsubLinkDetails = {
+    found: boolean;
+};
+export type PhysicalAddressDetails = {
+    found: boolean;
+    matchedPattern: string;
+};
+export type BrokenLinksDetails = {
+    items: BrokenLinkItem[];
+    timeouts: number;
+};
+export type BrokenLinkItem = {
+    url: string;
+    reason: string;
+    statusCode: number;
+    redirects: number;
+};
+export type SafeBrowsingDetails = {
+    items: SafeBrowsingItem[];
+    malwareCheckStatus: string;
+};
+export type SafeBrowsingItem = {
+    url: string;
+    category: string;
+    source: string;
+};
+export type TrackerConsistencyDetails = {
+    unwrappedCount: number;
+    totalCount: number;
+    unwrappedUrls: string[];
+};
+export type SpamScoreDetails = {
+    score: number;
+    action: string;
+    breakdown: SpamScoreSymbol[];
+    disclaimer: string;
+};
+export type SpamScoreSymbol = {
+    rule: string;
+    weight: number;
+};
+export type DeliveryResponseDetails = {
+    attempts: DeliveryAttempt[];
+};
+export type DeliveryAttempt = {
+    recipientDomain: string;
+    smtpStatus: number;
+    smtpMessage: string;
+    level: Level;
+};
+export type DkimSignatureDetails = {
+    valid: boolean;
+    domain: string;
+    selector: string;
+    algorithm: string;
+    reason: string;
+};
+export type SendingIpPoolDetails = {
+    ip: string;
+    poolName: string;
+};
+export type Level = 'UNSPECIFIED' | 'INFO' | 'WARNING' | 'ERROR';
+export type CheckStatus = 'CHECK_STATUS_UNSPECIFIED' | 'CHECK_STATUS_OK' | 'CHECK_STATUS_UNAVAILABLE' | 'CHECK_STATUS_TIMEOUT';

package/deliverability_checker.js

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

package/index.d.ts

@@ -20,6 +20,7 @@ import { MessagingService as pushwoosh_channels_messagingApi_v2_MessagingService
 import { CloudPagesService as pushwoosh_rpc_v2_cloud_pages_CloudPagesService } from './cloud_pages';
 import { CustomerJourneyService as pushwoosh_rpc_v2_customer_journey_CustomerJourneyService } from './customer_journey';
 import { DeeplinksService as pushwoosh_rpc_v2_deeplinks_DeeplinksService } from './deeplinks';
+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 { EmailTemplatesService as pushwoosh_rpc_v2_accounts_EmailTemplatesService } from './accounts';
@@ -84,6 +85,7 @@ export type API = {
     cloudPages: pushwoosh_rpc_v2_cloud_pages_CloudPagesService;
     customerJourney: pushwoosh_rpc_v2_customer_journey_CustomerJourneyService;
     deeplinks: pushwoosh_rpc_v2_deeplinks_DeeplinksService;
+    deliverabilityChecker: pushwoosh_rpc_v2_deliverability_checker_DeliverabilityCheckerService;
     devices: pushwoosh_rpc_v2_devices_DevicesService;
     emailCategories: pushwoosh_rpc_v2_email_categories_EmailCategoriesService;
     emailTemplates: pushwoosh_rpc_v2_accounts_EmailTemplatesService;

package/package.json

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