stripe 5.41.0 → 9.0.0

data/lib/stripe/resources/treasury/received_credit.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.
+    class ReceivedCredit < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "treasury.received_credit"
+
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = ReceivedCredit
+
+        def self.create(params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: "/v1/test_helpers/treasury/received_credits",
+            params: params,
+            opts: opts
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/treasury/received_debit.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount.
+    class ReceivedDebit < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "treasury.received_debit"
+
+      def test_helpers
+        TestHelpers.new(self)
+      end
+
+      class TestHelpers < APIResourceTestHelpers
+        RESOURCE_CLASS = ReceivedDebit
+
+        def self.create(params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: "/v1/test_helpers/treasury/received_debits",
+            params: params,
+            opts: opts
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/treasury/transaction.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # Transactions represent changes to a [FinancialAccount's](https://stripe.com/docs/api#financial_accounts) balance.
+    class Transaction < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "treasury.transaction"
+    end
+  end
+end

data/lib/stripe/resources/treasury/transaction_entry.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    # TransactionEntries represent individual units of money movements within a single [Transaction](https://stripe.com/docs/api#transactions).
+    class TransactionEntry < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "treasury.transaction_entry"
+
+      def self.resource_url
+        "/v1/treasury/transaction_entries"
+      end
+    end
+  end
+end

data/lib/stripe/resources/usage_record.rb

@@ -2,6 +2,10 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Usage records allow you to report customer usage and metrics to Stripe for
+  # metered billing of subscription prices.
+  #
+  # Related guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing)
   class UsageRecord < APIResource
     OBJECT_NAME = "usage_record"
   end

data/lib/stripe/resources/webhook_endpoint.rb

@@ -2,6 +2,13 @@
 # frozen_string_literal: true
 
 module Stripe
+  # You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be
+  # notified about events that happen in your Stripe account or connected
+  # accounts.
+  #
+  # Most users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.
+  #
+  # Related guide: [Setting up webhooks](https://stripe.com/docs/webhooks/configure)
   class WebhookEndpoint < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete

data/lib/stripe/resources.rb

@@ -3,19 +3,18 @@
 
 require "stripe/resources/account"
 require "stripe/resources/account_link"
-require "stripe/resources/alipay_account"
 require "stripe/resources/apple_pay_domain"
 require "stripe/resources/application_fee"
 require "stripe/resources/application_fee_refund"
+require "stripe/resources/apps/secret"
 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"
@@ -24,6 +23,7 @@ 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/customer_cash_balance_transaction"
 require "stripe/resources/discount"
 require "stripe/resources/dispute"
 require "stripe/resources/ephemeral_key"
@@ -31,6 +31,11 @@ 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"
@@ -38,16 +43,14 @@ require "stripe/resources/invoice_item"
 require "stripe/resources/invoice_line_item"
 require "stripe/resources/issuing/authorization"
 require "stripe/resources/issuing/card"
-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"
@@ -59,8 +62,6 @@ require "stripe/resources/quote"
 require "stripe/resources/radar/early_fraud_warning"
 require "stripe/resources/radar/value_list"
 require "stripe/resources/radar/value_list_item"
-require "stripe/resources/recipient"
-require "stripe/resources/recipient_transfer"
 require "stripe/resources/refund"
 require "stripe/resources/reporting/report_run"
 require "stripe/resources/reporting/report_type"
@@ -70,22 +71,38 @@ 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"
 require "stripe/resources/source_transaction"
 require "stripe/resources/subscription"
 require "stripe/resources/subscription_item"
 require "stripe/resources/subscription_schedule"
+require "stripe/resources/tax/calculation"
+require "stripe/resources/tax/calculation_line_item"
+require "stripe/resources/tax/settings"
+require "stripe/resources/tax/transaction"
+require "stripe/resources/tax/transaction_line_item"
 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/three_d_secure"
+require "stripe/resources/test_helpers/test_clock"
 require "stripe/resources/token"
 require "stripe/resources/topup"
 require "stripe/resources/transfer"
+require "stripe/resources/treasury/credit_reversal"
+require "stripe/resources/treasury/debit_reversal"
+require "stripe/resources/treasury/financial_account"
+require "stripe/resources/treasury/financial_account_features"
+require "stripe/resources/treasury/inbound_transfer"
+require "stripe/resources/treasury/outbound_payment"
+require "stripe/resources/treasury/outbound_transfer"
+require "stripe/resources/treasury/received_credit"
+require "stripe/resources/treasury/received_debit"
+require "stripe/resources/treasury/transaction"
+require "stripe/resources/treasury/transaction_entry"
 require "stripe/resources/usage_record"
 require "stripe/resources/usage_record_summary"
 require "stripe/resources/webhook_endpoint"

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

data/lib/stripe/stripe_client.rb

@@ -494,15 +494,16 @@ module Stripe
           end
         end
 
-      http_resp = execute_request_with_rescues(method, api_base, context) do
-        self.class
-            .default_connection_manager(config)
-            .execute_request(method, url,
-                             body: body,
-                             headers: headers,
-                             query: query,
-                             &response_block)
-      end
+      http_resp =
+        execute_request_with_rescues(method, api_base, headers, context) do
+          self.class
+              .default_connection_manager(config)
+              .execute_request(method, url,
+                               body: body,
+                               headers: headers,
+                               query: query,
+                               &response_block)
+        end
 
       [http_resp, api_key]
     end
@@ -564,7 +565,7 @@ module Stripe
       http_status >= 400
     end
 
-    private def execute_request_with_rescues(method, api_base, context)
+    private def execute_request_with_rescues(method, api_base, headers, context)
       num_retries = 0
 
       begin
@@ -585,9 +586,9 @@ module Stripe
           handle_error_response(resp, context)
         end
 
-        log_response(context, request_start, http_status, resp.body)
+        log_response(context, request_start, http_status, resp.body, resp)
         notify_request_end(context, request_duration, http_status,
-                           num_retries, user_data)
+                           num_retries, user_data, resp, headers)
 
         if config.enable_telemetry? && context.request_id
           request_duration_ms = (request_duration * 1000).to_i
@@ -609,12 +610,12 @@ module Stripe
           error_context = context.dup_from_response_headers(e.http_headers)
           http_status = resp.code.to_i
           log_response(error_context, request_start,
-                       e.http_status, e.http_body)
+                       e.http_status, e.http_body, resp)
         else
           log_response_error(error_context, request_start, e)
         end
         notify_request_end(context, request_duration, http_status, num_retries,
-                           user_data)
+                           user_data, resp, headers)
 
         if self.class.should_retry?(e,
                                     method: method,
@@ -657,17 +658,24 @@ module Stripe
     end
 
     private def notify_request_end(context, duration, http_status, num_retries,
-                                   user_data)
+                                   user_data, resp, headers)
       return if !Instrumentation.any_subscribers?(:request_end) &&
                 !Instrumentation.any_subscribers?(:request)
 
