stripe 13.2.0 → 13.3.0.pre.beta.1

data/lib/stripe/services/quote_preview_subscription_schedule_service.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class QuotePreviewSubscriptionScheduleService < StripeService
+    # Preview the schedules that would be generated by accepting the quote
+    def list(quote, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/preview_subscription_schedules", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/quote_service.rb

@@ -3,10 +3,14 @@
 
 module Stripe
   class QuoteService < StripeService
-    attr_reader :line_items, :computed_upfront_line_items
+    attr_reader :preview_invoices, :preview_subscription_schedules, :lines, :line_items, :computed_upfront_line_items
 
     def initialize(requestor)
       super(requestor)
+      @preview_invoices = Stripe::QuotePreviewInvoiceService.new(@requestor)
+      @preview_subscription_schedules = Stripe::QuotePreviewSubscriptionScheduleService
+                                        .new(@requestor)
+      @lines = Stripe::QuoteLineService.new(@requestor)
       @line_items = Stripe::QuoteLineItemService.new(@requestor)
       @computed_upfront_line_items = Stripe::QuoteComputedUpfrontLineItemsService.new(@requestor)
     end
@@ -54,6 +58,39 @@ module Stripe
       request(method: :get, path: "/v1/quotes", params: params, opts: opts, base_address: :api)
     end
 
+    # Preview the invoice line items that would be generated by accepting the quote.
+    def list_preview_invoice_lines(quote, preview_invoice, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/preview_invoices/%<preview_invoice>s/lines", { quote: CGI.escape(quote), preview_invoice: CGI.escape(preview_invoice) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Converts a stale quote to draft.
+    def mark_draft(quote, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/mark_draft", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Converts a draft or open quote to stale.
+    def mark_stale(quote, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/mark_stale", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    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 pdf(quote, params = {}, opts = {}, &read_body_chunk_block)
       opts = { api_base: APIRequestor.active_requestor.config.uploads_base }.merge(opts)
@@ -67,6 +104,17 @@ module Stripe
       )
     end
 
+    # Recompute the upcoming invoice estimate for the quote.
+    def reestimate(quote, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/reestimate", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
     # Retrieves the quote with the given ID.
     def retrieve(quote, params = {}, opts = {})
       request(

data/lib/stripe/services/subscription_schedule_service.rb

@@ -3,6 +3,17 @@
 
 module Stripe
   class SubscriptionScheduleService < StripeService
+    # Amends an existing subscription schedule.
+    def amend(schedule, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(schedule) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
     # Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
     def cancel(schedule, params = {}, opts = {})
       request(

data/lib/stripe/services/tax/association_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    class AssociationService < StripeService
+      # Finds a tax association object by PaymentIntent id.
+      def find(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/tax/associations/find",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/tax/form_service.rb

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Tax
+    class FormService < StripeService
+      # Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
+      def list(params = {}, opts = {})
+        request(method: :get, path: "/v1/tax/forms", params: params, opts: opts, base_address: :api)
+      end
+
+      # Download the PDF for a tax form.
+      def pdf(id, params = {}, opts = {}, &read_body_chunk_block)
+        opts = { api_base: APIRequestor.active_requestor.config.uploads_base }.merge(opts)
+        request_stream(
+          method: :get,
+          path: format("/v1/tax/forms/%<id>s/pdf", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :files,
+          &read_body_chunk_block
+        )
+      end
+
+      # Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/tax/forms/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/tax_service.rb

@@ -3,11 +3,13 @@
 
 module Stripe
   class TaxService < StripeService
-    attr_reader :calculations, :registrations, :settings, :transactions
+    attr_reader :associations, :calculations, :forms, :registrations, :settings, :transactions
 
     def initialize(requestor)
       super(requestor)
+      @associations = Stripe::Tax::AssociationService.new(@requestor)
       @calculations = Stripe::Tax::CalculationService.new(@requestor)
+      @forms = Stripe::Tax::FormService.new(@requestor)
       @registrations = Stripe::Tax::RegistrationService.new(@requestor)
       @settings = Stripe::Tax::SettingsService.new(@requestor)
       @transactions = Stripe::Tax::TransactionService.new(@requestor)

data/lib/stripe/services/terminal/reader_collected_data_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class ReaderCollectedDataService < StripeService
+      # Retrieve data collected using Reader hardware.
+      def retrieve(reader_collected_data, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/terminal/reader_collected_data/%<reader_collected_data>s", { reader_collected_data: CGI.escape(reader_collected_data) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/terminal/reader_service.rb

@@ -15,6 +15,39 @@ module Stripe
         )
       end
 
+      # Initiates an input collection flow on a Reader.
+      def collect_inputs(reader, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/collect_inputs", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation.
+      def collect_payment_method(reader, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/collect_payment_method", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Finalizes a payment on a Reader.
+      def confirm_payment_intent(reader, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/terminal/readers/%<reader>s/confirm_payment_intent", { reader: CGI.escape(reader) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
       # Creates a new Reader object.
       def create(params = {}, opts = {})
         request(

data/lib/stripe/services/terminal_service.rb

@@ -3,7 +3,7 @@
 
 module Stripe
   class TerminalService < StripeService
-    attr_reader :configurations, :connection_tokens, :locations, :readers
+    attr_reader :configurations, :connection_tokens, :locations, :readers, :reader_collected_data
 
     def initialize(requestor)
       super(requestor)
@@ -11,6 +11,7 @@ module Stripe
       @connection_tokens = Stripe::Terminal::ConnectionTokenService.new(@requestor)
       @locations = Stripe::Terminal::LocationService.new(@requestor)
       @readers = Stripe::Terminal::ReaderService.new(@requestor)
+      @reader_collected_data = Stripe::Terminal::ReaderCollectedDataService.new(@requestor)
     end
   end
 end

data/lib/stripe/services/v1_services.rb

@@ -4,7 +4,7 @@ module Stripe
   class V1Services < StripeService
     # v1 accessors: The beginning of the section generated from our OpenAPI spec
     attr_reader :accounts
-    attr_reader :account_links, :account_sessions, :apple_pay_domains, :application_fees, :apps, :balance, :balance_transactions, :billing, :billing_portal, :charges, :checkout, :climate, :confirmation_tokens, :test_helpers, :country_specs, :coupons, :credit_notes, :customers, :customer_sessions, :disputes, :entitlements, :ephemeral_keys, :events, :exchange_rates, :files, :file_links, :financial_connections, :forwarding, :identity, :invoices, :invoice_rendering_templates, :invoice_items, :issuing, :mandates, :payment_intents, :payment_links, :payment_methods, :payment_method_configurations, :payment_method_domains, :payouts, :plans, :prices, :products, :promotion_codes, :quotes, :radar, :refunds, :reporting, :reviews, :sigma, :setup_attempts, :setup_intents, :shipping_rates, :sources, :subscriptions, :subscription_items, :subscription_schedules, :tax, :tax_codes, :tax_ids, :tax_rates, :terminal, :tokens, :topups, :transfers, :treasury, :webhook_endpoints
+    attr_reader :account_links, :account_notices, :account_sessions, :apple_pay_domains, :application_fees, :apps, :balance, :balance_transactions, :billing, :billing_portal, :capital, :charges, :checkout, :climate, :confirmation_tokens, :test_helpers, :country_specs, :coupons, :credit_notes, :customers, :customer_sessions, :disputes, :entitlements, :ephemeral_keys, :events, :exchange_rates, :files, :file_links, :financial_connections, :forwarding, :gift_cards, :identity, :invoices, :invoice_rendering_templates, :invoice_items, :issuing, :mandates, :margins, :orders, :payment_attempt_records, :payment_intents, :payment_links, :payment_methods, :payment_method_configurations, :payment_method_domains, :payment_records, :payouts, :plans, :prices, :products, :promotion_codes, :quotes, :radar, :refunds, :reporting, :reviews, :sigma, :setup_attempts, :setup_intents, :shipping_rates, :sources, :subscriptions, :subscription_items, :subscription_schedules, :tax, :tax_codes, :tax_ids, :tax_rates, :terminal, :tokens, :topups, :transfers, :treasury, :webhook_endpoints
     # v1 accessors: The end of the section generated from our OpenAPI spec
 
     # OAuthService is manually maintained, as it has special behaviors
@@ -15,6 +15,7 @@ module Stripe
       # v1 services: The beginning of the section generated from our OpenAPI spec
       @accounts = Stripe::AccountService.new(@requestor)
       @account_links = Stripe::AccountLinkService.new(@requestor)
+      @account_notices = Stripe::AccountNoticeService.new(@requestor)
       @account_sessions = Stripe::AccountSessionService.new(@requestor)
       @apple_pay_domains = Stripe::ApplePayDomainService.new(@requestor)
       @application_fees = Stripe::ApplicationFeeService.new(@requestor)
@@ -23,6 +24,7 @@ module Stripe
       @balance_transactions = Stripe::BalanceTransactionService.new(@requestor)
       @billing = Stripe::BillingService.new(@requestor)
       @billing_portal = Stripe::BillingPortalService.new(@requestor)
+      @capital = Stripe::CapitalService.new(@requestor)
       @charges = Stripe::ChargeService.new(@requestor)
       @checkout = Stripe::CheckoutService.new(@requestor)
       @climate = Stripe::ClimateService.new(@requestor)
@@ -42,17 +44,22 @@ module Stripe
       @file_links = Stripe::FileLinkService.new(@requestor)
       @financial_connections = Stripe::FinancialConnectionsService.new(@requestor)
       @forwarding = Stripe::ForwardingService.new(@requestor)
+      @gift_cards = Stripe::GiftCardsService.new(@requestor)
       @identity = Stripe::IdentityService.new(@requestor)
       @invoices = Stripe::InvoiceService.new(@requestor)
       @invoice_rendering_templates = Stripe::InvoiceRenderingTemplateService.new(@requestor)
       @invoice_items = Stripe::InvoiceItemService.new(@requestor)
       @issuing = Stripe::IssuingService.new(@requestor)
       @mandates = Stripe::MandateService.new(@requestor)
+      @margins = Stripe::MarginService.new(@requestor)
+      @orders = Stripe::OrderService.new(@requestor)
+      @payment_attempt_records = Stripe::PaymentAttemptRecordService.new(@requestor)
       @payment_intents = Stripe::PaymentIntentService.new(@requestor)
       @payment_links = Stripe::PaymentLinkService.new(@requestor)
       @payment_methods = Stripe::PaymentMethodService.new(@requestor)
       @payment_method_configurations = Stripe::PaymentMethodConfigurationService.new(@requestor)
       @payment_method_domains = Stripe::PaymentMethodDomainService.new(@requestor)
+      @payment_records = Stripe::PaymentRecordService.new(@requestor)
       @payouts = Stripe::PayoutService.new(@requestor)
       @plans = Stripe::PlanService.new(@requestor)
       @prices = Stripe::PriceService.new(@requestor)

data/lib/stripe/services.rb

@@ -5,6 +5,7 @@ require "stripe/services/account_capability_service"
 require "stripe/services/account_external_account_service"
 require "stripe/services/account_link_service"
 require "stripe/services/account_login_link_service"
+require "stripe/services/account_notice_service"
 require "stripe/services/account_person_service"
 require "stripe/services/account_service"
 require "stripe/services/account_session_service"
@@ -27,6 +28,10 @@ require "stripe/services/billing_portal/configuration_service"
 require "stripe/services/billing_portal/session_service"
 require "stripe/services/billing_portal_service"
 require "stripe/services/billing_service"
+require "stripe/services/capital/financing_offer_service"
+require "stripe/services/capital/financing_summary_service"
+require "stripe/services/capital/financing_transaction_service"
+require "stripe/services/capital_service"
 require "stripe/services/charge_service"
 require "stripe/services/checkout/session_line_item_service"
 require "stripe/services/checkout/session_service"
@@ -59,37 +64,51 @@ require "stripe/services/event_service"
 require "stripe/services/exchange_rate_service"
 require "stripe/services/file_link_service"
 require "stripe/services/file_service"
+require "stripe/services/financial_connections/account_inferred_balance_service"
 require "stripe/services/financial_connections/account_owner_service"
 require "stripe/services/financial_connections/account_service"
+require "stripe/services/financial_connections/institution_service"
 require "stripe/services/financial_connections/session_service"
 require "stripe/services/financial_connections/transaction_service"
 require "stripe/services/financial_connections_service"
 require "stripe/services/forwarding/request_service"
 require "stripe/services/forwarding_service"
+require "stripe/services/gift_cards/card_service"
+require "stripe/services/gift_cards/transaction_service"
+require "stripe/services/gift_cards_service"
 require "stripe/services/identity/verification_report_service"
 require "stripe/services/identity/verification_session_service"
 require "stripe/services/identity_service"
 require "stripe/services/invoice_item_service"
 require "stripe/services/invoice_line_item_service"
+require "stripe/services/invoice_payment_service"
 require "stripe/services/invoice_rendering_template_service"
 require "stripe/services/invoice_service"
 require "stripe/services/invoice_upcoming_lines_service"
 require "stripe/services/issuing/authorization_service"
 require "stripe/services/issuing/card_service"
 require "stripe/services/issuing/cardholder_service"
+require "stripe/services/issuing/credit_underwriting_record_service"
 require "stripe/services/issuing/dispute_service"
+require "stripe/services/issuing/dispute_settlement_detail_service"
+require "stripe/services/issuing/fraud_liability_debit_service"
 require "stripe/services/issuing/personalization_design_service"
 require "stripe/services/issuing/physical_bundle_service"
 require "stripe/services/issuing/token_service"
 require "stripe/services/issuing/transaction_service"
 require "stripe/services/issuing_service"
 require "stripe/services/mandate_service"
+require "stripe/services/margin_service"
+require "stripe/services/order_line_item_service"
+require "stripe/services/order_service"
+require "stripe/services/payment_attempt_record_service"
 require "stripe/services/payment_intent_service"
 require "stripe/services/payment_link_line_item_service"
 require "stripe/services/payment_link_service"
 require "stripe/services/payment_method_configuration_service"
 require "stripe/services/payment_method_domain_service"
 require "stripe/services/payment_method_service"
+require "stripe/services/payment_record_service"
 require "stripe/services/payout_service"
 require "stripe/services/plan_service"
 require "stripe/services/price_service"
@@ -98,6 +117,9 @@ require "stripe/services/product_service"
 require "stripe/services/promotion_code_service"
 require "stripe/services/quote_computed_upfront_line_items_service"
 require "stripe/services/quote_line_item_service"
+require "stripe/services/quote_line_service"
+require "stripe/services/quote_preview_invoice_service"
+require "stripe/services/quote_preview_subscription_schedule_service"
 require "stripe/services/quote_service"
 require "stripe/services/radar/early_fraud_warning_service"
 require "stripe/services/radar/value_list_item_service"
@@ -120,8 +142,10 @@ require "stripe/services/subscription_item_usage_record_service"
 require "stripe/services/subscription_item_usage_record_summary_service"
 require "stripe/services/subscription_schedule_service"
 require "stripe/services/subscription_service"
+require "stripe/services/tax/association_service"
 require "stripe/services/tax/calculation_line_item_service"
 require "stripe/services/tax/calculation_service"
+require "stripe/services/tax/form_service"
 require "stripe/services/tax/registration_service"
 require "stripe/services/tax/settings_service"
 require "stripe/services/tax/transaction_line_item_service"
@@ -133,6 +157,7 @@ require "stripe/services/tax_service"
 require "stripe/services/terminal/configuration_service"
 require "stripe/services/terminal/connection_token_service"
 require "stripe/services/terminal/location_service"
+require "stripe/services/terminal/reader_collected_data_service"
 require "stripe/services/terminal/reader_service"
 require "stripe/services/terminal_service"
 require "stripe/services/test_helpers/confirmation_token_service"

data/lib/stripe/stripe_configuration.rb

@@ -25,7 +25,8 @@ module Stripe
   # If `.logger` is set, the value of `.log_level` is ignored. The decision on
   # what levels to print is entirely deferred to the logger.
   class StripeConfiguration
-    attr_accessor :api_key, :api_version, :client_id, :enable_telemetry, :logger, :stripe_account, :stripe_context
+    attr_accessor :api_key, :api_version, :authenticator, :client_id, :enable_telemetry, :logger,
+                  :stripe_account, :stripe_context
 
     attr_reader :api_base, :uploads_base, :connect_base, :meter_events_base, :base_addresses, :ca_bundle_path,
                 :log_level, :initial_network_retry_delay, :max_network_retries, :max_network_retry_delay,
@@ -52,6 +53,7 @@ module Stripe
 
     def initialize
       @api_version = ApiVersion::CURRENT
+
       @ca_bundle_path = Stripe::DEFAULT_CA_BUNDLE_PATH
       @enable_telemetry = true
       @verify_ssl_certs = true

data/lib/stripe/util.rb

@@ -300,7 +300,13 @@ module Stripe
       when String
         { api_key: opts }
       when Hash
-        check_api_key!(opts.fetch(:api_key)) if opts.key?(:api_key)
+        # If the user is using request signing for authentication,
+        # no need to check the api_key per request.
+        if !(opts.key?(:client) &&
+           opts.fetch(:client).config.authenticator) &&
+           opts.key?(:api_key)
+          check_api_key!(opts.fetch(:api_key))
+        end
         # Explicitly use dup here instead of clone to avoid preserving freeze
         # state on input params.
         opts.dup

data/lib/stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "13.2.0"
+  VERSION = "13.3.0-beta.1"
 end

data/lib/stripe.rb

@@ -13,6 +13,7 @@ require "set"
 require "socket"
 require "uri"
 require "forwardable"
+require "base64"
 
 # Version
 require "stripe/api_version"
@@ -50,6 +51,7 @@ require "stripe/api_resource_test_helpers"
 require "stripe/singleton_api_resource"
 require "stripe/webhook"
 require "stripe/stripe_configuration"
+require "stripe/request_signing_authenticator"
 require "stripe/thin_event"
 
 # Named API resources
@@ -85,6 +87,7 @@ module Stripe
 
     # User configurable options
     def_delegators :@config, :api_key, :api_key=
+    def_delegators :@config, :authenticator, :authenticator=
     def_delegators :@config, :api_version, :api_version=
     def_delegators :@config, :stripe_account, :stripe_account=
     def_delegators :@config, :api_base, :api_base=
@@ -132,6 +135,48 @@ module Stripe
       version: version,
     }
   end
+
+  def self.add_beta_version(beta_name, version)
+    if api_version.include?("; #{beta_name}=")
+      raise "Stripe version header #{api_version} already contains entry for beta #{beta_name}"
+    end
+
+    self.api_version = "#{api_version}; #{beta_name}=#{version}"
+  end
+
+  class RawRequest
+    def initialize
+      @opts = {}
+    end
+
+    def execute(method, url, base_address: :api, params: {}, opts: {}, usage: [])
+      opts = Util.normalize_opts(opts)
+      req_opts = RequestOptions.extract_opts_from_hash(opts)
+
+      requestor = APIRequestor.active_requestor
+      resp, = requestor.send(:execute_request_internal, method, url, base_address, params, req_opts,
+                             usage)
+
+      requestor.interpret_response(resp)
+    end
+  end
+
+  # Sends a request to Stripe REST API
+  def self.raw_request(method, url, params = {}, opts = {}, base_address: :api)
+    req = RawRequest.new
+    req.execute(method, url, base_address: base_address, params: params, opts: opts,
+                             usage: ["raw_request"])
+  end
+
+  def self.deserialize(data, api_mode: :v1)
+    data = JSON.parse(data) if data.is_a?(String)
+    Util.convert_to_stripe_object(data, {}, api_mode: api_mode)
+  end
+  class << self
+    extend Gem::Deprecate
+    deprecate :raw_request, "StripeClient#raw_request", 2024, 9
+    deprecate :deserialize, "StripeClient#deserialize", 2024, 9
+  end
 end
 
 Stripe.log_level = ENV["STRIPE_LOG"] unless ENV["STRIPE_LOG"].nil?