firecrawl-sdk 1.10.1 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0288d4900a5d0aeb3b9297736dd51bb6680fbf75b0d1b8c9db1363b3305e447
-  data.tar.gz: b95ec088c925c079ef13c22a7bd1ce102eff4832d1a9f256a07f103af1368e1a
+  metadata.gz: d608bb13154ad02ebe2a4925c4c12674b9a0d6160a20af3357fc882846b82a45
+  data.tar.gz: d8c167c5fe3709c140a2f97f1dc6e4bbb12aa9dcfa88d14f921e59ee4d6c8ca5
 SHA512:
-  metadata.gz: 1d832b4c6ca41f38980106df572ae76ed8467ff487c56c67ba2573af198a59fac5ef7c6b3e5344b7a3d5fd5a2c83f81de8d2248e368d66cd3906f0b972cb5f2e
-  data.tar.gz: 2eb53a25b4727c901caa5df7be4b63e6815593fedf20fd8bc66da850cca9109fc23b766dfeb68eb7f2065ea2085075313f3316f3e73aad14354df29552490f1e
+  metadata.gz: 61230d82a359bbd4334b3bab3c8c7863ca27e1dba5f0a4781b5672b5108fb7afaeb2e85d573f8247a8f1df93a3472921820b36ecf18c26c04e410384780f292b
+  data.tar.gz: c0172fda9bc21d6fa4132ebc9b6e606cb39a9ec9a8bc9276d0d44906b1ca012ad83a5500e37984f58b1d47f84f608c68363d81f2a32788187fbbbdda359d4d97

data/lib/firecrawl/models/agent_options.rb

@@ -6,13 +6,16 @@ module Firecrawl
     class AgentOptions
       FIELDS = %i[
         urls prompt schema integration max_credits
-        strict_constrain_to_urls model webhook
+        strict_constrain_to_urls model webhook audit_metadata
       ].freeze
 
       attr_reader(*FIELDS)
 
       def initialize(**kwargs)
         FIELDS.each { |f| instance_variable_set(:"@#{f}", kwargs[f]) }
+        if audit_metadata && !audit_metadata.is_a?(AuditMetadata)
+          raise ArgumentError, "audit_metadata must be an AuditMetadata"
+        end
         raise ArgumentError, "Agent prompt is required" if prompt.nil? || prompt.empty?
       end
 
@@ -26,6 +29,7 @@ module Firecrawl
           "strictConstrainToURLs" => strict_constrain_to_urls,
           "model" => model,
           "webhook" => webhook.is_a?(Hash) ? webhook : webhook&.to_h,
+          "auditMetadata" => audit_metadata&.to_h,
         }.compact
       end
     end

data/lib/firecrawl/models/audit_metadata.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Firecrawl
+  module Models
+    # User attribution included with SIEM logging events.
+    class AuditMetadata
+      attr_reader :username
+
+      def initialize(username:)
+        raise ArgumentError, "username must be a string" unless username.is_a?(String)
+
+        @username = username
+      end
+
+      def to_h
+        { "username" => username }
+      end
+    end
+  end
+end

data/lib/firecrawl/models/map_options.rb

@@ -6,13 +6,16 @@ module Firecrawl
     class MapOptions
       FIELDS = %i[
         search sitemap include_subdomains ignore_query_parameters
-        limit timeout integration location
+        limit timeout integration location audit_metadata
       ].freeze
 
       attr_reader(*FIELDS)
 
       def initialize(**kwargs)
         FIELDS.each { |f| instance_variable_set(:"@#{f}", kwargs[f]) }
+        if audit_metadata && !audit_metadata.is_a?(AuditMetadata)
+          raise ArgumentError, "audit_metadata must be an AuditMetadata"
+        end
       end
 
       def to_h
@@ -25,6 +28,7 @@ module Firecrawl
           "timeout" => timeout,
           "integration" => integration,
           "location" => location.is_a?(Hash) ? location : location&.to_h,
+          "auditMetadata" => audit_metadata&.to_h,
         }.compact
       end
     end

data/lib/firecrawl/models/parse_options.rb

@@ -13,13 +13,16 @@ module Firecrawl
       FIELDS = %i[
         formats headers include_tags exclude_tags only_main_content
         timeout parsers skip_tls_verification remove_base64_images
-        block_ads proxy integration redact_pii json_options
+        block_ads proxy integration redact_pii json_options audit_metadata
       ].freeze
 
       attr_reader(*FIELDS)
 
       def initialize(**kwargs)
         FIELDS.each { |f| instance_variable_set(:"@#{f}", kwargs[f]) }
+        if audit_metadata && !audit_metadata.is_a?(AuditMetadata)
+          raise ArgumentError, "audit_metadata must be an AuditMetadata"
+        end
 
         validate!
       end
@@ -40,6 +43,7 @@ module Firecrawl
           "integration" => integration,
           "redactPII" => redact_pii,
           "jsonOptions" => json_options.is_a?(Hash) ? json_options : json_options&.to_h,
+          "auditMetadata" => audit_metadata&.to_h,
         }.compact
       end
 

data/lib/firecrawl/models/scrape_options.rb

@@ -8,13 +8,16 @@ module Firecrawl
         formats headers include_tags exclude_tags only_main_content
         timeout wait_for mobile parsers actions location
         skip_tls_verification remove_base64_images block_ads proxy
-        max_age store_in_cache lockdown redact_pii integration
+        max_age store_in_cache lockdown redact_pii integration audit_metadata
       ].freeze
 
       attr_reader(*FIELDS)
 
       def initialize(**kwargs)
         FIELDS.each { |f| instance_variable_set(:"@#{f}", kwargs[f]) }
+        if audit_metadata && !audit_metadata.is_a?(AuditMetadata)
+          raise ArgumentError, "audit_metadata must be an AuditMetadata"
+        end
         @skip_tls_verification = false if @skip_tls_verification.nil?
       end
 
@@ -40,6 +43,7 @@ module Firecrawl
           "lockdown" => lockdown,
           "redactPII" => redact_pii,
           "integration" => integration,
+          "auditMetadata" => audit_metadata&.to_h,
         }.compact
       end
 

data/lib/firecrawl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Firecrawl
-  VERSION = "1.10.1"
+  VERSION = "1.11.1"
 end

data/lib/firecrawl.rb

@@ -7,6 +7,7 @@ require_relative "firecrawl/models/query_format"
 require_relative "firecrawl/models/product_profile"
 require_relative "firecrawl/models/menu_profile"
 require_relative "firecrawl/models/document"
+require_relative "firecrawl/models/audit_metadata"
 require_relative "firecrawl/models/scrape_options"
 require_relative "firecrawl/models/crawl_options"
 require_relative "firecrawl/models/crawl_response"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firecrawl-sdk
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.11.1
 platform: ruby
 authors:
 - Firecrawl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-16 00:00:00.000000000 Z
+date: 2026-07-27 00:00:00.000000000 Z
 dependencies: []
 description: A type-safe Ruby client for the Firecrawl v2 API. Supports scraping,
   crawling, batch scraping, URL mapping, web search, and AI agent operations.
@@ -27,6 +27,7 @@ files:
 - lib/firecrawl/models/agent_options.rb
 - lib/firecrawl/models/agent_response.rb
 - lib/firecrawl/models/agent_status_response.rb
+- lib/firecrawl/models/audit_metadata.rb
 - lib/firecrawl/models/batch_scrape_job.rb
 - lib/firecrawl/models/batch_scrape_options.rb
 - lib/firecrawl/models/batch_scrape_response.rb