Class: CloudmersiveValidateApiClient::TextInputApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-validate-api-client/api/text_input_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TextInputApi

Returns a new instance of TextInputApi.



19
20
21
 
# File 'lib/cloudmersive-validate-api-client/api/text_input_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/text_input_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#text_input_check_sql_injection(value, opts = {}) ⇒ SqlInjectionDetectionResult

Check text input for SQL Injection (SQLI) attacks Detects SQL Injection (SQLI) attacks from text input.

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :detection_level (String) —

    Set to Normal to target a high-security SQL Injection detection level with a very low false positive rate; select High to target a very-high security SQL Injection detection level with higher false positives. Default is Normal (recommended).

Returns:



28
29
30
31
 
# File 'lib/cloudmersive-validate-api-client/api/text_input_api.rb', line 28

def text_input_check_sql_injection(value, opts = {})
  data, _status_code, _headers = text_input_check_sql_injection_with_http_info(value, opts)
  data
end

#text_input_check_sql_injection_batch(value, opts = {}) ⇒ SqlInjectionCheckBatchResponse

Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch Detects SQL Injection (SQLI) attacks from multiple text inputs. Output preverses order of input items.

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



84
85
86
87
 
# File 'lib/cloudmersive-validate-api-client/api/text_input_api.rb', line 84

def text_input_check_sql_injection_batch(value, opts = {})
  data, _status_code, _headers = text_input_check_sql_injection_batch_with_http_info(value, opts)
  data
end

#text_input_check_sql_injection_batch_with_http_info(value, opts = {}) ⇒ Array<(SqlInjectionCheckBatchResponse, Fixnum, Hash)>

Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch Detects SQL Injection (SQLI) attacks from multiple text inputs. Output preverses order of input items.

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/cloudmersive-validate-api-client/api/text_input_api.rb', line 94

def text_input_check_sql_injection_batch_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TextInputApi.text_input_check_sql_injection_batch ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling TextInputApi.text_input_check_sql_injection_batch"
  end
  # resource path
  local_var_path = '/validate/text-input/check/sql-injection/batch'

  # 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(value)
  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 => 'SqlInjectionCheckBatchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TextInputApi#text_input_check_sql_injection_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#text_input_check_sql_injection_with_http_info(value, opts = {}) ⇒ Array<(SqlInjectionDetectionResult, Fixnum, Hash)>

Check text input for SQL Injection (SQLI) attacks Detects SQL Injection (SQLI) attacks from text input.

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :detection_level (String) —

    Set to Normal to target a high-security SQL Injection detection level with a very low false positive rate; select High to target a very-high security SQL Injection detection level with higher false positives. Default is Normal (recommended).

Returns:



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
77
78
 
# File 'lib/cloudmersive-validate-api-client/api/text_input_api.rb', line 39

def text_input_check_sql_injection_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TextInputApi.text_input_check_sql_injection ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling TextInputApi.text_input_check_sql_injection"
  end
  # resource path
  local_var_path = '/validate/text-input/check/sql-injection'

  # 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'])
  header_params[:'detectionLevel'] = opts[:'detection_level'] if !opts[:'detection_level'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(value)
  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 => 'SqlInjectionDetectionResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TextInputApi#text_input_check_sql_injection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#text_input_check_xss(value, opts = {}) ⇒ XssProtectionResult

Check text input for Cross-Site-Scripting (XSS) attacks Detects XSS (Cross-Site-Scripting) attacks from text input.

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



138
139
140
141
 
# File 'lib/cloudmersive-validate-api-client/api/text_input_api.rb', line 138

def text_input_check_xss(value, opts = {})
  data, _status_code, _headers = text_input_check_xss_with_http_info(value, opts)
  data
end

#text_input_check_xss_batch(value, opts = {}) ⇒ XssProtectionBatchResponse

Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch Detects XSS (Cross-Site-Scripting) attacks from multiple text inputs. Output preverses order of input items.

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



192
193
194
195
 
# File 'lib/cloudmersive-validate-api-client/api/text_input_api.rb', line 192

def text_input_check_xss_batch(value, opts = {})
  data, _status_code, _headers = text_input_check_xss_batch_with_http_info(value, opts)
  data
end

#text_input_check_xss_batch_with_http_info(value, opts = {}) ⇒ Array<(XssProtectionBatchResponse, Fixnum, Hash)>

Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch Detects XSS (Cross-Site-Scripting) attacks from multiple text inputs. Output preverses order of input items.

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(XssProtectionBatchResponse, Fixnum, Hash)>) —

    XssProtectionBatchResponse data, response status code and response headers



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/cloudmersive-validate-api-client/api/text_input_api.rb', line 202

def text_input_check_xss_batch_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TextInputApi.text_input_check_xss_batch ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling TextInputApi.text_input_check_xss_batch"
  end
  # resource path
  local_var_path = '/validate/text-input/check-and-protect/xss/batch'

  # 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(value)
  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 => 'XssProtectionBatchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TextInputApi#text_input_check_xss_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#text_input_check_xss_with_http_info(value, opts = {}) ⇒ Array<(XssProtectionResult, Fixnum, Hash)>

Check text input for Cross-Site-Scripting (XSS) attacks Detects XSS (Cross-Site-Scripting) attacks from text input.

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(XssProtectionResult, Fixnum, Hash)>) —

    XssProtectionResult data, response status code and response headers



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/cloudmersive-validate-api-client/api/text_input_api.rb', line 148

def text_input_check_xss_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TextInputApi.text_input_check_xss ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling TextInputApi.text_input_check_xss"
  end
  # resource path
  local_var_path = '/validate/text-input/check/xss'

  # 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(value)
  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 => 'XssProtectionResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TextInputApi#text_input_check_xss\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#text_input_protect_xss(value, opts = {}) ⇒ XssProtectionResult

Protect text input from Cross-Site-Scripting (XSS) attacks through normalization Detects and removes XSS (Cross-Site-Scripting) attacks from text input through normalization. Returns the normalized result, as well as information on whether the original input contained an XSS risk.

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



246
247
248
249
 
# File 'lib/cloudmersive-validate-api-client/api/text_input_api.rb', line 246

def text_input_protect_xss(value, opts = {})
  data, _status_code, _headers = text_input_protect_xss_with_http_info(value, opts)
  data
end

#text_input_protect_xss_with_http_info(value, opts = {}) ⇒ Array<(XssProtectionResult, Fixnum, Hash)>

Protect text input from Cross-Site-Scripting (XSS) attacks through normalization Detects and removes XSS (Cross-Site-Scripting) attacks from text input through normalization. Returns the normalized result, as well as information on whether the original input contained an XSS risk.

Parameters:

  • value —

    User-facing text input.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(XssProtectionResult, Fixnum, Hash)>) —

    XssProtectionResult data, response status code and response headers



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/cloudmersive-validate-api-client/api/text_input_api.rb', line 256

def text_input_protect_xss_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TextInputApi.text_input_protect_xss ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling TextInputApi.text_input_protect_xss"
  end
  # resource path
  local_var_path = '/validate/text-input/protect/xss'

  # 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(value)
  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 => 'XssProtectionResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TextInputApi#text_input_protect_xss\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end