stripe 12.5.0 → 15.0.0

data/lib/stripe/api_resource.rb

@@ -25,6 +25,12 @@ module Stripe
     end
 
     def self.resource_url
+      if name.include?("Stripe::V2")
+        raise NotImplementedError,
+              "V2 resources do not have a defined URL. Please use the StripeClient " \
+              "to make V2 requests"
+      end
+
       if self == APIResource
         raise NotImplementedError,
               "APIResource is an abstract class. You should perform actions " \
@@ -87,33 +93,48 @@ module Stripe
     end
 
     def refresh
-      resp, opts = execute_resource_request(:get, resource_url,
-                                            @retrieve_params)
-      initialize_from(resp.data, opts, resp)
+      if self.class.name.include?("Stripe::V2")
+        raise NotImplementedError,
+              "It is not possible to refresh v2 objects. Please retrieve the object using the StripeClient instead."
+      end
+
+      opts = RequestOptions.extract_opts_from_hash(@retrieve_opts || {})
+      @retrieve_opts = {} # Make sure to clear the retrieve options
+      @obj = @requestor.execute_request_initialize_from(:get, resource_url, :api, self, params: @retrieve_params,
+                                                                                        opts: opts)
+      initialize_from(
+        @obj.last_response.data,
+        @obj.instance_variable_get(:@opts),
+        @obj.last_response,
+        api_mode: :v1,
+        requestor: @requestor
+      )
     end
 
     def self.retrieve(id, opts = {})
-      opts = Util.normalize_opts(opts)
-      instance = new(id, opts)
+      if name.include?("Stripe::V2")
+        raise NotImplementedError,
+              "It is not possible to retrieve v2 objects on the resource. Please use the StripeClient instead."
+      end
+
+      instance = new(id)
+      # Explicitly send options for the retrieve call, to preserve custom headers
+      # This is so we can pass custom headers from this static function
+      # to the instance variable method call
+      # The custom headers will be cleaned up with the rest of the RequestOptions
+      instance.instance_variable_set(:@retrieve_opts, Util.normalize_opts(opts))
       instance.refresh
-      instance
     end
 
-    def request_stripe_object(method:, path:, params:, opts: {})
-      resp, opts = execute_resource_request(method, path, params, opts)
-
-      # If we're getting back this thing, update; otherwise, instantiate.
-      if Util.object_name_matches_class?(resp.data[:object], self.class)
-        initialize_from(resp.data, opts, resp)
-      else
-        Util.convert_to_stripe_object_with_params(resp.data, params, opts, resp)
-      end
+    def request_stripe_object(method:, path:, params:, base_address: :api, opts: {})
+      APIRequestor.active_requestor.execute_request_initialize_from(method, path, base_address, self,
+                                                                    params: params, opts: opts)
     end
 
