webscraping_ai 2.0.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9962503617721ab3362a7ba4c45f3bdf346d8c2762f25618e4daffd438f2d3f
-  data.tar.gz: 0b576d0c56ee0cbaa13690dea3a8740887ab3d76a7eb46f8f48ee7deb1e7a784
+  metadata.gz: 4867f8d8db8fd67de9d08cbccff1743f171c7494b45b2732f0a02b0895f2f90f
+  data.tar.gz: 15627c6dbe09d5319cc3c078fd00b5f7124c2f103c752b288f8763ec1f166f2f
 SHA512:
-  metadata.gz: b396ca118c8f0ee9a95f270b3931522a58725982859722e34ffa4039c671d2eb41961b645a1295fec08493351c1495a912484faaf47a73e3f3ad8ccb48763c0a
-  data.tar.gz: 4106699b17e5f19ac8d772ce93de5961d1020b02531f4fc28aff954332cb301035090a4b7e37a978be88d2127ac348eda4d3c27d7470bdae0b427237004643dc
+  metadata.gz: 84f320a205fce47ff07cf166f4745a7f3a82f70216ada66e1806937b2dc484a827cbb37e535fd04b3cd3fcf91f0517bc6ec01a4f8040dabcbfff0500466636a3
+  data.tar.gz: 489addbc3805ffe1ec9a9c60f5a42d7633d56512b2cb8a54dfec81bf98b2a28c5876f4e4c7ece8ecf4477a5fa744fa36d355b53500f557e702fa0426a3e45fcf

data/README.md

@@ -2,12 +2,12 @@
 
 WebScrapingAI - the Ruby gem for the WebScraping.AI
 
-A client for https://webscraping.ai API. It provides a web scaping automation API with Chrome JS rendering, rotating proxies and builtin HTML parsing.
+WebScraping.AI scraping API provides GPT-powered tools with Chromium JavaScript rendering, rotating proxies, and built-in HTML parsing.
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 2.0.1
-- Package version: 2.0.1
+- API version: 3.1.2
+- Package version: 3.1.2
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://webscraping.ai](https://webscraping.ai)
 
@@ -24,16 +24,16 @@ gem build webscraping_ai.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./webscraping_ai-2.0.1.gem
+gem install ./webscraping_ai-3.1.2.gem
 ```
 
-(for development, run `gem install --dev ./webscraping_ai-2.0.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./webscraping_ai-3.1.2.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'webscraping_ai', '~> 2.0.1'
+    gem 'webscraping_ai', '~> 3.1.2'
 
 ### Install from Git
 
@@ -62,23 +62,34 @@ 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'
+  # config.api_key_prefix['api_key'] = 'Bearer'
 end
 
