Add Stripe-Request-Trigger header (stripe#1805)

xavdid-stripe · web-flow · commit e6fa7786f9ff · 2026-03-05T15:36:44.000-08:00
* add "prepare" to justfile

* add Stripe-Request-Trigger header
diff --git a/justfile b/justfile
@@ -5,6 +5,9 @@ import? '../sdk-codegen/utils.just'
 _default:
     just --list --unsorted
 
+# ⭐ run lint, typecheck, and tests to prepare for CI
+prepare: lint typecheck test
+
 install *args:
     bundle install {{ if is_dependency() == "true" {"--quiet"} else {""} }} {{ args }}
 
diff --git a/lib/stripe/api_requestor.rb b/lib/stripe/api_requestor.rb
@@ -1093,13 +1093,13 @@ def self.uname_from_system_ver
       end
 
       AI_AGENTS = [
-        ["ANTIGRAVITY_CLI_ALIAS", "antigravity"],
-        ["CLAUDECODE", "claude_code"],
-        ["CLINE_ACTIVE", "cline"],
-        ["CODEX_SANDBOX", "codex_cli"],
-        ["CURSOR_AGENT", "cursor"],
-        ["GEMINI_CLI", "gemini_cli"],
-        ["OPENCODE", "open_code"],
+        %w[ANTIGRAVITY_CLI_ALIAS antigravity],
+        %w[CLAUDECODE claude_code],
+        %w[CLINE_ACTIVE cline],
+        %w[CODEX_SANDBOX codex_cli],
+        %w[CURSOR_AGENT cursor],
+        %w[GEMINI_CLI gemini_cli],
+        %w[OPENCODE open_code],
       ].freeze
 
       def self.detect_ai_agent(env = ENV)
diff --git a/lib/stripe/events/v1_billing_meter_error_report_triggered_event.rb b/lib/stripe/events/v1_billing_meter_error_report_triggered_event.rb
@@ -95,7 +95,7 @@ def fetch_related_object
           method: :get,
           path: related_object.url,
           base_address: :api,
-          opts: { stripe_context: context }
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
         )
       end
     end
@@ -113,7 +113,7 @@ def fetch_related_object
         resp = @client.raw_request(
           :get,
           related_object.url,
-          opts: { stripe_context: context },
+          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))
diff --git a/lib/stripe/events/v2_core_account_closed_event.rb b/lib/stripe/events/v2_core_account_closed_event.rb
@@ -15,7 +15,7 @@ def fetch_related_object
           method: :get,
           path: related_object.url,
           base_address: :api,
-          opts: { stripe_context: context }
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
         )
       end
       attr_reader :related_object
@@ -34,7 +34,7 @@ def fetch_related_object
         resp = @client.raw_request(
           :get,
           related_object.url,
-          opts: { stripe_context: context },
+          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))
diff --git a/lib/stripe/events/v2_core_account_created_event.rb b/lib/stripe/events/v2_core_account_created_event.rb
@@ -15,7 +15,7 @@ def fetch_related_object
           method: :get,
           path: related_object.url,
           base_address: :api,
-          opts: { stripe_context: context }
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
         )
       end
       attr_reader :related_object
@@ -34,7 +34,7 @@ def fetch_related_object
         resp = @client.raw_request(
           :get,
           related_object.url,
-          opts: { stripe_context: context },
+          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))
diff --git a/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb b/lib/stripe/events/v2_core_account_including_configuration_customer_capability_status_updated_event.rb
@@ -35,7 +35,7 @@ def fetch_related_object
           method: :get,
           path: related_object.url,
           base_address: :api,
-          opts: { stripe_context: context }
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
         )
       end
     end
@@ -53,7 +53,7 @@ def fetch_related_object
         resp = @client.raw_request(
           :get,
           related_object.url,
-          opts: { stripe_context: context },
+          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))
diff --git a/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb b/lib/stripe/events/v2_core_account_including_configuration_customer_updated_event.rb
@@ -15,7 +15,7 @@ def fetch_related_object
           method: :get,
           path: related_object.url,
           base_address: :api,
-          opts: { stripe_context: context }
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
         )
       end
       attr_reader :related_object
@@ -34,7 +34,7 @@ def fetch_related_object
         resp = @client.raw_request(
           :get,
           related_object.url,
-          opts: { stripe_context: context },
+          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))
diff --git a/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb b/lib/stripe/events/v2_core_account_including_configuration_merchant_capability_status_updated_event.rb
@@ -35,7 +35,7 @@ def fetch_related_object
           method: :get,
           path: related_object.url,
           base_address: :api,
-          opts: { stripe_context: context }
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
         )
       end
     end
