stripe 12.5.0 → 12.6.0.pre.beta.1

data/OPENAPI_VERSION

@@ -1 +1 @@
-v1187
+v1247

data/VERSION

@@ -1 +1 @@
-12.5.0
+12.6.0-beta.1

data/lib/stripe/api_operations/request.rb

@@ -48,13 +48,14 @@ module Stripe
           api_key = headers.delete(:api_key)
           api_base = headers.delete(:api_base)
           client = headers.delete(:client)
+          api_mode = headers.delete(:api_mode)
           # Assume all remaining opts must be headers
 
           resp, opts[:api_key] = client.send(
             client_request_method_sym,
             method, url,
             api_base: api_base, api_key: api_key,
-            headers: headers, params: params, usage: usage,
+            headers: headers, params: params, usage: usage, api_mode: api_mode,
             &read_body_chunk_block
           )
 

data/lib/stripe/api_version.rb

@@ -4,5 +4,6 @@
 module Stripe
   module ApiVersion
     CURRENT = "2024-06-20"
+    PREVIEW = "2024-09-05.preview-v2"
   end
 end

data/lib/stripe/object_types.rb

@@ -15,6 +15,7 @@ module Stripe
         # object classes: The beginning of the section generated from our OpenAPI spec
         Account.object_name => Account,
         AccountLink.object_name => AccountLink,
+        AccountNotice.object_name => AccountNotice,
         AccountSession.object_name => AccountSession,
         ApplePayDomain.object_name => ApplePayDomain,
         ApplicationFee.object_name => ApplicationFee,
@@ -31,6 +32,9 @@ module Stripe
         BillingPortal::Configuration.object_name => BillingPortal::Configuration,
         BillingPortal::Session.object_name => BillingPortal::Session,
         Capability.object_name => Capability,
+        Capital::FinancingOffer.object_name => Capital::FinancingOffer,
+        Capital::FinancingSummary.object_name => Capital::FinancingSummary,
+        Capital::FinancingTransaction.object_name => Capital::FinancingTransaction,
         Card.object_name => Card,
         CashBalance.object_name => CashBalance,
         Charge.object_name => Charge,
@@ -57,20 +61,27 @@ module Stripe
         File.object_name => File,
         FileLink.object_name => FileLink,
         FinancialConnections::Account.object_name => FinancialConnections::Account,
+        FinancialConnections::AccountInferredBalance.object_name =>
+        FinancialConnections::AccountInferredBalance,
         FinancialConnections::AccountOwner.object_name => FinancialConnections::AccountOwner,
         FinancialConnections::AccountOwnership.object_name => FinancialConnections::AccountOwnership,
+        FinancialConnections::Institution.object_name => FinancialConnections::Institution,
         FinancialConnections::Session.object_name => FinancialConnections::Session,
         FinancialConnections::Transaction.object_name => FinancialConnections::Transaction,
         Forwarding::Request.object_name => Forwarding::Request,
         FundingInstructions.object_name => FundingInstructions,
+        GiftCards::Card.object_name => GiftCards::Card,
+        GiftCards::Transaction.object_name => GiftCards::Transaction,
         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,
         Issuing::Authorization.object_name => Issuing::Authorization,
         Issuing::Card.object_name => Issuing::Card,
         Issuing::Cardholder.object_name => Issuing::Cardholder,
+        Issuing::CreditUnderwritingRecord.object_name => Issuing::CreditUnderwritingRecord,
         Issuing::Dispute.object_name => Issuing::Dispute,
         Issuing::PersonalizationDesign.object_name => Issuing::PersonalizationDesign,
         Issuing::PhysicalBundle.object_name => Issuing::PhysicalBundle,
@@ -79,6 +90,8 @@ module Stripe
         LineItem.object_name => LineItem,
         LoginLink.object_name => LoginLink,
         Mandate.object_name => Mandate,
+        Margin.object_name => Margin,
+        Order.object_name => Order,
         PaymentIntent.object_name => PaymentIntent,
         PaymentLink.object_name => PaymentLink,
         PaymentMethod.object_name => PaymentMethod,