-api_instance = WebScrapingAI::HTMLApi.new
-url = 'https://example.com' # String | URL of the target page
+api_instance = WebScrapingAI::AIApi.new
+url = 'https://example.com' # String | URL of the target page.
 opts = {
-  headers: {'key' => '{\"Cookie\":\"session=some_id\"}'}, # 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: 5000, # Integer | Maximum processing time in ms. Increase it in case of timeout errors (5000 by default, maximum is 30000)
-  js: true, # Boolean | Execute on-page JavaScript using a headless browser (true by default), costs 2 requests
-  proxy: 'datacenter' # String | Type of proxy, use residential proxies if your site restricts traffic from datacenters (datacenter by default)
+  question: 'What is the summary of this page content?', # String | Question or instructions to ask the LLM model about the target page.
+  context_limit: 4000, # Integer | Maximum number of tokens to use as context for the LLM model (4000 by default).
+  response_tokens: 100, # Integer | Maximum number of tokens to return in the LLM model response. The total context size (context_limit) includes the question, the target page content and the response, so this parameter reserves tokens for the response (see also on_context_limit).
+  on_context_limit: 'truncate', # String | What to do if the context_limit parameter is exceeded (truncate by default). The context is exceeded when the target page content is too long.
+  headers: { key: 3.56}, # 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.
+  proxy: 'datacenter', # String | Type of proxy, use residential proxies if your site restricts traffic from datacenters (datacenter by default). Note that residential 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). Only available on Startup and Custom plans.
+  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
-  #Page HTML by URL
-  api_instance.get_html(url, opts)
+  #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 "Exception when calling HTMLApi->get_html: #{e}"
+  puts "Exception when calling AIApi->get_question: #{e}"
 end
 
 ```
@@ -89,23 +100,24 @@ All URIs are relative to *https://api.webscraping.ai*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*WebScrapingAI::AIApi* | [**get_question**](docs/AIApi.md#get_question) | **GET** /ai/question | Get an answer to a question about a given web page
+*WebScrapingAI::AccountApi* | [**account**](docs/AccountApi.md#account) | **GET** /account | Information about your account calls quota
 *WebScrapingAI::HTMLApi* | [**get_html**](docs/HTMLApi.md#get_html) | **GET** /html | Page HTML by URL
-*WebScrapingAI::HTMLApi* | [**post_html**](docs/HTMLApi.md#post_html) | **POST** /html | Page HTML by URL with POST request to the target page
 *WebScrapingAI::SelectedHTMLApi* | [**get_selected**](docs/SelectedHTMLApi.md#get_selected) | **GET** /selected | HTML of a selected page area by URL and CSS selector
 *WebScrapingAI::SelectedHTMLApi* | [**get_selected_multiple**](docs/SelectedHTMLApi.md#get_selected_multiple) | **GET** /selected-multiple | HTML of multiple page areas by URL and CSS selectors
-*WebScrapingAI::SelectedHTMLApi* | [**post_selected**](docs/SelectedHTMLApi.md#post_selected) | **POST** /selected | HTML of a selected page areas by URL and CSS selector, with POST request to the target page
-*WebScrapingAI::SelectedHTMLApi* | [**post_selected_multiple**](docs/SelectedHTMLApi.md#post_selected_multiple) | **POST** /selected-multiple | HTML of multiple page areas by URL and CSS selectors, with POST request to the target page
+*WebScrapingAI::TextApi* | [**get_text**](docs/TextApi.md#get_text) | **GET** /text | Page text by URL
 
 
 ## Documentation for Models
 
+ - [WebScrapingAI::Account](docs/Account.md)
  - [WebScrapingAI::Error](docs/Error.md)
- - [WebScrapingAI::PageError](docs/PageError.md)
 
 
 ## Documentation for Authorization
 
 
+Authentication schemes defined for the API:
 ### api_key
 
 

data/docs/AIApi.md

@@ -0,0 +1,109 @@
+# WebScrapingAI::AIApi
+
+All URIs are relative to *https://api.webscraping.ai*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_question**](AIApi.md#get_question) | **GET** /ai/question | Get an answer to a question about a given web page |
+
+
+## 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.
+  context_limit: 4000, # Integer | Maximum number of tokens to use as context for the LLM model (4000 by default).
+  response_tokens: 100, # Integer | Maximum number of tokens to return in the LLM model response. The total context size (context_limit) includes the question, the target page content and the response, so this parameter reserves tokens for the response (see also on_context_limit).
+  on_context_limit: 'truncate', # String | What to do if the context_limit parameter is exceeded (truncate by default). The context is exceeded when the target page content is too long.
+  headers: { key: 3.56}, # 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.
+  proxy: 'datacenter', # String | Type of proxy, use residential proxies if your site restricts traffic from datacenters (datacenter by default). Note that residential 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). Only available on Startup and Custom plans.
+  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
+  # 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] |
+| **context_limit** | **Integer** | Maximum number of tokens to use as context for the LLM model (4000 by default). | [optional][default to 8000] |
+| **response_tokens** | **Integer** | Maximum number of tokens to return in the LLM model response. The total context size (context_limit) includes the question, the target page content and the response, so this parameter reserves tokens for the response (see also on_context_limit). | [optional][default to 100] |
+| **on_context_limit** | **String** | What to do if the context_limit parameter is exceeded (truncate by default). The context is exceeded when the target page content is too long. | [optional][default to &#39;truncate&#39;] |
+| **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] |
+| **proxy** | **String** | Type of proxy, use residential proxies if your site restricts traffic from datacenters (datacenter by default). Note that residential 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). Only available on Startup and Custom plans. | [optional][default to &#39;us&#39;] |
+| **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
+
+**String**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, text/html
+

data/docs/Account.md

@@ -0,0 +1,22 @@
+# WebScrapingAI::Account
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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(
+  remaining_api_calls: null,
+  resets_at: null,
+  remaining_concurrency: null
+)
+```
+

data/docs/AccountApi.md

@@ -0,0 +1,76 @@
+# 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

@@ -2,16 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message** | **String** | Error description | [optional] 
+| 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] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'WebScrapingAI'
+require 'webscraping_ai'
 
