@getbrevo/brevo 5.0.3 → 6.0.1

package/dist/esm/api/types/Transaction.d.mts

@@ -2,34 +2,53 @@
  * Represents a transaction involving a balance, including status and timestamps.
  */
 export interface Transaction {
+    /** Unique identifier (UUID) of the transaction. */
+    id?: string | undefined;
     /** The transaction amount. */
     amount?: number | undefined;
+    /** The type of the transaction. */
+    transactionType?: Transaction.TransactionType | undefined;
+    /** Optional metadata associated with the transaction. */
+    meta?: Record<string, unknown> | undefined;
+    /** The current status of the transaction. */
+    status?: Transaction.Status | undefined;
+    /** Unique identifier (UUID) of the associated loyalty program. */
+    loyaltyProgramId?: string | undefined;
     /** Unique identifier (UUID) of the associated balance definition. */
     balanceDefinitionId?: string | undefined;
-    /** Timestamp when the transaction was canceled (nullable). */
-    cancelledAt?: string | undefined;
-    /** Timestamp when the transaction was completed (nullable). */
-    completedAt?: string | undefined;
     /** Unique identifier of the contact associated with the transaction. */
     contactId?: number | undefined;
-    /** Timestamp when the transaction was created. */
-    createdAt?: string | undefined;
-    /** Optional timestamp indicating when the transaction event occurred. */
+    /** Optional timestamp indicating when the transaction event occurred (ISO 8601 format). */
     eventTime?: string | undefined;
-    /** Expiry date of the transaction (nullable). */
-    expirationDate?: string | undefined;
-    /** Unique identifier (UUID) of the transaction. */
-    id?: string | undefined;
-    /** Unique identifier (UUID) of the associated loyalty program. */
-    loyaltyProgramId?: string | undefined;
-    /** Optional metadata associated with the transaction. */
-    meta?: Record<string, unknown> | undefined;
     /** Reason for rejection if the transaction was declined (nullable). */
     rejectReason?: string | undefined;
     /** Timestamp when the transaction was rejected (nullable). */
     rejectedAt?: string | undefined;
-    /** The current status of the transaction (e.g., pending, completed, rejected). */
-    status?: string | undefined;
+    /** Expiry date of the transaction (nullable). */
+    expirationDate?: string | undefined;
+    /** Timestamp when the transaction was completed (nullable). */
+    completedAt?: string | undefined;
+    /** Timestamp when the transaction was canceled (nullable). */
+    cancelledAt?: string | undefined;
+    /** Timestamp when the transaction was created. */
+    createdAt?: string | undefined;
     /** Timestamp when the transaction was last updated. */
     updatedAt?: string | undefined;
 }
+export declare namespace Transaction {
+    /** The type of the transaction. */
+    const TransactionType: {
+        readonly Credit: "credit";
+        readonly Debit: "debit";
+    };
+    type TransactionType = (typeof TransactionType)[keyof typeof TransactionType];
+    /** The current status of the transaction. */
+    const Status: {
+        readonly Pending: "pending";
+        readonly Complete: "complete";
+        readonly Rejected: "rejected";
+        readonly Cancelled: "cancelled";
+        readonly Expired: "expired";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/esm/api/types/Transaction.mjs

@@ -1,2 +1,17 @@
 // This file was auto-generated by Fern from our API Definition.
-export {};
+export var Transaction;
+(function (Transaction) {
+    /** The type of the transaction. */
+    Transaction.TransactionType = {
+        Credit: "credit",
+        Debit: "debit",
+    };
+    /** The current status of the transaction. */
+    Transaction.Status = {
+        Pending: "pending",
+        Complete: "complete",
+        Rejected: "rejected",
+        Cancelled: "cancelled",
+        Expired: "expired",
+    };
+})(Transaction || (Transaction = {}));

package/dist/esm/core/auth/AuthProvider.d.mts

@@ -5,3 +5,4 @@ export interface AuthProvider {
         endpointMetadata?: EndpointMetadata;
     }): Promise<AuthRequest>;
 }
