fix: query reminders filter key and add channel to the reminder response#1575
Merged
fix: query reminders filter key and add channel to the reminder response#1575
Conversation
Contributor
|
Size Change: -18 B (0%) Total Size: 433 kB
|
There was a problem hiding this comment.
Pull Request Overview
This PR corrects the request payload key for querying reminders, enriches the reminder response with channel data, and expands the remind_at filter to include existence checks.
- Renamed
filter_conditionstofilterin thequeryReminderscall - Added a
channelproperty to theReminderResponsetype - Included the
$existsoperator forremind_atfilters
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/types.ts | Added channel to ReminderResponse and included $exists in remind_at filters |
| src/client.ts | Changed filter_conditions to filter in the POST body of queryReminders |
Comments suppressed due to low confidence (4)
src/client.ts:4576
- Update the method's JSDoc or inline comment to reference the renamed
filterparameter instead of the removedfilter_conditionsfor consistency.
async queryReminders({ filter, sort, ...rest }: QueryRemindersOptions = {}) {
src/types.ts:4058
- [nitpick] Consider adding a JSDoc comment for the new
channelproperty to clarify its role and structure withinReminderResponse.
channel: ChannelResponse;
src/types.ts:4096
- Add or update unit/integration tests to cover the
$existsfilter onremind_atso scheduled reminders are correctly filtered.
'$exists' | '$eq' | '$gt' | '$lt' | '$gte' | '$lte'
src/client.ts:4577
- The
return awaitis redundant here. You can return the promise directly:return this.post<...>(...)to avoid an extra microtask.
return await this.post<QueryRemindersResponse>(`${this.baseURL}/reminders/query`, {
xsahil03x
reviewed
Jul 2, 2025
xsahil03x
approved these changes
Jul 3, 2025
MartinCupela
approved these changes
Jul 7, 2025
|
🎉 This PR is included in version 9.10.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The following are fixed/added on this PR:
We had the filter key as
filter_conditions, which was not working, and I noticed it when working on the reminders listing page.channelresponse to the reminder response, which was needed.$existsfilter key for theremind_atas the BE supports it, and we have to use it to show only "Scheduled" reminders.