stripe 5.38.0 → 15.2.1

data/lib/stripe/object_types.rb

@@ -1,4 +1,3 @@
-# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 # rubocop:disable Metrics/MethodLength
@@ -8,100 +7,167 @@ module Stripe
     def self.object_names_to_classes
       {
         # data structures
-        ListObject::OBJECT_NAME => ListObject,
+        ListObject.object_name => ListObject,
+        SearchResultObject.object_name => SearchResultObject,
+        File.object_name_alt => File,
 
-        # business objects
-        Account::OBJECT_NAME => Account,
-        AccountLink::OBJECT_NAME => AccountLink,
-        AlipayAccount::OBJECT_NAME => AlipayAccount,
-        ApplePayDomain::OBJECT_NAME => ApplePayDomain,
-        ApplicationFee::OBJECT_NAME => ApplicationFee,
-        ApplicationFeeRefund::OBJECT_NAME => ApplicationFeeRefund,
-        Balance::OBJECT_NAME => Balance,
-        BalanceTransaction::OBJECT_NAME => BalanceTransaction,
-        BankAccount::OBJECT_NAME => BankAccount,
-        BillingPortal::Configuration::OBJECT_NAME => BillingPortal::Configuration,
-        BillingPortal::Session::OBJECT_NAME => BillingPortal::Session,
-        BitcoinReceiver::OBJECT_NAME => BitcoinReceiver,
-        BitcoinTransaction::OBJECT_NAME => BitcoinTransaction,
-        Capability::OBJECT_NAME => Capability,
-        Card::OBJECT_NAME => Card,
-        Charge::OBJECT_NAME => Charge,
-        Checkout::Session::OBJECT_NAME => Checkout::Session,
-        CountrySpec::OBJECT_NAME => CountrySpec,
-        Coupon::OBJECT_NAME => Coupon,
-        CreditNote::OBJECT_NAME => CreditNote,
-        CreditNoteLineItem::OBJECT_NAME => CreditNoteLineItem,
-        Customer::OBJECT_NAME => Customer,
-        CustomerBalanceTransaction::OBJECT_NAME => CustomerBalanceTransaction,
-        Discount::OBJECT_NAME => Discount,
-        Dispute::OBJECT_NAME => Dispute,
-        EphemeralKey::OBJECT_NAME => EphemeralKey,
-        Event::OBJECT_NAME => Event,
-        ExchangeRate::OBJECT_NAME => ExchangeRate,
-        File::OBJECT_NAME => File,
-        File::OBJECT_NAME_ALT => File,
-        FileLink::OBJECT_NAME => FileLink,
-        Identity::VerificationReport::OBJECT_NAME => Identity::VerificationReport,
-        Identity::VerificationSession::OBJECT_NAME => Identity::VerificationSession,
-        Invoice::OBJECT_NAME => Invoice,
-        InvoiceItem::OBJECT_NAME => InvoiceItem,
-        InvoiceLineItem::OBJECT_NAME => InvoiceLineItem,
-        Issuing::Authorization::OBJECT_NAME => Issuing::Authorization,
-        Issuing::Card::OBJECT_NAME => Issuing::Card,
-        Issuing::CardDetails::OBJECT_NAME => Issuing::CardDetails,
-        Issuing::Cardholder::OBJECT_NAME => Issuing::Cardholder,
-        Issuing::Dispute::OBJECT_NAME => Issuing::Dispute,
-        Issuing::Transaction::OBJECT_NAME => Issuing::Transaction,
-        LineItem::OBJECT_NAME => LineItem,
-        LoginLink::OBJECT_NAME => LoginLink,
-        Mandate::OBJECT_NAME => Mandate,
-        Order::OBJECT_NAME => Order,
-        OrderReturn::OBJECT_NAME => OrderReturn,
-        PaymentIntent::OBJECT_NAME => PaymentIntent,
-        PaymentMethod::OBJECT_NAME => PaymentMethod,
-        Payout::OBJECT_NAME => Payout,
-        Person::OBJECT_NAME => Person,
-        Plan::OBJECT_NAME => Plan,
-        Price::OBJECT_NAME => Price,
-        Product::OBJECT_NAME => Product,
-        PromotionCode::OBJECT_NAME => PromotionCode,
-        Quote::OBJECT_NAME => Quote,
-        Radar::EarlyFraudWarning::OBJECT_NAME => Radar::EarlyFraudWarning,
-        Radar::ValueList::OBJECT_NAME => Radar::ValueList,
-        Radar::ValueListItem::OBJECT_NAME => Radar::ValueListItem,
-        Recipient::OBJECT_NAME => Recipient,
-        RecipientTransfer::OBJECT_NAME => RecipientTransfer,
-        Refund::OBJECT_NAME => Refund,
-        Reporting::ReportRun::OBJECT_NAME => Reporting::ReportRun,
-        Reporting::ReportType::OBJECT_NAME => Reporting::ReportType,
-        Reversal::OBJECT_NAME => Reversal,
-        Review::OBJECT_NAME => Review,
-        SetupAttempt::OBJECT_NAME => SetupAttempt,
-        SetupIntent::OBJECT_NAME => SetupIntent,
-        Sigma::ScheduledQueryRun::OBJECT_NAME => Sigma::ScheduledQueryRun,
-        SKU::OBJECT_NAME => SKU,
-        Source::OBJECT_NAME => Source,
-        SourceTransaction::OBJECT_NAME => SourceTransaction,
-        Subscription::OBJECT_NAME => Subscription,
-        SubscriptionItem::OBJECT_NAME => SubscriptionItem,
-        SubscriptionSchedule::OBJECT_NAME => SubscriptionSchedule,
-        TaxCode::OBJECT_NAME => TaxCode,
-        TaxId::OBJECT_NAME => TaxId,
-        TaxRate::OBJECT_NAME => TaxRate,
-        Terminal::ConnectionToken::OBJECT_NAME => Terminal::ConnectionToken,
-        Terminal::Location::OBJECT_NAME => Terminal::Location,
-        Terminal::Reader::OBJECT_NAME => Terminal::Reader,
-        ThreeDSecure::OBJECT_NAME => ThreeDSecure,
-        Token::OBJECT_NAME => Token,
-        Topup::OBJECT_NAME => Topup,
-        Transfer::OBJECT_NAME => Transfer,
-        UsageRecord::OBJECT_NAME => UsageRecord,
-        UsageRecordSummary::OBJECT_NAME => UsageRecordSummary,
-        WebhookEndpoint::OBJECT_NAME => WebhookEndpoint,
+        # object classes: The beginning of the section generated from our OpenAPI spec
+        Account.object_name => Account,
+        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,
+        Balance.object_name => Balance,
+        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,
+        Billing::MeterEventSummary.object_name => Billing::MeterEventSummary,
+        BillingPortal::Configuration.object_name => BillingPortal::Configuration,
+        BillingPortal::Session.object_name => BillingPortal::Session,
+        Capability.object_name => Capability,
+        Card.object_name => Card,
+        CashBalance.object_name => CashBalance,
+        Charge.object_name => Charge,
+        Checkout::Session.object_name => Checkout::Session,
+        Climate::Order.object_name => Climate::Order,
+        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,
+        CreditNoteLineItem.object_name => CreditNoteLineItem,
+        Customer.object_name => Customer,
+        CustomerBalanceTransaction.object_name => CustomerBalanceTransaction,
+        CustomerCashBalanceTransaction.object_name => CustomerCashBalanceTransaction,
+        CustomerSession.object_name => CustomerSession,
+        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,
+        ExchangeRate.object_name => ExchangeRate,
+        File.object_name => File,
+        FileLink.object_name => FileLink,
+        FinancialConnections::Account.object_name => FinancialConnections::Account,
+        FinancialConnections::AccountOwner.object_name => FinancialConnections::AccountOwner,
+        FinancialConnections::AccountOwnership.object_name => FinancialConnections::AccountOwnership,
+        FinancialConnections::Session.object_name => FinancialConnections::Session,
+        FinancialConnections::Transaction.object_name => FinancialConnections::Transaction,
+        Forwarding::Request.object_name => Forwarding::Request,
+        FundingInstructions.object_name => FundingInstructions,
+        Identity::VerificationReport.object_name => Identity::VerificationReport,
+        Identity::VerificationSession.object_name => Identity::VerificationSession,
+        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,
+        Issuing::Dispute.object_name => Issuing::Dispute,
+        Issuing::PersonalizationDesign.object_name => Issuing::PersonalizationDesign,
+        Issuing::PhysicalBundle.object_name => Issuing::PhysicalBundle,
+        Issuing::Token.object_name => Issuing::Token,
+        Issuing::Transaction.object_name => Issuing::Transaction,
+        LineItem.object_name => LineItem,
+        LoginLink.object_name => LoginLink,
+        Mandate.object_name => Mandate,
+        PaymentIntent.object_name => PaymentIntent,
+        PaymentLink.object_name => PaymentLink,
+        PaymentMethod.object_name => PaymentMethod,
+        PaymentMethodConfiguration.object_name => PaymentMethodConfiguration,
+        PaymentMethodDomain.object_name => PaymentMethodDomain,
+        Payout.object_name => Payout,
+        Person.object_name => Person,
+        Plan.object_name => Plan,
+        Price.object_name => Price,
+        Product.object_name => Product,
+        ProductFeature.object_name => ProductFeature,
+        PromotionCode.object_name => PromotionCode,
+        Quote.object_name => Quote,
+        Radar::EarlyFraudWarning.object_name => Radar::EarlyFraudWarning,
+        Radar::ValueList.object_name => Radar::ValueList,
+        Radar::ValueListItem.object_name => Radar::ValueListItem,
+        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,
+        SetupIntent.object_name => SetupIntent,
+        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,
+        SubscriptionSchedule.object_name => SubscriptionSchedule,
+        Tax::Calculation.object_name => Tax::Calculation,
+        Tax::CalculationLineItem.object_name => Tax::CalculationLineItem,
+        Tax::Registration.object_name => Tax::Registration,
+        Tax::Settings.object_name => Tax::Settings,
+        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,
+        Terminal::ConnectionToken.object_name => Terminal::ConnectionToken,
+        Terminal::Location.object_name => Terminal::Location,
+        Terminal::Reader.object_name => Terminal::Reader,
+        TestHelpers::TestClock.object_name => TestHelpers::TestClock,
+        Token.object_name => Token,
+        Topup.object_name => Topup,
+        Transfer.object_name => Transfer,
+        Treasury::CreditReversal.object_name => Treasury::CreditReversal,
+        Treasury::DebitReversal.object_name => Treasury::DebitReversal,
+        Treasury::FinancialAccount.object_name => Treasury::FinancialAccount,
+        Treasury::FinancialAccountFeatures.object_name => Treasury::FinancialAccountFeatures,
+        Treasury::InboundTransfer.object_name => Treasury::InboundTransfer,
+        Treasury::OutboundPayment.object_name => Treasury::OutboundPayment,
+        Treasury::OutboundTransfer.object_name => Treasury::OutboundTransfer,
+        Treasury::ReceivedCredit.object_name => Treasury::ReceivedCredit,
+        Treasury::ReceivedDebit.object_name => Treasury::ReceivedDebit,
+        Treasury::Transaction.object_name => Treasury::Transaction,
+        Treasury::TransactionEntry.object_name => Treasury::TransactionEntry,
+        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
 
+# rubocop:enable Metrics/AbcSize
 # rubocop:enable Metrics/MethodLength

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