stripe 20.1.0.pre.alpha.3 → 20.1.0.pre.alpha.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b64703617ce265046f5dbe18d6086a33e03314c04912c7d316cb4956d78ebbe
-  data.tar.gz: ebe9972ad850ba4309c6100b1221ebf6c182baa5d1eff88e544a862d099492f6
+  metadata.gz: d71cd26c3b7e58470fe45fd5b67a202423d14b1442b1eef7d438e7043224c330
+  data.tar.gz: 3f41a42dbdf2472269069de8bc6f240f2b5e1f720c626cf5ede531ae1dbf161d
 SHA512:
-  metadata.gz: ef80c9aa1e1ee02e15ab8d97975c227f57b40f36051456602557c41411835415521b7d7d04eaa8a0c2c841e661cd32deb8eac4445d2bc7374717e9cb8b108e29
-  data.tar.gz: 13d9691e5e715b0986f5983f76f4ad04fdf7bab55473b118820b539ac9a8a20ff31569c891c0b812fd5375a411800690ef7c29487834173084caae4672356dc2
+  metadata.gz: 3a63b8dac31659ff1bad67b0a14ef7a12413700470995a1ba6f70c6fb942b9e327d2c334ac75e64af110ce24e32283bc80b805a1a3c8e0f58780520df396d399
+  data.tar.gz: d79e658cd191c1f2fd2cb46716710cc6edd9504758aa7f8bc7dcb7a985f2d2111b71c2b8e5506a9d624973ce195d3bebf6508cdfd2d6fd836d1d37c16f3a9630

data/lib/stripe/api_requestor.rb

@@ -490,7 +490,12 @@ module Stripe
 
       api_key ||= opts[:api_key]
 
-      check_api_key!(api_key)
+      if config.authenticator && config.api_key
+        raise AuthenticationError,
+              "Can't specify both api_key and authenticator."
+      end
+
+      check_api_key!(api_key) if api_key || !config.authenticator
 
       body_params = nil
       query_params = nil
@@ -507,6 +512,8 @@ module Stripe
       headers = request_headers(method, api_mode, opts)
       url = api_url(path, base_url)
 
+      auth_overridden = opts[:api_key] || opts[:headers]&.key?("Authorization")
+
       # Merge given query parameters with any already encoded in the path.
       query = query_params ? Util.encode_parameters(query_params, api_mode) : nil
 
@@ -541,7 +548,7 @@ module Stripe
         end
 
       http_resp =
