Remove create email api function from backend package #2548
Conversation
🦋 Changeset detectedLatest commit: c167623 The changes in this PR will be included in the next version bump. This PR includes changesets to release 7 packages
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 |
Nikpolik
changed the title
Nikpolik
force-pushed
the
nikpolik/core-1382-drop-v1-create-email
branch
2 times, most recently
from
4f7a76f to
52ed204
Compare
.changeset/curvy-suns-roll.md
Outdated
|
|
||
| Remove createEmail function from @clerk/backend. | ||
|
|
||
| The corresponding endpoint is also being removed from the API. |
There was a problem hiding this comment.
Discussed with @Nikpolik offline and we will not be providing an alternative method for the time being.
Can we please add a note informing any customers currently using this to reach out to our support team if they wish to update to v5?
| The corresponding endpoint is also being removed from the API. | |
| The `emails` endpoint helper and the corresponding `createEmail` method have been removed from the `@clerk/backend` SDK and `apiClint.emails.createEmail` will no longer be available. We will not be providing an alternative method for creating and sending emails directly from our JavaScript SDKs with this release. If you are currently using `createEmail` and you wish to update to the latest SDK version, please reach out to our support team (https://clerk.com/support) so we can assist you. |
There was a problem hiding this comment.
Much better message thanks!
| @@ -88,39 +86,6 @@ export default (QUnit: QUnit) => { | |||
| ); | |||
| }); | |||
|
|
|||
| test('executes a successful backend API request for a resource that contains data (key related to pagination)', async assert => { | |||
There was a problem hiding this comment.
🔧 Instead of removing this test, replace the apiClient.emails.createEmail(body); with another API call. This test is not related to the EmailAPI, it was just used as an example.
There was a problem hiding this comment.
Is it possible this test is no longer needed? 🤔 After looking around only SMSMessage and Emails contain the property readonly data?: Record<string, any> | null that is being checked here.
To be completely honest I am not 100% sure what is being tested here 😓 And whats the differences between this test and the first one that executes a successful backend API request for a single resource and parses the response
There was a problem hiding this comment.
You are correct. This case is no longer applicable. let's drop it.
Nikpolik
force-pushed
the
nikpolik/core-1382-drop-v1-create-email
branch
from
52ed204 to
fd7ff13
Compare
The corresponding api route is also being deprecated.
nikosdouvlis
force-pushed
the
nikpolik/core-1382-drop-v1-create-email
branch
from
fd7ff13 to
c167623
Compare
Description
Remove createEmail function from
@clerk/backend.The equivalent
/emailsBackend API endpoint will also be dropped in the future, since this feature will no longer be available for new instances.For a brief period it will still be accessible for instances that have used it in the past 7
days.
New instances will get a 403 forbidden response if they try to access it.
Checklist
npm testruns as expected.npm run buildruns as expected.Type of change
Packages affected
@clerk/backend@clerk/chrome-extension@clerk/clerk-js@clerk/clerk-expo@clerk/fastifygatsby-plugin-clerk@clerk/localizations@clerk/nextjs@clerk/clerk-react@clerk/remix@clerk/clerk-sdk-node@clerk/shared@clerk/themes@clerk/typesbuild/tooling/chore