@@ -53,7 +53,7 @@ def fetch_related_object
         resp = @client.raw_request(
           :get,
           related_object.url,
-          opts: { stripe_context: context },
+          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))
diff --git a/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb b/lib/stripe/events/v2_core_account_including_configuration_merchant_updated_event.rb
@@ -15,7 +15,7 @@ def fetch_related_object
           method: :get,
           path: related_object.url,
           base_address: :api,
-          opts: { stripe_context: context }
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
         )
       end
       attr_reader :related_object
@@ -34,7 +34,7 @@ def fetch_related_object
         resp = @client.raw_request(
           :get,
           related_object.url,
-          opts: { stripe_context: context },
+          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))
diff --git a/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb b/lib/stripe/events/v2_core_account_including_configuration_recipient_capability_status_updated_event.rb
@@ -35,7 +35,7 @@ def fetch_related_object
           method: :get,
           path: related_object.url,
           base_address: :api,
-          opts: { stripe_context: context }
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
         )
       end
     end
@@ -53,7 +53,7 @@ def fetch_related_object
         resp = @client.raw_request(
           :get,
           related_object.url,
-          opts: { stripe_context: context },
+          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))
diff --git a/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb b/lib/stripe/events/v2_core_account_including_configuration_recipient_updated_event.rb
@@ -15,7 +15,7 @@ def fetch_related_object
           method: :get,
           path: related_object.url,
           base_address: :api,
-          opts: { stripe_context: context }
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
         )
       end
       attr_reader :related_object
@@ -34,7 +34,7 @@ def fetch_related_object
         resp = @client.raw_request(
           :get,
           related_object.url,
-          opts: { stripe_context: context },
+          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))
diff --git a/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb b/lib/stripe/events/v2_core_account_including_defaults_updated_event.rb
@@ -15,7 +15,7 @@ def fetch_related_object
           method: :get,
           path: related_object.url,
           base_address: :api,
-          opts: { stripe_context: context }
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
         )
       end
       attr_reader :related_object
@@ -34,7 +34,7 @@ def fetch_related_object
         resp = @client.raw_request(
           :get,
           related_object.url,
-          opts: { stripe_context: context },
+          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))
diff --git a/lib/stripe/events/v2_core_account_including_future_requirements_updated_event.rb b/lib/stripe/events/v2_core_account_including_future_requirements_updated_event.rb
@@ -15,7 +15,7 @@ def fetch_related_object
           method: :get,
           path: related_object.url,
           base_address: :api,
-          opts: { stripe_context: context }
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
         )
       end
       attr_reader :related_object
@@ -34,7 +34,7 @@ def fetch_related_object
         resp = @client.raw_request(
           :get,
           related_object.url,
-          opts: { stripe_context: context },
+          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))
diff --git a/lib/stripe/events/v2_core_account_including_identity_updated_event.rb b/lib/stripe/events/v2_core_account_including_identity_updated_event.rb
@@ -15,7 +15,7 @@ def fetch_related_object
           method: :get,
           path: related_object.url,
           base_address: :api,
-          opts: { stripe_context: context }
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
         )
       end
       attr_reader :related_object
@@ -34,7 +34,7 @@ def fetch_related_object
         resp = @client.raw_request(
           :get,
           related_object.url,
-          opts: { stripe_context: context },
+          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))
diff --git a/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb b/lib/stripe/events/v2_core_account_including_requirements_updated_event.rb
@@ -15,7 +15,7 @@ def fetch_related_object
           method: :get,
           path: related_object.url,
           base_address: :api,
-          opts: { stripe_context: context }
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
         )
       end
       attr_reader :related_object
@@ -34,7 +34,7 @@ def fetch_related_object
         resp = @client.raw_request(
           :get,
           related_object.url,
-          opts: { stripe_context: context },
+          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))
diff --git a/lib/stripe/events/v2_core_account_person_created_event.rb b/lib/stripe/events/v2_core_account_person_created_event.rb
@@ -33,7 +33,7 @@ def fetch_related_object
           method: :get,
           path: related_object.url,
           base_address: :api,
-          opts: { stripe_context: context }
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
         )
       end
     end
@@ -51,7 +51,7 @@ def fetch_related_object
         resp = @client.raw_request(
           :get,
           related_object.url,
-          opts: { stripe_context: context },
+          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))
diff --git a/lib/stripe/events/v2_core_account_person_deleted_event.rb b/lib/stripe/events/v2_core_account_person_deleted_event.rb
@@ -33,7 +33,7 @@ def fetch_related_object
           method: :get,
           path: related_object.url,
           base_address: :api,
-          opts: { stripe_context: context }
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
         )
       end
     end