@@ -92,6 +105,9 @@ module Stripe
         ProductFeature.object_name => ProductFeature,
         PromotionCode.object_name => PromotionCode,
         Quote.object_name => Quote,
+        QuotePhase.object_name => QuotePhase,
+        QuotePreviewInvoice.object_name => QuotePreviewInvoice,
+        QuotePreviewSubscriptionSchedule.object_name => QuotePreviewSubscriptionSchedule,
         Radar::EarlyFraudWarning.object_name => Radar::EarlyFraudWarning,
         Radar::ValueList.object_name => Radar::ValueList,
         Radar::ValueListItem.object_name => Radar::ValueListItem,
@@ -109,8 +125,10 @@ module Stripe
         Subscription.object_name => Subscription,
         SubscriptionItem.object_name => SubscriptionItem,
         SubscriptionSchedule.object_name => SubscriptionSchedule,
+        Tax::Association.object_name => Tax::Association,
         Tax::Calculation.object_name => Tax::Calculation,
         Tax::CalculationLineItem.object_name => Tax::CalculationLineItem,
+        Tax::Form.object_name => Tax::Form,
         Tax::Registration.object_name => Tax::Registration,
         Tax::Settings.object_name => Tax::Settings,
         Tax::Transaction.object_name => Tax::Transaction,
@@ -122,6 +140,7 @@ module Stripe
         Terminal::ConnectionToken.object_name => Terminal::ConnectionToken,
         Terminal::Location.object_name => Terminal::Location,
         Terminal::Reader.object_name => Terminal::Reader,
+        Terminal::ReaderCollectedData.object_name => Terminal::ReaderCollectedData,
         TestHelpers::TestClock.object_name => TestHelpers::TestClock,
         Token.object_name => Token,
         Topup.object_name => Topup,

data/lib/stripe/request_signing_authenticator.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Stripe
+  class RequestSigningAuthenticator
+    AUTHORIZATION_HEADER_NAME = "Authorization"
+    CONTENT_TYPE_HEADER_NAME = "Content-Type"
+    STRIPE_CONTEXT_HEADER_NAME = "Stripe-Context"
+    STRIPE_ACCOUNT_HEADER_NAME = "Stripe-Account"
+    CONTENT_DIGEST_HEADER_NAME = "Content-Digest"
+    SIGNATURE_INPUT_HEADER_NAME = "Signature-Input"
+    SIGNATURE_HEADER_NAME = "Signature"
+
+    attr_reader :auth_token, :sign_lambda
+
+    def initialize(auth_token, sign_lambda)
+      raise ArgumentError, "auth_token must be a string" unless auth_token.is_a?(String)
+      raise ArgumentError, "sign_lambda must be a lambda" unless sign_lambda.is_a?(Proc)
+
+      @auth_token = auth_token
+      @sign_lambda = sign_lambda
+    end
+
+    def authenticate(method, headers, body)
+      covered_headers = [CONTENT_TYPE_HEADER_NAME,
+                         CONTENT_DIGEST_HEADER_NAME,
+                         STRIPE_CONTEXT_HEADER_NAME,
+                         STRIPE_ACCOUNT_HEADER_NAME,
+                         AUTHORIZATION_HEADER_NAME,]
+
+      headers[AUTHORIZATION_HEADER_NAME] = "STRIPE-V2-SIG #{auth_token}"
+
+      if method == :get
+        covered_headers -= [CONTENT_TYPE_HEADER_NAME,
+                            CONTENT_DIGEST_HEADER_NAME,]
+      else
+        content = body || ""
+        headers[CONTENT_DIGEST_HEADER_NAME] =
+          %(sha-256=:#{content_digest(content)}:)
+      end
+
+      covered_headers_formatted = covered_headers
+                                  .map { |string| %("#{string.downcase}") }
+                                  .join(" ")
+
+      signature_input = "(#{covered_headers_formatted});created=#{created_time}"
+
+      inputs = covered_headers
+               .map { |header| %("#{header.downcase}": #{headers[header]}) }
+               .join("\n")
+
+      signature_base = %(#{inputs}\n"@signature-params": #{signature_input})
+                       .encode(Encoding::UTF_8)
+
+      headers[SIGNATURE_INPUT_HEADER_NAME] = "sig1=#{signature_input}"
+
+      headers[SIGNATURE_HEADER_NAME] =
+        "sig1=:#{encoded_signature(signature_base)}:"
+    end
+
+    private def sign(signature_base)
+      @sign_lambda.call(signature_base)
+    end
+
+    private def encoded_signature(signature_base)
+      Base64.strict_encode64(sign(signature_base))
+    rescue StandardError
+      raise AuthenticationError, "Encountered '#{e.message} (#{e.class})' " \
+                                 "when calculating request signature."
+    end
+
+    private def content_digest(content)
+      Base64.strict_encode64(OpenSSL::Digest.new("SHA256").digest(content))
+    end
+
+    private def created_time
+      Time.now.to_i
+    end
+  end
+end

data/lib/stripe/resources/account.rb

@@ -48,7 +48,7 @@ module Stripe
     #
     # Test-mode accounts can be deleted at any time.
     #
-    # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://stripe.com/api/balance/balanace_object) are zero.
+    # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://stripe.com/api/balance/balance_object) are zero.
     #
     # If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead.
     def self.delete(id, params = {}, opts = {})
@@ -64,7 +64,7 @@ module Stripe
     #
     # Test-mode accounts can be deleted at any time.
     #
-    # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://stripe.com/api/balance/balanace_object) are zero.
+    # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://stripe.com/api/balance/balance_object) are zero.
     #
     # If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead.
     def delete(params = {}, opts = {})

data/lib/stripe/resources/account_notice.rb

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # A notice to a Connected account. Notice can be sent by Stripe on your behalf or you can opt to send the notices yourself.
+  #
+  # See the [guide to send notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) to your connected accounts.
+  class AccountNotice < APIResource
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "account_notice"
+    def self.object_name
+      "account_notice"
+    end
+
+    # Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
+    def self.list(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/account_notices", params: filters, opts: opts)
+    end
+
+    # Updates an AccountNotice object.
+    def self.update(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/account_notices/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+  end
+end

data/lib/stripe/resources/capital/financing_offer.rb

@@ -0,0 +1,49 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    # This is an object representing an offer of financing from
+    # Stripe Capital to a Connect subaccount.
+    class FinancingOffer < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "capital.financing_offer"
+      def self.object_name
+        "capital.financing_offer"
+      end
+
+      # Retrieves the financing offers available for Connected accounts that belong to your platform.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/capital/financing_offers",
+          params: filters,
+          opts: opts
+        )
+      end
+
+      # Acknowledges that platform has received and delivered the financing_offer to
+      # the intended merchant recipient.
+      def mark_delivered(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Acknowledges that platform has received and delivered the financing_offer to
+      # the intended merchant recipient.
+      def self.mark_delivered(financing_offer, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(financing_offer) }),
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/capital/financing_summary.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    # A financing object describes an account's current financing state. Used by Connect
+    # platforms to read the state of Capital offered to their connected accounts.
+    class FinancingSummary < SingletonAPIResource
+      OBJECT_NAME = "capital.financing_summary"
+      def self.object_name
+        "capital.financing_summary"
+      end
+    end
+  end
+end

data/lib/stripe/resources/capital/financing_transaction.rb

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    # This is an object representing the details of a transaction on a Capital financing object.
+    class FinancingTransaction < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "capital.financing_transaction"
+      def self.object_name
+        "capital.financing_transaction"
+      end
+
+      # Returns a list of financing transactions. The transactions are returned in sorted order,
+      # with the most recent transactions appearing first.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/capital/financing_transactions",
+          params: filters,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/customer_session.rb

@@ -4,6 +4,10 @@
 module Stripe
   # A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access
   # control over a Customer.
+  #
+  # Related guides: [Customer Session with the Payment Element](https://stripe.com/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),
+  # [Customer Session with the Pricing Table](https://stripe.com/payments/checkout/pricing-table#customer-session),
+  # [Customer Session with the Buy Button](https://stripe.com/payment-links/buy-button#pass-an-existing-customer).
   class CustomerSession < APIResource
     extend Stripe::APIOperations::Create
 

data/lib/stripe/resources/file.rb

@@ -18,6 +18,23 @@ module Stripe
       "file"
     end
 
+    # To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.
+    #
+    # 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)
+    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.
     def self.list(filters = {}, opts = {})
       request_stripe_object(method: :get, path: "/v1/files", params: filters, opts: opts)
@@ -35,18 +52,5 @@ module Stripe
     def self.resource_url
       "/v1/files"
     end
-
-    def self.create(params = {}, opts = {})
-      if params[:file] && !params[:file].is_a?(String) && !params[:file].respond_to?(:read)
-        raise ArgumentError, "file must respond to `#read`"
-      end
-
-      config = opts[:client]&.config || Stripe.config
-      opts = {
-        api_base: config.uploads_base,
-        content_type: MultipartEncoder::MULTIPART_FORM_DATA,
-      }.merge(Util.normalize_opts(opts))
-      super
-    end
   end
 end

data/lib/stripe/resources/financial_connections/account.rb

@@ -6,12 +6,15 @@ module Stripe
     # A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.
     class Account < APIResource
       extend Stripe::APIOperations::List
+      extend Stripe::APIOperations::NestedResource
 
       OBJECT_NAME = "financial_connections.account"
       def self.object_name
         "financial_connections.account"
       end
 
+      nested_resource_class_methods :inferred_balance, operations: %i[list]
+
       # Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
       def disconnect(params = {}, opts = {})
         request_stripe_object(

data/lib/stripe/resources/financial_connections/account_inferred_balance.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    # A historical balance for the account on a particular day. It may be sourced from a balance snapshot provided by a financial institution, or inferred using transactions data.
+    class AccountInferredBalance < APIResource
+      OBJECT_NAME = "financial_connections.account_inferred_balance"
+      def self.object_name
+        "financial_connections.account_inferred_balance"
+      end
+    end
+  end
+end

data/lib/stripe/resources/financial_connections/institution.rb

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    # An institution represents a financial institution to which an end user can connect using the Financial Connections authentication flow.
+    class Institution < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "financial_connections.institution"
+      def self.object_name
+        "financial_connections.institution"
+      end
+
+      # Returns a list of Financial Connections Institution objects.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/financial_connections/institutions",
+          params: filters,
+          opts: opts
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module GiftCards
+    # A gift card represents a single gift card owned by a customer, including the
+    # remaining balance, gift card code, and whether or not it is active.
+    class Card < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "gift_cards.card"
+      def self.object_name
+        "gift_cards.card"
+      end
+
+      # Creates a new gift card object.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/gift_cards/cards",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # List gift cards for an account
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/gift_cards/cards",
+          params: filters,
+          opts: opts
+        )
+      end
+
+      # Update a gift card
+      def self.update(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/cards/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Validates a gift card code, returning the matching gift card object if it exists.
+      def self.validate(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/gift_cards/cards/validate",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module GiftCards
+    # A gift card transaction represents a single transaction on a referenced gift card.
+    # A transaction is in one of three states, `confirmed`, `held` or `canceled`. A `confirmed`
+    # transaction is one that has added/deducted funds. A `held` transaction has created a
+    # temporary hold on funds, which can then be cancelled or confirmed. A `held` transaction
+    # can be confirmed into a `confirmed` transaction, or canceled into a `canceled` transaction.
+    # A `canceled` transaction has no effect on a gift card's balance.
+    class Transaction < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "gift_cards.transaction"
+      def self.object_name
+        "gift_cards.transaction"
+      end
+
+      # Cancel a gift card transaction
+      def cancel(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/cancel", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Cancel a gift card transaction
+      def self.cancel(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/cancel", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Confirm a gift card transaction
+      def confirm(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/confirm", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Confirm a gift card transaction
+      def self.confirm(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/confirm", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Create a gift card transaction
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/gift_cards/transactions",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # List gift card transactions for a gift card
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/gift_cards/transactions",
+          params: filters,
+          opts: opts
+        )
+      end
+
+      # Update a gift card transaction
+      def self.update(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end