More consistent type definitions #1107
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
This was referenced Mar 10, 2021
Closed
Closed
Closed
Closed
Closed
This was referenced Mar 14, 2021
chore(deps): bump stripe from 6.36.0 to 8.138.0 in /api-server
Technology-Community/freeCodeCamp#145
Closed
Closed
Closed
Closed
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.
r? @stripe/api-library-reviewers
A change in our codegen infra revealed a few inconsistencies/bugs in the Typescript definitions. This PR resolves those.
CustomerSourceis now qualified asStripe.CustomerSourceinsideCustomers.d.ts, which is more consistent with similar references. This is a no-op.Extra method definitions have been removed from
Refund.d.ts. This is a bug fix. The cause of this was that the openapi spec defines methods for both/v1/refunds/{refund}and/v1/charges/{charge}/refunds/{refund}. However, the actual Javascript code inrefunds.jsonly supports making requests to the/v1/refunds/{refund}routes, so I have removed the extra type definitions because they are incorrect and do not describe valid uses of the library.The type definition of
stripe.customers.updateSourcewithout theparamsfield has been removed. It doesn't make sense to call an "update" method without specifying params (although the API will accept it), and this is more consistent with what we do with other "update" methods. This is also more consistent with how we handle the multiple dispatch forupdateSourcein Java, which doesn't provide a paramsless signature.