Skip to content

docs(readme): fix Error Handling import to use Brevo namespace #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mourraille merged 1 commit into from
Sep 3, 2026
+12 −10
Merged

docs(readme): fix Error Handling import to use Brevo namespace #98

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,14 @@ const brevo = new BrevoClient({
The SDK throws specific error types based on HTTP status codes.

```typescript
import { BrevoError, UnauthorizedError, TooManyRequestsError } from '@getbrevo/brevo';
import { Brevo, BrevoError } from '@getbrevo/brevo';

try {
await brevo.transactionalEmails.sendTransacEmail({...});
} catch (err) {
if (err instanceof UnauthorizedError) {
if (err instanceof Brevo.UnauthorizedError) {
console.error('Invalid API key');
} else if (err instanceof TooManyRequestsError) {
} else if (err instanceof Brevo.TooManyRequestsError) {
const retryAfter = err.rawResponse.headers['retry-after'];
console.error(`Rate limited. Retry after ${retryAfter} seconds`);
} else if (err instanceof BrevoError) {
Expand All @@ -83,14 +83,16 @@ try {
}
```

Typed subclasses are namespaced under `Brevo` (e.g. `Brevo.UnauthorizedError`) — only `BrevoError` and `BrevoTimeoutError` are top-level exports.

**Error Types:**
- `400` - `BadRequestError`
- `401` - `UnauthorizedError`
- `403` - `ForbiddenError`
- `404` - `NotFoundError`
- `422` - `UnprocessableEntityError`
- `429` - `TooManyRequestsError`
- `500+` - `InternalServerError`
- `400` - `Brevo.BadRequestError`
- `401` - `Brevo.UnauthorizedError`
- `403` - `Brevo.ForbiddenError`
- `404` - `Brevo.NotFoundError`
- `422` - `Brevo.UnprocessableEntityError`
- `429` - `Brevo.TooManyRequestsError`
- `500+` - `Brevo.InternalServerError`

<details>
<summary>Error properties</summary>
Expand Down
Loading