Class: CloudmersiveValidateApiClient::UserAgentApi
- Inherits:
-
Object
- Object
- CloudmersiveValidateApiClient::UserAgentApi
- Defined in:
- lib/cloudmersive-validate-api-client/api/user_agent_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = ApiClient.default) ⇒ UserAgentApi
constructor
A new instance of UserAgentApi.
-
#user_agent_parse(request, opts = {}) ⇒ UserAgentValidateResponse
Parse an HTTP User-Agent string, identify robots Uses a parsing system and database to parse the User-Agent into its structured component parts, such as Browser, Browser Version, Browser Engine, Operating System, and importantly, Robot identification.
-
#user_agent_parse_with_http_info(request, opts = {}) ⇒ Array<(UserAgentValidateResponse, Fixnum, Hash)>
Parse an HTTP User-Agent string, identify robots Uses a parsing system and database to parse the User-Agent into its structured component parts, such as Browser, Browser Version, Browser Engine, Operating System, and importantly, Robot identification.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ UserAgentApi
Returns a new instance of UserAgentApi.
19 20 21 |
# File 'lib/cloudmersive-validate-api-client/api/user_agent_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/cloudmersive-validate-api-client/api/user_agent_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#user_agent_parse(request, opts = {}) ⇒ UserAgentValidateResponse
Parse an HTTP User-Agent string, identify robots Uses a parsing system and database to parse the User-Agent into its structured component parts, such as Browser, Browser Version, Browser Engine, Operating System, and importantly, Robot identification.
28 29 30 31 |
# File 'lib/cloudmersive-validate-api-client/api/user_agent_api.rb', line 28 def user_agent_parse(request, opts = {}) data, _status_code, _headers = user_agent_parse_with_http_info(request, opts) return data end |
#user_agent_parse_with_http_info(request, opts = {}) ⇒ Array<(UserAgentValidateResponse, Fixnum, Hash)>
Parse an HTTP User-Agent string, identify robots Uses a parsing system and database to parse the User-Agent into its structured component parts, such as Browser, Browser Version, Browser Engine, Operating System, and importantly, Robot identification.
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/cloudmersive-validate-api-client/api/user_agent_api.rb', line 38 def user_agent_parse_with_http_info(request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: UserAgentApi.user_agent_parse ..." end # verify the required parameter 'request' is set if @api_client.config.client_side_validation && request.nil? fail ArgumentError, "Missing the required parameter 'request' when calling UserAgentApi.user_agent_parse" end # resource path local_var_path = "/validate/useragent/parse" # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(request) auth_names = ['Apikey'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UserAgentValidateResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: UserAgentApi#user_agent_parse\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |