Add metadata_pair to both messages and drafts

[kraju3]

License

I confirm that this contribution is made under the terms of the MIT license and that I have the authority necessary to make this contribution on behalf of its copyright owner.

[AaronDDM]

Hey can we get a changelog added, and tests if necessary?

Thanks!

[playerzero-ai]

Pull Request Summary

• Messages Functionality:

  • Introduced metadata_pair support in ListMessagesQueryParams and FindMessageQueryParams.
  • This enhancement allows users to search and filter messages using metadata key/value pairs.
  • Documentation has been updated to guide developers on utilizing this new feature.

• Drafts Functionality:

  • Added an optional metadata_pair field to ListDraftsQueryParams.
  • This addition enables filtering of draft messages based on custom metadata, improving search and retrieval capabilities for drafts.

• Overall Impact:

  • These changes enhance the search and filtering capabilities for both messages and drafts by allowing the use of metadata key/value pairs.
  • Improves developer experience by providing clear documentation on the new functionality.

Functional Tests

• Verify that drafts can be filtered using the new 'metadata_pair' field and that the correct drafts are returned based on the specified metadata key/value pair.
• Ensure that messages can be searched and filtered using the 'metadata_pair' query parameter, and validate that the results match the expected metadata key/value criteria.
• Test the system's behavior when 'metadata_pair' is not provided, ensuring that the default search and retrieval functionality for drafts and messages remains unaffected.
• Check that the UI correctly reflects the use of 'metadata_pair' in search queries for both drafts and messages, and that it provides appropriate feedback or results to the user.

Files Changed

File Name	Summary
nylas/models/messages.py	- Added metadata_pair support in ListMessagesQueryParams and FindMessageQueryParams for metadata-based message search. - Updated docs with metadata_pair usage details.
nylas/models/drafts.py	- Added optional metadata_pair field to ListDraftsQueryParams for filtering drafts by metadata key/value.

View more in PlayerZero
updated: Jul 19 @ 12:06 AM UTC