feat: Adds contacts.checkExistence endpoint

[matheusbsilva137]

Proposed changes (including videos or screenshots)

• Added a new contacts.checkExistence endpoint, which allows identifying whether there's already a contact registered using a given email, phone, id or visitor to source association.

Issue(s)

Steps to test or reproduce

Example request (cURL):

curl --request GET \
  --url 'http://localhost:3000/api/v1/omnichannel/contacts.checkExistence?email=teste%40example.com' \
  --header 'X-Auth-Token: jVrwkAmobgfne3aEdL-dJh-znNXMkhg79pEAZS2rEIg' \
  --header 'X-User-Id: rMq9ovRmZabXHW4Do' \

Example response: { exists: true, success: true }

This endpoints only fails in case invalid query params (or more than one valid param) are provided. Accepted params are: contactId, email, phone and visitor (which is an object containing a visitorId and a source, same as in the contacts.get endpoint).

The view-livechat-contact permission is required in order to use this endpoint.

Further comments

CORE-888

[dionisio-bot]

Looks like this PR is ready to merge! 🎉
If you have any trouble, please check the PR guidelines

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.81%. Comparing base (82e667f) to head (c7af3ca).
Report is 1 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop   #34194   +/-   ##
========================================
  Coverage    75.81%   75.81%           
========================================
  Files          512      512           
  Lines        22208    22208           
  Branches      5404     5404           
========================================
  Hits         16837    16837           
  Misses        4720     4720           
  Partials       651      651           

Flag	Coverage Δ
unit	75.81% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

[github-actions]

PR Preview Action v1.4.8
🚀 Deployed preview to https://RocketChat.github.io/Rocket.Chat/pr-preview/pr-34194/
on branch gh-pages at 2024-12-19 12:24 UTC

[changeset-bot]

🦋 Changeset detected

Latest commit: c7af3ca

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 35 packages

Name	Type
@rocket.chat/rest-typings	Minor
@rocket.chat/meteor	Minor
@rocket.chat/api-client	Patch
@rocket.chat/core-services	Patch
@rocket.chat/ddp-client	Patch
@rocket.chat/ui-contexts	Major
@rocket.chat/account-service	Patch
@rocket.chat/authorization-service	Patch
@rocket.chat/ddp-streamer	Patch
@rocket.chat/stream-hub-service	Patch
@rocket.chat/omnichannel-services	Patch
@rocket.chat/presence	Patch
rocketchat-services	Patch
@rocket.chat/omnichannel-transcript	Patch
@rocket.chat/presence-service	Patch
@rocket.chat/queue-worker	Patch
@rocket.chat/network-broker	Patch
@rocket.chat/livechat	Patch
@rocket.chat/uikit-playground	Patch
@rocket.chat/fuselage-ui-kit	Major
@rocket.chat/gazzodown	Major
@rocket.chat/ui-avatar	Major
@rocket.chat/ui-client	Major
@rocket.chat/ui-video-conf	Major
@rocket.chat/ui-voip	Major
@rocket.chat/web-ui-registration	Major
@rocket.chat/core-typings	Minor
@rocket.chat/apps	Patch
@rocket.chat/cron	Patch
@rocket.chat/freeswitch	Patch
@rocket.chat/model-typings	Patch
@rocket.chat/license	Patch
@rocket.chat/pdf-worker	Patch
@rocket.chat/models	Patch
@rocket.chat/instance-status	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR