Add support for SearchResult.

[dcr-stripe]

Notify

r? @richardm-stripe

Summary

Adds support for search methods and search_result objects returned by the Stripe API. This requires updating auto pagination to support this. These paginate similarly to lists, however they rely on a next_page token included in the response rather than using object IDs + starting_before/ending_after. Thus, only forward pagination is supported

Test plan

Added unit tests. We'll want to add some more rigorous tests once a resource is using this.

[richardm-stripe]

fullPath is guaranteed not to have url params?

[dcr-stripe]

Fixed! If we're moving everything to full paths, definitely doesn't make sense to exclude these.

[richardm-stripe]

This looks good, but I wonder - would the code be simpler if we removed all relative paths and used fullPath everywhere? I don't think there is any virtue to relative paths.

[richardm-stripe]

supernit: this code would feel slightly better to me if the spec.methodType check was done once, top-level in makeAutoPaginationMethods, rather than each time within iterate.

Either something like

let getNextPagePromise;
if (spec.methodType === 'search') {
  getNextPagePromise = ...
} else {
  getNextPagePromise = ...
}
function iterate(pageResult) {
  ...
  return getPagePromise(...).then(iterate)
}

or

let iterate;
if (spec.methodType === 'search') {
  iterate = function (pageResult) {
    ...
  };
} else {
  iterate = ...
}

(the second would likely require factoring out a couple helper methods to keep it DRY)

[dcr-stripe]

Done - good call!

[richardm-stripe]

Nothing strictly blocking, though I'm curious what you think about fullPath everywhere

[dcr-stripe]

Thanks for the comments!

For full paths, I'll lay down the ground work in this PR and then in a follow up can update the other methods to use it as it depends on basic methods.

r? @richardm-stripe

[dcr-stripe]

Removing reviews for a second. I think it'd be good to split our the fullPath logic of this PR into its own PR.

[dcr-stripe]

I split out https://github.com/stripe/stripe-node/pull/1200/files for full path support. This should be good to go now.

r? @richardm-stripe

[richardm-stripe]

I am merging this. Despite the fact that this functionality is part of a private beta, this will not affect the public interface of the library and can be safely removed/changed.