@api-emulator/sendblue
v0.2.2
Published
Sendblue provides APIs for iMessage, RCS, SMS, contacts, phone lines, and webhooks.
Readme
@api-emulator/sendblue
Sendblue provides APIs for iMessage, RCS, SMS, contacts, phone lines, and webhooks.
Use this emulator for local tests, CI, and offline agent runs. It keeps your tests separate from the production API.
Start the emulator
- Install the package.
npm install @api-emulator/sendblue- From this registry, start the emulator.
npx -p api-emulator api --plugin ./providers/@sendblue/api-emulator.mjs --service sendblueThe emulator uses the local URL that api-emulator prints. Set your client base URL to this local URL.
Supported API
POST /api/send-messageGET /api/v2/messagesGET /api/v2/messages/:messageIdGET /api/statusGET /api/evaluate-serviceGET /api/v2/contacts/countGET /api/v2/contactsPOST /api/v2/contactsGET /api/v2/contacts/:phonePUT /api/v2/contacts/:phoneDELETE /api/v2/contacts/:phonePOST /api/v2/contacts/opt-outGET /api/linesGET /api/account/webhooksPOST /api/account/webhooksPUT /api/account/webhooksDELETE /api/account/webhooks
Coverage
- Level:
smoke-only - Meaning: A smoke test starts the emulator and checks its main behavior.
- Evidence: a direct smoke test exists, but a conformance manifest does not exist.
Credentials
Use a fixed bearer token or API key in each test. The emulator does not send these credentials to the provider.
Test data
Add repeatable test data to the provider configuration.
sendblue:
# Add provider-specific seed state here.