-      event = Instrumentation::RequestEndEvent.new(
+      request_context = Stripe::Instrumentation::RequestContext.new(
         duration: duration,
+        context: context,
+        header: headers
+      )
+      response_context = Stripe::Instrumentation::ResponseContext.new(
         http_status: http_status,
-        method: context.method,
+        response: resp
+      )
+
+      event = Instrumentation::RequestEndEvent.new(
+        request_context: request_context,
+        response_context: response_context,
         num_retries: num_retries,
-        path: context.path,
-        request_id: context.request_id,
         user_data: user_data || {}
       )
       Stripe::Instrumentation.notify(:request_end, event)
@@ -903,10 +911,13 @@ module Stripe
                      body: context.body,
                      idempotency_key: context.idempotency_key,
                      query: context.query,
-                     config: config)
+                     config: config,
+                     process_id: Process.pid,
+                     thread_object_id: Thread.current.object_id,
+                     log_timestamp: Util.monotonic_time)
     end
 
-    private def log_response(context, request_start, status, body)
+    private def log_response(context, request_start, status, body, resp)
       Util.log_info("Response from Stripe API",
                     account: context.account,
                     api_version: context.api_version,
@@ -921,7 +932,11 @@ module Stripe
                      body: body,
                      idempotency_key: context.idempotency_key,
                      request_id: context.request_id,
-                     config: config)
+                     config: config,
+                     process_id: Process.pid,
+                     thread_object_id: Thread.current.object_id,
+                     response_object_id: resp.object_id,
+                     log_timestamp: Util.monotonic_time)
 
       return unless context.request_id
 

data/lib/stripe/stripe_configuration.rb

@@ -63,6 +63,7 @@ module Stripe
     end
 
     def initialize
+      @api_version = ApiVersion::CURRENT
       @ca_bundle_path = Stripe::DEFAULT_CA_BUNDLE_PATH
       @enable_telemetry = true
       @verify_ssl_certs = true
@@ -86,13 +87,16 @@ module Stripe
         val = Stripe::LEVEL_DEBUG
       elsif val == "info"
         val = Stripe::LEVEL_INFO
+      elsif val == "error"
+        val = Stripe::LEVEL_ERROR
       end
 
       levels = [Stripe::LEVEL_INFO, Stripe::LEVEL_DEBUG, Stripe::LEVEL_ERROR]
 
       if !val.nil? && !levels.include?(val)
         raise ArgumentError,
-              "log_level should only be set to `nil`, `debug` or `info`"
+              "log_level should only be set to `nil`, `debug`, `info`," \
+              " or `error`"
       end
       @log_level = val
     end

data/lib/stripe/stripe_object.rb

@@ -429,13 +429,13 @@ module Stripe
     # * +:opts:+ Options for StripeObject like an API key.
     # * +:partial:+ Indicates that the re-initialization should not attempt to
     #   remove accessors.
-    protected def initialize_from(values, opts, partial = false)
+    protected def initialize_from(values, opts)
       @opts = Util.normalize_opts(opts)
 
       # the `#send` is here so that we can keep this method private
       @original_values = self.class.send(:deep_copy, values)
 
-      removed = partial ? Set.new : Set.new(@values.keys - values.keys)
+      removed = Set.new(@values.keys - values.keys)
       added = Set.new(values.keys - @values.keys)
 
       # Wipe old state before setting new.  This is useful for e.g. updating a

data/lib/stripe/util.rb

@@ -47,6 +47,53 @@ module Stripe
       Util.object_classes[object_name] == klass
     end
 
+    # Adds a custom method to a resource class. This is used to add support for
+    # non-CRUDL API requests, e.g. capturing charges. custom_method takes the
+    # following parameters:
+    # - name: the name of the custom method to create (as a symbol)
+    # - http_verb: the HTTP verb for the API request (:get, :post, or :delete)
+    # - http_path: the path to append to the resource's URL. If not provided,
+    #              the name is used as the path
+    # - resource: the resource implementation class
+    # - target: the class that custom static method will be added to
+    #
+    # For example, this call:
+    #     custom_method :capture, http_verb: post
+    # adds a `capture` class method to the resource class that, when called,
+    # will send a POST request to `/v1/<object_name>/capture`.
+    def self.custom_method(resource, target, name, http_verb, http_path)
+      unless %i[get post delete].include?(http_verb)
+        raise ArgumentError,
+              "Invalid http_verb value: #{http_verb.inspect}. Should be one " \
+              "of :get, :post or :delete."
+      end
+      unless target.respond_to?(:resource_url)
+        raise ArgumentError,
+              "Invalid target value: #{target}. Target class should have a " \
+              "`resource_url` method."
+      end
+      http_path ||= name.to_s
+      target.define_singleton_method(name) do |id, params = {}, opts = {}|
+        unless id.is_a?(String)
+          raise ArgumentError,
+                "id should be a string representing the ID of an API resource"
+        end
+
+        url = "#{target.resource_url}/"\
+              "#{CGI.escape(id)}/"\
+              "#{CGI.escape(http_path)}"
+
+        resp, opts = resource.execute_resource_request(
+          http_verb,
+          url,
+          params,
+          opts
+        )
+
+        Util.convert_to_stripe_object_with_params(resp.data, params, opts)
+      end
+    end
+
     # Converts a hash of fields or an array of hashes into a +StripeObject+ or
     # array of +StripeObject+s. These new objects will be created as a concrete
     # type as dictated by their `object` field (e.g. an `object` value of
@@ -57,9 +104,27 @@ module Stripe
     # ==== Attributes
     #
     # * +data+ - Hash of fields and values to be converted into a StripeObject.
+    # * +params+ - Params for +StripeObject+ like filters used in search that
+    #   will be reused on subsequent API calls.
     # * +opts+ - Options for +StripeObject+ like an API key that will be reused
     #   on subsequent API calls.
     def self.convert_to_stripe_object(data, opts = {})
