Class CustomerNotificationService

constructor

• new CustomerNotificationService(
      args: {
          customerNotificationPreferencesService: CustomerNotificationPreferencesService;
          db: B2bDatabase;
      },
  ): CustomerNotificationService

  Parameters

  • args: {
        customerNotificationPreferencesService: CustomerNotificationPreferencesService;
        db: B2bDatabase;
    }

  Returns CustomerNotificationService

Staticinstance

getApplicationRecipients

• getApplicationRecipients(
      __namedParameters: { workspaceId: string },
  ): Promise<{ email: string; name?: string }[]>

  Who to email about a self-serve application: every ACTIVE member of its workspace, CFX staff's internal roles aside. The workspace may have no customer yet, and no preference covers these emails.

  Parameters

  • __namedParameters: { workspaceId: string }

  Returns Promise<{ email: string; name?: string }[]>

getBillingRecipients

• getBillingRecipients(
      customerId: string,
  ): Promise<{ email: string; name?: string }[]>

  A customer's invoice and receipt recipients: the workspace's ACTIVE Owner and Admin members, then its billing addresses, deduped case-insensitively. Not gated by notification preferences: nobody opts out of a bill.

  Parameters

  • customerId: string

  Returns Promise<{ email: string; name?: string }[]>

getRecipients

• getRecipients(
      event: NotifiableEvent,
      objectId: string,
  ): Promise<{ email: string; name?: string }[]>

  Resolve recipients for a notification event, in two statements whatever the roster's size.

  Parameters

  • event: NotifiableEvent
  • objectId: string

    the notification's id: the deposit / withdrawal / transfer / instrument / identity id its "*.created" activity recorded

  Returns Promise<{ email: string; name?: string }[]>

  name + email of everyone who should receive this notification

getSmsRecipients

• getSmsRecipients(
      event: NotifiableEvent,
  ): Promise<{ recipients: SmsRecipient[]; withoutPhone: number }>

  Resolve who to text for a notification event: the customer's ACTIVE members matching the SMS userIds / userGroups, at their profile phone, in one roster statement. No creator rule and no member-level preferences.

  Parameters

  • event: NotifiableEvent

  Returns Promise<{ recipients: SmsRecipient[]; withoutPhone: number }>

  one recipient per phone, and how many nominated members have none