Why?

This PR address issues like #2168 where users want to manually paginate instead of auto-paginate after a List call using stripe.Client. Although there are possible workarounds with the current design, they are quite hacky (e.g. requesting an additional item from the API to determine if HasMore is true).

After much internal debate, we decided the best path forward to support both the manual and automatic pagination use cases is to introduce a breaking change where List returns a struct instead of a func. You can access the underlying data on the struct with Data() and Meta() methods, or call .All(ctx) to get back to the auto-pagination behavior. This is in line with how our other language SDKs handle List.

So, automated pagination will look like this:

for c, err := range sc.V1Customers.List(ctx, nil).All(ctx) {
	// handle err
	// do something
}

and manual pagination will look like:

list := sc.V1Customers.List(ctx, nil)
if list.Err() {
	// handle err
}
doSomething(list.Data(), list.Meta())

What?

• ⚠️ List and Search methods using stripe.Client now return a struct instead of Seq2.
• All of the logical changes are in iter.go and search_iter.go, where the new types and methods are introduced, and internal pagination logic depends on page() instead of next().
• Exports the type v1List --> V1List with a v1Page struct that represents the response from the API.
• Deprecates the NewV2List function and Fetch type which were really meant to be used only internally, and not exported.

Changelog

• ⚠️ List and Search methods using stripe.Client now return a struct instead of Seq2. This is a backwards incompatible change, and you will need to add an additional call to .All(ctx) in your for loop. E.g.

-for c, err := range sc.V1Customers.List(ctx, nil) {
+for c, err := range sc.V1Customers.List(ctx, nil).All(ctx) {
	// handle err
	// do something
}

For manual pagination use cases, you can access the API call's error by calling list.Err(), a page's data using list.Data(), and its metadata by calling list.Meta().