All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.factset.sdk.OpenRisk.api.AboutApi Maven / Gradle / Ivy

There is a newer version: 5.0.2
Show newest version
package com.factset.sdk.OpenRisk.api;

import com.factset.sdk.OpenRisk.ApiException;
import com.factset.sdk.OpenRisk.ApiClient;
import com.factset.sdk.OpenRisk.ApiResponse;
import com.factset.sdk.OpenRisk.Configuration;
import com.factset.sdk.OpenRisk.Pair;

import jakarta.ws.rs.core.GenericType;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;

import com.factset.sdk.OpenRisk.models.ErrorResponse;
import com.factset.sdk.OpenRisk.models.InlineResponse200;
import com.factset.sdk.OpenRisk.models.InlineResponse2001;
import com.factset.sdk.OpenRisk.models.InlineResponse2002;
import com.factset.sdk.OpenRisk.models.InlineResponse403;
import com.factset.sdk.OpenRisk.models.InlineResponse404;
import com.factset.sdk.OpenRisk.models.SupportedStats;
import com.factset.sdk.OpenRisk.models.SupportedStatsNamesOnly;

@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")

public class AboutApi {
  private ApiClient apiClient;

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

  public AboutApi(ApiClient apiClient) {
    this.apiClient = apiClient;
  }
  
  private static final Map healthStatusResponseTypeMap = new HashMap();
  static {
    healthStatusResponseTypeMap.put(200, new GenericType(){});
    healthStatusResponseTypeMap.put(401, new GenericType(){});
    healthStatusResponseTypeMap.put(403, new GenericType(){});
    healthStatusResponseTypeMap.put(404, new GenericType(){});
    healthStatusResponseTypeMap.put(500, new GenericType(){});
  }

  private static final Map listRiskModelsResponseTypeMap = new HashMap();
  static {
    listRiskModelsResponseTypeMap.put(200, new GenericType(){});
    listRiskModelsResponseTypeMap.put(401, new GenericType(){});
    listRiskModelsResponseTypeMap.put(404, new GenericType(){});
    listRiskModelsResponseTypeMap.put(500, new GenericType(){});
  }

  private static final Map riskModelMetadataResponseTypeMap = new HashMap();
  static {
    riskModelMetadataResponseTypeMap.put(200, new GenericType(){});
    riskModelMetadataResponseTypeMap.put(401, new GenericType(){});
    riskModelMetadataResponseTypeMap.put(404, new GenericType(){});
    riskModelMetadataResponseTypeMap.put(500, new GenericType(){});
  }

  private static final Map statsResponseTypeMap = new HashMap();
  static {
    statsResponseTypeMap.put(200, new GenericType(){});
    statsResponseTypeMap.put(401, new GenericType(){});
    statsResponseTypeMap.put(404, new GenericType(){});
    statsResponseTypeMap.put(500, new GenericType(){});
  }

  private static final Map statsNamesOnlyResponseTypeMap = new HashMap();
  static {
    statsNamesOnlyResponseTypeMap.put(200, new GenericType(){});
    statsNamesOnlyResponseTypeMap.put(401, new GenericType(){});
    statsNamesOnlyResponseTypeMap.put(404, new GenericType(){});
    statsNamesOnlyResponseTypeMap.put(500, new GenericType(){});
  }

  


