stripe 5.1.0 → 5.55.0

data/lib/stripe/resources/refund.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
@@ -7,5 +8,35 @@ module Stripe
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "refund"
+
+    custom_method :cancel, http_verb: :post
+
+    def cancel(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/cancel",
+        params: params,
+        opts: opts
+      )
+    end
+
+    def test_helpers
+      TestHelpers.new(self)
+    end
+
+    class TestHelpers < APIResourceTestHelpers
+      RESOURCE_CLASS = Refund
+
+      custom_method :expire, http_verb: :post
+
+      def expire(params = {}, opts = {})
+        @resource.request_stripe_object(
+          method: :post,
+          path: resource_url + "/expire",
+          params: params,
+          opts: opts
+        )
+      end
+    end
   end
 end

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

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

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

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/reversal.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
@@ -22,8 +23,8 @@ module Stripe
     def self.retrieve(_id, _opts = {})
       raise NotImplementedError,
             "Reversals cannot be retrieved without a transfer ID. Retrieve " \
-             "a reversal using `Transfer.retrieve_reversal('transfer_id', " \
-             "'reversal_id')`"
+            "a reversal using `Transfer.retrieve_reversal('transfer_id', " \
+            "'reversal_id'`"
     end
   end
 end

data/lib/stripe/resources/review.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/setup_attempt.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class SetupAttempt < APIResource
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "setup_attempt"
+  end
+end

data/lib/stripe/resources/setup_intent.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
@@ -10,6 +11,7 @@ module Stripe
 
     custom_method :cancel, http_verb: :post
     custom_method :confirm, http_verb: :post
+    custom_method :verify_microdeposits, http_verb: :post
 
     def cancel(params = {}, opts = {})
       request_stripe_object(
@@ -28,5 +30,14 @@ module Stripe
         opts: opts
       )
     end
+
+    def verify_microdeposits(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/verify_microdeposits",
+        params: params,
+        opts: opts
+      )
+    end
   end
 end

data/lib/stripe/resources/shipping_rate.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  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

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/sku.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/source.rb

@@ -1,14 +1,19 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
   class Source < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Save
+    extend Stripe::APIOperations::NestedResource
 
     OBJECT_NAME = "source"
 
     custom_method :verify, http_verb: :post
 
