com.factset.sdk.FactSetPrivateMarkets.api.NonPeriodicApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of factsetprivatemarkets Show documentation
Show all versions of factsetprivatemarkets Show documentation
FactSet SDK for Java - factsetprivatemarkets
The newest version!
package com.factset.sdk.FactSetPrivateMarkets.api;
import com.factset.sdk.FactSetPrivateMarkets.ApiException;
import com.factset.sdk.FactSetPrivateMarkets.ApiClient;
import com.factset.sdk.FactSetPrivateMarkets.ApiResponse;
import com.factset.sdk.FactSetPrivateMarkets.Configuration;
import com.factset.sdk.FactSetPrivateMarkets.Pair;
import jakarta.ws.rs.core.GenericType;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import com.factset.sdk.FactSetPrivateMarkets.models.ErrorResponse;
import com.factset.sdk.FactSetPrivateMarkets.models.NonPeriodicRequest;
import com.factset.sdk.FactSetPrivateMarkets.models.NonPeriodicResponse;
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class NonPeriodicApi {
private ApiClient apiClient;
public NonPeriodicApi() {
this(Configuration.getDefaultApiClient());
}
public NonPeriodicApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
private static final Map getNonPeriodicResponseTypeMap = new HashMap();
static {
getNonPeriodicResponseTypeMap.put(200, new GenericType(){});
getNonPeriodicResponseTypeMap.put(400, new GenericType(){});
getNonPeriodicResponseTypeMap.put(401, new GenericType(){});
getNonPeriodicResponseTypeMap.put(403, new GenericType(){});
getNonPeriodicResponseTypeMap.put(415, new GenericType(){});
getNonPeriodicResponseTypeMap.put(500, new GenericType(){});
}
private static final Map getNonPeriodicForListResponseTypeMap = new HashMap();
static {
getNonPeriodicForListResponseTypeMap.put(200, new GenericType(){});
getNonPeriodicForListResponseTypeMap.put(400, new GenericType(){});
getNonPeriodicForListResponseTypeMap.put(401, new GenericType(){});
getNonPeriodicForListResponseTypeMap.put(403, new GenericType(){});
getNonPeriodicForListResponseTypeMap.put(415, new GenericType(){});
getNonPeriodicForListResponseTypeMap.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;
}
/**
* Returns Private Company reference data for a list of ids.
* Returns Private Company reference information.
* @param ids The requested FactSet Private Market Entity Identifier in XXXXXX-E format.<p>**Max Ids Limit set to 3000 in a single request**</p> *<p>Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective \\\"POST\\\" method.</p>* (required)
* @param fields Private Markets Non-Periodic Fields. (required)
* @return NonPeriodicResponse
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Fetches Private Company reference data for a list of ids. - 400 Bad Request. This can occur for several reasons. Please review the \"message\" for more details. - 401 Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the **Report Issue** in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. - 403 The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. - 415 Unsupported Media Type. This error may be returned when the caller sends a resource in a format that is not accepted by the server. This can be fixed by ensuring that Content-Type header is set to the correct value. In this instance, \"application/json\" would be the appropriate value. - 500 Internal Server Error. -
*/
public NonPeriodicResponse getNonPeriodic(java.util.List ids, java.util.List fields) throws ApiException {
return getNonPeriodicWithHttpInfo(ids, fields).getData();
}
/**
* Returns Private Company reference data for a list of ids.
* Returns Private Company reference information.
* @param ids The requested FactSet Private Market Entity Identifier in XXXXXX-E format.<p>**Max Ids Limit set to 3000 in a single request**</p> *<p>Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective \\\"POST\\\" method.</p>* (required)
* @param fields Private Markets Non-Periodic Fields. (required)
* @return ApiResponse<NonPeriodicResponse>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Fetches Private Company reference data for a list of ids. - 400 Bad Request. This can occur for several reasons. Please review the \"message\" for more details. - 401 Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the **Report Issue** in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. - 403 The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. - 415 Unsupported Media Type. This error may be returned when the caller sends a resource in a format that is not accepted by the server. This can be fixed by ensuring that Content-Type header is set to the correct value. In this instance, \"application/json\" would be the appropriate value. - 500 Internal Server Error. -
*/
public ApiResponse getNonPeriodicWithHttpInfo(java.util.List ids, java.util.List fields) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'ids' is set
if (ids == null) {
throw new ApiException(400, "Missing the required parameter 'ids' when calling getNonPeriodic");
}
// verify the required parameter 'fields' is set
if (fields == null) {
throw new ApiException(400, "Missing the required parameter 'fields' when calling getNonPeriodic");
}
// create path and map variables
String localVarPath = "/factset-private-markets/v1/non-periodic";
// 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();
localVarQueryParams.addAll(apiClient.parameterToPairs("csv", "ids", ids));
localVarQueryParams.addAll(apiClient.parameterToPairs("csv", "fields", fields));
final String[] localVarAccepts = {
"application/json"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" };
ApiResponse<
NonPeriodicResponse
> apiResponse = apiClient.invokeAPI("NonPeriodicApi.getNonPeriodic", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getNonPeriodicResponseTypeMap, false);
return apiResponse;
}
/**
* Returns Private Company reference data for a list of ids.
* Returns a private markets reference object for the requested ids.
* @param nonPeriodicRequest Request Body to request a list of Private Market non-periodic objects. (required)
* @return NonPeriodicResponse
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Private Company Reference data items - 400 Bad Request. This can occur for several reasons. Please review the \"message\" for more details. - 401 Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the **Report Issue** in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. - 403 The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. - 415 Unsupported Media Type. This error may be returned when the caller sends a resource in a format that is not accepted by the server. This can be fixed by ensuring that Content-Type header is set to the correct value. In this instance, \"application/json\" would be the appropriate value. - 500 Internal Server Error. -
*/
public NonPeriodicResponse getNonPeriodicForList(NonPeriodicRequest nonPeriodicRequest) throws ApiException {
return getNonPeriodicForListWithHttpInfo(nonPeriodicRequest).getData();
}
/**
* Returns Private Company reference data for a list of ids.
* Returns a private markets reference object for the requested ids.
* @param nonPeriodicRequest Request Body to request a list of Private Market non-periodic objects. (required)
* @return ApiResponse<NonPeriodicResponse>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Private Company Reference data items - 400 Bad Request. This can occur for several reasons. Please review the \"message\" for more details. - 401 Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the **Report Issue** in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. - 403 The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. - 415 Unsupported Media Type. This error may be returned when the caller sends a resource in a format that is not accepted by the server. This can be fixed by ensuring that Content-Type header is set to the correct value. In this instance, \"application/json\" would be the appropriate value. - 500 Internal Server Error. -
*/
public ApiResponse getNonPeriodicForListWithHttpInfo(NonPeriodicRequest nonPeriodicRequest) throws ApiException {
Object localVarPostBody = nonPeriodicRequest;
// verify the required parameter 'nonPeriodicRequest' is set
if (nonPeriodicRequest == null) {
throw new ApiException(400, "Missing the required parameter 'nonPeriodicRequest' when calling getNonPeriodicForList");
}
// create path and map variables
String localVarPath = "/factset-private-markets/v1/non-periodic";
// 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"
};
final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] localVarContentTypes = {
"application/json"
};
final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);
String[] localVarAuthNames = new String[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" };
ApiResponse<
NonPeriodicResponse
> apiResponse = apiClient.invokeAPI("NonPeriodicApi.getNonPeriodicForList", localVarPath, "POST", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getNonPeriodicForListResponseTypeMap, false);
return apiResponse;
}
}