+export declare function isAuthProvider(value: unknown): value is AuthProvider;

package/dist/esm/core/auth/AuthProvider.mjs

@@ -1 +1,6 @@
-export {};
+export function isAuthProvider(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        "getAuthRequest" in value &&
+        typeof value.getAuthRequest === "function");
+}

package/dist/esm/core/auth/BasicAuth.d.mts

@@ -1,6 +1,6 @@
 export interface BasicAuth {
-    username: string;
-    password: string;
+    username?: string;
+    password?: string;
 }
 export declare const BasicAuth: {
     toAuthorizationHeader: (basicAuth: BasicAuth | undefined) => string | undefined;

package/dist/esm/core/auth/BasicAuth.mjs

@@ -2,10 +2,16 @@ import { base64Decode, base64Encode } from "../base64.mjs";
 const BASIC_AUTH_HEADER_PREFIX = /^Basic /i;
 export const BasicAuth = {
     toAuthorizationHeader: (basicAuth) => {
+        var _a, _b;
         if (basicAuth == null) {
             return undefined;
         }
-        const token = base64Encode(`${basicAuth.username}:${basicAuth.password}`);
+        const username = (_a = basicAuth.username) !== null && _a !== void 0 ? _a : "";
+        const password = (_b = basicAuth.password) !== null && _b !== void 0 ? _b : "";
+        if (username === "" && password === "") {
+            return undefined;
+        }
+        const token = base64Encode(`${username}:${password}`);
         return `Basic ${token}`;
     },
     fromAuthorizationHeader: (header) => {

package/dist/esm/core/auth/index.d.mts

@@ -1,4 +1,4 @@
-export type { AuthProvider } from "./AuthProvider.mjs";
+export { type AuthProvider, isAuthProvider } from "./AuthProvider.mjs";
 export type { AuthRequest } from "./AuthRequest.mjs";
 export { BasicAuth } from "./BasicAuth.mjs";
 export { BearerToken } from "./BearerToken.mjs";

package/dist/esm/core/auth/index.mjs

@@ -1,3 +1,4 @@
+export { isAuthProvider } from "./AuthProvider.mjs";
 export { BasicAuth } from "./BasicAuth.mjs";
 export { BearerToken } from "./BearerToken.mjs";
 export { NoOpAuthProvider } from "./NoOpAuthProvider.mjs";

package/dist/esm/core/fetcher/Fetcher.d.mts

@@ -8,7 +8,13 @@ export declare namespace Fetcher {
         method: string;
         contentType?: string;
         headers?: Record<string, unknown>;
+        /**
+         * @deprecated Prefer `queryString` (produced by `core.url.queryBuilder()`).
+         * Retained for backwards compatibility with custom fetchers and callers that
+         * still construct request args with a query-parameter object.
+         */
         queryParameters?: Record<string, unknown>;
+        queryString?: string;
         body?: unknown;
         timeoutMs?: number;
         maxRetries?: number;
@@ -38,10 +44,12 @@ export declare namespace Fetcher {
     }
     interface TimeoutError {
         reason: "timeout";
+        cause?: unknown;
     }
     interface UnknownError {
         reason: "unknown";
         errorMessage: string;
+        cause?: unknown;
     }
 }
 export declare function fetcherImpl<R = unknown>(args: Fetcher.Args): Promise<APIResponse<R, Fetcher.Error>>;

package/dist/esm/core/fetcher/Fetcher.mjs

@@ -71,16 +71,11 @@ const SENSITIVE_QUERY_PARAMS = new Set([
 ]);
 function redactQueryParameters(queryParameters) {
     if (queryParameters == null) {
-        return queryParameters;
+        return undefined;
     }
     const redacted = {};
     for (const [key, value] of Object.entries(queryParameters)) {
-        if (SENSITIVE_QUERY_PARAMS.has(key.toLowerCase())) {
-            redacted[key] = "[REDACTED]";
-        }
-        else {
-            redacted[key] = value;
-        }
+        redacted[key] = SENSITIVE_QUERY_PARAMS.has(key.toLowerCase()) ? "[REDACTED]" : value;
     }
     return redacted;
 }
@@ -182,7 +177,13 @@ function getHeaders(args) {
 export function fetcherImpl(args) {
     return __awaiter(this, void 0, void 0, function* () {
         var _a, _b, _c;
-        const url = createRequestUrl(args.url, args.queryParameters);
+        let url = args.url;
+        if (args.queryString != null && args.queryString.length > 0) {
+            url = `${url}?${args.queryString}`;
+        }
+        else {
+            url = createRequestUrl(args.url, args.queryParameters);
+        }
         const requestBody = yield getRequestBody({
             body: args.body,
             type: (_a = args.requestType) !== null && _a !== void 0 ? _a : "other",
@@ -257,6 +258,7 @@ export function fetcherImpl(args) {
                     error: {
                         reason: "unknown",
                         errorMessage: "The user aborted a request",
+                        cause: error,
                     },
                     rawResponse: abortRawResponse,
                 };
@@ -274,6 +276,7 @@ export function fetcherImpl(args) {
                     ok: false,
                     error: {
                         reason: "timeout",
+                        cause: error,
                     },
                     rawResponse: abortRawResponse,
                 };
@@ -292,6 +295,7 @@ export function fetcherImpl(args) {
                     error: {
                         reason: "unknown",
                         errorMessage: error.message,
+                        cause: error,
                     },
                     rawResponse: unknownRawResponse,
                 };
@@ -309,6 +313,7 @@ export function fetcherImpl(args) {
                 error: {
                     reason: "unknown",
                     errorMessage: toJson(error),
+                    cause: error,
                 },
                 rawResponse: unknownRawResponse,
             };

package/dist/esm/core/fetcher/requestWithRetries.mjs

@@ -11,6 +11,9 @@ const INITIAL_RETRY_DELAY = 1000; // in milliseconds
 const MAX_RETRY_DELAY = 60000; // in milliseconds
 const DEFAULT_MAX_RETRIES = 2;
 const JITTER_FACTOR = 0.2; // 20% random jitter
+function isRetryableStatusCode(statusCode) {
+    return [408, 429].includes(statusCode) || statusCode >= 500;
+}
 function addPositiveJitter(delay) {
     const jitterMultiplier = 1 + Math.random() * JITTER_FACTOR;
     return delay * jitterMultiplier;
@@ -50,7 +53,7 @@ export function requestWithRetries(requestFn_1) {
     return __awaiter(this, arguments, void 0, function* (requestFn, maxRetries = DEFAULT_MAX_RETRIES) {
         let response = yield requestFn();
         for (let i = 0; i < maxRetries; ++i) {
-            if ([408, 429].includes(response.status) || response.status >= 500) {
+            if (isRetryableStatusCode(response.status)) {
                 const delay = getRetryDelayFromHeaders(response, i);
                 yield new Promise((resolve) => setTimeout(resolve, delay));
                 response = yield requestFn();

package/dist/esm/core/file/file.mjs

@@ -48,7 +48,7 @@ function getFileWithMetadata(file_1) {
         }
         if ("path" in file) {
             const fs = yield import("fs");
-            if (!fs || !fs.createReadStream) {
+            if (!(fs === null || fs === void 0 ? void 0 : fs.createReadStream)) {
                 throw new Error("File path uploads are not supported in this environment.");
             }
             const data = fs.createReadStream(file.path);
@@ -89,9 +89,10 @@ function isFileLike(value) {
 }
 function tryGetFileSizeFromPath(path) {
     return __awaiter(this, void 0, void 0, function* () {
+        var _a;
         try {
             const fs = yield import("fs");
-            if (!fs || !fs.promises || !fs.promises.stat) {
+            if (!((_a = fs === null || fs === void 0 ? void 0 : fs.promises) === null || _a === void 0 ? void 0 : _a.stat)) {
                 return undefined;
             }
             const fileStat = yield fs.promises.stat(path);

package/dist/esm/core/url/QueryStringBuilder.d.mts

@@ -0,0 +1,47 @@
+/**
+ * Creates a fluent builder for constructing URL query strings.
+ *
+ * Each `.add()` call serializes its value immediately (like C#'s builder),
+ * so no format tracking is needed — the style is applied at add-time.
+ *
+ * Usage (generated code):
+ *
+ *     const qs = core.url.queryBuilder()
+ *         .add("limit", limit)
+ *         .add("tags", tags, { style: "comma" })   // explode: false
+ *         .mergeAdditional(requestOptions?.queryParams)
+ *         .build();
+ */
+export declare function queryBuilder(): QueryStringBuilder;
+declare class QueryStringBuilder {
+    private parts;
+    /**
+     * Adds a query parameter, serializing it immediately.
+     *
+     * By default arrays use "repeat" format (`key=a&key=b`).
+     * Pass `{ style: "comma" }` for OpenAPI `explode: false` parameters
+     * to get comma-separated values (`key=a,b,c`).
+     *
+     * Null / undefined values are silently skipped.
+     */
+    add(key: string, value: unknown, options?: {
+        style?: "comma";
+    }): this;
+    /**
+     * Adds multiple query parameters at once from a record.
+     * All parameters use the default "repeat" array format.
+     * Null / undefined values are silently skipped.
+     */
+    addMany(params: Record<string, unknown>): this;
+    /**
+     * Merges additional query parameters supplied at call-time via
+     * `requestOptions.queryParams`. Overrides existing keys (last-write-wins).
+     */
+    mergeAdditional(additionalParams?: Record<string, unknown>): this;
+    /**
+     * Returns the assembled query string (without the leading `?`).
+     * Returns an empty string when no parameters were added.
+     */
+    build(): string;
+}
+export {};

package/dist/esm/core/url/QueryStringBuilder.mjs

@@ -0,0 +1,80 @@
+import { toQueryString } from "./qs.mjs";
+/**
+ * Creates a fluent builder for constructing URL query strings.
+ *
+ * Each `.add()` call serializes its value immediately (like C#'s builder),
+ * so no format tracking is needed — the style is applied at add-time.
+ *
+ * Usage (generated code):
+ *
+ *     const qs = core.url.queryBuilder()
+ *         .add("limit", limit)
+ *         .add("tags", tags, { style: "comma" })   // explode: false
+ *         .mergeAdditional(requestOptions?.queryParams)
+ *         .build();
+ */
+export function queryBuilder() {
+    return new QueryStringBuilder();
+}
+class QueryStringBuilder {
+    constructor() {
+        this.parts = new Map();
+    }
+    /**
+     * Adds a query parameter, serializing it immediately.
+     *
+     * By default arrays use "repeat" format (`key=a&key=b`).
+     * Pass `{ style: "comma" }` for OpenAPI `explode: false` parameters
+     * to get comma-separated values (`key=a,b,c`).
+     *
+     * Null / undefined values are silently skipped.
+     */
+    add(key, value, options) {
+        if (value === undefined || value === null) {
+            return this;
+        }
+        const serialized = toQueryString({ [key]: value }, { arrayFormat: (options === null || options === void 0 ? void 0 : options.style) === "comma" ? "comma" : "repeat" });
+        if (serialized.length > 0) {
+            this.parts.set(key, serialized);
+        }
+        return this;
+    }
+    /**
+     * Adds multiple query parameters at once from a record.
+     * All parameters use the default "repeat" array format.
+     * Null / undefined values are silently skipped.
+     */
+    addMany(params) {
+        if (params != null) {
+            for (const [key, value] of Object.entries(params)) {
+                this.add(key, value);
+            }
+        }
+        return this;
+    }
+    /**
+     * Merges additional query parameters supplied at call-time via
+     * `requestOptions.queryParams`. Overrides existing keys (last-write-wins).
+     */
+    mergeAdditional(additionalParams) {
+        if (additionalParams != null) {
+            for (const [key, value] of Object.entries(additionalParams)) {
+                if (value === undefined || value === null) {
+                    continue;
+                }
+                const serialized = toQueryString({ [key]: value }, { arrayFormat: "repeat" });
+                if (serialized.length > 0) {
+                    this.parts.set(key, serialized);
+                }
+            }
+        }
+        return this;
+    }
+    /**
+     * Returns the assembled query string (without the leading `?`).
+     * Returns an empty string when no parameters were added.
+     */
+    build() {
+        return [...this.parts.values()].join("&");
+    }
+}

package/dist/esm/core/url/index.d.mts

@@ -1,3 +1,4 @@
 export { encodePathParam } from "./encodePathParam.mjs";
 export { join } from "./join.mjs";
+export { queryBuilder } from "./QueryStringBuilder.mjs";
 export { toQueryString } from "./qs.mjs";

package/dist/esm/core/url/index.mjs

@@ -1,3 +1,4 @@
 export { encodePathParam } from "./encodePathParam.mjs";
 export { join } from "./join.mjs";
+export { queryBuilder } from "./QueryStringBuilder.mjs";
 export { toQueryString } from "./qs.mjs";

package/dist/esm/core/url/qs.d.mts

@@ -1,5 +1,6 @@
+type ArrayFormat = "indices" | "repeat" | "comma";
 interface QueryStringOptions {
-    arrayFormat?: "indices" | "repeat";
+    arrayFormat?: ArrayFormat;
     encode?: boolean;
 }
 export declare function toQueryString(obj: unknown, options?: QueryStringOptions): string;

package/dist/esm/core/url/qs.mjs

@@ -23,19 +23,31 @@ function stringifyObject(obj, prefix = "", options) {
             if (value.length === 0) {
                 continue;
             }
-            for (let i = 0; i < value.length; i++) {
-                const item = value[i];
-                if (item === undefined) {
-                    continue;
+            const effectiveFormat = options.arrayFormat;
+            if (effectiveFormat === "comma") {
+                const encodedKey = options.encode ? encodeURIComponent(fullKey) : fullKey;
+                const encodedValues = value
+                    .filter((item) => item !== undefined && item !== null)
+                    .map((item) => encodeValue(item, options.encode));
+                if (encodedValues.length > 0) {
+                    parts.push(`${encodedKey}=${encodedValues.join(",")}`);
                 }
-                if (typeof item === "object" && !Array.isArray(item) && item !== null) {
-                    const arrayKey = options.arrayFormat === "indices" ? `${fullKey}[${i}]` : fullKey;
-                    parts.push(...stringifyObject(item, arrayKey, options));
-                }
-                else {
-                    const arrayKey = options.arrayFormat === "indices" ? `${fullKey}[${i}]` : fullKey;
-                    const encodedKey = options.encode ? encodeURIComponent(arrayKey) : arrayKey;
-                    parts.push(`${encodedKey}=${encodeValue(item, options.encode)}`);
+            }
+            else {
+                for (let i = 0; i < value.length; i++) {
+                    const item = value[i];
+                    if (item === undefined) {
+                        continue;
+                    }
+                    if (typeof item === "object" && !Array.isArray(item) && item !== null) {
+                        const arrayKey = effectiveFormat === "indices" ? `${fullKey}[${i}]` : fullKey;
+                        parts.push(...stringifyObject(item, arrayKey, options));
+                    }
+                    else {
+                        const arrayKey = effectiveFormat === "indices" ? `${fullKey}[${i}]` : fullKey;
+                        const encodedKey = options.encode ? encodeURIComponent(arrayKey) : arrayKey;
+                        parts.push(`${encodedKey}=${encodeValue(item, options.encode)}`);
+                    }
                 }
             }
         }

package/dist/esm/errors/BrevoError.d.mts

@@ -3,10 +3,12 @@ export declare class BrevoError extends Error {
     readonly statusCode?: number;
     readonly body?: unknown;
     readonly rawResponse?: core.RawResponse;
-    constructor({ message, statusCode, body, rawResponse, }: {
+    readonly cause?: unknown;
+    constructor({ message, statusCode, body, rawResponse, cause, }: {
         message?: string;
         statusCode?: number;
         body?: unknown;
         rawResponse?: core.RawResponse;
+        cause?: unknown;
     });
 }

package/dist/esm/errors/BrevoError.mjs

@@ -1,7 +1,7 @@
 // This file was auto-generated by Fern from our API Definition.
 import { toJson } from "../core/json.mjs";
 export class BrevoError extends Error {
-    constructor({ message, statusCode, body, rawResponse, }) {
+    constructor({ message, statusCode, body, rawResponse, cause, }) {
         super(buildMessage({ message, statusCode, body }));
         Object.setPrototypeOf(this, new.target.prototype);
         if (Error.captureStackTrace) {
@@ -11,6 +11,9 @@ export class BrevoError extends Error {
         this.statusCode = statusCode;
         this.body = body;
         this.rawResponse = rawResponse;
+        if (cause != null) {
+            this.cause = cause;
+        }
     }
 }
 function buildMessage({ message, statusCode, body, }) {

package/dist/esm/errors/BrevoTimeoutError.d.mts

@@ -1,3 +1,6 @@
 export declare class BrevoTimeoutError extends Error {
-    constructor(message: string);
+    readonly cause?: unknown;
+    constructor(message: string, opts?: {
+        cause?: unknown;
+    });
 }

package/dist/esm/errors/BrevoTimeoutError.mjs

@@ -1,11 +1,14 @@
 // This file was auto-generated by Fern from our API Definition.
 export class BrevoTimeoutError extends Error {
-    constructor(message) {
+    constructor(message, opts) {
         super(message);
         Object.setPrototypeOf(this, new.target.prototype);
         if (Error.captureStackTrace) {
             Error.captureStackTrace(this, this.constructor);
         }
         this.name = this.constructor.name;
+        if ((opts === null || opts === void 0 ? void 0 : opts.cause) != null) {
+            this.cause = opts.cause;
+        }
     }
 }

package/dist/esm/errors/handleNonStatusCodeError.mjs

@@ -14,11 +14,14 @@ export function handleNonStatusCodeError(error, rawResponse, method, path) {
                 rawResponse: rawResponse,
             });
         case "timeout":
-            throw new errors.BrevoTimeoutError(`Timeout exceeded when calling ${method} ${path}.`);
+            throw new errors.BrevoTimeoutError(`Timeout exceeded when calling ${method} ${path}.`, {
+                cause: error.cause,
+            });
         case "unknown":
             throw new errors.BrevoError({
                 message: error.errorMessage,
                 rawResponse: rawResponse,
+                cause: error.cause,
             });
         default:
             throw new errors.BrevoError({

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "5.0.3";
+export declare const SDK_VERSION = "6.0.1";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "5.0.3";
+export const SDK_VERSION = "6.0.1";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@getbrevo/brevo",
-    "version": "5.0.3",
+    "version": "6.0.1",
     "private": false,
     "repository": {
         "type": "git",
@@ -398,13 +398,13 @@
     },
     "dependencies": {},
     "devDependencies": {
-        "webpack": "^5.97.1",
-        "ts-loader": "^9.5.1",
-        "vitest": "^3.2.4",
+        "webpack": "^5.105.4",
+        "ts-loader": "^9.5.4",
+        "vitest": "^4.1.1",
         "msw": "2.11.2",
-        "@types/node": "^18.19.70",
-        "typescript": "~5.7.2",
-        "@biomejs/biome": "2.4.3"
+        "@types/node": "^20.0.0",
+        "typescript": "~5.9.3",
+        "@biomejs/biome": "2.4.10"
     },
     "browser": {
         "fs": false,
@@ -413,7 +413,7 @@
         "stream": false,
         "crypto": false
     },
-    "packageManager": "pnpm@10.20.0",
+    "packageManager": "pnpm@10.33.0",
     "engines": {
         "node": ">=18.0.0"
     },