com.blazebit.query.connector.kandji.api.ThreatsApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of blaze-query-connector-kandji-jersey3 Show documentation
A multi-platform querying library
The newest version!
package com.blazebit.query.connector.kandji.api;

import com.blazebit.query.connector.kandji.invoker.ApiException;
import com.blazebit.query.connector.kandji.invoker.ApiClient;
import com.blazebit.query.connector.kandji.invoker.ApiResponse;
import com.blazebit.query.connector.kandji.invoker.Configuration;
import com.blazebit.query.connector.kandji.invoker.Pair;

import jakarta.ws.rs.core.GenericType;

import com.blazebit.query.connector.kandji.model.GetThreatDetails200Response;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2025-04-30T07:19:31.168100307Z[Etc/UTC]", comments = "Generator version: 7.10.0")
public class ThreatsApi {
  private ApiClient apiClient;

  public ThreatsApi() {
    this(Configuration.getDefaultApiClient());
  }

  public ThreatsApi(ApiClient apiClient) {
    this.apiClient = apiClient;
  }

  /**
   * Get the API client
   *
   * @return API client
   */
  public ApiClient getApiClient() {
    return apiClient;
  }

  /**
   * Set the API client
   *
   * @param apiClient an instance of API client
   */
  public void setApiClient(ApiClient apiClient) {
    this.apiClient = apiClient;
  }

  /**
   * Get Threat Details
   * Get threat details.
   * @param classification Return all records matching a specified classification. The following classification options are available: `malware` and `pup`. Leave this parameter empty to return all classification types. (optional)
   * @param dateRange Return all records within a specified number of days. Any positive number of days may be specified. Examples: `7`, `30`, `60`, `90`, `180`, or `365`. (optional)
   * @param deviceId  (optional)
   * @param status Return all records matching a specified status. The following status options are available: `quarantined`, `not_quarantined`, or `released`. Leave this parameter empty to return all status types. (optional)
   * @param sortBy Results can be sorted with the following options:  - threat_name - classification - device_name - process_name - process_owner - detection_date - status  Prepending a dash (-) to the parameter value will reverse the order of the returned results.  `?sort_by=-device_name` will order the response by device_name in descending order. (optional)
   * @param term Search term to filter threat results.  The response will include anything matching the following fields: `device_name`, `file_hash`, and `file_path`.  So if you search for `bad file`, the results will include anywhere `bad file` exists in the three fields above. (optional)
   * @param limit A hard upper `limit` is set at 1000 records returned per request. If more records are expected, pagination should be used using the `limit` and `offset` parameters.   Additionally, parameter queries can be added to a request to limit the results. (optional)
   * @param offset Specify the starting record to return (optional)
   * @return GetThreatDetails200Response
   * @throws ApiException if fails to make API call
   * @http.response.details
     
       Response Details
        Status Code  Description  Response Headers 
        200  Get all details   -  
     
   */
  public GetThreatDetails200Response getThreatDetails(String classification, String dateRange, String deviceId, String status, String sortBy, String term, String limit, String offset) throws ApiException {
    return getThreatDetailsWithHttpInfo(classification, dateRange, deviceId, status, sortBy, term, limit, offset).getData();
  }

  /**
   * Get Threat Details
   * Get threat details.
   * @param classification Return all records matching a specified classification. The following classification options are available: `malware` and `pup`. Leave this parameter empty to return all classification types. (optional)
   * @param dateRange Return all records within a specified number of days. Any positive number of days may be specified. Examples: `7`, `30`, `60`, `90`, `180`, or `365`. (optional)
   * @param deviceId  (optional)
   * @param status Return all records matching a specified status. The following status options are available: `quarantined`, `not_quarantined`, or `released`. Leave this parameter empty to return all status types. (optional)
   * @param sortBy Results can be sorted with the following options:  - threat_name - classification - device_name - process_name - process_owner - detection_date - status  Prepending a dash (-) to the parameter value will reverse the order of the returned results.  `?sort_by=-device_name` will order the response by device_name in descending order. (optional)
   * @param term Search term to filter threat results.  The response will include anything matching the following fields: `device_name`, `file_hash`, and `file_path`.  So if you search for `bad file`, the results will include anywhere `bad file` exists in the three fields above. (optional)
   * @param limit A hard upper `limit` is set at 1000 records returned per request. If more records are expected, pagination should be used using the `limit` and `offset` parameters.   Additionally, parameter queries can be added to a request to limit the results. (optional)
   * @param offset Specify the starting record to return (optional)
   * @return ApiResponse<GetThreatDetails200Response>
   * @throws ApiException if fails to make API call
   * @http.response.details
     
       Response Details
        Status Code  Description  Response Headers 
        200  Get all details   -  
     
   */
  public ApiResponse getThreatDetailsWithHttpInfo(String classification, String dateRange, String deviceId, String status, String sortBy, String term, String limit, String offset) throws ApiException {
    // Query parameters
    List localVarQueryParams = new ArrayList<>(
            apiClient.parameterToPairs("", "classification", classification)
    );
    localVarQueryParams.addAll(apiClient.parameterToPairs("", "date_range", dateRange));
    localVarQueryParams.addAll(apiClient.parameterToPairs("", "device_id", deviceId));
    localVarQueryParams.addAll(apiClient.parameterToPairs("", "status", status));
    localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort_by", sortBy));
    localVarQueryParams.addAll(apiClient.parameterToPairs("", "term", term));
    localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit));
    localVarQueryParams.addAll(apiClient.parameterToPairs("", "offset", offset));

    String localVarAccept = apiClient.selectHeaderAccept("application/json");
    String localVarContentType = apiClient.selectHeaderContentType();
    String[] localVarAuthNames = new String[] {"bearerAuth"};
    GenericType localVarReturnType = new GenericType() {};
    return apiClient.invokeAPI("ThreatsApi.getThreatDetails", "/api/v1/threat-details", "GET", localVarQueryParams, null,
                               new LinkedHashMap<>(), new LinkedHashMap<>(), new LinkedHashMap<>(), localVarAccept, localVarContentType,
                               localVarAuthNames, localVarReturnType, false);
  }
}