  /**
   * 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 health of service
   * Health status of the service
   * @return InlineResponse2002
   * @throws ApiException if fails to make API call
   * @http.response.details
     
Status Code Description Response Headers
200 Service is operational and healthy * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
401 Missing or invalid authentication -
403 Service is unavailable or in a state of degraded health * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
404 API version not found * RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
429 Rate limit reached. Wait until the time specified in header 'Retry-After' has elapsed before making further requests. * Retry-After -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
500 Service is unavailable or in a state of degraded health * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
*/ public InlineResponse2002 healthStatus() throws ApiException { return healthStatusWithHttpInfo().getData(); } /** * Get health of service * Health status of the service * @return ApiResponse<InlineResponse2002> * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 Service is operational and healthy * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
401 Missing or invalid authentication -
403 Service is unavailable or in a state of degraded health * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
404 API version not found * RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
429 Rate limit reached. Wait until the time specified in header 'Retry-After' has elapsed before making further requests. * Retry-After -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
500 Service is unavailable or in a state of degraded health * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
*/ public ApiResponse healthStatusWithHttpInfo() throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/health"; // query params java.util.List localVarQueryParams = new java.util.ArrayList(); java.util.Map localVarHeaderParams = new java.util.HashMap(); java.util.Map localVarCookieParams = new java.util.HashMap(); java.util.Map localVarFormParams = new java.util.HashMap(); final String[] localVarAccepts = { "application/json", "text/plain" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); final String[] localVarContentTypes = { }; final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" }; ApiResponse< InlineResponse2002 > apiResponse = apiClient.invokeAPI("AboutApi.healthStatus", localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, healthStatusResponseTypeMap, false); return apiResponse; } /** * Get available risk models * Get the list of available risk models, including their respective model codes required for use with other routes. * @return InlineResponse200 * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 Returns the list of available risk models for use. Both risk model subscription and each risk model vendor specific Open:Risk API subscription are required for use. For subscription, please report an issue from FactSet:Developer portal. * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
401 Missing or invalid authentication -
404 Endpoint not found * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
429 Rate limit reached. Wait until the time specified in header 'Retry-After' has elapsed before making further requests. * Retry-After -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
500 Internal server error occurred * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
*/ public InlineResponse200 listRiskModels() throws ApiException { return listRiskModelsWithHttpInfo().getData(); } /** * Get available risk models * Get the list of available risk models, including their respective model codes required for use with other routes. * @return ApiResponse<InlineResponse200> * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 Returns the list of available risk models for use. Both risk model subscription and each risk model vendor specific Open:Risk API subscription are required for use. For subscription, please report an issue from FactSet:Developer portal. * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
401 Missing or invalid authentication -
404 Endpoint not found * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
429 Rate limit reached. Wait until the time specified in header 'Retry-After' has elapsed before making further requests. * Retry-After -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
500 Internal server error occurred * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
*/ public ApiResponse listRiskModelsWithHttpInfo() throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/riskmodels"; // query params java.util.List localVarQueryParams = new java.util.ArrayList(); java.util.Map localVarHeaderParams = new java.util.HashMap(); java.util.Map localVarCookieParams = new java.util.HashMap(); java.util.Map localVarFormParams = new java.util.HashMap(); final String[] localVarAccepts = { "application/json", "text/plain" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); final String[] localVarContentTypes = { }; final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" }; ApiResponse< InlineResponse200 > apiResponse = apiClient.invokeAPI("AboutApi.listRiskModels", localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, listRiskModelsResponseTypeMap, false); return apiResponse; } /** * Get risk model details * Get the metadata of the risk model for the corresponding modelCode. modelCode can be obtained via '/linear/{version}/riskmodels/' route. * @param modelCode Model code (required) * @return InlineResponse2001 * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 Returns the metadata of risk model. * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
401 Missing or invalid authentication -
404 Endpoint not found * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
429 Rate limit reached. Wait until the time specified in header 'Retry-After' has elapsed before making further requests. * Retry-After -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
500 Internal server error occurred * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
*/ public InlineResponse2001 riskModelMetadata(String modelCode) throws ApiException { return riskModelMetadataWithHttpInfo(modelCode).getData(); } /** * Get risk model details * Get the metadata of the risk model for the corresponding modelCode. modelCode can be obtained via '/linear/{version}/riskmodels/' route. * @param modelCode Model code (required) * @return ApiResponse<InlineResponse2001> * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 Returns the metadata of risk model. * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
401 Missing or invalid authentication -
404 Endpoint not found * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
429 Rate limit reached. Wait until the time specified in header 'Retry-After' has elapsed before making further requests. * Retry-After -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
500 Internal server error occurred * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
*/ public ApiResponse riskModelMetadataWithHttpInfo(String modelCode) throws ApiException { Object localVarPostBody = null; // verify the required parameter 'modelCode' is set if (modelCode == null) { throw new ApiException(400, "Missing the required parameter 'modelCode' when calling riskModelMetadata"); } // create path and map variables String localVarPath = "/riskmodels/{modelCode}" .replaceAll("\\{" + "modelCode" + "\\}", apiClient.escapeString(modelCode.toString())); // query params java.util.List localVarQueryParams = new java.util.ArrayList(); java.util.Map localVarHeaderParams = new java.util.HashMap(); java.util.Map localVarCookieParams = new java.util.HashMap(); java.util.Map localVarFormParams = new java.util.HashMap(); final String[] localVarAccepts = { "application/json", "text/plain" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); final String[] localVarContentTypes = { }; final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" }; ApiResponse< InlineResponse2001 > apiResponse = apiClient.invokeAPI("AboutApi.riskModelMetadata", localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, riskModelMetadataResponseTypeMap, false); return apiResponse; } /** * Get available risk statistics details * All base risk statistic names and their respective support and/or requirement for certain name-settings statistics options (such as: correlated specific risk, covariance isolation method, etc.), available levels, and security group calculation methodology. When 'securityGroupMethod' is 'statSpecific', please refer to statistics documentation service for more information. * @return SupportedStats * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 All base risk statistic names with details on their available options and calculation methodologies. * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
401 Missing or invalid authentication -
404 Endpoint not found * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
429 Rate limit reached. Wait until the time specified in header 'Retry-After' has elapsed before making further requests. * Retry-After -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
500 Internal server error occurred * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
*/ public SupportedStats stats() throws ApiException { return statsWithHttpInfo().getData(); } /** * Get available risk statistics details * All base risk statistic names and their respective support and/or requirement for certain name-settings statistics options (such as: correlated specific risk, covariance isolation method, etc.), available levels, and security group calculation methodology. When 'securityGroupMethod' is 'statSpecific', please refer to statistics documentation service for more information. * @return ApiResponse<SupportedStats> * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 All base risk statistic names with details on their available options and calculation methodologies. * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
401 Missing or invalid authentication -
404 Endpoint not found * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
429 Rate limit reached. Wait until the time specified in header 'Retry-After' has elapsed before making further requests. * Retry-After -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
500 Internal server error occurred * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
*/ public ApiResponse statsWithHttpInfo() throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/stats"; // query params java.util.List localVarQueryParams = new java.util.ArrayList(); java.util.Map localVarHeaderParams = new java.util.HashMap(); java.util.Map localVarCookieParams = new java.util.HashMap(); java.util.Map localVarFormParams = new java.util.HashMap(); final String[] localVarAccepts = { "application/json", "text/plain" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); final String[] localVarContentTypes = { }; final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" }; ApiResponse< SupportedStats > apiResponse = apiClient.invokeAPI("AboutApi.stats", localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, statsResponseTypeMap, false); return apiResponse; } /** * Get available risk statistics names * All available risk statistic names including statistics names containing risk statistics options such as CSR (correlated specific risk) * @return SupportedStatsNamesOnly * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 All available risk statistic names including statistics names containing risk statistics options such as CSR (correlated specific risk) * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
401 Missing or invalid authentication -
404 Endpoint not found * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
429 Rate limit reached. Wait until the time specified in header 'Retry-After' has elapsed before making further requests. * Retry-After -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
500 Internal server error occurred * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
*/ public SupportedStatsNamesOnly statsNamesOnly() throws ApiException { return statsNamesOnlyWithHttpInfo().getData(); } /** * Get available risk statistics names * All available risk statistic names including statistics names containing risk statistics options such as CSR (correlated specific risk) * @return ApiResponse<SupportedStatsNamesOnly> * @throws ApiException if fails to make API call * @http.response.details
Status Code Description Response Headers
200 All available risk statistic names including statistics names containing risk statistics options such as CSR (correlated specific risk) * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
401 Missing or invalid authentication -
404 Endpoint not found * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
429 Rate limit reached. Wait until the time specified in header 'Retry-After' has elapsed before making further requests. * Retry-After -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
500 Internal server error occurred * api-supported-versions -
* api-version -
* RateLimit-Limit -
* RateLimit-Remaining -
* RateLimit-Reset -
*/ public ApiResponse statsNamesOnlyWithHttpInfo() throws ApiException { Object localVarPostBody = null; // create path and map variables String localVarPath = "/stats-names-only"; // query params java.util.List localVarQueryParams = new java.util.ArrayList(); java.util.Map localVarHeaderParams = new java.util.HashMap(); java.util.Map localVarCookieParams = new java.util.HashMap(); java.util.Map localVarFormParams = new java.util.HashMap(); final String[] localVarAccepts = { "application/json", "text/plain" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); final String[] localVarContentTypes = { }; final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" }; ApiResponse< SupportedStatsNamesOnly > apiResponse = apiClient.invokeAPI("AboutApi.statsNamesOnly", localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType, localVarAuthNames, statsNamesOnlyResponseTypeMap, false); return apiResponse; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy