Update API documentation for version 0.10.4

Author: jjsaunier

docs/scrapfly/browser_config.html

@@ -48,7 +48,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="scrapfly.browser_config.BrowserConfig"><code class="flex name class">
 <span>class <span class="ident">BrowserConfig</span></span>
-<span>(</span><span>proxy_pool: str | <a title="scrapfly.browser_config.ProxyPool" href="#scrapfly.browser_config.ProxyPool">ProxyPool</a> | None = None,<br>os: str | <a title="scrapfly.browser_config.OperatingSystem" href="#scrapfly.browser_config.OperatingSystem">OperatingSystem</a> | None = None,<br>session: str | None = None,<br>country: str | None = None,<br>auto_close: bool | None = None,<br>timeout: int | None = None,<br>debug: bool | None = None,<br>extensions: List[str] | None = None,<br>block_images: bool | None = None,<br>block_styles: bool | None = None,<br>block_fonts: bool | None = None,<br>block_media: bool | None = None,<br>screenshot: bool | None = None,<br>resolution: str | None = None,<br>target_url: str | None = None,<br>cache: bool | None = None,<br>blacklist: bool | None = None,<br>unblock: bool | None = None,<br>unblock_timeout: int | None = None,<br>browser_brand: str | None = None,<br>byop_proxy: str | None = None,<br>enable_mcp: bool | None = None,<br>solve_captcha: bool | None = None)</span>
+<span>(</span><span>proxy_pool: str | <a title="scrapfly.browser_config.ProxyPool" href="#scrapfly.browser_config.ProxyPool">ProxyPool</a> | None = None,<br>os: str | <a title="scrapfly.browser_config.OperatingSystem" href="#scrapfly.browser_config.OperatingSystem">OperatingSystem</a> | None = None,<br>session: str | None = None,<br>country: str | None = None,<br>auto_close: bool | None = None,<br>timeout: int | None = None,<br>debug: bool | None = None,<br>extensions: List[str] | None = None,<br>block_images: bool | None = None,<br>block_styles: bool | None = None,<br>block_fonts: bool | None = None,<br>block_media: bool | None = None,<br>screenshot: bool | None = None,<br>resolution: str | None = None,<br>target_url: str | None = None,<br>cache: bool | None = None,<br>blacklist: bool | None = None,<br>unblock: bool | None = None,<br>unblock_timeout: int | None = None,<br>browser_brand: str | None = None,<br>byop_proxy: str | None = None,<br>enable_mcp: bool | None = None,<br>solve_captcha: bool | None = None,<br>vault: str | None = None,<br>vault_key: str | None = None)</span>
 </code></dt>
 <dd>
 <details class="source">
@@ -84,6 +84,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         byop_proxy: Optional[str] = None,
         enable_mcp: Optional[bool] = None,
         solve_captcha: Optional[bool] = None,
