Class VibesClient

constructor

• new VibesClient(): VibesClient

  Returns VibesClient

Staticinstance

sendSmsMessage

• sendSmsMessage(
      __namedParameters: {
          destination: string;
          message: string;
          submitterMessageId: string;
      },
  ): Promise<
      | {
          ok: true;
          value: {
              mtMessageRsp: {
                  carrier: string;
                  messageId: string;
                  submitterMessageId: string;
              };
          };
      }
      | { error: ServiceError; ok: false },
  >

  VIBES_ERROR when Vibes refuses the message with a 4xx; any other failure throws a plain Error with the details in cause.

  Parameters

  • __namedParameters: { destination: string; message: string; submitterMessageId: string }

  Returns Promise<
      | {
          ok: true;
          value: {
              mtMessageRsp: {
                  carrier: string;
                  messageId: string;
                  submitterMessageId: string;
              };
          };
      }
      | { error: ServiceError; ok: false },
  >