stripe 4.21.3 → 5.52.0

data/lib/stripe/multipart_encoder.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require "securerandom"
+require "tempfile"
+
+module Stripe
+  # Encodes parameters into a `multipart/form-data` payload as described by RFC
+  # 2388:
+  #
+  #     https://tools.ietf.org/html/rfc2388
+  #
+  # This is most useful for transferring file-like objects.
+  #
+  # Parameters should be added with `#encode`. When ready, use `#body` to get
+  # the encoded result and `#content_type` to get the value that should be
+  # placed in the `Content-Type` header of a subsequent request (which includes
+  # a boundary value).
+  class MultipartEncoder
+    MULTIPART_FORM_DATA = "multipart/form-data"
+
+    # A shortcut for encoding a single set of parameters and finalizing a
+    # result.
+    #
+    # Returns an encoded body and the value that should be set in the content
+    # type header of a subsequent request.
+    def self.encode(params)
+      encoder = MultipartEncoder.new
+      encoder.encode(params)
+      encoder.close
+      [encoder.body, encoder.content_type]
+    end
+
+    # Gets the object's randomly generated boundary string.
+    attr_reader :boundary
+
+    # Initializes a new multipart encoder.
+    def initialize
+      # Kind of weird, but required by Rubocop because the unary plus operator
+      # is considered faster than `Stripe.new`.
+      @body = +""
+
+      # Chose the same number of random bytes that Go uses in its standard
+      # library implementation. Easily enough entropy to ensure that it won't
+      # be present in a file we're sending.
+      @boundary = SecureRandom.hex(30)
+
+      @closed = false
+      @first_field = true
+    end
+
+    # Gets the encoded body. `#close` must be called first.
+    def body
+      raise "object must be closed before getting body" unless @closed
+
+      @body
+    end
+
+    # Finalizes the object by writing the final boundary.
+    def close
+      raise "object already closed" if @closed
+
+      @body << "\r\n"
+      @body << "--#{@boundary}--"
+
+      @closed = true
+
+      nil
+    end
+
+    # Gets the value including boundary that should be put into a multipart
+    # request's `Content-Type`.
+    def content_type
+      "#{MULTIPART_FORM_DATA}; boundary=#{@boundary}"
+    end
+
+    # Encodes a set of parameters to the body.
+    #
+    # Note that parameters are expected to be a hash, but a "flat" hash such
+    # that complex substructures like hashes and arrays have already been
+    # appropriately Stripe-encoded. Pass a complex structure through
+    # `Util.flatten_params` first before handing it off to this method.
+    def encode(params)
+      raise "no more parameters can be written to closed object" if @closed
+
+      params.each do |name, val|
+        if val.is_a?(::File) || val.is_a?(::Tempfile)
+          write_field(name, val.read, filename: ::File.basename(val.path))
+        elsif val.respond_to?(:read)
+          write_field(name, val.read, filename: "blob")
+        else
+          write_field(name, val, filename: nil)
+        end
+      end
+
+      nil
+    end
+
+    #
+    # private
+    #
+
+    # Escapes double quotes so that the given value can be used in a
+    # double-quoted string and replaces any linebreak characters with spaces.
+    private def escape(str)
+      str.gsub('"', "%22").tr("\n", " ").tr("\r", " ")
+    end
+
+    private def write_field(name, data, filename:)
+      if !@first_field
+        @body << "\r\n"
+      else
+        @first_field = false
+      end
+
+      @body << "--#{@boundary}\r\n"
+
+      if filename
+        @body << %(Content-Disposition: form-data) +
+                 %(; name="#{escape(name.to_s)}") +
+                 %(; filename="#{escape(filename)}"\r\n)
+        @body << %(Content-Type: application/octet-stream\r\n)
+      else
+        @body << %(Content-Disposition: form-data) +
+                 %(; name="#{escape(name.to_s)}"\r\n)
+      end
+
+      @body << "\r\n"
+      @body << data.to_s
+    end
+  end
+end

data/lib/stripe/oauth.rb

@@ -5,10 +5,10 @@ module Stripe
     module OAuthOperations
       extend APIOperations::Request::ClassMethods
 
-      def self.request(method, url, params, opts)
+      def self.execute_resource_request(method, url, params, opts)
         opts = Util.normalize_opts(opts)
-        opts[:client] ||= StripeClient.active_client
-        opts[:api_base] ||= Stripe.connect_base
+        opts[:client] ||= opts[:client] || StripeClient.active_client
+        opts[:api_base] ||= opts[:client].config.connect_base
 
         super(method, url, params, opts)
       end