+      convert_to_stripe_object_with_params(data, {}, opts)
+    end
+
+    # Converts a hash of fields or an array of hashes into a +StripeObject+ or
+    # array of +StripeObject+s. These new objects will be created as a concrete
+    # type as dictated by their `object` field (e.g. an `object` value of
+    # `charge` would create an instance of +Charge+), but if `object` is not
+    # present or of an unknown type, the newly created instance will fall back
+    # to being a +StripeObject+.
+    #
+    # ==== Attributes
+    #
+    # * +data+ - Hash of fields and values to be converted into a StripeObject.
+    # * +opts+ - Options for +StripeObject+ like an API key that will be reused
+    #   on subsequent API calls.
+    def self.convert_to_stripe_object_with_params(data, params, opts = {})
       opts = normalize_opts(opts)
 
       case data
@@ -68,8 +133,17 @@ module Stripe
       when Hash
         # Try converting to a known object class.  If none available, fall back
         # to generic StripeObject
-        object_classes.fetch(data[:object], StripeObject)
-                      .construct_from(data, opts)
+        object_name = data[:object] || data["object"]
+        obj = object_classes.fetch(object_name, StripeObject)
+                            .construct_from(data, opts)
+
+        # set filters so that we can fetch the same limit, expansions, and
+        # predicates when accessing the next and previous pages
+        if obj && (obj.is_a?(SearchResultObject) || obj.is_a?(ListObject))
+          obj.filters = params.dup
+        end
+
+        obj
       else
         data
       end
@@ -343,6 +417,15 @@ module Stripe
       # Hopefully val is a string, but protect in case it's not.
       val = val.to_s
 
+      # Some values returned by the server are encoded in ASCII-8BIT before
+      # being parsed as UTF-8 by Marshal. If we don't transform these here, then
+      # puts will fail as it tries to render UTF-8 characters as ASCII-8BIT
+      # which is not valid.
+      if val && val.encoding == Encoding::ASCII_8BIT
+        # Dup the string as it is a frozen literal.
+        val = val.dup.force_encoding("UTF-8")
+      end
+
       if %r{[^\w\-/]} =~ val
         # If the string contains any special characters, escape any double
         # quotes it has, remove newlines, and wrap the whole thing in quotes.

data/lib/stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "5.41.0"
+  VERSION = "9.0.0"
 end

data/lib/stripe.rb

@@ -15,6 +15,7 @@ require "uri"
 require "forwardable"
 
 # Version
+require "stripe/api_version"
 require "stripe/version"
 
 # API operations
@@ -24,6 +25,7 @@ require "stripe/api_operations/list"
 require "stripe/api_operations/nested_resource"
 require "stripe/api_operations/request"
 require "stripe/api_operations/save"
+require "stripe/api_operations/search"
 
 # API resource support classes
 require "stripe/errors"
@@ -35,8 +37,10 @@ require "stripe/stripe_client"
 require "stripe/stripe_object"
 require "stripe/stripe_response"
 require "stripe/list_object"
+require "stripe/search_result_object"
 require "stripe/error_object"
 require "stripe/api_resource"
+require "stripe/api_resource_test_helpers"
 require "stripe/singleton_api_resource"
 require "stripe/webhook"
 require "stripe/stripe_configuration"
@@ -103,7 +107,7 @@ module Stripe
   # with API requests. Useful for plugin authors to identify their plugin when
   # communicating with Stripe.
   #
-  # Takes a name and optional  partner program ID, plugin URL, and version.
+  # Takes a name and optional partner program ID, plugin URL, and version.
   def self.set_app_info(name, partner_id: nil, url: nil, version: nil)
     @app_info = {
       name: name,

data/stripe.gemspec

@@ -13,16 +13,16 @@ Gem::Specification.new do |s|
                   "See https://stripe.com for details."
   s.author = "Stripe"
   s.email = "support@stripe.com"
-  s.homepage = "https://stripe.com/docs/api/ruby"
+  s.homepage = "https://stripe.com/docs/api?lang=ruby"
   s.license = "MIT"
 
   s.metadata = {
     "bug_tracker_uri" => "https://github.com/stripe/stripe-ruby/issues",
     "changelog_uri" =>
       "https://github.com/stripe/stripe-ruby/blob/master/CHANGELOG.md",
-    "documentation_uri" => "https://stripe.com/docs/api/ruby",
+    "documentation_uri" => "https://stripe.com/docs/api?lang=ruby",
     "github_repo" => "ssh://github.com/stripe/stripe-ruby",
-    "homepage_uri" => "https://stripe.com/docs/api/ruby",
+    "homepage_uri" => "https://stripe.com/docs/api?lang=ruby",
     "source_code_uri" => "https://github.com/stripe/stripe-ruby",
   }