Class CustomerNotificationPreferencesService

constructor

• new CustomerNotificationPreferencesService(
      __namedParameters: {
          db: B2bDatabase;
          internalEventPublisher: InternalEventPublisher | null;
      },
  ): CustomerNotificationPreferencesService

  Parameters

  • __namedParameters: { db: B2bDatabase; internalEventPublisher: InternalEventPublisher | null }

    • db: B2bDatabase

    • internalEventPublisher: InternalEventPublisher | null

      Publishes the preference events; null for readers (notification handlers, bots, tests).

  Returns CustomerNotificationPreferencesService

Staticinstance

get

• get(
      __namedParameters: { customerId: string },
  ): Promise<
      {
          ok: true;
          value: | Required<
              Pick<
                  {
                      email?: {
                          emailAddresses: string[];
                          events: NotificationEventToggles;
                          userGroups: string[];
                          userIds: string[];
                      };
                      internalEmailUserIds?: string[];
                      slack?: NotificationEventToggles;
                      sms?: {
                          events: NotificationEventToggles;
                          userGroups: string[];
                          userIds: string[];
                      };
                  },
                  "email"
                  | "slack"
                  | "sms",
              >,
          >
          | null;
      },
  >

  Parameters

  • __namedParameters: { customerId: string }

  Returns Promise<
      {
          ok: true;
          value: | Required<
              Pick<
                  {
                      email?: {
                          emailAddresses: string[];
                          events: NotificationEventToggles;
                          userGroups: string[];
                          userIds: string[];
                      };
                      internalEmailUserIds?: string[];
                      slack?: NotificationEventToggles;
                      sms?: {
                          events: NotificationEventToggles;
                          userGroups: string[];
                          userIds: string[];
                      };
                  },
                  "email"
                  | "slack"
                  | "sms",
              >,
          >
          | null;
      },
  >

  Persisted customer notification preferences, or the defaults if not set. null if the customer does not exist.

getInternalEmailSubscribers

• getInternalEmailSubscribers(
      __namedParameters: { customerId: string },
  ): Promise<{ ok: true; value: InternalEmailUserIds | null }>

  Parameters

  • __namedParameters: { customerId: string }

  Returns Promise<{ ok: true; value: InternalEmailUserIds | null }>

  The CFX staff emailed alongside the customer's recipients, hidden from the customer. null if the customer does not exist.

setInternalEmailSubscription

• setInternalEmailSubscription(
      __namedParameters: {
          customerId: string;
          subscribed: boolean;
          userId: string;
      },
  ): Promise<
      | { error: ServiceError; ok: false }
      | { ok: true; value: InternalEmailUserIds },
  >

  Add or remove one hidden recipient in a single statement, so concurrent toggles and customer saves never overwrite each other. Idempotent.

  Parameters

  • __namedParameters: { customerId: string; subscribed: boolean; userId: string }

  Returns Promise<
      | { error: ServiceError; ok: false }
      | { ok: true; value: InternalEmailUserIds },
  >

  The hidden recipients after the change

shouldSendEmail

• shouldSendEmail(
      __namedParameters: { customerId: string; event: NotificationEvent },
  ): Promise<
      | { error: ServiceError; ok: false }
      | {
          ok: true;
          value: Omit<
              {
                  emailAddresses: string[];
                  events: NotificationEventToggles;
                  userGroups: string[];
                  userIds: string[];
              },
              "events",
          > & { internalUserIds: InternalEmailUserIds };
      },
  >

  Parameters

  • __namedParameters: { customerId: string; event: NotificationEvent }

  Returns Promise<
      | { error: ServiceError; ok: false }
      | {
          ok: true;
          value: Omit<
              {
                  emailAddresses: string[];
                  events: NotificationEventToggles;
                  userGroups: string[];
                  userIds: string[];
              },
              "events",
          > & { internalUserIds: InternalEmailUserIds };
      },
  >

  Who will receive the email notification. Empty arrays means no one. internalUserIds are CFX staff admin users, gated on user-shadow:r by the caller.

shouldSendSlack

• shouldSendSlack(
      __namedParameters: { customerId: string; event: NotificationEvent },
  ): Promise<
      | { error: ServiceError; ok: false }
      | { ok: true; value: { outcome: boolean } },
  >

  Parameters

  • __namedParameters: { customerId: string; event: NotificationEvent }

  Returns Promise<
      | { error: ServiceError; ok: false }
      | { ok: true; value: { outcome: boolean } },
  >

  Whether to send a Slack notification or not.

shouldSendSms

• shouldSendSms(
      __namedParameters: { customerId: string; event: NotificationEvent },
  ): Promise<{ error: ServiceError; ok: false } | { ok: true; value: T }>

  Parameters

  • __namedParameters: { customerId: string; event: NotificationEvent }

  Returns Promise<{ error: ServiceError; ok: false } | { ok: true; value: T }>

  Who will receive the SMS notification. Empty arrays means no one.

upsert

• upsert(
      __namedParameters: Partial<
          Required<
              Pick<
                  {
                      email?: {
                          emailAddresses: string[];
                          events: NotificationEventToggles;
                          userGroups: string[];
                          userIds: string[];
                      };
                      internalEmailUserIds?: string[];
                      slack?: NotificationEventToggles;
                      sms?: {
                          events: NotificationEventToggles;
                          userGroups: string[];
                          userIds: string[];
                      };
                  },
                  "email"
                  | "slack"
                  | "sms",
              >,
          >,
      > & { customerId: string },
  ): Promise<{ ok: true; value: T } | { error: ServiceError; ok: false }>

  Create or update the customer notification preferences

  The top-level fields are replaced completely if present, i.e. if email preferences are supplied, it overrides the persisted values but leaves slack preferences as-is. The internal recipients are another top-level key, so no upsert touches them.

  Parameters

  • __namedParameters: Partial<
        Required<
            Pick<
                {
                    email?: {
                        emailAddresses: string[];
                        events: NotificationEventToggles;
                        userGroups: string[];
                        userIds: string[];
                    };
                    internalEmailUserIds?: string[];
                    slack?: NotificationEventToggles;
                    sms?: {
                        events: NotificationEventToggles;
                        userGroups: string[];
                        userIds: string[];
                    };
                },
                "email"
                | "slack"
                | "sms",
            >,
        >,
    > & { customerId: string }

  Returns Promise<{ ok: true; value: T } | { error: ServiceError; ok: false }>