webscraping_ai 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87c7c3987da110e442c1a4af9c64faf489e1357e19e961d9e8ccf064986b2cf0
-  data.tar.gz: 7705c46a0f70dccbbc8c3e51467e37c84faab243330bbeb6069733fa732a3afa
+  metadata.gz: 07d4d1eb8c57b1363022778dda4537e1e4780a88bdeedd261e26a9e8f319c664
+  data.tar.gz: 473ebf4a64f87b3fdb5d04209b3a359a8e841a501ec97b26f71dd8261f40efda
 SHA512:
-  metadata.gz: 33d32382161eb7cdbacfb27ffb75c0d758b507e7945adc8c9d418fee2ff6bda748d1b5671ed7c2f430af3fc522537856a7a2ef85fd844e92272203d3d8f06341
-  data.tar.gz: 3482be7567deceb06613d2cf82a9d56d1cc7c9ef51b8a27fde3d2df283c91f3d695fceb9dca8adc96a8f48f81c1ad624c9419f1eb700f533e932285e9e512da8
+  metadata.gz: 26b7ab5c70da5df4802990aae74c3448751d9942d3fe2cfb7dcba186ef13f53887b9ae95b8bb495624c28a2f5400436212d5180facc631bda134499901e19e17
+  data.tar.gz: a0ae994a5d415e381effa2bb8d7169954b781452d967de888cf04374715092ac8d1e0c912be3bd6378c1b8f72522056d4fe827ad9c4ec00ea5a98d9b950b2d96

data/Gemfile

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

data/README.md

@@ -2,21 +2,52 @@
 
 WebScrapingAI - the Ruby gem for the WebScraping.AI
 
-A client for https://webscraping.ai API. It provides Chrome JS rendering, rotating proxies and HTML parsing for web scraping.
+A client for https://webscraping.ai API. It provides a web scaping automation API with Chrome JS rendering, rotating proxies and builtin HTML parsing.
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 1.0.0
-- Package version: 1.0.0
+- API version: 2.0.0
+- Package version: 2.0.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://webscraping.ai](https://webscraping.ai)
 
 ## Installation
 
-### Install from RubyGems
+### Build a gem
 
-Add the following in the Gemfile:
+To build the Ruby code into a gem:
 
