Remove endpoint aliases #315
Merged
Conversation
This file contains 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
These endpoint aliases were deprecated in #234. The first version to include this deprecation is 3.6.0, released on 10 February 2022. In the era of TypeScript, I feel the confusion caused by having two (or sometimes three) separate functions in the type definition outweighs the backwards compatibility. Consumers of an API expect every part of it to be significant.
Pimm
force-pushed
the
pimm/spring-cleaning
branch
from
2892ddf
to
f718c94
Compare
Pimm
added a commit
that referenced
this pull request
Jul 9, 2024
We removed aliases for endpoints here: #315. This commit re-introduces the aliases, this time unenumerable and non-existent in the TypeScript types.
Pimm
added a commit
that referenced
this pull request
Jul 9, 2024
We removed aliases for endpoints here: #315. This commit re-introduces the aliases, this time unenumerable and non-existent in the TypeScript types.
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.
These endpoint aliases (such as
client.payments.deleteforclient.payments.cancel) were deprecated in #234. The first version to include this deprecation is 3.6.0, released on 10 February 2022.This PR removes the aliases.
Rationale:
deleteinstead ofcancel". We now live in the era of TypeScript, we no longer rely on memory; we rely on code completion. When one relies on code completion, aliases introduce confusion: "deletesounds like what I need, but so doescancel… what's the difference between the two? When should I use which? Why am I usingdeletewhile this snippet on StackOverflow usescancel?"allaliases have always been deceptive. Instead of returning all objects in an array, they were aliases forpageand thus returned the first page in an array.pageorlist, you can see whether the result will be paginated or not.The change is breaking. The next release will be 4.0.0.