-instance = WebScrapingAI::Error.new(message: null)
+instance = WebScrapingAI::Error.new(
+  message: null,
+  status_code: null,
+  status_message: null,
+  body: null
+)
 ```
 
-

data/docs/HTMLApi.md

@@ -2,130 +2,95 @@
 
 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
-[**post_html**](HTMLApi.md#post_html) | **POST** /html | Page HTML by URL with POST request to the target page
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_html**](HTMLApi.md#get_html) | **GET** /html | Page HTML by URL |
 
 
 ## get_html
 
-> get_html(url, opts)
+> String get_html(url, opts)
 
 Page HTML by URL
 
-Returns just HTML on success, JSON on error
+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.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+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'
+  # config.api_key_prefix['api_key'] = 'Bearer'
 end
 
 api_instance = WebScrapingAI::HTMLApi.new
-url = 'https://example.com' # String | URL of the target page
+url = 'https://example.com' # String | URL of the target page.
 opts = {
-  headers: {'key' => '{\"Cookie\":\"session=some_id\"}'}, # 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: 5000, # Integer | Maximum processing time in ms. Increase it in case of timeout errors (5000 by default, maximum is 30000)
-  js: true, # Boolean | Execute on-page JavaScript using a headless browser (true by default), costs 2 requests
-  proxy: 'datacenter' # String | Type of proxy, use residential proxies if your site restricts traffic from datacenters (datacenter by default)
+  headers: { key: 3.56}, # 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.
+  proxy: 'datacenter', # String | Type of proxy, use residential proxies if your site restricts traffic from datacenters (datacenter by default). Note that residential 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). Only available on Startup and Custom plans.
+  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).
 }
 
 begin
-  #Page HTML by URL
-  api_instance.get_html(url, opts)
+  # Page HTML by URL
+  result = api_instance.get_html(url, opts)
+  p result
 rescue WebScrapingAI::ApiError => e
-  puts "Exception when calling HTMLApi->get_html: #{e}"
+  puts "Error when calling HTMLApi->get_html: #{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 processing time in ms. Increase it in case of timeout errors (5000 by default, maximum is 30000) | [optional] [default to 5000]
- **js** | **Boolean**| Execute on-page JavaScript using a headless browser (true by default), costs 2 requests | [optional] [default to true]
- **proxy** | **String**| Type of proxy, use residential proxies if your site restricts traffic from datacenters (datacenter by default) | [optional] [default to &#39;datacenter&#39;]
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[api_key](../README.md#api_key)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json, text/html
-
+#### Using the get_html_with_http_info variant
 
-## post_html
+This returns an Array which contains the response data, status code and headers.
 
-> post_html(url, opts)
-
-Page HTML by URL with POST request to the target page
-
-Returns just HTML on success, JSON on error. Request body will be passed to the target page.
-
-### Example
+> <Array(String, Integer, Hash)> get_html_with_http_info(url, opts)
 
 ```ruby
-# load the gem
-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://httpbin.org/post' # String | URL of the target page
-opts = {
-  headers: {'key' => '{\"Cookie\":\"session=some_id\"}'}, # 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: 5000, # Integer | Maximum processing time in ms. Increase it in case of timeout errors (5000 by default, maximum is 30000)
-  js: true, # Boolean | Execute on-page JavaScript using a headless browser (true by default), costs 2 requests
-  proxy: 'datacenter', # String | Type of proxy, use residential proxies if your site restricts traffic from datacenters (datacenter by default)
-  request_body: nil # Hash<String, Object> | Request body to pass to the target page
-}
-
 begin
-  #Page HTML by URL with POST request to the target page
-  api_instance.post_html(url, opts)
+  # 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 "Exception when calling HTMLApi->post_html: #{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 processing time in ms. Increase it in case of timeout errors (5000 by default, maximum is 30000) | [optional] [default to 5000]
- **js** | **Boolean**| Execute on-page JavaScript using a headless browser (true by default), costs 2 requests | [optional] [default to true]
- **proxy** | **String**| Type of proxy, use residential proxies if your site restricts traffic from datacenters (datacenter by default) | [optional] [default to &#39;datacenter&#39;]
- **request_body** | [**Hash&lt;String, Object&gt;**](Object.md)| Request body to pass to the target page | [optional] 
+| 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] |
+| **proxy** | **String** | Type of proxy, use residential proxies if your site restricts traffic from datacenters (datacenter by default). Note that residential 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). Only available on Startup and Custom plans. | [optional][default to &#39;us&#39;] |
+| **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] |
 
 ### Return type
 
-nil (empty response body)
+**String**
 
 ### Authorization
 
@@ -133,6 +98,6 @@ nil (empty response body)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json, application/x-www-form-urlencoded, application/xml, text/plain
+- **Content-Type**: Not defined
 - **Accept**: application/json, text/html