List API changes #322
Merged
List API changes #322
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
* The List interface to Page * networkClient.list to networkClient.page * networkClient.listPlain to networkClient.list
…ions.list from Page (previously List) to plain arrays.
|
LGTM, only note I have is that I would make this part of a major version upgrade since it will break TS builds. |
edorivai
approved these changes
Jun 19, 2023
Yes! I changed the description of the PR accordingly. |
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.
Plain array return types
Changed the return type of
methods.list,orderShipments.list, andpermissions.listto (plain) arrays.Previously, the object returned by those methods had optional properties, including
nextPage:As the underlying endpoints are not paginated,
nextPagewas alwaysundefinedanyway. Removing thenextPageproperty communicates this better.Iterator return types
Changed the return type of several helper functions to iterators, including
customer.getPayments.This forces users to handle the scenario in which the items do not fit on a single page, e.g. one customer has more than 250 payments. See #291.
Renames
Renamed types and methods to solidify the distinction between (exhaustive) lists and pages. This does not affect the public-facing API (unless you count the exported TypeScript types).
Some changes are breaking. The next release will be 4.0.0.