@@ -51,7 +51,7 @@ def fetch_related_object
         resp = @client.raw_request(
           :get,
           related_object.url,
-          opts: { stripe_context: context },
+          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))
diff --git a/lib/stripe/events/v2_core_account_person_updated_event.rb b/lib/stripe/events/v2_core_account_person_updated_event.rb
@@ -33,7 +33,7 @@ def fetch_related_object
           method: :get,
           path: related_object.url,
           base_address: :api,
-          opts: { stripe_context: context }
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
         )
       end
     end
@@ -51,7 +51,7 @@ def fetch_related_object
         resp = @client.raw_request(
           :get,
           related_object.url,
-          opts: { stripe_context: context },
+          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))
diff --git a/lib/stripe/events/v2_core_account_updated_event.rb b/lib/stripe/events/v2_core_account_updated_event.rb
@@ -15,7 +15,7 @@ def fetch_related_object
           method: :get,
           path: related_object.url,
           base_address: :api,
-          opts: { stripe_context: context }
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
         )
       end
       attr_reader :related_object
@@ -34,7 +34,7 @@ def fetch_related_object
         resp = @client.raw_request(
           :get,
           related_object.url,
-          opts: { stripe_context: context },
+          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))
diff --git a/lib/stripe/events/v2_core_event_destination_ping_event.rb b/lib/stripe/events/v2_core_event_destination_ping_event.rb
@@ -15,7 +15,7 @@ def fetch_related_object
           method: :get,
           path: related_object.url,
           base_address: :api,
-          opts: { stripe_context: context }
+          opts: { stripe_context: context, "Stripe-Request-Trigger": "event=#{id}" }
         )
       end
       attr_reader :related_object
@@ -34,7 +34,7 @@ def fetch_related_object
         resp = @client.raw_request(
           :get,
           related_object.url,
-          opts: { stripe_context: context },
+          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))
diff --git a/lib/stripe/resources/v2/core/event_notification.rb b/lib/stripe/resources/v2/core/event_notification.rb
@@ -52,7 +52,8 @@ def initialize(event_payload, client)
 
         # Retrieves the Event that generated this EventNotification.
         def fetch_event
-          resp = @client.raw_request(:get, "/v2/core/events/#{id}", opts: { stripe_context: context },
+          resp = @client.raw_request(:get, "/v2/core/events/#{id}", opts: { stripe_context: context,
+                                                                            "Stripe-Request-Trigger" => "event=#{id}", },
                                                                     usage: ["fetch_event"])
           @client.deserialize(resp.http_body, api_mode: :v2)
         end
diff --git a/test/stripe/api_requestor_test.rb b/test/stripe/api_requestor_test.rb
@@ -841,7 +841,7 @@ class RequestorTest < Test::Unit::TestCase
 
             stub_request(:post, "#{Stripe::DEFAULT_API_BASE}/v1/account")
               .with do |req|
-                assert_match(/AIAgent\/cursor$/, req.headers["User-Agent"])
+                assert_match(%r{AIAgent/cursor$}, req.headers["User-Agent"])
 
                 data = JSON.parse(req.headers["X-Stripe-Client-User-Agent"])
                 assert_equal "cursor", data["ai_agent"]
@@ -1760,19 +1760,19 @@ class SystemProfilerTest < Test::Unit::TestCase
 
     context ".detect_ai_agent" do
       should "detect agent when env var is set" do
-        assert_equal "claude_code", APIRequestor::SystemProfiler.detect_ai_agent({"CLAUDECODE" => "1"})
+        assert_equal "claude_code", APIRequestor::SystemProfiler.detect_ai_agent({ "CLAUDECODE" => "1" })
       end
 
       should "return empty string when no agent env vars are set" do
         assert_equal "", APIRequestor::SystemProfiler.detect_ai_agent({})
       end
 
       should "return first matching agent when multiple env vars are set" do
-        assert_equal "cursor", APIRequestor::SystemProfiler.detect_ai_agent({"CURSOR_AGENT" => "1", "OPENCODE" => "1"})
+        assert_equal "cursor", APIRequestor::SystemProfiler.detect_ai_agent({ "CURSOR_AGENT" => "1", "OPENCODE" => "1" })
       end
 
       should "ignore empty string env vars" do
-        assert_equal "", APIRequestor::SystemProfiler.detect_ai_agent({"CLAUDECODE" => ""})
+        assert_equal "", APIRequestor::SystemProfiler.detect_ai_agent({ "CLAUDECODE" => "" })
       end
     end
   end
diff --git a/test/stripe/v2_event_test.rb b/test/stripe/v2_event_test.rb
