Add support for SearchResult objects. #1251
Merged
+573
−0
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? @pakrym-stripe
cc @richardm-stripe
Summary
Adds support for
search_result
objects returned by the Stripe API, including adding a templatedSearchResult
class and aSearch
trait which can be added to resources to support invoking search APIs.This behaves similarly to
Collection
in that they both wrap around a list of objects and provide pagination. However theSearchResult
object paginates by relying on anext_page
token included in the response rather than using object IDs +starting_before
/ending_after
. Thus, only forward pagination is supportedThis was revived from #1134 with the following API changes:
page
is used in the requestnext_page
is always returned, just null when there's no more page.Test 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.php
andlib/Util/ObjectTypes.php
should be updated to include these new classes going forward.