Add support for SearchResult objects #1134
Closed
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
dcr-stripe
force-pushed
the
dcr-php-search-impl
branch
4 times, most recently
from
72a1fb1 to
e9e9492
Compare
|
Reviewed via One suggestion: would you be willing to copy your Github PR "summary" into the docstring for |
Thanks @richardm-stripe - great idea! Done. PTAL? |
richardm-stripe
changed the title
|
(I think we can merge this at any time, by the way) |
richardm-stripe
approved these changes
Jul 9, 2021
|
@richardm-stripe We shouldn't merge since it's a private beta and could change at any time. |
dcr-stripe
force-pushed
the
dcr-php-search-impl
branch
from
a19e3fa to
8a1842e
Compare
dcr-stripe
changed the title
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.
Notify
r? @richardm-stripe
Summary
Adds support for
search_resultobjects returned by the Stripe API, including adding aSearchResultclass and aSearchtrait which can be added to resources to support invoking search APIs.This behaves similarly to
Collectionin that they both wrap around a list of objects and provide pagination. However theSearchResultobject paginates by relying on anext_pagetoken included in the response rather than using object IDs +starting_before/ending_after. Thus, only forward pagination is supportedTest plan
Added unit tests. We'll want to add some more rigorous tests once stripe-mock has been updated to include at least one API that returns this resource.
Post-merge
The generation for
init.phpandlib/Util/ObjectTypes.phpshould be updated to include these new classes going forward.