webscraping_ai 3.2.0 → 4.0.0

data/lib/webscraping_ai/api/ai_api.rb

@@ -1,295 +0,0 @@
-=begin
-#WebScraping.AI
-
-#WebScraping.AI scraping API provides LLM-powered tools with Chromium JavaScript rendering, rotating proxies, and built-in HTML parsing.
-
-The version of the OpenAPI document: 3.2.0
-Contact: support@webscraping.ai
-Generated by: https://openapi-generator.tech
-Generator version: 7.11.0
-
-=end
-
-require 'cgi'
-
-module WebScrapingAI
-  class AIApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # 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.
-    # @param url [String] URL of the target page.
-    # @param fields [Hash<String, String>] Object describing fields to extract from the page and their descriptions
-    # @param [Hash] opts the optional parameters
-    # @option opts [Hash<String, String>] :headers 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;}).
-    # @option opts [Integer] :timeout Maximum web page retrieval time in ms. Increase it in case of timeout errors (10000 by default, maximum is 30000). (default to 10000)
-    # @option opts [Boolean] :js Execute on-page JavaScript using a headless browser (true by default). (default to true)
-    # @option opts [Integer] :js_timeout Maximum JavaScript rendering time in ms. Increase it in case if you see a loading indicator instead of data on the target page. (default to 2000)
-    # @option opts [String] :wait_for CSS selector to wait for before returning the page content. Useful for pages with dynamic content loading. Overrides js_timeout.
-    # @option opts [String] :proxy 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. (default to 'datacenter')
-    # @option opts [String] :country Country of the proxy to use (US by default). (default to 'us')
-    # @option opts [String] :custom_proxy 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).
-    # @option opts [String] :device Type of device emulation. (default to 'desktop')
-    # @option opts [Boolean] :error_on_404 Return error on 404 HTTP status on the target page (false by default). (default to false)
-    # @option opts [Boolean] :error_on_redirect Return error on redirect on the target page (false by default). (default to false)
-    # @option opts [String] :js_script Custom JavaScript code to execute on the target page.
-    # @return [Hash<String, String>]
-    def get_fields(url, fields, opts = {})
-      data, _status_code, _headers = get_fields_with_http_info(url, fields, opts)
-      data
-    end
-
-    # 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.
-    # @param url [String] URL of the target page.
-    # @param fields [Hash<String, String>] Object describing fields to extract from the page and their descriptions
-    # @param [Hash] opts the optional parameters
-    # @option opts [Hash<String, String>] :headers 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;}).
-    # @option opts [Integer] :timeout Maximum web page retrieval time in ms. Increase it in case of timeout errors (10000 by default, maximum is 30000). (default to 10000)
-    # @option opts [Boolean] :js Execute on-page JavaScript using a headless browser (true by default). (default to true)
-    # @option opts [Integer] :js_timeout Maximum JavaScript rendering time in ms. Increase it in case if you see a loading indicator instead of data on the target page. (default to 2000)
-    # @option opts [String] :wait_for CSS selector to wait for before returning the page content. Useful for pages with dynamic content loading. Overrides js_timeout.
-    # @option opts [String] :proxy 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. (default to 'datacenter')
-    # @option opts [String] :country Country of the proxy to use (US by default). (default to 'us')
-    # @option opts [String] :custom_proxy 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).
-    # @option opts [String] :device Type of device emulation. (default to 'desktop')
-    # @option opts [Boolean] :error_on_404 Return error on 404 HTTP status on the target page (false by default). (default to false)
-    # @option opts [Boolean] :error_on_redirect Return error on redirect on the target page (false by default). (default to false)
-    # @option opts [String] :js_script Custom JavaScript code to execute on the target page.
-    # @return [Array<(Hash<String, String>, Integer, Hash)>] Hash<String, String> data, response status code and response headers
-    def get_fields_with_http_info(url, fields, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AIApi.get_fields ...'
-      end
-      # verify the required parameter 'url' is set
-      if @api_client.config.client_side_validation && url.nil?
-        fail ArgumentError, "Missing the required parameter 'url' when calling AIApi.get_fields"
-      end
-      # verify the required parameter 'fields' is set
-      if @api_client.config.client_side_validation && fields.nil?
-        fail ArgumentError, "Missing the required parameter 'fields' when calling AIApi.get_fields"
-      end
-      if @api_client.config.client_side_validation && !opts[:'timeout'].nil? && opts[:'timeout'] > 30000
-        fail ArgumentError, 'invalid value for "opts[:"timeout"]" when calling AIApi.get_fields, must be smaller than or equal to 30000.'
-      end
-
-      if @api_client.config.client_side_validation && !opts[:'timeout'].nil? && opts[:'timeout'] < 1
-        fail ArgumentError, 'invalid value for "opts[:"timeout"]" when calling AIApi.get_fields, must be greater than or equal to 1.'
-      end
-
-      if @api_client.config.client_side_validation && !opts[:'js_timeout'].nil? && opts[:'js_timeout'] > 20000
-        fail ArgumentError, 'invalid value for "opts[:"js_timeout"]" when calling AIApi.get_fields, must be smaller than or equal to 20000.'
-      end
-
-      if @api_client.config.client_side_validation && !opts[:'js_timeout'].nil? && opts[:'js_timeout'] < 1
-        fail ArgumentError, 'invalid value for "opts[:"js_timeout"]" when calling AIApi.get_fields, must be greater than or equal to 1.'
-      end
-
-      allowable_values = ["datacenter", "residential"]
-      if @api_client.config.client_side_validation && opts[:'proxy'] && !allowable_values.include?(opts[:'proxy'])
-        fail ArgumentError, "invalid value for \"proxy\", must be one of #{allowable_values}"
-      end
-      allowable_values = ["us", "gb", "de", "it", "fr", "ca", "es", "ru", "jp", "kr", "in"]
-      if @api_client.config.client_side_validation && opts[:'country'] && !allowable_values.include?(opts[:'country'])
-        fail ArgumentError, "invalid value for \"country\", must be one of #{allowable_values}"
-      end
-      allowable_values = ["desktop", "mobile", "tablet"]
-      if @api_client.config.client_side_validation && opts[:'device'] && !allowable_values.include?(opts[:'device'])
-        fail ArgumentError, "invalid value for \"device\", must be one of #{allowable_values}"
-      end
-      # resource path
-      local_var_path = '/ai/fields'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'url'] = url
-      query_params[:'fields'] = fields
-      query_params[:'headers'] = opts[:'headers'] if !opts[:'headers'].nil?
-      query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
-      query_params[:'js'] = opts[:'js'] if !opts[:'js'].nil?
-      query_params[:'js_timeout'] = opts[:'js_timeout'] if !opts[:'js_timeout'].nil?
-      query_params[:'wait_for'] = opts[:'wait_for'] if !opts[:'wait_for'].nil?
-      query_params[:'proxy'] = opts[:'proxy'] if !opts[:'proxy'].nil?
-      query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
-      query_params[:'custom_proxy'] = opts[:'custom_proxy'] if !opts[:'custom_proxy'].nil?
-      query_params[:'device'] = opts[:'device'] if !opts[:'device'].nil?
-      query_params[:'error_on_404'] = opts[:'error_on_404'] if !opts[:'error_on_404'].nil?
-      query_params[:'error_on_redirect'] = opts[:'error_on_redirect'] if !opts[:'error_on_redirect'].nil?
-      query_params[:'js_script'] = opts[:'js_script'] if !opts[:'js_script'].nil?
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body]
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'Hash<String, String>'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['api_key']
-
-      new_options = opts.merge(
-        :operation => :"AIApi.get_fields",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AIApi#get_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # 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.
-    # @param url [String] URL of the target page.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :question Question or instructions to ask the LLM model about the target page.
-    # @option opts [Hash<String, String>] :headers 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;}).
-    # @option opts [Integer] :timeout Maximum web page retrieval time in ms. Increase it in case of timeout errors (10000 by default, maximum is 30000). (default to 10000)
-    # @option opts [Boolean] :js Execute on-page JavaScript using a headless browser (true by default). (default to true)
-    # @option opts [Integer] :js_timeout Maximum JavaScript rendering time in ms. Increase it in case if you see a loading indicator instead of data on the target page. (default to 2000)
-    # @option opts [String] :wait_for CSS selector to wait for before returning the page content. Useful for pages with dynamic content loading. Overrides js_timeout.
-    # @option opts [String] :proxy 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. (default to 'datacenter')
-    # @option opts [String] :country Country of the proxy to use (US by default). (default to 'us')
-    # @option opts [String] :custom_proxy 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).
-    # @option opts [String] :device Type of device emulation. (default to 'desktop')
-    # @option opts [Boolean] :error_on_404 Return error on 404 HTTP status on the target page (false by default). (default to false)
-    # @option opts [Boolean] :error_on_redirect Return error on redirect on the target page (false by default). (default to false)
-    # @option opts [String] :js_script Custom JavaScript code to execute on the target page.
-    # @option opts [String] :format 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. (default to 'json')
-    # @return [String]
-    def get_question(url, opts = {})
-      data, _status_code, _headers = get_question_with_http_info(url, opts)
-      data
-    end
-
-    # 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.
-    # @param url [String] URL of the target page.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :question Question or instructions to ask the LLM model about the target page.
-    # @option opts [Hash<String, String>] :headers 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;}).
-    # @option opts [Integer] :timeout Maximum web page retrieval time in ms. Increase it in case of timeout errors (10000 by default, maximum is 30000). (default to 10000)
-    # @option opts [Boolean] :js Execute on-page JavaScript using a headless browser (true by default). (default to true)
-    # @option opts [Integer] :js_timeout Maximum JavaScript rendering time in ms. Increase it in case if you see a loading indicator instead of data on the target page. (default to 2000)
-    # @option opts [String] :wait_for CSS selector to wait for before returning the page content. Useful for pages with dynamic content loading. Overrides js_timeout.
-    # @option opts [String] :proxy 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. (default to 'datacenter')
-    # @option opts [String] :country Country of the proxy to use (US by default). (default to 'us')
-    # @option opts [String] :custom_proxy 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).
-    # @option opts [String] :device Type of device emulation. (default to 'desktop')
-    # @option opts [Boolean] :error_on_404 Return error on 404 HTTP status on the target page (false by default). (default to false)
-    # @option opts [Boolean] :error_on_redirect Return error on redirect on the target page (false by default). (default to false)
-    # @option opts [String] :js_script Custom JavaScript code to execute on the target page.
-    # @option opts [String] :format 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. (default to 'json')
-    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
-    def get_question_with_http_info(url, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AIApi.get_question ...'
-      end
-      # verify the required parameter 'url' is set
-      if @api_client.config.client_side_validation && url.nil?
-        fail ArgumentError, "Missing the required parameter 'url' when calling AIApi.get_question"
-      end
-      if @api_client.config.client_side_validation && !opts[:'timeout'].nil? && opts[:'timeout'] > 30000
-        fail ArgumentError, 'invalid value for "opts[:"timeout"]" when calling AIApi.get_question, must be smaller than or equal to 30000.'
-      end
-
-      if @api_client.config.client_side_validation && !opts[:'timeout'].nil? && opts[:'timeout'] < 1
-        fail ArgumentError, 'invalid value for "opts[:"timeout"]" when calling AIApi.get_question, must be greater than or equal to 1.'
-      end
-
-      if @api_client.config.client_side_validation && !opts[:'js_timeout'].nil? && opts[:'js_timeout'] > 20000
-        fail ArgumentError, 'invalid value for "opts[:"js_timeout"]" when calling AIApi.get_question, must be smaller than or equal to 20000.'
-      end
-
-      if @api_client.config.client_side_validation && !opts[:'js_timeout'].nil? && opts[:'js_timeout'] < 1
-        fail ArgumentError, 'invalid value for "opts[:"js_timeout"]" when calling AIApi.get_question, must be greater than or equal to 1.'
-      end
-
-      allowable_values = ["datacenter", "residential"]
-      if @api_client.config.client_side_validation && opts[:'proxy'] && !allowable_values.include?(opts[:'proxy'])
-        fail ArgumentError, "invalid value for \"proxy\", must be one of #{allowable_values}"
-      end
-      allowable_values = ["us", "gb", "de", "it", "fr", "ca", "es", "ru", "jp", "kr", "in"]
-      if @api_client.config.client_side_validation && opts[:'country'] && !allowable_values.include?(opts[:'country'])
-        fail ArgumentError, "invalid value for \"country\", must be one of #{allowable_values}"
-      end
-      allowable_values = ["desktop", "mobile", "tablet"]
-      if @api_client.config.client_side_validation && opts[:'device'] && !allowable_values.include?(opts[:'device'])
-        fail ArgumentError, "invalid value for \"device\", must be one of #{allowable_values}"
-      end
-      allowable_values = ["json", "text"]
-      if @api_client.config.client_side_validation && opts[:'format'] && !allowable_values.include?(opts[:'format'])
-        fail ArgumentError, "invalid value for \"format\", must be one of #{allowable_values}"
-      end
-      # resource path
-      local_var_path = '/ai/question'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'url'] = url
-      query_params[:'question'] = opts[:'question'] if !opts[:'question'].nil?
-      query_params[:'headers'] = opts[:'headers'] if !opts[:'headers'].nil?
-      query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
-      query_params[:'js'] = opts[:'js'] if !opts[:'js'].nil?
-      query_params[:'js_timeout'] = opts[:'js_timeout'] if !opts[:'js_timeout'].nil?
-      query_params[:'wait_for'] = opts[:'wait_for'] if !opts[:'wait_for'].nil?
-      query_params[:'proxy'] = opts[:'proxy'] if !opts[:'proxy'].nil?
-      query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
-      query_params[:'custom_proxy'] = opts[:'custom_proxy'] if !opts[:'custom_proxy'].nil?
-      query_params[:'device'] = opts[:'device'] if !opts[:'device'].nil?
-      query_params[:'error_on_404'] = opts[:'error_on_404'] if !opts[:'error_on_404'].nil?
-      query_params[:'error_on_redirect'] = opts[:'error_on_redirect'] if !opts[:'error_on_redirect'].nil?
-      query_params[:'js_script'] = opts[:'js_script'] if !opts[:'js_script'].nil?
-      query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/html']) unless header_params['Accept']
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body]
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'String'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['api_key']
-
-      new_options = opts.merge(
-        :operation => :"AIApi.get_question",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AIApi#get_question\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end

data/lib/webscraping_ai/api/html_api.rb

@@ -1,160 +0,0 @@
-=begin
-#WebScraping.AI
-
-#WebScraping.AI scraping API provides LLM-powered tools with Chromium JavaScript rendering, rotating proxies, and built-in HTML parsing.
-
-The version of the OpenAPI document: 3.2.0
-Contact: support@webscraping.ai
-Generated by: https://openapi-generator.tech
-Generator version: 7.11.0
-
-=end
-
-require 'cgi'
-
-module WebScrapingAI
-  class HTMLApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # 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.
-    # @param url [String] URL of the target page.
-    # @param [Hash] opts the optional parameters
-    # @option opts [Hash<String, String>] :headers 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;}).
-    # @option opts [Integer] :timeout Maximum web page retrieval time in ms. Increase it in case of timeout errors (10000 by default, maximum is 30000). (default to 10000)
-    # @option opts [Boolean] :js Execute on-page JavaScript using a headless browser (true by default). (default to true)
-    # @option opts [Integer] :js_timeout Maximum JavaScript rendering time in ms. Increase it in case if you see a loading indicator instead of data on the target page. (default to 2000)
-    # @option opts [String] :wait_for CSS selector to wait for before returning the page content. Useful for pages with dynamic content loading. Overrides js_timeout.
-    # @option opts [String] :proxy 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. (default to 'datacenter')
-    # @option opts [String] :country Country of the proxy to use (US by default). (default to 'us')
-    # @option opts [String] :custom_proxy 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).
-    # @option opts [String] :device Type of device emulation. (default to 'desktop')
-    # @option opts [Boolean] :error_on_404 Return error on 404 HTTP status on the target page (false by default). (default to false)
-    # @option opts [Boolean] :error_on_redirect Return error on redirect on the target page (false by default). (default to false)
-    # @option opts [String] :js_script Custom JavaScript code to execute on the target page.
-    # @option opts [Boolean] :return_script_result Return result of the custom JavaScript code (js_script parameter) execution on the target page (false by default, page HTML will be returned). (default to false)
-    # @option opts [String] :format 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. (default to 'json')
-    # @return [String]
-    def get_html(url, opts = {})
-      data, _status_code, _headers = get_html_with_http_info(url, opts)
-      data
-    end
-
-    # 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.
-    # @param url [String] URL of the target page.
-    # @param [Hash] opts the optional parameters
-    # @option opts [Hash<String, String>] :headers 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;}).
-    # @option opts [Integer] :timeout Maximum web page retrieval time in ms. Increase it in case of timeout errors (10000 by default, maximum is 30000). (default to 10000)
-    # @option opts [Boolean] :js Execute on-page JavaScript using a headless browser (true by default). (default to true)
-    # @option opts [Integer] :js_timeout Maximum JavaScript rendering time in ms. Increase it in case if you see a loading indicator instead of data on the target page. (default to 2000)
-    # @option opts [String] :wait_for CSS selector to wait for before returning the page content. Useful for pages with dynamic content loading. Overrides js_timeout.
-    # @option opts [String] :proxy 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. (default to 'datacenter')
-    # @option opts [String] :country Country of the proxy to use (US by default). (default to 'us')
-    # @option opts [String] :custom_proxy 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).
-    # @option opts [String] :device Type of device emulation. (default to 'desktop')
-    # @option opts [Boolean] :error_on_404 Return error on 404 HTTP status on the target page (false by default). (default to false)
-    # @option opts [Boolean] :error_on_redirect Return error on redirect on the target page (false by default). (default to false)
-    # @option opts [String] :js_script Custom JavaScript code to execute on the target page.
-    # @option opts [Boolean] :return_script_result Return result of the custom JavaScript code (js_script parameter) execution on the target page (false by default, page HTML will be returned). (default to false)
-    # @option opts [String] :format 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. (default to 'json')
-    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
-    def get_html_with_http_info(url, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: HTMLApi.get_html ...'
-      end
-      # verify the required parameter 'url' is set
-      if @api_client.config.client_side_validation && url.nil?
-        fail ArgumentError, "Missing the required parameter 'url' when calling HTMLApi.get_html"
-      end
-      if @api_client.config.client_side_validation && !opts[:'timeout'].nil? && opts[:'timeout'] > 30000
-        fail ArgumentError, 'invalid value for "opts[:"timeout"]" when calling HTMLApi.get_html, must be smaller than or equal to 30000.'
-      end
-
-      if @api_client.config.client_side_validation && !opts[:'timeout'].nil? && opts[:'timeout'] < 1
-        fail ArgumentError, 'invalid value for "opts[:"timeout"]" when calling HTMLApi.get_html, must be greater than or equal to 1.'
-      end
-
-      if @api_client.config.client_side_validation && !opts[:'js_timeout'].nil? && opts[:'js_timeout'] > 20000
-        fail ArgumentError, 'invalid value for "opts[:"js_timeout"]" when calling HTMLApi.get_html, must be smaller than or equal to 20000.'
-      end
-
-      if @api_client.config.client_side_validation && !opts[:'js_timeout'].nil? && opts[:'js_timeout'] < 1
-        fail ArgumentError, 'invalid value for "opts[:"js_timeout"]" when calling HTMLApi.get_html, must be greater than or equal to 1.'
-      end
-
-      allowable_values = ["datacenter", "residential"]
-      if @api_client.config.client_side_validation && opts[:'proxy'] && !allowable_values.include?(opts[:'proxy'])
-        fail ArgumentError, "invalid value for \"proxy\", must be one of #{allowable_values}"
-      end
-      allowable_values = ["us", "gb", "de", "it", "fr", "ca", "es", "ru", "jp", "kr", "in"]
-      if @api_client.config.client_side_validation && opts[:'country'] && !allowable_values.include?(opts[:'country'])
-        fail ArgumentError, "invalid value for \"country\", must be one of #{allowable_values}"
-      end
-      allowable_values = ["desktop", "mobile", "tablet"]
-      if @api_client.config.client_side_validation && opts[:'device'] && !allowable_values.include?(opts[:'device'])
-        fail ArgumentError, "invalid value for \"device\", must be one of #{allowable_values}"
-      end
-      allowable_values = ["json", "text"]
-      if @api_client.config.client_side_validation && opts[:'format'] && !allowable_values.include?(opts[:'format'])
-        fail ArgumentError, "invalid value for \"format\", must be one of #{allowable_values}"
-      end
-      # resource path
-      local_var_path = '/html'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'url'] = url
-      query_params[:'headers'] = opts[:'headers'] if !opts[:'headers'].nil?
-      query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
-      query_params[:'js'] = opts[:'js'] if !opts[:'js'].nil?
-      query_params[:'js_timeout'] = opts[:'js_timeout'] if !opts[:'js_timeout'].nil?
-      query_params[:'wait_for'] = opts[:'wait_for'] if !opts[:'wait_for'].nil?
-      query_params[:'proxy'] = opts[:'proxy'] if !opts[:'proxy'].nil?
-      query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
-      query_params[:'custom_proxy'] = opts[:'custom_proxy'] if !opts[:'custom_proxy'].nil?
-      query_params[:'device'] = opts[:'device'] if !opts[:'device'].nil?
-      query_params[:'error_on_404'] = opts[:'error_on_404'] if !opts[:'error_on_404'].nil?
-      query_params[:'error_on_redirect'] = opts[:'error_on_redirect'] if !opts[:'error_on_redirect'].nil?
-      query_params[:'js_script'] = opts[:'js_script'] if !opts[:'js_script'].nil?
-      query_params[:'return_script_result'] = opts[:'return_script_result'] if !opts[:'return_script_result'].nil?
-      query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/html']) unless header_params['Accept']
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body]
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'String'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['api_key']
-
-      new_options = opts.merge(
-        :operation => :"HTMLApi.get_html",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: HTMLApi#get_html\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end