@@ -29,7 +29,8 @@ module Stripe
     end
 
     def self.authorize_url(params = {}, opts = {})
-      base = opts[:connect_base] || Stripe.connect_base
+      client = opts[:client] || StripeClient.active_client
+      base = opts[:connect_base] || client.config.connect_base
 
       path = "/oauth/authorize"
       path = "/express" + path if opts[:express]
@@ -43,7 +44,8 @@ module Stripe
 
     def self.token(params = {}, opts = {})
       opts = Util.normalize_opts(opts)
-      resp, opts = OAuthOperations.request(
+      opts[:api_key] = params[:client_secret] if params[:client_secret]
+      resp, opts = OAuthOperations.execute_resource_request(
         :post, "/oauth/token", params, opts
       )
       # This is just going to return a generic StripeObject, but that's okay
@@ -53,7 +55,7 @@ module Stripe
     def self.deauthorize(params = {}, opts = {})
       opts = Util.normalize_opts(opts)
       params[:client_id] = get_client_id(params)
-      resp, opts = OAuthOperations.request(
+      resp, opts = OAuthOperations.execute_resource_request(
         :post, "/oauth/deauthorize", params, opts
       )
       # This is just going to return a generic StripeObject, but that's okay

data/lib/stripe/object_types.rb

@@ -1,6 +1,6 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/LineLength
 # rubocop:disable Metrics/MethodLength
 
 module Stripe
@@ -9,6 +9,7 @@ module Stripe
       {
         # data structures
         ListObject::OBJECT_NAME => ListObject,
+        SearchResultObject::OBJECT_NAME => SearchResultObject,
 
         # business objects
         Account::OBJECT_NAME => Account,
@@ -20,6 +21,8 @@ module Stripe
         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,
@@ -29,6 +32,7 @@ module Stripe
         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,
@@ -39,25 +43,33 @@ module Stripe
         File::OBJECT_NAME => File,
         File::OBJECT_NAME_ALT => File,
         FileLink::OBJECT_NAME => FileLink,
+        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,
-        IssuerFraudRecord::OBJECT_NAME => IssuerFraudRecord,
         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,
+        PaymentLink::OBJECT_NAME => PaymentLink,
         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,
@@ -68,20 +80,24 @@ module Stripe
         Reporting::ReportType::OBJECT_NAME => Reporting::ReportType,
         Reversal::OBJECT_NAME => Reversal,
         Review::OBJECT_NAME => Review,
-        SKU::OBJECT_NAME => SKU,
+        SetupAttempt::OBJECT_NAME => SetupAttempt,
         SetupIntent::OBJECT_NAME => SetupIntent,
+        ShippingRate::OBJECT_NAME => ShippingRate,
         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,
-        SubscriptionScheduleRevision::OBJECT_NAME => SubscriptionScheduleRevision,
+        TaxCode::OBJECT_NAME => TaxCode,
         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,
         ThreeDSecure::OBJECT_NAME => ThreeDSecure,
         Token::OBJECT_NAME => Token,
         Topup::OBJECT_NAME => Topup,
@@ -94,5 +110,4 @@ module Stripe
   end
 end
 
-# rubocop:enable Metrics/LineLength
 # rubocop:enable Metrics/MethodLength

data/lib/stripe/resources/account.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
@@ -9,7 +10,7 @@ module Stripe
     include Stripe::APIOperations::Save
     extend Stripe::APIOperations::NestedResource
 
-    OBJECT_NAME = "account".freeze
+    OBJECT_NAME = "account"
 
     custom_method :reject, http_verb: :post
 
@@ -20,8 +21,12 @@ module Stripe
                                   operations: %i[create retrieve update delete list]
 
     def reject(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/reject", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/reject",
+        params: params,
+        opts: opts
+      )
     end
 
     save_nested_resource :external_account
@@ -31,10 +36,6 @@ module Stripe
 
     nested_resource_class_methods :login_link, operations: %i[create]
 
-    # This method is deprecated. Please use `#external_account=` instead.
-    save_nested_resource :bank_account
-    deprecate :bank_account=, "#external_account=", 2017, 8
-
     def resource_url
       if self["id"]
         super
@@ -44,12 +45,8 @@ module Stripe
     end
 
     # @override To make id optional
-    def self.retrieve(id = ARGUMENT_NOT_PROVIDED, opts = {})
-      id = if id.equal?(ARGUMENT_NOT_PROVIDED)
-             nil
-           else
-             Util.check_string_argument!(id)
-           end
+    def self.retrieve(id = nil, opts = {})
+      Util.check_string_argument!(id) if id
 
       # Account used to be a singleton, where this method's signature was
       # `(opts={})`. For the sake of not breaking folks who pass in an OAuth
@@ -64,7 +61,7 @@ module Stripe
     end
 
     def persons(params = {}, opts = {})
-      resp, opts = request(:get, resource_url + "/persons", params, opts)
+      resp, opts = execute_resource_request(:get, resource_url + "/persons", params, opts)
       Util.convert_to_stripe_object(resp.data, opts)
     end
 
@@ -135,11 +132,10 @@ module Stripe
         client_id: client_id,
         stripe_user_id: id,
       }
+      opts = @opts.merge(Util.normalize_opts(opts))
       OAuth.deauthorize(params, opts)
     end
 
-    ARGUMENT_NOT_PROVIDED = Object.new
-
     private def serialize_additional_owners(legal_entity, additional_owners)
       original_value =
         legal_entity

data/lib/stripe/resources/account_link.rb

@@ -1,9 +1,10 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
   class AccountLink < APIResource
     extend Stripe::APIOperations::Create
 
-    OBJECT_NAME = "account_link".freeze
+    OBJECT_NAME = "account_link"
   end
 end

data/lib/stripe/resources/alipay_account.rb

@@ -5,7 +5,7 @@ module Stripe
     include Stripe::APIOperations::Save
     include Stripe::APIOperations::Delete
 
-    OBJECT_NAME = "alipay_account".freeze
+    OBJECT_NAME = "alipay_account"
 
     def resource_url
       if !respond_to?(:customer) || customer.nil?

data/lib/stripe/resources/apple_pay_domain.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
@@ -7,7 +8,7 @@ module Stripe
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = "apple_pay_domain".freeze
+    OBJECT_NAME = "apple_pay_domain"
 
     def self.resource_url
       "/v1/apple_pay/domains"

data/lib/stripe/resources/application_fee.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
@@ -5,20 +6,9 @@ module Stripe
     extend Stripe::APIOperations::List
     extend Stripe::APIOperations::NestedResource
 
-    OBJECT_NAME = "application_fee".freeze
+    OBJECT_NAME = "application_fee"
 
     nested_resource_class_methods :refund,
                                   operations: %i[create retrieve update list]
-
-    # If you don't need access to an updated fee object after the refund, it's
-    # more performant to just call `fee.refunds.create` directly.
-    def refund(params = {}, opts = {})
-      refunds.create(params, opts)
-
-      # now that a refund has been created, we expect the state of this object
-      # to change as well (i.e. `refunded` will now be `true`) so refresh it
-      # from the server
-      refresh
-    end
   end
 end

data/lib/stripe/resources/application_fee_refund.rb

@@ -1,11 +1,12 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
   class ApplicationFeeRefund < APIResource
-    include Stripe::APIOperations::Save
     extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
 
-    OBJECT_NAME = "fee_refund".freeze
+    OBJECT_NAME = "fee_refund"
 
     def resource_url
       "#{ApplicationFee.resource_url}/#{CGI.escape(fee)}/refunds" \

data/lib/stripe/resources/balance.rb

@@ -1,7 +1,8 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
   class Balance < SingletonAPIResource
-    OBJECT_NAME = "balance".freeze
+    OBJECT_NAME = "balance"
   end
 end

data/lib/stripe/resources/balance_transaction.rb

@@ -1,13 +1,10 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
   class BalanceTransaction < APIResource
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = "balance_transaction".freeze
-
-    def self.resource_url
-      "/v1/balance/history"
-    end
+    OBJECT_NAME = "balance_transaction"
   end
 end

data/lib/stripe/resources/bank_account.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
@@ -6,10 +7,10 @@ module Stripe
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
 
-    OBJECT_NAME = "bank_account".freeze
+    OBJECT_NAME = "bank_account"
 
     def verify(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/verify", params, opts)
+      resp, opts = execute_resource_request(:post, resource_url + "/verify", params, opts)
       initialize_from(resp.data, opts)
     end
 

data/lib/stripe/resources/billing_portal/configuration.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module BillingPortal
+    class Configuration < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "billing_portal.configuration"
+    end
+  end
+end

data/lib/stripe/resources/billing_portal/session.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module BillingPortal
+    class Session < APIResource
+      extend Stripe::APIOperations::Create
+
+      OBJECT_NAME = "billing_portal.session"
+    end
+  end
+end

data/lib/stripe/resources/bitcoin_receiver.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
@@ -6,7 +7,7 @@ module Stripe
   class BitcoinReceiver < APIResource
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = "bitcoin_receiver".freeze
+    OBJECT_NAME = "bitcoin_receiver"
 
     def self.resource_url
       "/v1/bitcoin/receivers"

data/lib/stripe/resources/bitcoin_transaction.rb

@@ -1,12 +1,13 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
+  # Directly retrieving BitcoinTransactions is deprecated. Please use
+  # the Sources API instead: https://stripe.com/docs/sources/bitcoin
   class BitcoinTransaction < APIResource
-    # Directly retrieving BitcoinTransactions is deprecated. Please use the
-    # Sources API instead: https://stripe.com/docs/sources/bitcoin
     extend Stripe::APIOperations::List
 
-    OBJECT_NAME = "bitcoin_transaction".freeze
+    OBJECT_NAME = "bitcoin_transaction"
 
     def self.resource_url
       "/v1/bitcoin/transactions"

data/lib/stripe/resources/capability.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
@@ -5,7 +6,7 @@ module Stripe
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
 
-    OBJECT_NAME = "capability".freeze
+    OBJECT_NAME = "capability"
 
     def resource_url
       if !respond_to?(:account) || account.nil?
@@ -26,7 +27,7 @@ module Stripe
     def self.update(_id, _params = nil, _opts = nil)
       raise NotImplementedError,
             "Capabilities cannot be updated without an account ID. Update a " \
-            "capability using Account.update_capability('account_id', " \
+            "capability using `Account.update_capability('account_id', " \
             "'capability_id', update_params)`"
     end
   end

data/lib/stripe/resources/card.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
@@ -6,7 +7,7 @@ module Stripe
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
 
-    OBJECT_NAME = "card".freeze
+    OBJECT_NAME = "card"
 
     def resource_url
       if respond_to?(:recipient) && !recipient.nil? && !recipient.empty?

data/lib/stripe/resources/charge.rb

@@ -1,84 +1,32 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
   class Charge < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
-    OBJECT_NAME = "charge".freeze
+    OBJECT_NAME = "charge"
 
     custom_method :capture, http_verb: :post
 
-    def refund(params = {}, opts = {})
-      # Old versions of charge objects included a `refunds` field that was just
-      # a vanilla array instead of a Stripe list object.
-      #
-      # Where possible, we'd still like to use the new refund endpoint (thus
-      # `self.refunds.create`), but detect the old API version by looking for
-      # an `Array` and fall back to the old refund URL if necessary so as to
-      # maintain internal compatibility.
-      if refunds.is_a?(Array)
-        resp, opts = request(:post, refund_url, params, opts)
-        initialize_from(resp.data, opts)
-      else
-        refunds.create(params, opts)
-
-        # now that a refund has been created, we expect the state of this object
-        # to change as well (i.e. `refunded` will now be `true`) so refresh it
-        # from the server
-        refresh
-      end
-    end
-
     def capture(params = {}, opts = {})
-      resp, opts = request(:post, capture_url, params, opts)
-      initialize_from(resp.data, opts)
-    end
-
-    def update_dispute(params = {}, opts = {})
-      resp, opts = request(:post, dispute_url, params, opts)
-      initialize_from({ dispute: resp.data }, opts, true)
-      dispute
-    end
-
-    def close_dispute(params = {}, opts = {})
-      resp, opts = request(:post, close_dispute_url, params, opts)
-      initialize_from(resp.data, opts)
-    end
-
-    def mark_as_fraudulent
-      params = {
-        fraud_details: { user_report: "fraudulent" },
-      }
-      resp, opts = request(:post, resource_url, params)
-      initialize_from(resp.data, opts)
-    end
-
-    def mark_as_safe
-      params = {
-        fraud_details: { user_report: "safe" },
-      }
-      resp, opts = request(:post, resource_url, params)
-      initialize_from(resp.data, opts)
-    end
-
-    private def capture_url
-      resource_url + "/capture"
-    end
-
-    private def dispute_url
-      resource_url + "/dispute"
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/capture",
+        params: params,
+        opts: opts
+      )
     end
 
-    private def close_dispute_url
-      resource_url + "/dispute/close"
+    def self.search(params = {}, opts = {})
+      _search("/v1/charges/search", params, opts)
     end
 
-    # Note that this is actually the *old* refund URL and its use is no longer
-    # preferred.
-    private def refund_url
-      resource_url + "/refund"
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
     end
   end
 end