Update SearchResult documentation.

stripe · Jul 20, 2021 · 63ce687 · 63ce687
1 parent b0a0fe7
commit 63ce687
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/lib/SearchResult.php b/lib/SearchResult.php
@@ -3,7 +3,14 @@
 namespace Stripe;
 
 /**
- * Class search results.
+ * Search results for an API resource.
+ *
+ * This behaves similarly to <code>Collection</code> in that they both wrap
+ * around a list of objects and provide pagination. However the
+ * <code>SearchResult</code> object paginates by relying on a
+ * <code>next_page</code> token included in the response rather than using
+ * object IDs and a <code>starting_before</code>/<code>ending_after</code>
+ * parameter. Thus, <code>SearchResult</code> only supports forwards pagination.
  *
  * @property string $object
  * @property string $url