-        execute_request_with_rescues(base_url, headers, api_mode, usage, context) do
+        execute_request_with_rescues(base_url, headers, api_mode, usage, context, auth_overridden) do
           self.class
               .default_connection_manager(config)
               .execute_request(method, url,
@@ -621,8 +628,13 @@ module Stripe
       http_status >= 400
     end
 
-    private def execute_request_with_rescues(base_url, headers, api_mode, usage, context)
+    private def execute_request_with_rescues(base_url, headers, api_mode, usage, context, auth_overridden)
       num_retries = 0
+      auth_replayed = false
+      workload_credentials =
+        if !auth_overridden && config.authenticator.is_a?(WorkloadIdentity::Authenticator)
+          config.authenticator.credentials
+        end
 
       begin
         request_start = nil
@@ -670,6 +682,13 @@ module Stripe
         notify_request_end(context, request_duration, http_status, num_retries,
                            user_data, resp, headers)
 
+        if workload_credentials && !auth_replayed && e.is_a?(AuthenticationError) && e.http_status == 401
+          auth_replayed = true
+          workload_credentials.refresh_token(WorkloadIdentity.extract_bearer_token(headers["Authorization"]))
+          headers["Authorization"] = config.authenticator.call
+          retry
+        end
+
         if self.class.should_retry?(e,
                                     num_retries: num_retries,
                                     config: config)
@@ -1018,6 +1037,18 @@ module Stripe
             message + "\n\n(Network error: #{error.message})"
     end
 
+    private def build_authorization_header(req_opts)
+      return req_opts[:headers]["Authorization"] if req_opts[:headers]&.key?("Authorization")
+      return "Bearer #{req_opts[:api_key]}" if req_opts[:api_key] || !config.authenticator
+
+      value = config.authenticator.call
+      unless value.is_a?(String) && !value.empty?
+        raise AuthenticationError, "The configured authenticator did not return a usable Authorization " \
+                                   "header value."
+      end
+      value
+    end
+
     private def request_headers(method, api_mode, req_opts)
       user_agent = "Stripe/#{api_mode} RubyBindings/#{Stripe::VERSION}"
       user_agent += " " + format_app_info(Stripe.app_info) unless Stripe.app_info.nil?
@@ -1027,7 +1058,7 @@ module Stripe
 
       headers = {
         "User-Agent" => user_agent,
-        "Authorization" => "Bearer #{req_opts[:api_key]}",
+        "Authorization" => build_authorization_header(req_opts),
       }
 
       if config.enable_telemetry?

data/lib/stripe/errors.rb

@@ -49,6 +49,12 @@ module Stripe
   class APIConnectionError < StripeError
   end
 
+  # WorkloadIdentityError is raised when workload identity authentication
+  # fails, for example because the identity provider couldn't produce an
+  # assertion or the token exchange was rejected
+  class WorkloadIdentityError < StripeError
+  end
+
   # APIError is a generic error that may be raised in cases where none of the
   # other named errors cover the problem. It could also be raised in the case
   # that a new error has been introduced in the API, but this version of the

data/lib/stripe/event_types.rb

@@ -744,6 +744,8 @@ module Stripe
         Events::V2ReportingReportRunUpdatedEvent.lookup_type => Events::V2ReportingReportRunUpdatedEvent,
         Events::V2SignalsAccountEvaluationCompleteEvent.lookup_type =>
         Events::V2SignalsAccountEvaluationCompleteEvent,
+        Events::V2SignalsAccountSignalCustomerRiskReadyEvent.lookup_type =>
+        Events::V2SignalsAccountSignalCustomerRiskReadyEvent,
         Events::V2SignalsAccountSignalFraudulentMerchantReadyEvent.lookup_type =>
         Events::V2SignalsAccountSignalFraudulentMerchantReadyEvent,
         Events::V2SignalsAccountSignalFraudulentWebsiteReadyEvent.lookup_type =>
@@ -1645,6 +1647,8 @@ module Stripe
         Events::V2ReportingReportRunUpdatedEventNotification,
         Events::V2SignalsAccountEvaluationCompleteEventNotification.lookup_type =>
         Events::V2SignalsAccountEvaluationCompleteEventNotification,
+        Events::V2SignalsAccountSignalCustomerRiskReadyEventNotification.lookup_type =>
+        Events::V2SignalsAccountSignalCustomerRiskReadyEventNotification,
         Events::V2SignalsAccountSignalFraudulentMerchantReadyEventNotification.lookup_type =>
         Events::V2SignalsAccountSignalFraudulentMerchantReadyEventNotification,
         Events::V2SignalsAccountSignalFraudulentWebsiteReadyEventNotification.lookup_type =>

data/lib/stripe/events/v2_signals_account_signal_customer_risk_ready_event.rb

@@ -0,0 +1,44 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Events
+    # Occurs when a customer's risk level changes and a new customer risk signal is ready.
+    class V2SignalsAccountSignalCustomerRiskReadyEvent < Stripe::V2::Core::Event
+      def self.lookup_type
+        "v2.signals.account_signal.customer_risk_ready"
+      end
+
+      # Retrieves the related object from the API. Makes an API request on every call.
+      def fetch_related_object
+        _request(
+          method: :get,
+          path: related_object.url,
+          base_address: :api,
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
+        )
+      end
+      attr_reader :related_object
+    end
+
+    # Occurs when a customer's risk level changes and a new customer risk signal is ready.
+    class V2SignalsAccountSignalCustomerRiskReadyEventNotification < Stripe::V2::Core::EventNotification
+      def self.lookup_type
+        "v2.signals.account_signal.customer_risk_ready"
+      end
+
+      attr_reader :related_object
+
+      # Retrieves the AccountSignal related to this EventNotification from the Stripe API. Makes an API request on every call.
+      def fetch_related_object
+        resp = @client.raw_request(
+          :get,
+          related_object.url,
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" },
+          usage: ["fetch_related_object"]
+        )
+        @client.deserialize(resp.http_body, api_mode: Util.get_api_mode(related_object.url))
+      end
+    end
+  end
+end

data/lib/stripe/object_types.rb

@@ -171,6 +171,7 @@ module Stripe
         Reserve::Release.object_name => Reserve::Release,
         ReserveTransaction.object_name => ReserveTransaction,
         Review.object_name => Review,
+        Risk::Form.object_name => Risk::Form,
         RiskSignals.object_name => RiskSignals,
         SetupAttempt.object_name => SetupAttempt,
         SetupIntent.object_name => SetupIntent,
@@ -230,6 +231,7 @@ module Stripe
     def self.v2_object_names_to_classes
       {
         V2::ListObject.object_name => V2::ListObject,
+        V2::SearchResultObject.object_name => V2::SearchResultObject,
 
         # v2 object classes: The beginning of the section generated from our OpenAPI spec
         V2::Billing::BillSetting.object_name => V2::Billing::BillSetting,
@@ -290,6 +292,7 @@ module Stripe
         V2::Data::ReportRun.object_name => V2::Data::ReportRun,
         V2::Data::Reporting::QueryRun.object_name => V2::Data::Reporting::QueryRun,
         V2::Data::Schema.object_name => V2::Data::Schema,
+        V2::Data::SearchResultList.object_name => V2::Data::SearchResultList,
         V2::Extend::Workflow.object_name => V2::Extend::Workflow,
         V2::Extend::WorkflowRun.object_name => V2::Extend::WorkflowRun,
         V2::Iam::ActivityLog.object_name => V2::Iam::ActivityLog,

data/lib/stripe/params/account_create_params.rb

@@ -1691,7 +1691,7 @@ module Stripe
       end
 
       class Fees < ::Stripe::RequestParams
-        # A value indicating the responsible payer of Stripe fees on this account. Defaults to `account`. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).
+        # Controls who pays Stripe fees for direct charges and other pricing-control-eligible Stripe products. Setting `controller.losses.payments=application` requires `controller.fees.payer=application`. For destination charges and separate charges and transfers, Stripe bills the platform regardless of this setting. Defaults to `account`. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior), including application fees and pricing considerations.
         attr_accessor :payer
 
         def initialize(payer: nil)
@@ -1700,7 +1700,7 @@ module Stripe
       end
 
       class Losses < ::Stripe::RequestParams
-        # A value indicating who is liable when this account can't pay back negative balances resulting from payments. Defaults to `stripe`.
+        # Controls who is responsible for payment-related negative balances on this account. The platform remains liable for negative balances on its own account. To use Stripe negative balance liability, your integration must meet [Managed Risk requirements](https://docs.stripe.com/connect/risk-management/managed-risk). Defaults to `stripe`.
         attr_accessor :payments
 
         def initialize(payments: nil)
@@ -2687,7 +2687,7 @@ module Stripe
     attr_accessor :capabilities
     # Information about the company or business. This field is available for any `business_type`. Once you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property can only be updated for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.
     attr_accessor :company
-    # A hash of configuration describing the account controller's attributes.
+    # Configures the account's Dashboard access, loss liability, requirements collection, and Stripe fee responsibility.
     attr_accessor :controller
     # The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [Stripe's global markets](https://stripe.com/global) as well as countries where [cross-border payouts](https://stripe.com/docs/connect/cross-border-payouts) are supported.
     attr_accessor :country