webscraping_ai 3.2.1 → 4.0.0

metadata

@@ -1,99 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: webscraping_ai
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 4.0.0
 platform: ruby
 authors:
 - WebScraping.AI
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.1
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.6.0
-description: WebScraping.AI scraping API provides LLM-powered tools with Chromium
-  JavaScript rendering, rotating proxies, and built-in HTML parsing.
+        version: '2.0'
+description: WebScraping.AI provides LLM-powered web scraping with Chromium JavaScript
+  rendering, rotating proxies, and built-in HTML parsing. This gem is the official
+  Ruby client.
 email:
 - hello@webscraping.ai
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
+- CHANGELOG.md
+- LICENSE
 - README.md
-- Rakefile
-- docs/AIApi.md
-- docs/Account.md
-- docs/AccountApi.md
-- docs/Error.md
-- docs/HTMLApi.md
-- docs/SelectedHTMLApi.md
-- docs/TextApi.md
-- git_push.sh
 - lib/webscraping_ai.rb
-- lib/webscraping_ai/api/account_api.rb
-- lib/webscraping_ai/api/ai_api.rb
-- lib/webscraping_ai/api/html_api.rb
-- lib/webscraping_ai/api/selected_html_api.rb
-- lib/webscraping_ai/api/text_api.rb
-- lib/webscraping_ai/api_client.rb
-- lib/webscraping_ai/api_error.rb
-- lib/webscraping_ai/api_model_base.rb
+- lib/webscraping_ai/client.rb
 - lib/webscraping_ai/configuration.rb
-- lib/webscraping_ai/models/account.rb
-- lib/webscraping_ai/models/error.rb
+- lib/webscraping_ai/errors.rb
+- lib/webscraping_ai/query_encoder.rb
 - lib/webscraping_ai/version.rb
-- spec/api/account_api_spec.rb
-- spec/api/ai_api_spec.rb
-- spec/api/html_api_spec.rb
-- spec/api/selected_html_api_spec.rb
-- spec/api/text_api_spec.rb
-- spec/models/account_spec.rb
-- spec/models/error_spec.rb
-- spec/spec_helper.rb
 - webscraping_ai.gemspec
 homepage: https://webscraping.ai
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://webscraping.ai
+  source_code_uri: https://github.com/webscraping-ai/webscraping-ai-ruby
+  bug_tracker_uri: https://github.com/webscraping-ai/webscraping-ai-ruby/issues
+  changelog_uri: https://github.com/webscraping-ai/webscraping-ai-ruby/blob/master/CHANGELOG.md
+  documentation_uri: https://webscraping.ai/docs/api
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,22 +61,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
-summary: WebScraping.AI Ruby Gem
-test_files:
-- spec/api/account_api_spec.rb
-- spec/api/ai_api_spec.rb
-- spec/api/html_api_spec.rb
-- spec/api/selected_html_api_spec.rb
-- spec/api/text_api_spec.rb
-- spec/models/account_spec.rb
-- spec/models/error_spec.rb
-- spec/spec_helper.rb
+summary: Ruby client for the WebScraping.AI API.
+test_files: []

data/Gemfile

@@ -1,9 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :development, :test do
-  gem 'rake', '~> 13.0.1'
-  gem 'pry-byebug'
-  gem 'rubocop', '~> 0.66.0'
-end

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-
-begin
-  require 'rspec/core/rake_task'
-
-  RSpec::Core::RakeTask.new(:spec)
-  task default: :spec
-rescue LoadError
-  # no rspec available
-end

data/docs/AIApi.md

@@ -1,209 +0,0 @@
-# WebScrapingAI::AIApi
-
-All URIs are relative to *https://api.webscraping.ai*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_fields**](AIApi.md#get_fields) | **GET** /ai/fields | Extract structured data fields from a web page |
-| [**get_question**](AIApi.md#get_question) | **GET** /ai/question | Get an answer to a question about a given web page |
-
-
-## get_fields
-
-> Hash<String, String> get_fields(url, fields, opts)
-
-Extract structured data fields from a web page
-
-Returns structured data fields extracted from the webpage using an LLM model. Proxies and Chromium JavaScript rendering are used for page retrieval and processing.
-
-### Examples
-
-```ruby
-require 'time'
-require 'webscraping_ai'
-# setup authorization
-WebScrapingAI.configure do |config|
-  # Configure API key authorization: api_key
-  config.api_key['api_key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['api_key'] = 'Bearer'
-end
-
-api_instance = WebScrapingAI::AIApi.new
-url = 'https://example.com' # String | URL of the target page.
-fields = { key: { key: 'inner_example'}} # Hash<String, String> | Object describing fields to extract from the page and their descriptions
-opts = {
-  headers: { key: { key: 'inner_example'}}, # Hash<String, String> | HTTP headers to pass to the target page. Can be specified either via a nested query parameter (...&headers[One]=value1&headers=[Another]=value2) or as a JSON encoded object (...&headers={\"One\": \"value1\", \"Another\": \"value2\"}).
-  timeout: 10000, # Integer | Maximum web page retrieval time in ms. Increase it in case of timeout errors (10000 by default, maximum is 30000).
-  js: true, # Boolean | Execute on-page JavaScript using a headless browser (true by default).
-  js_timeout: 2000, # Integer | Maximum JavaScript rendering time in ms. Increase it in case if you see a loading indicator instead of data on the target page.
-  wait_for: 'wait_for_example', # String | CSS selector to wait for before returning the page content. Useful for pages with dynamic content loading. Overrides js_timeout.
-  proxy: 'datacenter', # String | Type of proxy. Use `residential` if your site restricts traffic from datacenters, or `stealth` for the most heavily protected sites with advanced anti-bot detection (`datacenter` by default). Residential and stealth proxy requests are more expensive than datacenter, see the pricing page for details.
-  country: 'us', # String | Country of the proxy to use (US by default).
-  custom_proxy: 'custom_proxy_example', # String | Your own proxy URL to use instead of our built-in proxy pool in \"http://user:password@host:port\" format (<a target=\"_blank\" href=\"https://webscraping.ai/proxies/smartproxy\">Smartproxy</a> for example).
-  device: 'desktop', # String | Type of device emulation.
-  error_on_404: false, # Boolean | Return error on 404 HTTP status on the target page (false by default).
-  error_on_redirect: false, # Boolean | Return error on redirect on the target page (false by default).
-  js_script: 'document.querySelector('button').click();' # String | Custom JavaScript code to execute on the target page.
-}
-
-begin
-  # Extract structured data fields from a web page
-  result = api_instance.get_fields(url, fields, opts)
-  p result
-rescue WebScrapingAI::ApiError => e
-  puts "Error when calling AIApi->get_fields: #{e}"
-end
-```
-
-#### Using the get_fields_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(Hash&lt;String, String&gt;, Integer, Hash)> get_fields_with_http_info(url, fields, opts)
-
-```ruby
-begin
-  # Extract structured data fields from a web page
-  data, status_code, headers = api_instance.get_fields_with_http_info(url, fields, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => Hash&lt;String, String&gt;
-rescue WebScrapingAI::ApiError => e
-  puts "Error when calling AIApi->get_fields_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **url** | **String** | URL of the target page. |  |
-| **fields** | [**Hash&lt;String, String&gt;**](String.md) | Object describing fields to extract from the page and their descriptions |  |
-| **headers** | [**Hash&lt;String, String&gt;**](String.md) | HTTP headers to pass to the target page. Can be specified either via a nested query parameter (...&amp;headers[One]&#x3D;value1&amp;headers&#x3D;[Another]&#x3D;value2) or as a JSON encoded object (...&amp;headers&#x3D;{\&quot;One\&quot;: \&quot;value1\&quot;, \&quot;Another\&quot;: \&quot;value2\&quot;}). | [optional] |
-| **timeout** | **Integer** | Maximum web page retrieval time in ms. Increase it in case of timeout errors (10000 by default, maximum is 30000). | [optional][default to 10000] |
-| **js** | **Boolean** | Execute on-page JavaScript using a headless browser (true by default). | [optional][default to true] |
-| **js_timeout** | **Integer** | Maximum JavaScript rendering time in ms. Increase it in case if you see a loading indicator instead of data on the target page. | [optional][default to 2000] |
-| **wait_for** | **String** | CSS selector to wait for before returning the page content. Useful for pages with dynamic content loading. Overrides js_timeout. | [optional] |
-| **proxy** | **String** | Type of proxy. Use &#x60;residential&#x60; if your site restricts traffic from datacenters, or &#x60;stealth&#x60; for the most heavily protected sites with advanced anti-bot detection (&#x60;datacenter&#x60; by default). Residential and stealth proxy requests are more expensive than datacenter, see the pricing page for details. | [optional][default to &#39;datacenter&#39;] |
-| **country** | **String** | Country of the proxy to use (US by default). | [optional][default to &#39;us&#39;] |
-| **custom_proxy** | **String** | Your own proxy URL to use instead of our built-in proxy pool in \&quot;http://user:password@host:port\&quot; format (&lt;a target&#x3D;\&quot;_blank\&quot; href&#x3D;\&quot;https://webscraping.ai/proxies/smartproxy\&quot;&gt;Smartproxy&lt;/a&gt; for example). | [optional] |
-| **device** | **String** | Type of device emulation. | [optional][default to &#39;desktop&#39;] |
-| **error_on_404** | **Boolean** | Return error on 404 HTTP status on the target page (false by default). | [optional][default to false] |
-| **error_on_redirect** | **Boolean** | Return error on redirect on the target page (false by default). | [optional][default to false] |
-| **js_script** | **String** | Custom JavaScript code to execute on the target page. | [optional] |
-
-### Return type
-
-**Hash&lt;String, String&gt;**
-
-### Authorization
-
-[api_key](../README.md#api_key)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_question
-
-> String get_question(url, opts)
-
-Get an answer to a question about a given web page
-
-Returns the answer in plain text. Proxies and Chromium JavaScript rendering are used for page retrieval and processing, then the answer is extracted using an LLM model.
-
-### Examples
-
-```ruby
-require 'time'
-require 'webscraping_ai'
-# setup authorization
-WebScrapingAI.configure do |config|
-  # Configure API key authorization: api_key
-  config.api_key['api_key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['api_key'] = 'Bearer'
-end
-
-api_instance = WebScrapingAI::AIApi.new
-url = 'https://example.com' # String | URL of the target page.
-opts = {
-  question: 'What is the summary of this page content?', # String | Question or instructions to ask the LLM model about the target page.
-  headers: { key: { key: 'inner_example'}}, # Hash<String, String> | HTTP headers to pass to the target page. Can be specified either via a nested query parameter (...&headers[One]=value1&headers=[Another]=value2) or as a JSON encoded object (...&headers={\"One\": \"value1\", \"Another\": \"value2\"}).
-  timeout: 10000, # Integer | Maximum web page retrieval time in ms. Increase it in case of timeout errors (10000 by default, maximum is 30000).
-  js: true, # Boolean | Execute on-page JavaScript using a headless browser (true by default).
-  js_timeout: 2000, # Integer | Maximum JavaScript rendering time in ms. Increase it in case if you see a loading indicator instead of data on the target page.
-  wait_for: 'wait_for_example', # String | CSS selector to wait for before returning the page content. Useful for pages with dynamic content loading. Overrides js_timeout.
-  proxy: 'datacenter', # String | Type of proxy. Use `residential` if your site restricts traffic from datacenters, or `stealth` for the most heavily protected sites with advanced anti-bot detection (`datacenter` by default). Residential and stealth proxy requests are more expensive than datacenter, see the pricing page for details.
-  country: 'us', # String | Country of the proxy to use (US by default).
-  custom_proxy: 'custom_proxy_example', # String | Your own proxy URL to use instead of our built-in proxy pool in \"http://user:password@host:port\" format (<a target=\"_blank\" href=\"https://webscraping.ai/proxies/smartproxy\">Smartproxy</a> for example).
-  device: 'desktop', # String | Type of device emulation.
-  error_on_404: false, # Boolean | Return error on 404 HTTP status on the target page (false by default).
-  error_on_redirect: false, # Boolean | Return error on redirect on the target page (false by default).
-  js_script: 'document.querySelector('button').click();', # String | Custom JavaScript code to execute on the target page.
-  format: 'json' # String | Format of the response (text by default). \"json\" will return a JSON object with the response, \"text\" will return a plain text/HTML response.
-}
-
-begin
-  # Get an answer to a question about a given web page
-  result = api_instance.get_question(url, opts)
-  p result
-rescue WebScrapingAI::ApiError => e
-  puts "Error when calling AIApi->get_question: #{e}"
-end
-```
-
-#### Using the get_question_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(String, Integer, Hash)> get_question_with_http_info(url, opts)
-
-```ruby
-begin
-  # Get an answer to a question about a given web page
-  data, status_code, headers = api_instance.get_question_with_http_info(url, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => String
-rescue WebScrapingAI::ApiError => e
-  puts "Error when calling AIApi->get_question_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **url** | **String** | URL of the target page. |  |
-| **question** | **String** | Question or instructions to ask the LLM model about the target page. | [optional] |
-| **headers** | [**Hash&lt;String, String&gt;**](String.md) | HTTP headers to pass to the target page. Can be specified either via a nested query parameter (...&amp;headers[One]&#x3D;value1&amp;headers&#x3D;[Another]&#x3D;value2) or as a JSON encoded object (...&amp;headers&#x3D;{\&quot;One\&quot;: \&quot;value1\&quot;, \&quot;Another\&quot;: \&quot;value2\&quot;}). | [optional] |
-| **timeout** | **Integer** | Maximum web page retrieval time in ms. Increase it in case of timeout errors (10000 by default, maximum is 30000). | [optional][default to 10000] |
-| **js** | **Boolean** | Execute on-page JavaScript using a headless browser (true by default). | [optional][default to true] |
-| **js_timeout** | **Integer** | Maximum JavaScript rendering time in ms. Increase it in case if you see a loading indicator instead of data on the target page. | [optional][default to 2000] |
-| **wait_for** | **String** | CSS selector to wait for before returning the page content. Useful for pages with dynamic content loading. Overrides js_timeout. | [optional] |
-| **proxy** | **String** | Type of proxy. Use &#x60;residential&#x60; if your site restricts traffic from datacenters, or &#x60;stealth&#x60; for the most heavily protected sites with advanced anti-bot detection (&#x60;datacenter&#x60; by default). Residential and stealth proxy requests are more expensive than datacenter, see the pricing page for details. | [optional][default to &#39;datacenter&#39;] |
-| **country** | **String** | Country of the proxy to use (US by default). | [optional][default to &#39;us&#39;] |
-| **custom_proxy** | **String** | Your own proxy URL to use instead of our built-in proxy pool in \&quot;http://user:password@host:port\&quot; format (&lt;a target&#x3D;\&quot;_blank\&quot; href&#x3D;\&quot;https://webscraping.ai/proxies/smartproxy\&quot;&gt;Smartproxy&lt;/a&gt; for example). | [optional] |
-| **device** | **String** | Type of device emulation. | [optional][default to &#39;desktop&#39;] |
-| **error_on_404** | **Boolean** | Return error on 404 HTTP status on the target page (false by default). | [optional][default to false] |
-| **error_on_redirect** | **Boolean** | Return error on redirect on the target page (false by default). | [optional][default to false] |
-| **js_script** | **String** | Custom JavaScript code to execute on the target page. | [optional] |
-| **format** | **String** | Format of the response (text by default). \&quot;json\&quot; will return a JSON object with the response, \&quot;text\&quot; will return a plain text/HTML response. | [optional][default to &#39;json&#39;] |
-
-### Return type
-
-**String**
-
-### Authorization
-
-[api_key](../README.md#api_key)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json, text/html
-

data/docs/Account.md

@@ -1,24 +0,0 @@
-# WebScrapingAI::Account
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **email** | **String** | Your account email | [optional] |
-| **remaining_api_calls** | **Integer** | Remaining API credits quota | [optional] |
-| **resets_at** | **Integer** | Next billing cycle start time (UNIX timestamp) | [optional] |
-| **remaining_concurrency** | **Integer** | Remaining concurrent requests | [optional] |
-
-## Example
-
-```ruby
-require 'webscraping_ai'
-
-instance = WebScrapingAI::Account.new(
-  email: null,
-  remaining_api_calls: null,
-  resets_at: null,
-  remaining_concurrency: null
-)
-```
-

data/docs/AccountApi.md

@@ -1,76 +0,0 @@
-# WebScrapingAI::AccountApi
-
-All URIs are relative to *https://api.webscraping.ai*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**account**](AccountApi.md#account) | **GET** /account | Information about your account calls quota |
-
-
-## account
-
-> <Account> account
-
-Information about your account calls quota
-
-Returns information about your account, including the remaining API credits quota, the next billing cycle start time, and the remaining concurrent requests. The response is in JSON format.
-
-### Examples
-
-```ruby
-require 'time'
-require 'webscraping_ai'
-# setup authorization
-WebScrapingAI.configure do |config|
-  # Configure API key authorization: api_key
-  config.api_key['api_key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['api_key'] = 'Bearer'
-end
-
-api_instance = WebScrapingAI::AccountApi.new
-
-begin
-  # Information about your account calls quota
-  result = api_instance.account
-  p result
-rescue WebScrapingAI::ApiError => e
-  puts "Error when calling AccountApi->account: #{e}"
-end
-```
-
-#### Using the account_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Account>, Integer, Hash)> account_with_http_info
-
-```ruby
-begin
-  # Information about your account calls quota
-  data, status_code, headers = api_instance.account_with_http_info
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Account>
-rescue WebScrapingAI::ApiError => e
-  puts "Error when calling AccountApi->account_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-[**Account**](Account.md)
-
-### Authorization
-
-[api_key](../README.md#api_key)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/Error.md

@@ -1,24 +0,0 @@
-# WebScrapingAI::Error
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **message** | **String** | Error description | [optional] |
-| **status_code** | **Integer** | Target page response HTTP status code (403, 500, etc) | [optional] |
-| **status_message** | **String** | Target page response HTTP status message | [optional] |
-| **body** | **String** | Target page response body | [optional] |
-
-## Example
-
-```ruby
-require 'webscraping_ai'
-
-instance = WebScrapingAI::Error.new(
-  message: null,
-  status_code: null,
-  status_message: null,
-  body: null
-)
-```
-

data/docs/HTMLApi.md

@@ -1,109 +0,0 @@
-# WebScrapingAI::HTMLApi
-
-All URIs are relative to *https://api.webscraping.ai*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_html**](HTMLApi.md#get_html) | **GET** /html | Page HTML by URL |
-
-
-## get_html
-
-> String get_html(url, opts)
-
-Page HTML by URL
-
-Returns the full HTML content of a webpage specified by the URL. The response is in plain text. Proxies and Chromium JavaScript rendering are used for page retrieval and processing.
-
-### Examples
-
-```ruby
-require 'time'
-require 'webscraping_ai'
-# setup authorization
-WebScrapingAI.configure do |config|
-  # Configure API key authorization: api_key
-  config.api_key['api_key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['api_key'] = 'Bearer'
-end
-
-api_instance = WebScrapingAI::HTMLApi.new
-url = 'https://example.com' # String | URL of the target page.
-opts = {
-  headers: { key: { key: 'inner_example'}}, # Hash<String, String> | HTTP headers to pass to the target page. Can be specified either via a nested query parameter (...&headers[One]=value1&headers=[Another]=value2) or as a JSON encoded object (...&headers={\"One\": \"value1\", \"Another\": \"value2\"}).
-  timeout: 10000, # Integer | Maximum web page retrieval time in ms. Increase it in case of timeout errors (10000 by default, maximum is 30000).
-  js: true, # Boolean | Execute on-page JavaScript using a headless browser (true by default).
-  js_timeout: 2000, # Integer | Maximum JavaScript rendering time in ms. Increase it in case if you see a loading indicator instead of data on the target page.
-  wait_for: 'wait_for_example', # String | CSS selector to wait for before returning the page content. Useful for pages with dynamic content loading. Overrides js_timeout.
-  proxy: 'datacenter', # String | Type of proxy. Use `residential` if your site restricts traffic from datacenters, or `stealth` for the most heavily protected sites with advanced anti-bot detection (`datacenter` by default). Residential and stealth proxy requests are more expensive than datacenter, see the pricing page for details.
-  country: 'us', # String | Country of the proxy to use (US by default).
-  custom_proxy: 'custom_proxy_example', # String | Your own proxy URL to use instead of our built-in proxy pool in \"http://user:password@host:port\" format (<a target=\"_blank\" href=\"https://webscraping.ai/proxies/smartproxy\">Smartproxy</a> for example).
-  device: 'desktop', # String | Type of device emulation.
-  error_on_404: false, # Boolean | Return error on 404 HTTP status on the target page (false by default).
-  error_on_redirect: false, # Boolean | Return error on redirect on the target page (false by default).
-  js_script: 'document.querySelector('button').click();', # String | Custom JavaScript code to execute on the target page.
-  return_script_result: false, # Boolean | Return result of the custom JavaScript code (js_script parameter) execution on the target page (false by default, page HTML will be returned).
-  format: 'json' # String | Format of the response (text by default). \"json\" will return a JSON object with the response, \"text\" will return a plain text/HTML response.
-}
-
-begin
-  # Page HTML by URL
-  result = api_instance.get_html(url, opts)
-  p result
-rescue WebScrapingAI::ApiError => e
-  puts "Error when calling HTMLApi->get_html: #{e}"
-end
-```
-
-#### Using the get_html_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(String, Integer, Hash)> get_html_with_http_info(url, opts)
-
-```ruby
-begin
-  # Page HTML by URL
-  data, status_code, headers = api_instance.get_html_with_http_info(url, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => String
-rescue WebScrapingAI::ApiError => e
-  puts "Error when calling HTMLApi->get_html_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **url** | **String** | URL of the target page. |  |
-| **headers** | [**Hash&lt;String, String&gt;**](String.md) | HTTP headers to pass to the target page. Can be specified either via a nested query parameter (...&amp;headers[One]&#x3D;value1&amp;headers&#x3D;[Another]&#x3D;value2) or as a JSON encoded object (...&amp;headers&#x3D;{\&quot;One\&quot;: \&quot;value1\&quot;, \&quot;Another\&quot;: \&quot;value2\&quot;}). | [optional] |
-| **timeout** | **Integer** | Maximum web page retrieval time in ms. Increase it in case of timeout errors (10000 by default, maximum is 30000). | [optional][default to 10000] |
-| **js** | **Boolean** | Execute on-page JavaScript using a headless browser (true by default). | [optional][default to true] |
-| **js_timeout** | **Integer** | Maximum JavaScript rendering time in ms. Increase it in case if you see a loading indicator instead of data on the target page. | [optional][default to 2000] |
-| **wait_for** | **String** | CSS selector to wait for before returning the page content. Useful for pages with dynamic content loading. Overrides js_timeout. | [optional] |
-| **proxy** | **String** | Type of proxy. Use &#x60;residential&#x60; if your site restricts traffic from datacenters, or &#x60;stealth&#x60; for the most heavily protected sites with advanced anti-bot detection (&#x60;datacenter&#x60; by default). Residential and stealth proxy requests are more expensive than datacenter, see the pricing page for details. | [optional][default to &#39;datacenter&#39;] |
-| **country** | **String** | Country of the proxy to use (US by default). | [optional][default to &#39;us&#39;] |
-| **custom_proxy** | **String** | Your own proxy URL to use instead of our built-in proxy pool in \&quot;http://user:password@host:port\&quot; format (&lt;a target&#x3D;\&quot;_blank\&quot; href&#x3D;\&quot;https://webscraping.ai/proxies/smartproxy\&quot;&gt;Smartproxy&lt;/a&gt; for example). | [optional] |
-| **device** | **String** | Type of device emulation. | [optional][default to &#39;desktop&#39;] |
-| **error_on_404** | **Boolean** | Return error on 404 HTTP status on the target page (false by default). | [optional][default to false] |
-| **error_on_redirect** | **Boolean** | Return error on redirect on the target page (false by default). | [optional][default to false] |
-| **js_script** | **String** | Custom JavaScript code to execute on the target page. | [optional] |
-| **return_script_result** | **Boolean** | Return result of the custom JavaScript code (js_script parameter) execution on the target page (false by default, page HTML will be returned). | [optional][default to false] |
-| **format** | **String** | Format of the response (text by default). \&quot;json\&quot; will return a JSON object with the response, \&quot;text\&quot; will return a plain text/HTML response. | [optional][default to &#39;json&#39;] |
-
-### Return type
-
-**String**
-
-### Authorization
-
-[api_key](../README.md#api_key)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json, text/html
-