@cfxlabsinc/b2b-services
    Preparing search index...

    Class EmailNotificationSender

    Sends email notifications.

    The SendGrid template id is supplied per send (by the calling <Domain>NotificationService, from its own env key) rather than held as a map — so a process only needs the template ids for the notifications it actually sends.

    Note: For backward-incompatible changes and to minimise disruptions, introduce a new version of the template in Sendgrid.

    Index

    Constructors

    constructor

    Methods

    send

    Constructors

    Methods

    • Send an email notification

      Parameters

      • __namedParameters: {
            notification:
                | {
                    customerName: string;
                    depositUrl: string;
                    id: string;
                    name: string;
                    status: | "PENDING_VERIFICATION"
                    | "ACTIVE"
                    | "REVIEW"
                    | "DISABLED"
                    | "BLOCKED"
                    | "DELETED";
                    supportUrl: string;
                    template: "IDENTITY";
                    url: string;
                }
                | {
                    customerName: string;
                    depositUrl: string;
                    id: string;
                    name: string;
                    status: "PENDING_VERIFICATION"
                    | "ACTIVE"
                    | "DISABLED";
                    supportUrl: string;
                    template: "ORGANIZATION";
                    url: string;
                }
                | {
                    customerName: string;
                    id: string;
                    name: string;
                    supportUrl: string;
                    template: "LEDGER_ACCOUNT";
                    url: string;
                }
                | {
                    customerName: string;
                    id: string;
                    name: string;
                    paymentUrl: string;
                    status: "PENDING_VERIFICATION"
                    | "ACTIVE"
                    | "BLOCKED";
                    supportUrl: string;
                    template: "PAYMENT_INSTRUMENT";
                    type: "SWIFT_WIRE" | "US_ACH" | "US_WIRE" | "WALLET";
                    url: string;
                }
                | {
                    account: string;
                    accountUrl: string;
                    amount: string;
                    customerName: string;
                    date?: string;
                    entityName: string;
                    id: string;
                    imad?: string;
                    memo?: string;
                    omad?: string;
                    reference?: string;
                    senderName?: string;
                    status: "PENDING"
                    | "DEPOSITED"
                    | "CANCELLED";
                    supportUrl: string;
                    template: "DEPOSIT";
                    type: "SWIFT_WIRE" | "US_WIRE" | "DIRECT" | "US_BANK_ACH";
                    url: string;
                }
                | {
                    account: string;
                    accountUrl: string;
                    amount: string;
                    customerName: string;
                    entityName: string;
                    id: string;
                    imad?: string;
                    omad?: string;
                    paymentInstrumentName: string;
                    status: "PENDING"
                    | "COMPLETED"
                    | "RETURNED";
                    supportUrl: string;
                    template: "WITHDRAW";
                    type: "SWIFT_WIRE" | "US_ACH" | "US_WIRE" | "BLOCKCHAIN";
                    url: string;
                }
                | {
                    amount: string;
                    customerName: string;
                    id: string;
                    senderMessage?: string;
                    sourceAccount: string;
                    sourceAccountUrl: string;
                    sourceCustomerName: string;
                    status: "PENDING"
                    | "CANCELLED"
                    | "SUCCEEDED";
                    supportUrl: string;
                    targetAccount: string;
                    targetAccountUrl: string;
                    targetCustomerName: string;
                    template: "TRANSFER";
                    type: "INTERNAL" | "NETWORK_SENDER" | "NETWORK_RECEIVER";
                    url: string;
                }
                | {
                    amount: string;
                    card: string;
                    id: string;
                    merchantName: string;
                    reason?: string;
                    status: "PENDING"
                    | "COMPLETED"
                    | "DECLINED"
                    | "AUTHORIZED";
                    supportUrl: string;
                    template: "CARD_TRANSACTION";
                    type: "AUTHORIZATION" | "REVERSAL";
                    url: string;
                };
            recipients: { email: string; name?: string }[];
            templateId: string;
        }
        • notification:
              | {
                  customerName: string;
                  depositUrl: string;
                  id: string;
                  name: string;
                  status: | "PENDING_VERIFICATION"
                  | "ACTIVE"
                  | "REVIEW"
                  | "DISABLED"
                  | "BLOCKED"
                  | "DELETED";
                  supportUrl: string;
                  template: "IDENTITY";
                  url: string;
              }
              | {
                  customerName: string;
                  depositUrl: string;
                  id: string;
                  name: string;
                  status: "PENDING_VERIFICATION"
                  | "ACTIVE"
                  | "DISABLED";
                  supportUrl: string;
                  template: "ORGANIZATION";
                  url: string;
              }
              | {
                  customerName: string;
                  id: string;
                  name: string;
                  supportUrl: string;
                  template: "LEDGER_ACCOUNT";
                  url: string;
              }
              | {
                  customerName: string;
                  id: string;
                  name: string;
                  paymentUrl: string;
                  status: "PENDING_VERIFICATION"
                  | "ACTIVE"
                  | "BLOCKED";
                  supportUrl: string;
                  template: "PAYMENT_INSTRUMENT";
                  type: "SWIFT_WIRE" | "US_ACH" | "US_WIRE" | "WALLET";
                  url: string;
              }
              | {
                  account: string;
                  accountUrl: string;
                  amount: string;
                  customerName: string;
                  date?: string;
                  entityName: string;
                  id: string;
                  imad?: string;
                  memo?: string;
                  omad?: string;
                  reference?: string;
                  senderName?: string;
                  status: "PENDING"
                  | "DEPOSITED"
                  | "CANCELLED";
                  supportUrl: string;
                  template: "DEPOSIT";
                  type: "SWIFT_WIRE" | "US_WIRE" | "DIRECT" | "US_BANK_ACH";
                  url: string;
              }
              | {
                  account: string;
                  accountUrl: string;
                  amount: string;
                  customerName: string;
                  entityName: string;
                  id: string;
                  imad?: string;
                  omad?: string;
                  paymentInstrumentName: string;
                  status: "PENDING"
                  | "COMPLETED"
                  | "RETURNED";
                  supportUrl: string;
                  template: "WITHDRAW";
                  type: "SWIFT_WIRE" | "US_ACH" | "US_WIRE" | "BLOCKCHAIN";
                  url: string;
              }
              | {
                  amount: string;
                  customerName: string;
                  id: string;
                  senderMessage?: string;
                  sourceAccount: string;
                  sourceAccountUrl: string;
                  sourceCustomerName: string;
                  status: "PENDING"
                  | "CANCELLED"
                  | "SUCCEEDED";
                  supportUrl: string;
                  targetAccount: string;
                  targetAccountUrl: string;
                  targetCustomerName: string;
                  template: "TRANSFER";
                  type: "INTERNAL" | "NETWORK_SENDER" | "NETWORK_RECEIVER";
                  url: string;
              }
              | {
                  amount: string;
                  card: string;
                  id: string;
                  merchantName: string;
                  reason?: string;
                  status: "PENDING"
                  | "COMPLETED"
                  | "DECLINED"
                  | "AUTHORIZED";
                  supportUrl: string;
                  template: "CARD_TRANSACTION";
                  type: "AUTHORIZATION" | "REVERSAL";
                  url: string;
              }

          Sendgrid template and merge variables

        • recipients: { email: string; name?: string }[]
        • templateId: string

          SendGrid template id, supplied by the calling notification service.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods