Class CustomerSmsNotificationSender

constructor

• new CustomerSmsNotificationSender(
      args: {
          logger?: Pick<Console, "info">;
          smsTemplateService: Pick<SmsTemplateService, "get" | "getVersion">;
          twilioClient: TwilioClient;
          vibesClient: VibesClient;
      },
  ): CustomerSmsNotificationSender

  Parameters

  • args: {
        logger?: Pick<Console, "info">;
        smsTemplateService: Pick<SmsTemplateService, "get" | "getVersion">;
        twilioClient: TwilioClient;
        vibesClient: VibesClient;
    }

  Returns CustomerSmsNotificationSender

Staticinstance

send

• send(
      __namedParameters: {
          idempotencyKey: string;
          notification: SmsNotification;
          recipients: { phoneNumber: string }[];
      },
  ): Promise<void>

  Send an SMS notification to each recipient, unless its template is switched off.

  Routing: US numbers → Vibes; non-US / unparseable → Twilio. Recipients are sent sequentially; a provider error propagates immediately. A stored body the validator rejects throws rather than sending.

  Parameters

  • __namedParameters: {
        idempotencyKey: string;
        notification: SmsNotification;
        recipients: { phoneNumber: string }[];
    }

    • idempotencyKey: string

      Stable per-send id; passed to Vibes as submitterMessageId.

    • notification: SmsNotification

    • recipients: { phoneNumber: string }[]

      E.164 phone numbers.

  Returns Promise<void>

sendTest

• sendTest(
      __namedParameters: {
          idempotencyKey: string;
          notification: SmsNotification;
          recipients: { phoneNumber: string }[];
          versionId: string;
      },
  ): Promise<
      | { ok: true; value: void }
      | {
          error:
              | ServiceError<"SMS_TEMPLATE_VERSION_NOT_FOUND">
              | ServiceError<"SMS_TEMPLATE_VERSION_KEY_MISMATCH">
              | ServiceError<
                  "SMS_TEMPLATE_INVALID",
                  {
                      issues: Readonly<
                          {
                              code: SmsTemplateIssueCode;
                              message: string;
                              offset?: number;
                              value?: string;
                          },
                      >[];
                  },
              >;
          ok: false;
      },
  >

  The admin test send: one saved version of notification.template, named by its smstv_… id, validated, rendered for notification and sent with a [TEST] prefix. Sends even when the template is DISABLED, so a switched-off text can be tried before it is switched back on.

  Parameters

  • __namedParameters: {
        idempotencyKey: string;
        notification: SmsNotification;
        recipients: { phoneNumber: string }[];
        versionId: string;
    }

    • idempotencyKey: string

    • notification: SmsNotification

    • recipients: { phoneNumber: string }[]

    • versionId: string

      smstv_…

  Returns Promise<
      | { ok: true; value: void }
      | {
          error:
              | ServiceError<"SMS_TEMPLATE_VERSION_NOT_FOUND">
              | ServiceError<"SMS_TEMPLATE_VERSION_KEY_MISMATCH">
              | ServiceError<
                  "SMS_TEMPLATE_INVALID",
                  {
                      issues: Readonly<
                          {
                              code: SmsTemplateIssueCode;
                              message: string;
                              offset?: number;
                              value?: string;
                          },
                      >[];
                  },
              >;
          ok: false;
      },
  >