Class: Falcon::TailoredIntelligenceApi
- Inherits:
-
Object
- Object
- Falcon::TailoredIntelligenceApi
- Defined in:
- lib/crimson-falcon/api/tailored_intelligence_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get_events_body(id, opts = {}) ⇒ Array<Integer>
Get event body for the provided event ID.
-
#get_events_body_with_http_info(id, opts = {}) ⇒ Array<(Array<Integer>, Integer, Hash)>
Get event body for the provided event ID.
-
#get_events_entities(body, opts = {}) ⇒ DomainEventEntitiesResponse
Get events entities for specified ids.
-
#get_events_entities_with_http_info(body, opts = {}) ⇒ Array<(DomainEventEntitiesResponse, Integer, Hash)>
Get events entities for specified ids.
-
#get_rules_entities(body, opts = {}) ⇒ DomainRuleEntitiesResponse
Get rules entities for specified ids.
-
#get_rules_entities_with_http_info(body, opts = {}) ⇒ Array<(DomainRuleEntitiesResponse, Integer, Hash)>
Get rules entities for specified ids.
-
#initialize(api_client = ApiClient.default) ⇒ TailoredIntelligenceApi
constructor
A new instance of TailoredIntelligenceApi.
-
#query_events(opts = {}) ⇒ DomainQueryResponse
Get events ids that match the provided filter criteria.
-
#query_events_with_http_info(opts = {}) ⇒ Array<(DomainQueryResponse, Integer, Hash)>
Get events ids that match the provided filter criteria.
-
#query_rules(opts = {}) ⇒ DomainQueryResponse
Get rules ids that match the provided filter criteria.
-
#query_rules_with_http_info(opts = {}) ⇒ Array<(DomainQueryResponse, Integer, Hash)>
Get rules ids that match the provided filter criteria.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ TailoredIntelligenceApi
Returns a new instance of TailoredIntelligenceApi.
36 37 38 |
# File 'lib/crimson-falcon/api/tailored_intelligence_api.rb', line 36 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
34 35 36 |
# File 'lib/crimson-falcon/api/tailored_intelligence_api.rb', line 34 def api_client @api_client end |
Instance Method Details
#get_events_body(id, opts = {}) ⇒ Array<Integer>
Get event body for the provided event ID
43 44 45 46 |
# File 'lib/crimson-falcon/api/tailored_intelligence_api.rb', line 43 def get_events_body(id, opts = {}) data, _status_code, _headers = get_events_body_with_http_info(id, opts) data end |
#get_events_body_with_http_info(id, opts = {}) ⇒ Array<(Array<Integer>, Integer, Hash)>
Get event body for the provided event ID
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 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'lib/crimson-falcon/api/tailored_intelligence_api.rb', line 52 def get_events_body_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TailoredIntelligenceApi.get_events_body ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling TailoredIntelligenceApi.get_events_body" end # resource path local_var_path = '/ti/events/entities/events-full-body/v2' # query parameters query_params = opts[:query_params] || {} query_params[:'id'] = id # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Array<Integer>' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"TailoredIntelligenceApi.get_events_body", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TailoredIntelligenceApi#get_events_body\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_events_entities(body, opts = {}) ⇒ DomainEventEntitiesResponse
Get events entities for specified ids.
105 106 107 108 |
# File 'lib/crimson-falcon/api/tailored_intelligence_api.rb', line 105 def get_events_entities(body, opts = {}) data, _status_code, _headers = get_events_entities_with_http_info(body, opts) data end |
#get_events_entities_with_http_info(body, opts = {}) ⇒ Array<(DomainEventEntitiesResponse, Integer, Hash)>
Get events entities for specified ids.
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/crimson-falcon/api/tailored_intelligence_api.rb', line 114 def get_events_entities_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TailoredIntelligenceApi.get_events_entities ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling TailoredIntelligenceApi.get_events_entities" end # resource path local_var_path = '/ti/events/entities/events/GET/v2' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:debug_return_type] || 'DomainEventEntitiesResponse' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"TailoredIntelligenceApi.get_events_entities", :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(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TailoredIntelligenceApi#get_events_entities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_rules_entities(body, opts = {}) ⇒ DomainRuleEntitiesResponse
Get rules entities for specified ids.
171 172 173 174 |
# File 'lib/crimson-falcon/api/tailored_intelligence_api.rb', line 171 def get_rules_entities(body, opts = {}) data, _status_code, _headers = get_rules_entities_with_http_info(body, opts) data end |
#get_rules_entities_with_http_info(body, opts = {}) ⇒ Array<(DomainRuleEntitiesResponse, Integer, Hash)>
Get rules entities for specified ids.
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 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 |
# File 'lib/crimson-falcon/api/tailored_intelligence_api.rb', line 180 def get_rules_entities_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TailoredIntelligenceApi.get_rules_entities ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling TailoredIntelligenceApi.get_rules_entities" end # resource path local_var_path = '/ti/rules/entities/rules/GET/v2' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(body) # return_type return_type = opts[:debug_return_type] || 'DomainRuleEntitiesResponse' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"TailoredIntelligenceApi.get_rules_entities", :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(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TailoredIntelligenceApi#get_rules_entities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#query_events(opts = {}) ⇒ DomainQueryResponse
Get events ids that match the provided filter criteria.
241 242 243 244 |
# File 'lib/crimson-falcon/api/tailored_intelligence_api.rb', line 241 def query_events(opts = {}) data, _status_code, _headers = query_events_with_http_info(opts) data end |
#query_events_with_http_info(opts = {}) ⇒ Array<(DomainQueryResponse, Integer, Hash)>
Get events ids that match the provided filter criteria.
254 255 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 295 296 297 298 299 300 301 |
# File 'lib/crimson-falcon/api/tailored_intelligence_api.rb', line 254 def query_events_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TailoredIntelligenceApi.query_events ...' end # resource path local_var_path = '/ti/events/queries/events/v2' # query parameters query_params = opts[:query_params] || {} query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil? query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'DomainQueryResponse' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"TailoredIntelligenceApi.query_events", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TailoredIntelligenceApi#query_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#query_rules(opts = {}) ⇒ DomainQueryResponse
Get rules ids that match the provided filter criteria.
311 312 313 314 |
# File 'lib/crimson-falcon/api/tailored_intelligence_api.rb', line 311 def query_rules(opts = {}) data, _status_code, _headers = query_rules_with_http_info(opts) data end |
#query_rules_with_http_info(opts = {}) ⇒ Array<(DomainQueryResponse, Integer, Hash)>
Get rules ids that match the provided filter criteria.
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 |
# File 'lib/crimson-falcon/api/tailored_intelligence_api.rb', line 324 def query_rules_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TailoredIntelligenceApi.query_rules ...' end # resource path local_var_path = '/ti/rules/queries/rules/v2' # query parameters query_params = opts[:query_params] || {} query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil? query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'DomainQueryResponse' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"TailoredIntelligenceApi.query_rules", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: TailoredIntelligenceApi#query_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |