com.factset.sdk.FactSetPrivateMarkets.api.UniverseApi 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.EntityMatchRequest;
import com.factset.sdk.FactSetPrivateMarkets.models.EntityMatchesResponse;
import com.factset.sdk.FactSetPrivateMarkets.models.ErrorResponse;
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class UniverseApi {
private ApiClient apiClient;
public UniverseApi() {
this(Configuration.getDefaultApiClient());
}
public UniverseApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
private static final Map getUniverseResponseTypeMap = new HashMap();
static {
getUniverseResponseTypeMap.put(200, new GenericType(){});
getUniverseResponseTypeMap.put(400, new GenericType(){});
getUniverseResponseTypeMap.put(401, new GenericType(){});
getUniverseResponseTypeMap.put(403, new GenericType(){});
getUniverseResponseTypeMap.put(415, new GenericType(){});
getUniverseResponseTypeMap.put(500, new GenericType(){});
}
private static final Map getUniverseForListResponseTypeMap = new HashMap();
static {
getUniverseForListResponseTypeMap.put(200, new GenericType(){});
getUniverseForListResponseTypeMap.put(400, new GenericType(){});
getUniverseForListResponseTypeMap.put(401, new GenericType(){});
getUniverseForListResponseTypeMap.put(403, new GenericType(){});
getUniverseForListResponseTypeMap.put(415, new GenericType(){});
getUniverseForListResponseTypeMap.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 Entity Candidates and Matches for a single name and attributes.
* Finds the best candidate entities matching the given entity name. Country code can also be supplied to narrow the search. <p>**Max of 1 Name permitted in a single GET request.** Use the POST method for /entity-match to fetch up to 25 names.</p><p>
* @param name Name of Entity to match. (required)
* @param country ISO2 country code corresponding to the entity name that is used when evaluating candidates for a match. For a list of ISO2 Country codes, visit [OA 8754](https://my.apps.factset.com/oa/pages/8754). (optional)
* @return EntityMatchesResponse
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Response containing Entity Match results. - 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 EntityMatchesResponse getUniverse(String name, String country) throws ApiException {
return getUniverseWithHttpInfo(name, country).getData();
}
/**
* Get Entity Candidates and Matches for a single name and attributes.
* Finds the best candidate entities matching the given entity name. Country code can also be supplied to narrow the search. <p>**Max of 1 Name permitted in a single GET request.** Use the POST method for /entity-match to fetch up to 25 names.</p><p>
* @param name Name of Entity to match. (required)
* @param country ISO2 country code corresponding to the entity name that is used when evaluating candidates for a match. For a list of ISO2 Country codes, visit [OA 8754](https://my.apps.factset.com/oa/pages/8754). (optional)
* @return ApiResponse<EntityMatchesResponse>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Response containing Entity Match results. - 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 getUniverseWithHttpInfo(String name, String country) throws ApiException {
Object localVarPostBody = null;
// verify the required parameter 'name' is set
if (name == null) {
throw new ApiException(400, "Missing the required parameter 'name' when calling getUniverse");
}
// create path and map variables
String localVarPath = "/factset-private-markets/v1/universe";
// 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("", "name", name));
localVarQueryParams.addAll(apiClient.parameterToPairs("", "country", country));
final String[] localVarAccepts = {
"application/json;charset=utf-8", "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<
EntityMatchesResponse
> apiResponse = apiClient.invokeAPI("UniverseApi.getUniverse", localVarPath, "GET", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getUniverseResponseTypeMap, false);
return apiResponse;
}
/**
* Get a list of Entity Candidates and Matches for a requested list of up to 25 names and attributes.
* Finds the best candidate entities matching the given entity name. Country code can also be supplied to narrow the search. Finds the best candidate entities matching the given company name. <p>**Max of 25 Names inputted.**</p><p>
* @param entityMatchRequest A request to match an Entity. (required)
* @return EntityMatchesResponse
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Response containing Entity Match results. - 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 EntityMatchesResponse getUniverseForList(EntityMatchRequest entityMatchRequest) throws ApiException {
return getUniverseForListWithHttpInfo(entityMatchRequest).getData();
}
/**
* Get a list of Entity Candidates and Matches for a requested list of up to 25 names and attributes.
* Finds the best candidate entities matching the given entity name. Country code can also be supplied to narrow the search. Finds the best candidate entities matching the given company name. <p>**Max of 25 Names inputted.**</p><p>
* @param entityMatchRequest A request to match an Entity. (required)
* @return ApiResponse<EntityMatchesResponse>
* @throws ApiException if fails to make API call
* @http.response.details
Status Code Description Response Headers 200 Response containing Entity Match results. - 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 getUniverseForListWithHttpInfo(EntityMatchRequest entityMatchRequest) throws ApiException {
Object localVarPostBody = entityMatchRequest;
// verify the required parameter 'entityMatchRequest' is set
if (entityMatchRequest == null) {
throw new ApiException(400, "Missing the required parameter 'entityMatchRequest' when calling getUniverseForList");
}
// create path and map variables
String localVarPath = "/factset-private-markets/v1/universe";
// 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;charset=utf-8", "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<
EntityMatchesResponse
> apiResponse = apiClient.invokeAPI("UniverseApi.getUniverseForList", localVarPath, "POST", localVarQueryParams, localVarPostBody,
localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
localVarAuthNames, getUniverseForListResponseTypeMap, false);
return apiResponse;
}
}