stripe 12.7.0.pre.beta.2 → 13.1.0.pre.beta.2

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,35 @@ 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
+
+      @requestor.execute_request_initialize_from(:get, resource_url, :api, self, params: @retrieve_params)
     end
 
     def self.retrieve(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
+
       opts = Util.normalize_opts(opts)
       instance = new(id, 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,7 +3,6 @@
 
 module Stripe
   module ApiVersion
-    CURRENT = "2024-06-20"
-    PREVIEW = "cs_ubb_launch"
+    CURRENT = "2024-09-30.acacia"
   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,7 +27,8 @@ module Stripe
     def construct_error_object
       return nil if @json_body.nil? || !@json_body.key?(:error)
 
-      ErrorObject.construct_from(@json_body[:error])
+      # ErrorObject is shared between v1 and v2, so use original object_classes to find
+      ErrorObject.construct_from(@json_body[:error], {}, nil, :v1)
     end
 
     # Whether the error was the result of an idempotent replay, meaning that it
@@ -130,7 +131,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 +167,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
@@ -25,6 +24,9 @@ module Stripe
         BalanceTransaction.object_name => BalanceTransaction,
         BankAccount.object_name => BankAccount,
         Billing::Alert.object_name => Billing::Alert,
+        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,
@@ -163,6 +165,19 @@ module Stripe
         # 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 object classes: The end of the section generated from our OpenAPI spec
+      }
+    end
   end
 end
 

data/lib/stripe/request_options.rb

@@ -0,0 +1,128 @@
+# 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.
+    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[:api_version],
+      }
+
+      # 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/resources/billing/credit_balance_summary.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # Indicates the credit balance for credits granted to a customer.
+    class CreditBalanceSummary < SingletonAPIResource
+      OBJECT_NAME = "billing.credit_balance_summary"
+      def self.object_name
+        "billing.credit_balance_summary"
+      end
+    end
+  end
+end

data/lib/stripe/resources/billing/credit_balance_transaction.rb

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.
+    class CreditBalanceTransaction < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "billing.credit_balance_transaction"
+      def self.object_name
+        "billing.credit_balance_transaction"
+      end
+
+      # Retrieve a list of credit balance transactions
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/billing/credit_balance_transactions",
+          params: filters,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/billing/credit_grant.rb

@@ -0,0 +1,88 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    # A credit grant is a resource that records a grant of some credit to a customer.
+    class CreditGrant < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "billing.credit_grant"
+      def self.object_name
+        "billing.credit_grant"
+      end
+
+      # Creates a credit grant
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/billing/credit_grants",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Expires a credit grant
+      def expire(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s/expire", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Expires a credit grant
+      def self.expire(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s/expire", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Retrieve a list of credit grants
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/billing/credit_grants",
+          params: filters,
+          opts: opts
+        )
+      end
+
+      # Updates a credit grant
+      def self.update(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Voids a credit grant
+      def void_grant(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s/void", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Voids a credit grant
+      def self.void_grant(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s/void", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/billing/meter.rb

@@ -4,6 +4,8 @@
 module Stripe
   module Billing
     # A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make.
+    #
+    # Related guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)
     class Meter < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List

data/lib/stripe/resources/customer.rb

@@ -2,9 +2,8 @@
 # frozen_string_literal: true
 
 module Stripe
-  # This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer.
-  #
-  # Related guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment)
+  # This object represents a customer of your business. Use it to [create recurring charges](https://stripe.com/docs/invoicing/customer), [save payment](https://stripe.com/docs/payments/save-during-payment) and contact information,
+  # and track payments that belong to the same customer.
   class Customer < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete

data/lib/stripe/resources/file.rb

@@ -22,17 +22,19 @@ module Stripe
     #
     # All of Stripe's officially supported Client libraries support sending multipart/form-data.
     def self.create(params = {}, opts = {})
-      config = opts[:client]&.config || Stripe.config
-      upload_base = config.uploads_base
-      opts = { api_base: upload_base }.merge(Util.normalize_opts(opts))
-
       if params[:file] && !params[:file].is_a?(String) && !params[:file].respond_to?(:read)
         raise ArgumentError, "file must respond to `#read`"
       end
 
       opts = { content_type: MultipartEncoder::MULTIPART_FORM_DATA }.merge(Util.normalize_opts(opts))
 
-      request_stripe_object(method: :post, path: "/v1/files", params: params, opts: opts)
+      request_stripe_object(
+        method: :post,
+        path: "/v1/files",
+        params: params,
+        opts: opts,
+        base_address: :files
+      )
     end
 
     # Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

data/lib/stripe/resources/issuing/card.rb

@@ -123,6 +123,26 @@ module Stripe
             opts: opts
           )
         end
+
+        # Updates the shipping status of the specified Issuing Card object to submitted. This method is only available with Stripe Version ‘2024-09-30.acacia' or above.
+        def self.submit_card(card, params = {}, opts = {})
+          request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/cards/%<card>s/shipping/submit", { card: CGI.escape(card) }),
+            params: params,
+            opts: opts
+          )
+        end
+
+        # Updates the shipping status of the specified Issuing Card object to submitted. This method is only available with Stripe Version ‘2024-09-30.acacia' or above.
+        def submit_card(params = {}, opts = {})
+          @resource.request_stripe_object(
+            method: :post,
+            path: format("/v1/test_helpers/issuing/cards/%<card>s/shipping/submit", { card: CGI.escape(@resource["id"]) }),
+            params: params,
+            opts: opts
+          )
+        end
       end
     end
   end

data/lib/stripe/resources/quote.rb

@@ -210,24 +210,24 @@ module Stripe
 
     # Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)
     def pdf(params = {}, opts = {}, &read_body_chunk_block)
-      config = opts[:client]&.config || Stripe.config
-      opts = { api_base: config.uploads_base }.merge(opts)
+      opts = { api_base: APIRequestor.active_requestor.config.uploads_base }.merge(opts)
       request_stream(
         method: :get,
         path: format("/v1/quotes/%<quote>s/pdf", { quote: CGI.escape(self["id"]) }),
         params: params,
         opts: opts,
+        base_address: :files,
         &read_body_chunk_block
       )
     end
 
     # Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)
     def self.pdf(quote, params = {}, opts = {}, &read_body_chunk_block)
-      config = opts[:client]&.config || Stripe.config
-      opts = { api_base: config.uploads_base }.merge(opts)
+      opts = { api_base: APIRequestor.active_requestor.config.uploads_base }.merge(opts)
       execute_resource_request_stream(
         :get,
         format("/v1/quotes/%<quote>s/pdf", { quote: CGI.escape(quote) }),
+        :files,
         params,
         opts,
         &read_body_chunk_block

data/lib/stripe/resources/source.rb

@@ -70,8 +70,9 @@ module Stripe
 
       url = "#{Customer.resource_url}/#{CGI.escape(customer)}/sources" \
             "/#{CGI.escape(id)}"
-      resp, opts = execute_resource_request(:delete, url, params, opts)
-      initialize_from(resp.data, opts)
+      opts = Util.normalize_opts(opts)
+      APIRequestor.active_requestor.execute_request_initialize_from(:delete, url, :api, self,
+                                                                    params: params, opts: opts)
     end
 
     def source_transactions(params = {}, opts = {})