-    protected def request_stream(method:, path:, params:, opts: {},
+    protected def request_stream(method:, path:, params:, base_address: :api, opts: {},
                                  &read_body_chunk_block)
       resp, = execute_resource_request_stream(
-        method, path, params, opts, &read_body_chunk_block
+        method, path, base_address, params, opts, &read_body_chunk_block
       )
       resp
     end

data/lib/stripe/api_version.rb

@@ -3,6 +3,6 @@
 
 module Stripe
   module ApiVersion
-    CURRENT = "2024-06-20"
+    CURRENT = "2025-03-31.basil"
   end
 end

data/lib/stripe/connection_manager.rb

@@ -12,7 +12,7 @@ module Stripe
   class ConnectionManager
     # Timestamp (in seconds procured from the system's monotonic clock)
     # indicating when the connection manager last made a request. This is used
-    # by `StripeClient` to determine whether a connection manager should be
+    # by `APIRequestor` to determine whether a connection manager should be
     # garbage collected or not.
     attr_reader :last_used
     attr_reader :config

data/lib/stripe/errors.rb

@@ -27,14 +27,8 @@ module Stripe
     def construct_error_object
       return nil if @json_body.nil? || !@json_body.key?(:error)
 
-      ErrorObject.construct_from(@json_body[:error])
-    end
-
-    # Whether the error was the result of an idempotent replay, meaning that it
-    # originally occurred on a previous request and is being replayed back
-    # because the user sent the same idempotency key for this one.
-    def idempotent_replayed?
-      @idempotent_replayed
+      # ErrorObject is shared between v1 and v2, so use original object_classes to find
+      ErrorObject.construct_from(@json_body[:error], {}, nil, :v1)
     end
 
     def to_s
@@ -130,7 +124,7 @@ module Stripe
       def construct_error_object
         return nil if @json_body.nil?
 
-        OAuthErrorObject.construct_from(@json_body)
+        OAuthErrorObject.construct_from(@json_body, {}, nil, :v1)
       end
     end
 
@@ -166,4 +160,9 @@ module Stripe
     class UnsupportedResponseTypeError < OAuthError
     end
   end
+
+  # class definitions: The beginning of the section generated from our OpenAPI spec
+  class TemporarySessionExpiredError < StripeError
+  end
+  # class definitions: The end of the section generated from our OpenAPI spec
 end

data/lib/stripe/event_types.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Stripe
+  module EventTypes
+    def self.thin_event_names_to_classes
+      {
+        # The beginning of the section generated from our OpenAPI spec
+        V1BillingMeterErrorReportTriggeredEvent.lookup_type => V1BillingMeterErrorReportTriggeredEvent,
+        V1BillingMeterNoMeterFoundEvent.lookup_type => V1BillingMeterNoMeterFoundEvent,
+        # The end of the section generated from our OpenAPI spec
+      }
+    end
+  end
+end

data/lib/stripe/events/v1_billing_meter_error_report_triggered_event.rb

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # This event occurs when there are invalid async usage events for a given meter.
+  class V1BillingMeterErrorReportTriggeredEvent < Stripe::V2::Event
+    def self.lookup_type
+      "v1.billing.meter.error_report_triggered"
+    end
+    # There is additional data present for this event, accessible with the `data` property.
+    # See the Stripe API docs for more information.
+
+    # Retrieves the related object from the API. Make an API request on every call.
+    def fetch_related_object
+      _request(
+        method: :get,
+        path: related_object.url,
+        base_address: :api,
+        opts: { stripe_account: context }
+      )
+    end
+  end
+end

data/lib/stripe/events/v1_billing_meter_no_meter_found_event.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # This event occurs when async usage events have missing or invalid meter ids.
+  class V1BillingMeterNoMeterFoundEvent < Stripe::V2::Event
+    def self.lookup_type
+      "v1.billing.meter.no_meter_found"
+    end
+    # There is additional data present for this event, accessible with the `data` property.
+    # See the Stripe API docs for more information.
+  end
+end

data/lib/stripe/list_object.rb

@@ -21,7 +21,7 @@ module Stripe
     # 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_list(opts = {})
-      ListObject.construct_from({ data: [] }, opts)
+      ListObject.construct_from({ data: [] }, opts, nil, :v1)
     end
 
     def initialize(*args)
@@ -96,8 +96,7 @@ module Stripe
     def retrieve(id, opts = {})
       id, retrieve_params = Util.normalize_id(id)
       url = "#{resource_url}/#{CGI.escape(id)}"
-      resp, opts = execute_resource_request(:get, url, retrieve_params, opts)
-      Util.convert_to_stripe_object(resp.data, opts)
+      execute_resource_request(:get, url, :api, retrieve_params, opts)
     end
 
     # Fetches the next page in the resource list (if there is one).

data/lib/stripe/oauth.rb

@@ -5,12 +5,10 @@ module Stripe
     module OAuthOperations
       extend APIOperations::Request::ClassMethods
 
-      def self.execute_resource_request(method, url, params, opts)
+      def self.execute_resource_request(method, url, base_address, params, opts)
         opts = Util.normalize_opts(opts)
-        opts[:client] ||= opts[:client] || StripeClient.active_client
-        opts[:api_base] ||= opts[:client].config.connect_base
 
-        super(method, url, params, opts)
+        super(method, url, base_address, params, opts)
       end
     end
 
@@ -29,15 +27,14 @@ module Stripe
     end
 
     def self.authorize_url(params = {}, opts = {})
-      client = opts[:client] || StripeClient.active_client
-      base = opts[:connect_base] || client.config.connect_base
+      base = opts[:connect_base] || APIRequestor.active_requestor.config.connect_base
 
       path = "/oauth/authorize"
       path = "/express" + path if opts[:express]
 
       params[:client_id] = get_client_id(params)
       params[:response_type] ||= "code"
-      query = Util.encode_parameters(params)
+      query = Util.encode_parameters(params, :v1)
 
       "#{base}#{path}?#{query}"
     end
@@ -45,21 +42,17 @@ module Stripe
     def self.token(params = {}, opts = {})
       opts = Util.normalize_opts(opts)
       opts[:api_key] = params[:client_secret] if params[:client_secret]
-      resp, opts = OAuthOperations.execute_resource_request(
-        :post, "/oauth/token", params, opts
+      OAuthOperations.execute_resource_request(
+        :post, "/oauth/token", :connect, params, opts
       )
-      # This is just going to return a generic StripeObject, but that's okay
-      Util.convert_to_stripe_object(resp.data, opts)
     end
 
     def self.deauthorize(params = {}, opts = {})
       opts = Util.normalize_opts(opts)
       params[:client_id] = get_client_id(params)
-      resp, opts = OAuthOperations.execute_resource_request(
-        :post, "/oauth/deauthorize", params, opts
+      OAuthOperations.execute_resource_request(
+        :post, "/oauth/deauthorize", :connect, params, opts
       )
-      # This is just going to return a generic StripeObject, but that's okay
-      Util.convert_to_stripe_object(resp.data, opts)
     end
   end
 end

data/lib/stripe/object_types.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 # rubocop:disable Metrics/MethodLength
-# rubocop:disable Metrics/AbcSize
 
 module Stripe
   module ObjectTypes
@@ -17,6 +16,7 @@ module Stripe
         AccountLink.object_name => AccountLink,
         AccountSession.object_name => AccountSession,
         ApplePayDomain.object_name => ApplePayDomain,
+        Application.object_name => Application,
         ApplicationFee.object_name => ApplicationFee,
         ApplicationFeeRefund.object_name => ApplicationFeeRefund,
         Apps::Secret.object_name => Apps::Secret,
@@ -24,6 +24,10 @@ module Stripe
         BalanceTransaction.object_name => BalanceTransaction,
         BankAccount.object_name => BankAccount,
         Billing::Alert.object_name => Billing::Alert,
+        Billing::AlertTriggered.object_name => Billing::AlertTriggered,
+        Billing::CreditBalanceSummary.object_name => Billing::CreditBalanceSummary,
+        Billing::CreditBalanceTransaction.object_name => Billing::CreditBalanceTransaction,
+        Billing::CreditGrant.object_name => Billing::CreditGrant,
         Billing::Meter.object_name => Billing::Meter,
         Billing::MeterEvent.object_name => Billing::MeterEvent,
         Billing::MeterEventAdjustment.object_name => Billing::MeterEventAdjustment,
@@ -39,6 +43,7 @@ module Stripe
         Climate::Product.object_name => Climate::Product,
         Climate::Supplier.object_name => Climate::Supplier,
         ConfirmationToken.object_name => ConfirmationToken,
+        ConnectCollectionTransfer.object_name => ConnectCollectionTransfer,
         CountrySpec.object_name => CountrySpec,
         Coupon.object_name => Coupon,
         CreditNote.object_name => CreditNote,
@@ -50,6 +55,7 @@ module Stripe
         Discount.object_name => Discount,
         Dispute.object_name => Dispute,
         Entitlements::ActiveEntitlement.object_name => Entitlements::ActiveEntitlement,
+        Entitlements::ActiveEntitlementSummary.object_name => Entitlements::ActiveEntitlementSummary,
         Entitlements::Feature.object_name => Entitlements::Feature,
         EphemeralKey.object_name => EphemeralKey,
         Event.object_name => Event,
@@ -68,6 +74,8 @@ module Stripe
         Invoice.object_name => Invoice,
         InvoiceItem.object_name => InvoiceItem,
         InvoiceLineItem.object_name => InvoiceLineItem,
+        InvoicePayment.object_name => InvoicePayment,
+        InvoiceRenderingTemplate.object_name => InvoiceRenderingTemplate,
         Issuing::Authorization.object_name => Issuing::Authorization,
         Issuing::Card.object_name => Issuing::Card,
         Issuing::Cardholder.object_name => Issuing::Cardholder,
@@ -98,6 +106,7 @@ module Stripe
         Refund.object_name => Refund,
         Reporting::ReportRun.object_name => Reporting::ReportRun,
         Reporting::ReportType.object_name => Reporting::ReportType,
+        ReserveTransaction.object_name => ReserveTransaction,
         Reversal.object_name => Reversal,
         Review.object_name => Review,
         SetupAttempt.object_name => SetupAttempt,
@@ -105,6 +114,7 @@ module Stripe
         ShippingRate.object_name => ShippingRate,
         Sigma::ScheduledQueryRun.object_name => Sigma::ScheduledQueryRun,
         Source.object_name => Source,
+        SourceMandateNotification.object_name => SourceMandateNotification,
         SourceTransaction.object_name => SourceTransaction,
         Subscription.object_name => Subscription,
         SubscriptionItem.object_name => SubscriptionItem,
@@ -116,6 +126,7 @@ module Stripe
         Tax::Transaction.object_name => Tax::Transaction,
         Tax::TransactionLineItem.object_name => Tax::TransactionLineItem,
         TaxCode.object_name => TaxCode,
+        TaxDeductedAtSource.object_name => TaxDeductedAtSource,
         TaxId.object_name => TaxId,
         TaxRate.object_name => TaxRate,
         Terminal::Configuration.object_name => Terminal::Configuration,
@@ -137,12 +148,24 @@ module Stripe
         Treasury::ReceivedDebit.object_name => Treasury::ReceivedDebit,
         Treasury::Transaction.object_name => Treasury::Transaction,
         Treasury::TransactionEntry.object_name => Treasury::TransactionEntry,
-        UsageRecord.object_name => UsageRecord,
-        UsageRecordSummary.object_name => UsageRecordSummary,
         WebhookEndpoint.object_name => WebhookEndpoint,
         # object classes: The end of the section generated from our OpenAPI spec
       }
     end
+
+    def self.v2_object_names_to_classes
+      {
+        V2::ListObject.object_name => V2::ListObject,
+
+        # v2 object classes: The beginning of the section generated from our OpenAPI spec
+        V2::Billing::MeterEvent.object_name => V2::Billing::MeterEvent,
+        V2::Billing::MeterEventAdjustment.object_name => V2::Billing::MeterEventAdjustment,
+        V2::Billing::MeterEventSession.object_name => V2::Billing::MeterEventSession,
+        V2::Event.object_name => V2::Event,
+        V2::EventDestination.object_name => V2::EventDestination,
+        # v2 object classes: The end of the section generated from our OpenAPI spec
+      }
+    end
   end
 end
 

data/lib/stripe/request_options.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+# typed: true
+
+module Stripe
+  # RequestOptions is a class that encapsulates configurable options
+  # for requests made to the Stripe API. It is used by the APIRequestor
+  # to set per-request options.
+  #
+  # For internal use only. Does not provide a stable API and may be broken
+  # with future non-major changes.
+  module RequestOptions
+    # Options that a user is allowed to specify.
+    OPTS_USER_SPECIFIED = Set[
+      :api_key,
+      :idempotency_key,
+      :stripe_account,
+      :stripe_context,
+      :stripe_version
+    ].freeze
+
+    # Options that should be copyable from one StripeObject to another
+    # including options that may be internal.
+    OPTS_COPYABLE = (
+      OPTS_USER_SPECIFIED + Set[:api_base]
+    ).freeze
+
+    # Options that should be persisted between API requests.
+    OPTS_PERSISTABLE = (
+      OPTS_USER_SPECIFIED - Set[:idempotency_key, :stripe_context]
+    ).freeze
+
+    # Merges requestor options on a StripeConfiguration object
+    # with a per-request options hash, giving precedence
+    # to the per-request options. Expects StripeConfiguration and hash.
+    def self.merge_config_and_opts(config, req_opts)
+      # Raise an error if config is not a StripeConfiguration object
+      unless config.is_a?(StripeConfiguration)
+        raise ArgumentError, "config must be a Stripe::StripeConfiguration object"
+      end
+
+      merged_opts = {
+        api_key: req_opts[:api_key] || config.api_key,
+        idempotency_key: req_opts[:idempotency_key],
+        stripe_account: req_opts[:stripe_account] || config.stripe_account,
+        stripe_context: req_opts[:stripe_context] || config.stripe_context,
+        stripe_version: req_opts[:stripe_version] || config.api_version,
+        headers: req_opts[:headers] || {},
+      }
+
+      # Remove nil values from headers
+      merged_opts.delete_if { |_, v| v.nil? }
+
+      merged_opts
+    end
+
+    # Merges requestor options hash on a StripeObject
+    # with a per-request options hash, giving precedence
+    # to the per-request options. Returns the merged request options.
+    # Expects two hashes, expects extract_opts_from_hash to be called first!!!
+    def self.combine_opts(object_opts, req_opts)
+      merged_opts = {
+        api_key: req_opts[:api_key] || object_opts[:api_key],
+        idempotency_key: req_opts[:idempotency_key],
+        stripe_account: req_opts[:stripe_account] || object_opts[:stripe_account],
+        stripe_context: req_opts[:stripe_context] || object_opts[:stripe_context],
+        stripe_version: req_opts[:stripe_version] || object_opts[:stripe_version],
+        headers: req_opts[:headers] || {},
+      }
+
+      # Remove nil values from headers
+      merged_opts.delete_if { |_, v| v.nil? }
+
+      merged_opts
+    end
+
+    # Extracts options from a user-provided hash, returning a new request options hash
+    # containing the recognized request options and a `headers` entry for the remaining options.
+    def self.extract_opts_from_hash(opts)
+      req_opts = {}
+      normalized_opts = Util.normalize_opts(opts.clone)
+
+      RequestOptions.error_on_non_string_user_opts(normalized_opts)
+
+      OPTS_USER_SPECIFIED.each do |opt|
+        req_opts[opt] = normalized_opts[opt] if normalized_opts.key?(opt)
+        normalized_opts.delete(opt)
+      end
+
+      # Remaining user-provided opts should be treated as headers
+      req_opts[:headers] = Util.normalize_headers(normalized_opts) if normalized_opts.any?
+
+      req_opts
+    end
+
+    # Validates a normalized opts hash.
+    def self.error_on_non_string_user_opts(normalized_opts)
+      OPTS_USER_SPECIFIED.each do |opt|
+        next unless normalized_opts.key?(opt)
+
+        val = normalized_opts[opt]
+        next if val.nil?
+        next if val.is_a?(String)
+
+        raise ArgumentError,
+              "request option '#{opt}' should be a string value " \
+              "(was a #{val.class})"
+      end
+    end
+
+    # Get options that persist between requests
+    def self.persistable(req_opts)
+      opts_to_persist = {}
+
+      # Hash#select returns an array before 1.9
+      req_opts.each do |k, v|
+        opts_to_persist[k] = v if RequestOptions::OPTS_PERSISTABLE.include?(k)
+      end
+
+      opts_to_persist
+    end
+
+    # Get options that are copyable from StripeObject to StripeObject
+    def self.copyable(req_opts)
+      req_opts.select do |k, _v|
+        RequestOptions::OPTS_COPYABLE.include?(k)
+      end
+    end
+  end
+end

data/lib/stripe/request_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+# typed: true
+
+module Stripe
+  # For internal use only. Does not provide a stable API and may be broken
+  # with future non-major changes.
+  class RequestParams
+    def to_h
+      instance_variables.each_with_object({}) do |var, hash|
+        key = var.to_s.delete("@").to_sym
+        value = instance_variable_get(var)
+
+        hash[key] = if value.is_a?(RequestParams)
+                      value.to_h
+                    # Check if value is an array and contains RequestParams objects
+                    elsif value.is_a?(Array)
+                      value.map { |item| item.is_a?(RequestParams) ? item.to_h : item }
+                    else
+                      value
+                    end
+      end
+    end
+  end
+end