stripe 5.39.0 → 10.1.0

data/lib/stripe/resources/product.rb

@@ -2,12 +2,29 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Products describe the specific goods or services you offer to your customers.
+  # For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.
+  # They can be used in conjunction with [Prices](https://stripe.com/docs/api#prices) to configure pricing in Payment Links, Checkout, and Subscriptions.
+  #
+  # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription),
+  # [share a Payment Link](https://stripe.com/docs/payment-links),
+  # [accept payments with Checkout](https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront),
+  # and more about [Products and Prices](https://stripe.com/docs/products-prices/overview)
   class Product < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "product"
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/products/search", params, opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
   end
 end

data/lib/stripe/resources/promotion_code.rb

@@ -2,6 +2,8 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/api#coupons). It can be used to
+  # create multiple codes for a single coupon.
   class PromotionCode < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/quote.rb

@@ -2,6 +2,8 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A Quote is a way to model prices that you'd like to provide to a customer.
+  # Once accepted, it will automatically create an invoice, subscription or subscription schedule.
   class Quote < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
@@ -9,16 +11,10 @@ module Stripe
 
     OBJECT_NAME = "quote"
 
-    custom_method :accept, http_verb: :post
-    custom_method :cancel, http_verb: :post
-    custom_method :finalize_quote, http_verb: :post, http_path: "finalize"
-    custom_method :list_computed_upfront_line_items, http_verb: :get, http_path: "computed_upfront_line_items"
-    custom_method :list_line_items, http_verb: :get, http_path: "line_items"
-
     def accept(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/accept",
+        path: format("/v1/quotes/%<quote>s/accept", { quote: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -27,7 +23,7 @@ module Stripe
     def cancel(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/cancel",
+        path: format("/v1/quotes/%<quote>s/cancel", { quote: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -36,7 +32,7 @@ module Stripe
     def finalize_quote(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/finalize",
+        path: format("/v1/quotes/%<quote>s/finalize", { quote: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -45,7 +41,7 @@ module Stripe
     def list_computed_upfront_line_items(params = {}, opts = {})
       request_stripe_object(
         method: :get,
-        path: resource_url + "/computed_upfront_line_items",
+        path: format("/v1/quotes/%<quote>s/computed_upfront_line_items", { quote: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -54,52 +50,79 @@ module Stripe
     def list_line_items(params = {}, opts = {})
       request_stripe_object(
         method: :get,
-        path: resource_url + "/line_items",
+        path: format("/v1/quotes/%<quote>s/line_items", { quote: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
     end
 
     def pdf(params = {}, opts = {}, &read_body_chunk_block)
-      unless block_given?
-        raise ArgumentError, "A read_body_chunk_block block parameter is required when calling the pdf method."
-      end
-
       config = opts[:client]&.config || Stripe.config
-
+      opts = { api_base: config.uploads_base }.merge(opts)
       request_stream(
         method: :get,
-        path: resource_url + "/pdf",
+        path: format("/v1/quotes/%<quote>s/pdf", { quote: CGI.escape(self["id"]) }),
         params: params,
-        opts: {
-          api_base: config.uploads_base,
-        }.merge(opts),
+        opts: opts,
         &read_body_chunk_block
       )
     end
 
-    def self.pdf(id, params = {}, opts = {}, &read_body_chunk_block)
-      unless id.is_a?(String)
-        raise ArgumentError,
-              "id should be a string representing the ID of an API resource"
-      end
+    def self.accept(quote, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/accept", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts
+      )
+    end
 
-      unless block_given?
-        raise ArgumentError, "A read_body_chunk_block block parameter is required when calling the pdf method."
-      end
+    def self.cancel(quote, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/cancel", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts
+      )
+    end
 
-      config = opts[:client]&.config || Stripe.config
+    def self.finalize_quote(quote, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/finalize", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.list_computed_upfront_line_items(quote, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/computed_upfront_line_items", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts
+      )
+    end
 
-      resp = execute_resource_request_stream(
+    def self.list_line_items(quote, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/line_items", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.pdf(quote, params = {}, opts = {}, &read_body_chunk_block)
+      config = opts[:client]&.config || Stripe.config
+      opts = { api_base: config.uploads_base }.merge(opts)
+      execute_resource_request_stream(
         :get,
-        "#{resource_url}/#{CGI.escape(id)}/pdf",
+        format("/v1/quotes/%<quote>s/pdf", { quote: CGI.escape(quote) }),
         params,
-        {
-          api_base: config.uploads_base,
-        }.merge(opts),
+        opts,
         &read_body_chunk_block
       )
-      resp
     end
   end
 end

data/lib/stripe/resources/radar/early_fraud_warning.rb

@@ -3,6 +3,10 @@
 
 module Stripe
   module Radar
+    # An early fraud warning indicates that the card issuer has notified us that a
+    # charge may be fraudulent.
+    #
+    # Related guide: [Early fraud warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings)
     class EarlyFraudWarning < APIResource
       extend Stripe::APIOperations::List
 

data/lib/stripe/resources/radar/value_list.rb

@@ -3,6 +3,9 @@
 
 module Stripe
   module Radar
+    # Value lists allow you to group values together which can then be referenced in rules.
+    #
+    # Related guide: [Default Stripe lists](https://stripe.com/docs/radar/lists#managing-list-items)
     class ValueList < APIResource
       extend Stripe::APIOperations::Create
       include Stripe::APIOperations::Delete

data/lib/stripe/resources/radar/value_list_item.rb

@@ -3,6 +3,9 @@
 
 module Stripe
   module Radar
+    # Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.
+    #
+    # Related guide: [Managing list items](https://stripe.com/docs/radar/lists#managing-list-items)
     class ValueListItem < APIResource
       extend Stripe::APIOperations::Create
       include Stripe::APIOperations::Delete

data/lib/stripe/resources/refund.rb

@@ -2,11 +2,60 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Refund objects allow you to refund a previously created charge that isn't
+  # refunded yet. Funds are refunded to the credit or debit card that's
+  # initially charged.
+  #
+  # Related guide: [Refunds](https://stripe.com/docs/refunds)
   class Refund < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "refund"
+
+    def cancel(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/refunds/%<refund>s/cancel", { refund: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.cancel(refund, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/refunds/%<refund>s/cancel", { refund: CGI.escape(refund) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def test_helpers
+      TestHelpers.new(self)
+    end
+
+    class TestHelpers < APIResourceTestHelpers
+      RESOURCE_CLASS = Refund
+
+      def self.expire(refund, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/test_helpers/refunds/%<refund>s/expire", { refund: CGI.escape(refund) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def expire(params = {}, opts = {})
+        @resource.request_stripe_object(
+          method: :post,
+          path: format("/v1/test_helpers/refunds/%<refund>s/expire", { refund: CGI.escape(@resource["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+    end
   end
 end

data/lib/stripe/resources/reporting/report_run.rb

@@ -3,6 +3,14 @@
 
 module Stripe
   module Reporting
+    # The Report Run object represents an instance of a report type generated with
+    # specific run parameters. Once the object is created, Stripe begins processing the report.
+    # When the report has finished running, it will give you a reference to a file
+    # where you can retrieve your results. For an overview, see
+    # [API Access to Reports](https://stripe.com/docs/reporting/statements/api).
+    #
+    # Note that certain report types can only be run based on your live-mode data (not test-mode
+    # data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).
     class ReportRun < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List

data/lib/stripe/resources/reporting/report_type.rb

@@ -3,8 +3,15 @@
 
 module Stripe
   module Reporting
+    # The Report Type resource corresponds to a particular type of report, such as
+    # the "Activity summary" or "Itemized payouts" reports. These objects are
+    # identified by an ID belonging to a set of enumerated values. See
+    # [API Access to Reports documentation](https://stripe.com/docs/reporting/statements/api)
+    # for those Report Type IDs, along with required and optional parameters.
+    #
+    # Note that certain report types can only be run based on your live-mode data (not test-mode
+    # data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).
     class ReportType < APIResource
-      extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List
 
       OBJECT_NAME = "reporting.report_type"

data/lib/stripe/resources/reversal.rb

@@ -2,6 +2,19 @@
 # frozen_string_literal: true
 
 module Stripe
+  # [Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a
+  # connected account, either entirely or partially, and can also specify whether
+  # to refund any related application fees. Transfer reversals add to the
+  # platform's balance and subtract from the destination account's balance.
+  #
+  # Reversing a transfer that was made for a [destination
+  # charge](https://stripe.com/docs/connect/destination-charges) is allowed only up to the amount of
+  # the charge. It is possible to reverse a
+  # [transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options)
+  # transfer only if the destination account has enough balance to cover the
+  # reversal.
+  #
+  # Related guide: [Reversing transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reversing-transfers)
   class Reversal < APIResource
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save

data/lib/stripe/resources/review.rb

@@ -2,17 +2,28 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Reviews can be used to supplement automated fraud detection with human expertise.
+  #
+  # Learn more about [Radar](https://stripe.com/radar) and reviewing payments
+  # [here](https://stripe.com/docs/radar/reviews).
   class Review < APIResource
     extend Stripe::APIOperations::List
 
     OBJECT_NAME = "review"
 
-    custom_method :approve, http_verb: :post
-
     def approve(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/approve",
+        path: format("/v1/reviews/%<review>s/approve", { review: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.approve(review, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/reviews/%<review>s/approve", { review: CGI.escape(review) }),
         params: params,
         opts: opts
       )

data/lib/stripe/resources/setup_attempt.rb

@@ -2,6 +2,10 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A SetupAttempt describes one attempted confirmation of a SetupIntent,
+  # whether that confirmation is successful or unsuccessful. You can use
+  # SetupAttempts to inspect details of a specific attempt at setting up a
+  # payment method using a SetupIntent.
   class SetupAttempt < APIResource
     extend Stripe::APIOperations::List
 

data/lib/stripe/resources/setup_intent.rb

@@ -2,6 +2,27 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
+  # For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
+  # Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.
+  #
+  # Create a SetupIntent when you're ready to collect your customer's payment credentials.
+  # Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid.
+  # The SetupIntent transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides
+  # you through the setup process.
+  #
+  # Successful SetupIntents result in payment credentials that are optimized for future payments.
+  # For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through
+  # [Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) during payment method collection
+  # to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents).
+  # If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),
+  # it automatically attaches the resulting payment method to that Customer after successful setup.
+  # We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on
+  # PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.
+  #
+  # By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.
+  #
+  # Related guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents)
   class SetupIntent < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
@@ -9,13 +30,10 @@ module Stripe
 
     OBJECT_NAME = "setup_intent"
 
-    custom_method :cancel, http_verb: :post
-    custom_method :confirm, http_verb: :post
-
     def cancel(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/cancel",
+        path: format("/v1/setup_intents/%<intent>s/cancel", { intent: CGI.escape(self["id"]) }),
         params: params,
         opts: opts
       )
@@ -24,7 +42,43 @@ module Stripe
     def confirm(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/confirm",
+        path: format("/v1/setup_intents/%<intent>s/confirm", { intent: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def verify_microdeposits(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/setup_intents/%<intent>s/verify_microdeposits", { intent: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.cancel(intent, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/setup_intents/%<intent>s/cancel", { intent: CGI.escape(intent) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.confirm(intent, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/setup_intents/%<intent>s/confirm", { intent: CGI.escape(intent) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.verify_microdeposits(intent, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/setup_intents/%<intent>s/verify_microdeposits", { intent: CGI.escape(intent) }),
         params: params,
         opts: opts
       )

data/lib/stripe/resources/shipping_rate.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # Shipping rates describe the price of shipping presented to your customers and
+  # applied to a purchase. For more information, see [Charge for shipping](https://stripe.com/docs/payments/during-payment/charge-shipping).
+  class ShippingRate < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "shipping_rate"
+  end
+end

data/lib/stripe/resources/sigma/scheduled_query_run.rb

@@ -3,6 +3,10 @@
 
 module Stripe
   module Sigma
+    # If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll
+    # receive a `sigma.scheduled_query_run.created` webhook each time the query
+    # runs. The webhook contains a `ScheduledQueryRun` object, which you can use to
+    # retrieve the query results.
     class ScheduledQueryRun < APIResource
       extend Stripe::APIOperations::List
 

data/lib/stripe/resources/source.rb

@@ -2,6 +2,16 @@
 # frozen_string_literal: true
 
 module Stripe
+  # `Source` objects allow you to accept a variety of payment methods. They
+  # represent a customer's payment instrument, and can be used with the Stripe API
+  # just like a `Card` object: once chargeable, they can be charged, or can be
+  # attached to customers.
+  #
+  # Stripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources).
+  # We recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods).
+  # This newer API provides access to our latest features and payment method types.
+  #
+  # Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).
   class Source < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Save
@@ -9,15 +19,21 @@ module Stripe
 
     OBJECT_NAME = "source"
 
-    custom_method :verify, http_verb: :post
-
-    nested_resource_class_methods :source_transaction,
-                                  operations: %i[retrieve list]
+    nested_resource_class_methods :source_transaction, operations: %i[retrieve list]
 
     def verify(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/verify",
+        path: format("/v1/sources/%<source>s/verify", { source: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.verify(source, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/sources/%<source>s/verify", { source: CGI.escape(source) }),
         params: params,
         opts: opts
       )
@@ -37,9 +53,12 @@ module Stripe
     end
 
     def source_transactions(params = {}, opts = {})
-      resp, opts = execute_resource_request(:get, resource_url + "/source_transactions", params,
-                                            opts)
-      Util.convert_to_stripe_object(resp.data, opts)
+      request_stripe_object(
+        method: :get,
+        path: resource_url + "/source_transactions",
+        params: params,
+        opts: opts
+      )
     end
     extend Gem::Deprecate
     deprecate :source_transactions, :"Source.list_source_transactions", 2020, 1

data/lib/stripe/resources/source_transaction.rb

@@ -1,6 +1,11 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
+  # Some payment methods have no required amount that a customer must send.
+  # Customers can be instructed to send any amount, and it can be made up of
+  # multiple transactions. As such, sources can have multiple associated
+  # transactions.
   class SourceTransaction < StripeObject
     OBJECT_NAME = "source_transaction"
   end

data/lib/stripe/resources/subscription.rb

@@ -2,25 +2,79 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Subscriptions allow you to charge a customer on a recurring basis.
+  #
+  # Related guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating)
   class Subscription < APIResource
     extend Stripe::APIOperations::Create
-    include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "subscription"
 
-    custom_method :delete_discount, http_verb: :delete, http_path: "discount"
+    def cancel(params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/subscriptions/%<subscription_exposed_id>s", { subscription_exposed_id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
 
     def delete_discount(params = {}, opts = {})
       request_stripe_object(
         method: :delete,
-        path: resource_url + "/discount",
+        path: format("/v1/subscriptions/%<subscription_exposed_id>s/discount", { subscription_exposed_id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def resume(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscriptions/%<subscription>s/resume", { subscription: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.cancel(subscription_exposed_id, params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/subscriptions/%<subscription_exposed_id>s", { subscription_exposed_id: CGI.escape(subscription_exposed_id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.delete_discount(subscription_exposed_id, params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/subscriptions/%<subscription_exposed_id>s/discount", { subscription_exposed_id: CGI.escape(subscription_exposed_id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.resume(subscription, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscriptions/%<subscription>s/resume", { subscription: CGI.escape(subscription) }),
         params: params,
         opts: opts
       )
     end
 
     save_nested_resource :source
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/subscriptions/search", params, opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
   end
 end