com.blazebit.query.connector.kandji.api.CustomScriptsApi 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.CreateCustomScript201Response;
import com.blazebit.query.connector.kandji.model.ListCustomScripts200Response;
import com.blazebit.query.connector.kandji.model.ListCustomScripts200ResponseResultsInner;
import com.blazebit.query.connector.kandji.model.UpdateCustomScript200Response;

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 CustomScriptsApi {
  private ApiClient apiClient;

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

  public CustomScriptsApi(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;
  }

  /**
   * Create Custom Script
   * This request allows you to create a custom script in the Kandji library.
   * @return CreateCustomScript201Response
   * @throws ApiException if fails to make API call
   * @http.response.details
     
       Response Details
        Status Code  Description  Response Headers 
        201  success   * Allow -  
  * Content-Length -  
  * Content-Security-Policy -  
  * Cross-Origin-Opener-Policy -  
  * Date -  
  * Feature-Policy -  
  * Referrer-Policy -  
  * Server -  
  * Vary -  
  * X-Content-Type-Options -  
  * X-Frame-Options -  
  
     
   */
  public CreateCustomScript201Response createCustomScript() throws ApiException {
    return createCustomScriptWithHttpInfo().getData();
  }

  /**
   * Create Custom Script
   * This request allows you to create a custom script in the Kandji library.
   * @return ApiResponse<CreateCustomScript201Response>
   * @throws ApiException if fails to make API call
   * @http.response.details
     
       Response Details
        Status Code  Description  Response Headers 
        201  success   * Allow -  
  * Content-Length -  
  * Content-Security-Policy -  
  * Cross-Origin-Opener-Policy -  
  * Date -  
  * Feature-Policy -  
  * Referrer-Policy -  
  * Server -  
  * Vary -  
  * X-Content-Type-Options -  
  * X-Frame-Options -  
  
     
   */
  public ApiResponse createCustomScriptWithHttpInfo() throws ApiException {
    String localVarAccept = apiClient.selectHeaderAccept("application/json");
    String localVarContentType = apiClient.selectHeaderContentType("application/json");
    String[] localVarAuthNames = new String[] {"bearerAuth"};
    GenericType localVarReturnType = new GenericType() {};
    return apiClient.invokeAPI("CustomScriptsApi.createCustomScript", "/api/v1/library/custom-scripts", "POST", new ArrayList<>(), null,
                               new LinkedHashMap<>(), new LinkedHashMap<>(), new LinkedHashMap<>(), localVarAccept, localVarContentType,
                               localVarAuthNames, localVarReturnType, false);
  }
  /**
   * Delete Custom Script
   * NOTICE: This is permanent so be careful.  This endpoint sends a request to delete a specific custom scripts from the Kandji library.  ### Request Parameters  `library_item_id` (path parameter): The unique identifier of the library item.
   * @param libraryItemId  (required)
   * @throws ApiException if fails to make API call
   * @http.response.details
     
       Response Details
        Status Code  Description  Response Headers 
        204  success   * Allow -  
  * Content-Length -  
  * Content-Security-Policy -  
  * Cross-Origin-Opener-Policy -  
  * Date -  
  * Feature-Policy -  
  * Referrer-Policy -  
  * Server -  
  * Vary -  
  * X-Content-Type-Options -  
  * X-Frame-Options -  
  
        404  requested library item not found   * Accept-Ranges -  
  * Access-Control-Allow-Origin -  
  * Connection -  
  * Content-Encoding -  
  * Content-Security-Policy -  
  * Cross-Origin-Opener-Policy -  
  * Date -  
  * Feature-Policy -  
  * Ratelimit-Limit -  
  * Ratelimit-Remaining -  
  * Ratelimit-Reset -  
  * Referrer-Policy -  
  * Server -  
  * Strict-Transport-Security -  
  * Vary -  
  * Via -  
  * X-Cache -  
  * X-Cache-Hits -  
  * X-Content-Type-Options -  
  * X-Frame-Options -  
  * X-Kong-Proxy-Latency -  
  * X-Kong-Upstream-Latency -  
  * X-Ratelimit-Limit-Hour -  
  * X-Ratelimit-Limit-Second -  
  * X-Ratelimit-Remaining-Hour -  
  * X-Ratelimit-Remaining-Second -  
  * X-Served-By -  
  * X-Timer -  
  * transfer-encoding -  
  
     
   */
  public void deleteCustomScript(String libraryItemId) throws ApiException {
    deleteCustomScriptWithHttpInfo(libraryItemId);
  }

  /**
   * Delete Custom Script
   * NOTICE: This is permanent so be careful.  This endpoint sends a request to delete a specific custom scripts from the Kandji library.  ### Request Parameters  `library_item_id` (path parameter): The unique identifier of the library item.
   * @param libraryItemId  (required)
   * @return ApiResponse<Void>
   * @throws ApiException if fails to make API call
   * @http.response.details
     
       Response Details
        Status Code  Description  Response Headers 
        204  success   * Allow -  
  * Content-Length -  
  * Content-Security-Policy -  
  * Cross-Origin-Opener-Policy -  
  * Date -  
  * Feature-Policy -  
  * Referrer-Policy -  
  * Server -  
  * Vary -  
  * X-Content-Type-Options -  
  * X-Frame-Options -  
  
        404  requested library item not found   * Accept-Ranges -  
  * Access-Control-Allow-Origin -  
  * Connection -  
  * Content-Encoding -  
  * Content-Security-Policy -  
  * Cross-Origin-Opener-Policy -  
  * Date -  
  * Feature-Policy -  
  * Ratelimit-Limit -  
  * Ratelimit-Remaining -  
  * Ratelimit-Reset -  
  * Referrer-Policy -  
  * Server -  
  * Strict-Transport-Security -  
  * Vary -  
  * Via -  
  * X-Cache -  
  * X-Cache-Hits -  
  * X-Content-Type-Options -  
  * X-Frame-Options -  
  * X-Kong-Proxy-Latency -  
  * X-Kong-Upstream-Latency -  
  * X-Ratelimit-Limit-Hour -  
  * X-Ratelimit-Limit-Second -  
  * X-Ratelimit-Remaining-Hour -  
  * X-Ratelimit-Remaining-Second -  
  * X-Served-By -  
  * X-Timer -  
  * transfer-encoding -  
  
     
   */
  public ApiResponse deleteCustomScriptWithHttpInfo(String libraryItemId) throws ApiException {
    // Check required parameters
    if (libraryItemId == null) {
      throw new ApiException(400, "Missing the required parameter 'libraryItemId' when calling deleteCustomScript");
    }

    // Path parameters
    String localVarPath = "/api/v1/library/custom-scripts/{library_item_id}"
            .replaceAll("\\{library_item_id}", apiClient.escapeString(libraryItemId.toString()));

    String localVarAccept = apiClient.selectHeaderAccept("text/plain");
    String localVarContentType = apiClient.selectHeaderContentType();
    String[] localVarAuthNames = new String[] {"bearerAuth"};
    return apiClient.invokeAPI("CustomScriptsApi.deleteCustomScript", localVarPath, "DELETE", new ArrayList<>(), null,
                               new LinkedHashMap<>(), new LinkedHashMap<>(), new LinkedHashMap<>(), localVarAccept, localVarContentType,
                               localVarAuthNames, null, false);
  }
  /**
   * Get Custom Script
   * This endpoint retrieves details about a specific custom script from the Kandji library.  ### Request Parameters  `library_item_id` (path parameter): The unique identifier of the library item.
   * @param libraryItemId  (required)
   * @return ListCustomScripts200ResponseResultsInner
   * @throws ApiException if fails to make API call
   * @http.response.details
     
       Response Details
        Status Code  Description  Response Headers 
        200  success   * Allow -  
  * Content-Length -  
  * Content-Security-Policy -  
  * Cross-Origin-Opener-Policy -  
  * Date -  
  * Feature-Policy -  
  * Referrer-Policy -  
  * Server -  
  * Vary -  
  * X-Content-Type-Options -  
  * X-Frame-Options -  
  
     
   */
  public ListCustomScripts200ResponseResultsInner getCustomScript(String libraryItemId) throws ApiException {
    return getCustomScriptWithHttpInfo(libraryItemId).getData();
  }

  /**
   * Get Custom Script
   * This endpoint retrieves details about a specific custom script from the Kandji library.  ### Request Parameters  `library_item_id` (path parameter): The unique identifier of the library item.
   * @param libraryItemId  (required)
   * @return ApiResponse<ListCustomScripts200ResponseResultsInner>
   * @throws ApiException if fails to make API call
   * @http.response.details
     
       Response Details
        Status Code  Description  Response Headers 
        200  success   * Allow -  
  * Content-Length -  
  * Content-Security-Policy -  
  * Cross-Origin-Opener-Policy -  
  * Date -  
  * Feature-Policy -  
  * Referrer-Policy -  
  * Server -  
  * Vary -  
  * X-Content-Type-Options -  
  * X-Frame-Options -  
  
     
   */
  public ApiResponse getCustomScriptWithHttpInfo(String libraryItemId) throws ApiException {
    // Check required parameters
    if (libraryItemId == null) {
      throw new ApiException(400, "Missing the required parameter 'libraryItemId' when calling getCustomScript");
    }

    // Path parameters
    String localVarPath = "/api/v1/library/custom-scripts/{library_item_id}"
            .replaceAll("\\{library_item_id}", apiClient.escapeString(libraryItemId.toString()));

    String localVarAccept = apiClient.selectHeaderAccept("application/json");
    String localVarContentType = apiClient.selectHeaderContentType();
    String[] localVarAuthNames = new String[] {"bearerAuth"};
    GenericType localVarReturnType = new GenericType() {};
    return apiClient.invokeAPI("CustomScriptsApi.getCustomScript", localVarPath, "GET", new ArrayList<>(), null,
                               new LinkedHashMap<>(), new LinkedHashMap<>(), new LinkedHashMap<>(), localVarAccept, localVarContentType,
                               localVarAuthNames, localVarReturnType, false);
  }
  /**
   * List Custom Scripts
   * This endpoint makes a request to retrieve a list of custom scripts from the Kandji library.
   * @param page Optional page number (when results exceed pagination threshold) (optional)
   * @return ListCustomScripts200Response
   * @throws ApiException if fails to make API call
   * @http.response.details
     
       Response Details
        Status Code  Description  Response Headers 
        200  success   * Accept-Ranges -  
  * Access-Control-Allow-Origin -  
  * Allow -  
  * Connection -  
  * Content-Encoding -  
  * Content-Security-Policy -  
  * Cross-Origin-Opener-Policy -  
  * Date -  
  * Feature-Policy -  
  * Ratelimit-Limit -  
  * Ratelimit-Remaining -  
  * Ratelimit-Reset -  
  * Referrer-Policy -  
  * Server -  
  * Strict-Transport-Security -  
  * Vary -  
  * Via -  
  * X-Cache -  
  * X-Cache-Hits -  
  * X-Content-Type-Options -  
  * X-Frame-Options -  
  * X-Kong-Proxy-Latency -  
  * X-Kong-Upstream-Latency -  
  * X-Ratelimit-Limit-Hour -  
  * X-Ratelimit-Limit-Second -  
  * X-Ratelimit-Remaining-Hour -  
  * X-Ratelimit-Remaining-Second -  
  * X-Served-By -  
  * X-Timer -  
  * transfer-encoding -  
  
     
   */
  public ListCustomScripts200Response listCustomScripts(String page) throws ApiException {
    return listCustomScriptsWithHttpInfo(page).getData();
  }

  /**
   * List Custom Scripts
   * This endpoint makes a request to retrieve a list of custom scripts from the Kandji library.
   * @param page Optional page number (when results exceed pagination threshold) (optional)
   * @return ApiResponse<ListCustomScripts200Response>
   * @throws ApiException if fails to make API call
   * @http.response.details
     
       Response Details
        Status Code  Description  Response Headers 
        200  success   * Accept-Ranges -  
  * Access-Control-Allow-Origin -  
  * Allow -  
  * Connection -  
  * Content-Encoding -  
  * Content-Security-Policy -  
  * Cross-Origin-Opener-Policy -  
  * Date -  
  * Feature-Policy -  
  * Ratelimit-Limit -  
  * Ratelimit-Remaining -  
  * Ratelimit-Reset -  
  * Referrer-Policy -  
  * Server -  
  * Strict-Transport-Security -  
  * Vary -  
  * Via -  
  * X-Cache -  
  * X-Cache-Hits -  
  * X-Content-Type-Options -  
  * X-Frame-Options -  
  * X-Kong-Proxy-Latency -  
  * X-Kong-Upstream-Latency -  
  * X-Ratelimit-Limit-Hour -  
  * X-Ratelimit-Limit-Second -  
  * X-Ratelimit-Remaining-Hour -  
  * X-Ratelimit-Remaining-Second -  
  * X-Served-By -  
  * X-Timer -  
  * transfer-encoding -  
  
     
   */
  public ApiResponse listCustomScriptsWithHttpInfo(String page) throws ApiException {
    // Query parameters
    List localVarQueryParams = new ArrayList<>(
            apiClient.parameterToPairs("", "page", page)
    );

    String localVarAccept = apiClient.selectHeaderAccept("application/json");
    String localVarContentType = apiClient.selectHeaderContentType();
    String[] localVarAuthNames = new String[] {"bearerAuth"};
    GenericType localVarReturnType = new GenericType() {};
    return apiClient.invokeAPI("CustomScriptsApi.listCustomScripts", "/api/v1/library/custom-scripts", "GET", localVarQueryParams, null,
                               new LinkedHashMap<>(), new LinkedHashMap<>(), new LinkedHashMap<>(), localVarAccept, localVarContentType,
                               localVarAuthNames, localVarReturnType, false);
  }
  /**
   * Update Custom Script
   * This request allows you to update a custom script in the Kandji library.
   * @param libraryItemId  (required)
   * @return UpdateCustomScript200Response
   * @throws ApiException if fails to make API call
   * @http.response.details
     
       Response Details
        Status Code  Description  Response Headers 
        200  success / success - zsh example   * Accept-Ranges -  
  * Access-Control-Allow-Origin -  
  * Allow -  
  * Connection -  
  * Content-Encoding -  
  * Content-Security-Policy -  
  * Cross-Origin-Opener-Policy -  
  * Date -  
  * Feature-Policy -  
  * Ratelimit-Limit -  
  * Ratelimit-Remaining -  
  * Ratelimit-Reset -  
  * Referrer-Policy -  
  * Server -  
  * Strict-Transport-Security -  
  * Vary -  
  * Via -  
  * X-Cache -  
  * X-Cache-Hits -  
  * X-Content-Type-Options -  
  * X-Frame-Options -  
  * X-Kong-Proxy-Latency -  
  * X-Kong-Upstream-Latency -  
  * X-Ratelimit-Limit-Hour -  
  * X-Ratelimit-Limit-Second -  
  * X-Ratelimit-Remaining-Hour -  
  * X-Ratelimit-Remaining-Second -  
  * X-Served-By -  
  * X-Timer -  
  * transfer-encoding -  
  
     
   */
  public UpdateCustomScript200Response updateCustomScript(String libraryItemId) throws ApiException {
    return updateCustomScriptWithHttpInfo(libraryItemId).getData();
  }

  /**
   * Update Custom Script
   * This request allows you to update a custom script in the Kandji library.
   * @param libraryItemId  (required)
   * @return ApiResponse<UpdateCustomScript200Response>
   * @throws ApiException if fails to make API call
   * @http.response.details
     
       Response Details
        Status Code  Description  Response Headers 
        200  success / success - zsh example   * Accept-Ranges -  
  * Access-Control-Allow-Origin -  
  * Allow -  
  * Connection -  
  * Content-Encoding -  
  * Content-Security-Policy -  
  * Cross-Origin-Opener-Policy -  
  * Date -  
  * Feature-Policy -  
  * Ratelimit-Limit -  
  * Ratelimit-Remaining -  
  * Ratelimit-Reset -  
  * Referrer-Policy -  
  * Server -  
  * Strict-Transport-Security -  
  * Vary -  
  * Via -  
  * X-Cache -  
  * X-Cache-Hits -  
  * X-Content-Type-Options -  
  * X-Frame-Options -  
  * X-Kong-Proxy-Latency -  
  * X-Kong-Upstream-Latency -  
  * X-Ratelimit-Limit-Hour -  
  * X-Ratelimit-Limit-Second -  
  * X-Ratelimit-Remaining-Hour -  
  * X-Ratelimit-Remaining-Second -  
  * X-Served-By -  
  * X-Timer -  
  * transfer-encoding -  
  
     
   */
  public ApiResponse updateCustomScriptWithHttpInfo(String libraryItemId) throws ApiException {
    // Check required parameters
    if (libraryItemId == null) {
      throw new ApiException(400, "Missing the required parameter 'libraryItemId' when calling updateCustomScript");
    }

    // Path parameters
    String localVarPath = "/api/v1/library/custom-scripts/{library_item_id}"
            .replaceAll("\\{library_item_id}", apiClient.escapeString(libraryItemId.toString()));

    String localVarAccept = apiClient.selectHeaderAccept("application/json");
    String localVarContentType = apiClient.selectHeaderContentType("application/json");
    String[] localVarAuthNames = new String[] {"bearerAuth"};
    GenericType localVarReturnType = new GenericType() {};
    return apiClient.invokeAPI("CustomScriptsApi.updateCustomScript", localVarPath, "PATCH", new ArrayList<>(), null,
                               new LinkedHashMap<>(), new LinkedHashMap<>(), new LinkedHashMap<>(), localVarAccept, localVarContentType,
                               localVarAuthNames, localVarReturnType, false);
  }
}
Status Code	Description	Response Headers
201	success	* Allow - * Content-Length - * Content-Security-Policy - * Cross-Origin-Opener-Policy - * Date - * Feature-Policy - * Referrer-Policy - * Server - * Vary - * X-Content-Type-Options - * X-Frame-Options -