+    nested_resource_class_methods :source_transaction,
+                                  operations: %i[retrieve list]
+
     def verify(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -27,14 +32,16 @@ module Stripe
 
       url = "#{Customer.resource_url}/#{CGI.escape(customer)}/sources" \
             "/#{CGI.escape(id)}"
-      resp, opts = request(:delete, url, params, opts)
+      resp, opts = execute_resource_request(:delete, url, params, opts)
       initialize_from(resp.data, opts)
     end
 
     def source_transactions(params = {}, opts = {})
-      resp, opts = request(:get, resource_url + "/source_transactions", params,
-                           opts)
+      resp, opts = execute_resource_request(:get, resource_url + "/source_transactions", params,
+                                            opts)
       Util.convert_to_stripe_object(resp.data, opts)
     end
+    extend Gem::Deprecate
+    deprecate :source_transactions, :"Source.list_source_transactions", 2020, 1
   end
 end

data/lib/stripe/resources/source_transaction.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/subscription.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
@@ -5,6 +6,7 @@ module Stripe
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "subscription"
@@ -21,5 +23,13 @@ module Stripe
     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

data/lib/stripe/resources/subscription_item.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
@@ -11,10 +12,15 @@ module Stripe
     OBJECT_NAME = "subscription_item"
 
     nested_resource_class_methods :usage_record, operations: %i[create]
+    nested_resource_class_methods :usage_record_summary,
+                                  operations: %i[list],
+                                  resource_plural: "usage_record_summaries"
 
     def usage_record_summaries(params = {}, opts = {})
-      resp, opts = request(:get, resource_url + "/usage_record_summaries", params, opts)
+      resp, opts = execute_resource_request(:get, resource_url + "/usage_record_summaries", params, opts)
       Util.convert_to_stripe_object(resp.data, opts)
     end
+    extend Gem::Deprecate
+    deprecate :usage_record_summaries, :"SubscriptionItem.list_usage_record_summaries", 2020, 1
   end
 end

data/lib/stripe/resources/subscription_schedule.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/tax_code.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TaxCode < APIResource
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "tax_code"
+  end
+end

data/lib/stripe/resources/tax_id.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/tax_rate.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/terminal/configuration.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class Configuration < APIResource
+      extend Stripe::APIOperations::Create
+      include Stripe::APIOperations::Delete
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "terminal.configuration"
+    end
+  end
+end

data/lib/stripe/resources/terminal/connection_token.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/terminal/location.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/terminal/reader.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
@@ -9,6 +10,66 @@ module Stripe
       include Stripe::APIOperations::Save
 
       OBJECT_NAME = "terminal.reader"
+
+      custom_method :cancel_action, http_verb: :post
+      custom_method :process_payment_intent, http_verb: :post
+      custom_method :process_setup_intent, http_verb: :post
+      custom_method :set_reader_display, http_verb: :post
+
+      def cancel_action(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/cancel_action",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def process_payment_intent(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/process_payment_intent",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def process_setup_intent(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/process_setup_intent",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def set_reader_display(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/set_reader_display",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = Reader
+
+        custom_method :present_payment_method, http_verb: :post
+
+        def present_payment_method(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: resource_url + "/present_payment_method",
+            params: params,
+            opts: opts
+          )
+        end
+      end
     end
   end
 end

data/lib/stripe/resources/test_helpers/test_clock.rb

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module TestHelpers
+    class TestClock < APIResource
+      extend Stripe::APIOperations::Create
+      include Stripe::APIOperations::Delete
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "test_helpers.test_clock"
+
+      custom_method :advance, http_verb: :post
+
+      def advance(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/advance",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/three_d_secure.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/token.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/topup.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/transfer.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/usage_record.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/usage_record_summary.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources/webhook_endpoint.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe

data/lib/stripe/resources.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 require "stripe/resources/account"
@@ -9,15 +10,19 @@ require "stripe/resources/application_fee_refund"
 require "stripe/resources/balance"
 require "stripe/resources/balance_transaction"
 require "stripe/resources/bank_account"
+require "stripe/resources/billing_portal/configuration"
+require "stripe/resources/billing_portal/session"
 require "stripe/resources/bitcoin_receiver"
 require "stripe/resources/bitcoin_transaction"
 require "stripe/resources/capability"
 require "stripe/resources/card"
+require "stripe/resources/cash_balance"
 require "stripe/resources/charge"
 require "stripe/resources/checkout/session"
 require "stripe/resources/country_spec"
 require "stripe/resources/coupon"
 require "stripe/resources/credit_note"
+require "stripe/resources/credit_note_line_item"
 require "stripe/resources/customer"
 require "stripe/resources/customer_balance_transaction"
 require "stripe/resources/discount"
@@ -27,6 +32,13 @@ require "stripe/resources/event"
 require "stripe/resources/exchange_rate"
 require "stripe/resources/file"
 require "stripe/resources/file_link"
+require "stripe/resources/financial_connections/account"
+require "stripe/resources/financial_connections/account_owner"
+require "stripe/resources/financial_connections/account_ownership"
+require "stripe/resources/financial_connections/session"
+require "stripe/resources/funding_instructions"
+require "stripe/resources/identity/verification_report"
+require "stripe/resources/identity/verification_session"
 require "stripe/resources/invoice"
 require "stripe/resources/invoice_item"
 require "stripe/resources/invoice_line_item"
@@ -36,15 +48,21 @@ require "stripe/resources/issuing/card_details"
 require "stripe/resources/issuing/cardholder"
 require "stripe/resources/issuing/dispute"
 require "stripe/resources/issuing/transaction"
+require "stripe/resources/line_item"
 require "stripe/resources/login_link"
+require "stripe/resources/mandate"
 require "stripe/resources/order"
 require "stripe/resources/order_return"
 require "stripe/resources/payment_intent"
+require "stripe/resources/payment_link"
 require "stripe/resources/payment_method"
 require "stripe/resources/payout"
 require "stripe/resources/person"
 require "stripe/resources/plan"
+require "stripe/resources/price"
 require "stripe/resources/product"
+require "stripe/resources/promotion_code"
+require "stripe/resources/quote"
 require "stripe/resources/radar/early_fraud_warning"
 require "stripe/resources/radar/value_list"
 require "stripe/resources/radar/value_list_item"
@@ -55,7 +73,9 @@ require "stripe/resources/reporting/report_run"
 require "stripe/resources/reporting/report_type"
 require "stripe/resources/reversal"
 require "stripe/resources/review"
+require "stripe/resources/setup_attempt"
 require "stripe/resources/setup_intent"
+require "stripe/resources/shipping_rate"
 require "stripe/resources/sigma/scheduled_query_run"
 require "stripe/resources/sku"
 require "stripe/resources/source"
@@ -63,11 +83,14 @@ require "stripe/resources/source_transaction"
 require "stripe/resources/subscription"
 require "stripe/resources/subscription_item"
 require "stripe/resources/subscription_schedule"
+require "stripe/resources/tax_code"
 require "stripe/resources/tax_id"
 require "stripe/resources/tax_rate"
+require "stripe/resources/terminal/configuration"
 require "stripe/resources/terminal/connection_token"
 require "stripe/resources/terminal/location"
 require "stripe/resources/terminal/reader"
+require "stripe/resources/test_helpers/test_clock"
 require "stripe/resources/three_d_secure"
 require "stripe/resources/token"
 require "stripe/resources/topup"

data/lib/stripe/search_result_object.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Stripe
+  class SearchResultObject < StripeObject
+    include Enumerable
+    include Stripe::APIOperations::Search
+    include Stripe::APIOperations::Request
+
+    OBJECT_NAME = "search_result"
+
+    # This accessor allows a `SearchResultObject` to inherit various filters
+    # that were given to a predecessor. This allows for things like consistent
+    # limits, expansions, and predicates as a user pages through resources.
+    attr_accessor :filters
+
+    # An empty search result object. This is returned from +next+ when we know
+    # that there isn't a next page in order to replicate the behavior of the API
+    # when it attempts to return a page beyond the last.
+    def self.empty_search_result(opts = {})
+      SearchResultObject.construct_from({ data: [] }, opts)
+    end
+
+    def initialize(*args)
+      super
+      self.filters = {}
+    end
+
+    def [](key)
+      case key
+      when String, Symbol
+        super
+      else
+        raise ArgumentError,
+              "You tried to access the #{key.inspect} index, but " \
+              "SearchResultObject types only support String keys. " \
+              "(HINT: Search calls return an object with a 'data' (which is " \
+              "the data array). You likely want to call #data[#{key.inspect}])"
+      end
+    end
+
+    # Iterates through each resource in the page represented by the current
+    # `SearchListObject`.
+    #
+    # Note that this method makes no effort to fetch a new page when it gets to
+    # the end of the current page's resources. See also +auto_paging_each+.
+    def each(&blk)
+      data.each(&blk)
+    end
+
+    # Returns true if the page object contains no elements.
+    def empty?
+      data.empty?
+    end
+
+    # Iterates through each resource in all pages, making additional fetches to
+    # the API as necessary.
+    #
+    # Note that this method will make as many API calls as necessary to fetch
+    # all resources. For more granular control, please see +each+ and
+    # +next_search_result_page+.
+    def auto_paging_each(&blk)
+      return enum_for(:auto_paging_each) unless block_given?
+
+      page = self
+
+      loop do
+        page.each(&blk)
+        page = page.next_search_result_page
+
+        break if page.empty?
+      end
+    end
+
+    # Fetches the next page in the resource list (if there is one).
+    #
+    # This method will try to respect the limit of the current page. If none
+    # was given, the default limit will be fetched again.
+    def next_search_result_page(params = {}, opts = {})
+      return self.class.empty_search_result(opts) unless has_more
+
+      params = filters.merge(page: next_page).merge(params)
+
+      _search(url, params, opts)
+    end
+  end
+end