+        vault: Optional[str] = None,
+        vault_key: Optional[str] = None,
     ):
         if timeout is not None and timeout &gt; 1800:
             raise ValueError(&#39;timeout cannot exceed 1800 seconds (30 minutes)&#39;)
@@ -129,6 +131,15 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         # automatically. Billed per solve; failures cost nothing.
         # https://scrapfly.io/docs/cloud-browser-api/captcha-solver
         self.solve_captcha = solve_captcha
+        # Cloud Browser Credential Vault binding. `vault` is the vault id
+        # (UUID) returned by POST /vault; `vault_key` is the base64 32-byte
+        # customer-held key returned (once) by POST /vault or POST
+        # /vault/&lt;id&gt;/rotate. Both are forwarded as query params on the
+        # wss:// URL — the server uses them to decrypt items into the
+        # session&#39;s secret broker. Treat `vault_key` as a credential: never
+        # log it, never persist it server-side.
+        self.vault = vault
+        self.vault_key = vault_key
 
     def websocket_url(self, api_key: str, host: Optional[str] = None) -&gt; str:
         params = {&#39;api_key&#39;: api_key}
@@ -149,7 +160,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             params[&#39;auto_close&#39;] = self._bool_to_http(self.auto_close)
 
         if self.timeout is not None:
-            params[&#39;timeout&#39;] = self.timeout
+            params[&#39;timeout&#39;] = str(self.timeout)
 
         if self.debug is not None:
             params[&#39;debug&#39;] = self._bool_to_http(self.debug)
@@ -188,7 +199,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             params[&#39;unblock&#39;] = self._bool_to_http(self.unblock)
 
         if self.unblock_timeout is not None:
-            params[&#39;unblock_timeout&#39;] = self.unblock_timeout
+            params[&#39;unblock_timeout&#39;] = str(self.unblock_timeout)
 
         if self.browser_brand is not None:
             params[&#39;browser_brand&#39;] = self.browser_brand
@@ -202,6 +213,12 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         if self.solve_captcha is not None:
             params[&#39;solve_captcha&#39;] = self._bool_to_http(self.solve_captcha)
 
+        if self.vault is not None:
+            params[&#39;vault&#39;] = self.vault
+
+        if self.vault_key is not None:
+            params[&#39;vault_key&#39;] = self.vault_key
+
         base_host = host or self.CLOUD_BROWSER_HOST
         return base_host + &#39;?&#39; + urlencode(params)
 
@@ -230,6 +247,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             &#39;byop_proxy&#39;: self.byop_proxy,
             &#39;enable_mcp&#39;: self.enable_mcp,
             &#39;solve_captcha&#39;: self.solve_captcha,
+            &#39;vault&#39;: self.vault,
+            &#39;vault_key&#39;: self.vault_key,
         }
 
     @staticmethod
@@ -266,6 +285,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             byop_proxy=browser_config_dict.get(&#39;byop_proxy&#39;, None),
             enable_mcp=browser_config_dict.get(&#39;enable_mcp&#39;, None),
             solve_captcha=browser_config_dict.get(&#39;solve_captcha&#39;, None),
+            vault=browser_config_dict.get(&#39;vault&#39;, None),
+            vault_key=browser_config_dict.get(&#39;vault_key&#39;, None),
         )</code></pre>
 </details>
 <div class="desc"></div>
@@ -324,6 +345,8 @@ <h3>Static methods</h3>
         byop_proxy=browser_config_dict.get(&#39;byop_proxy&#39;, None),
         enable_mcp=browser_config_dict.get(&#39;enable_mcp&#39;, None),
         solve_captcha=browser_config_dict.get(&#39;solve_captcha&#39;, None),
+        vault=browser_config_dict.get(&#39;vault&#39;, None),
+        vault_key=browser_config_dict.get(&#39;vault_key&#39;, None),
     )</code></pre>
 </details>
 <div class="desc"></div>
@@ -364,6 +387,8 @@ <h3>Methods</h3>
         &#39;byop_proxy&#39;: self.byop_proxy,
         &#39;enable_mcp&#39;: self.enable_mcp,
         &#39;solve_captcha&#39;: self.solve_captcha,
+        &#39;vault&#39;: self.vault,
+        &#39;vault_key&#39;: self.vault_key,
     }</code></pre>
 </details>
 <div class="desc"></div>
@@ -395,7 +420,7 @@ <h3>Methods</h3>
         params[&#39;auto_close&#39;] = self._bool_to_http(self.auto_close)
 
     if self.timeout is not None:
-        params[&#39;timeout&#39;] = self.timeout
+        params[&#39;timeout&#39;] = str(self.timeout)
 
     if self.debug is not None:
         params[&#39;debug&#39;] = self._bool_to_http(self.debug)
@@ -434,7 +459,7 @@ <h3>Methods</h3>
         params[&#39;unblock&#39;] = self._bool_to_http(self.unblock)
 
     if self.unblock_timeout is not None:
-        params[&#39;unblock_timeout&#39;] = self.unblock_timeout
+        params[&#39;unblock_timeout&#39;] = str(self.unblock_timeout)
 
     if self.browser_brand is not None:
         params[&#39;browser_brand&#39;] = self.browser_brand
@@ -448,6 +473,12 @@ <h3>Methods</h3>
     if self.solve_captcha is not None:
         params[&#39;solve_captcha&#39;] = self._bool_to_http(self.solve_captcha)
 
+    if self.vault is not None:
+        params[&#39;vault&#39;] = self.vault
+
+    if self.vault_key is not None:
+        params[&#39;vault_key&#39;] = self.vault_key
+
     base_host = host or self.CLOUD_BROWSER_HOST
     return base_host + &#39;?&#39; + urlencode(params)</code></pre>
 </details>