Skip to content

Fix Email Logs API multi-value filters query string to use brackets notation #118

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
mklocek merged 1 commit into from
Mar 17, 2026
Merged

Fix Email Logs API multi-value filters query string to use brackets notation #118

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions src/__tests__/lib/api/resources/EmailLogs.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,8 +137,8 @@ describe("lib/api/resources/EmailLogs: ", () => {
const baseUrl = `${GENERAL_ENDPOINT}/api/accounts/${accountId}/email_logs`;
const expectedQuery =
"filters[category][operator]=equal" +
"&filters[category][value]=Welcome%20Email" +
"&filters[category][value]=Forget%20Password";
"&filters[category][value][]=Welcome%20Email" +
"&filters[category][value][]=Forget%20Password";
const expectedUrl = `${baseUrl}?${expectedQuery}`;

expect.assertions(2);
Expand Down
4 changes: 2 additions & 2 deletions src/lib/api/resources/EmailLogs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const { GENERAL_ENDPOINT } = CLIENT_SETTINGS;
/**
* Serialize query params for email logs list. Uses qs for deepObject-style
* bracket notation (e.g. filters[sent_after]=..., filters[to][operator]=...)
* with repeated keys for array values.
* with bracket notation for arrays (Rails-style, e.g. filters[category][value][]=foo).
*/
function serializeEmailLogsParams(params: EmailLogsListParams): string {
const query: Record<string, unknown> = {};
Expand All @@ -25,7 +25,7 @@ function serializeEmailLogsParams(params: EmailLogsListParams): string {
query.filters = params.filters;
}
return qs.stringify(query, {
arrayFormat: "repeat",
arrayFormat: "brackets",
encode: true,
encodeValuesOnly: true,
});
Expand Down
Loading