-    gem 'webscraping_ai'
+```shell
+gem build webscraping_ai.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./webscraping_ai-2.0.0.gem
+```
+
+(for development, run `gem install --dev ./webscraping_ai-2.0.0.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.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/webscraping-ai/webscraping-ai-ruby, then add the following in the Gemfile:
+
+    gem 'webscraping_ai', :git => 'https://github.com/webscraping-ai/webscraping-ai-ruby.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
 
 ## Getting Started
 
@@ -29,41 +60,47 @@ require 'webscraping_ai'
 # Setup authorization
 WebScrapingAI.configure do |config|
   # Configure API key authorization: api_key
-  config.api_key['api_key'] = 'test-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 page to get
+api_instance = WebScrapingAI::HTMLApi.new
+url = 'https://example.com' # String | URL of the target page
 opts = {
-  selector: 'html', # String | CSS selector to get a part of the page (null by default, returns whole page HTML)
-  outer_html: false, # Boolean | Return outer HTML of the selected element (false by default, returns inner HTML)
-  proxy: 'US', # String | Proxy country code, for geotargeting (US by default)
-  disable_js: false, # Boolean | Disable JS execution (false by default)
-  inline_css: false # Boolean | Inline included CSS files to make page viewable on other domains (false by default)
+  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)
 }
 
 begin
-  #Get page HTML by URL (renders JS in Chrome and uses rotating proxies)
-  result = api_instance.get_page(url, opts)
-  p result
+  #Page HTML by URL
+  api_instance.get_html(url, opts)
 rescue WebScrapingAI::ApiError => e
-  puts "Exception when calling HtmlApi->get_page: #{e}"
+  puts "Exception when calling HTMLApi->get_html: #{e}"
 end
 
 ```
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *https://webscraping.ai/api*
+All URIs are relative to *https://api.webscraping.ai*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*WebScrapingAI::HtmlApi* | [**get_page**](docs/HtmlApi.md#get_page) | **GET** / | Get page HTML by URL (renders JS in Chrome and uses rotating proxies)
+*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
 
 
 ## Documentation for Models
 
- - [WebScrapingAI::ScrappedPage](docs/ScrappedPage.md)
+ - [WebScrapingAI::Error](docs/Error.md)
+ - [WebScrapingAI::PageError](docs/PageError.md)
 
 
 ## Documentation for Authorization

data/docs/Error.md

@@ -0,0 +1,17 @@
+# WebScrapingAI::Error
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** | Error description | [optional] 
+
+## Code Sample
+
+```ruby
+require 'WebScrapingAI'
+
+instance = WebScrapingAI::Error.new(message: null)
+```
+
+

data/docs/HTMLApi.md

@@ -0,0 +1,136 @@
+# 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
+[**post_html**](HTMLApi.md#post_html) | **POST** /html | Page HTML by URL with POST request to the target page
+
+
+
+## get_html
+
+> get_html(url, opts)
+
+Page HTML by URL
+
+Returns just HTML on success, JSON on error
+
+### Example
+
+```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://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)
+}
+
+begin
+  #Page HTML by URL
+  api_instance.get_html(url, opts)
+rescue WebScrapingAI::ApiError => e
+  puts "Exception 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
+
+
+## post_html
+
+> 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
+
+```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://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)
+}
+
+begin
+  #Page HTML by URL with POST request to the target page
+  api_instance.post_html(url, opts)
+rescue WebScrapingAI::ApiError => e
+  puts "Exception when calling HTMLApi->post_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
+

data/docs/PageError.md

@@ -0,0 +1,19 @@
+# WebScrapingAI::PageError
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status_code** | **Integer** | Response HTTP status code (403, 500, etc) | [optional] 
+**status_message** | **String** | Response HTTP status message | [optional] 
+
+## Code Sample
+
+```ruby
+require 'WebScrapingAI'
+
+instance = WebScrapingAI::PageError.new(status_code: null,
+                                 status_message: null)
+```
+
+

data/docs/SelectedHTMLApi.md

@@ -0,0 +1,274 @@
+# WebScrapingAI::SelectedHTMLApi
+
+All URIs are relative to *https://api.webscraping.ai*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_selected**](SelectedHTMLApi.md#get_selected) | **GET** /selected | HTML of a selected page area by URL and CSS selector
+[**get_selected_multiple**](SelectedHTMLApi.md#get_selected_multiple) | **GET** /selected-multiple | HTML of multiple page areas by URL and CSS selectors
+[**post_selected**](SelectedHTMLApi.md#post_selected) | **POST** /selected | HTML of a selected page areas by URL and CSS selector, with POST request to the target page
+[**post_selected_multiple**](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
+
+
+
+## get_selected
+
+> get_selected(url, opts)
+
+HTML of a selected page area by URL and CSS selector
+
+Returns just HTML on success, JSON on error
+
+### Example
+
+```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::SelectedHTMLApi.new
+url = 'https://example.com' # String | URL of the target page
+opts = {
+  selector: 'h1', # String | CSS selector (null by default, returns whole page HTML)
+  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)
+}
+
+begin
+  #HTML of a selected page area by URL and CSS selector
+  api_instance.get_selected(url, opts)
+rescue WebScrapingAI::ApiError => e
+  puts "Exception when calling SelectedHTMLApi->get_selected: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **url** | **String**| URL of the target page | 
+ **selector** | **String**| CSS selector (null by default, returns whole page HTML) | [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 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
+
+
+## get_selected_multiple
+
+> Array&lt;String&gt; get_selected_multiple(url, opts)
+
+HTML of multiple page areas by URL and CSS selectors
+
+Always returns JSON
+
+### Example
+
+```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::SelectedHTMLApi.new
+url = 'https://example.com' # String | URL of the target page
+opts = {
+  selectors: ['[\"h1\"]'], # Array<String> | Multiple CSS selectors (null by default, returns whole page HTML)
+  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)
+}
+
+begin
+  #HTML of multiple page areas by URL and CSS selectors
+  result = api_instance.get_selected_multiple(url, opts)
+  p result
+rescue WebScrapingAI::ApiError => e
+  puts "Exception when calling SelectedHTMLApi->get_selected_multiple: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **url** | **String**| URL of the target page | 
+ **selectors** | [**Array&lt;String&gt;**](String.md)| Multiple CSS selectors (null by default, returns whole page HTML) | [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 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
+
+**Array&lt;String&gt;**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## post_selected
+
+> post_selected(url, opts)
+
+HTML of a selected page areas by URL and CSS selector, 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
+
+```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::SelectedHTMLApi.new
+url = 'https://example.com' # String | URL of the target page
+opts = {
+  selector: 'h1', # String | CSS selector (null by default, returns whole page HTML)
+  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)
+}
+
+begin
+  #HTML of a selected page areas by URL and CSS selector, with POST request to the target page
+  api_instance.post_selected(url, opts)
+rescue WebScrapingAI::ApiError => e
+  puts "Exception when calling SelectedHTMLApi->post_selected: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **url** | **String**| URL of the target page | 
+ **selector** | **String**| CSS selector (null by default, returns whole page HTML) | [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 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
+
+
+## post_selected_multiple
+
+> Array&lt;String&gt; post_selected_multiple(url, opts)
+
+HTML of multiple page areas by URL and CSS selectors, with POST request to the target page
+
+Always returns JSON. Request body will be passed to the target page.
+
+### Example
+
+```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::SelectedHTMLApi.new
+url = 'https://example.com' # String | URL of the target page
+opts = {
+  selectors: ['[\"h1\"]'], # Array<String> | Multiple CSS selectors (null by default, returns whole page HTML)
+  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)
+}
+
+begin
+  #HTML of multiple page areas by URL and CSS selectors, with POST request to the target page
+  result = api_instance.post_selected_multiple(url, opts)
+  p result
+rescue WebScrapingAI::ApiError => e
+  puts "Exception when calling SelectedHTMLApi->post_selected_multiple: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **url** | **String**| URL of the target page | 
+ **selectors** | [**Array&lt;String&gt;**](String.md)| Multiple CSS selectors (null by default, returns whole page HTML) | [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 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
+
+**Array&lt;String&gt;**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+