• Home
• com.factset.sdk
• paengine
• 3.1.0
• source code
• PricingSourcesApi.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.factset.sdk.PAEngine.api.PricingSourcesApi Maven / Gradle / Ivy

package com.factset.sdk.PAEngine.api;

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

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

import com.factset.sdk.PAEngine.models.ClientErrorResponse;
import com.factset.sdk.PAEngine.models.PAPricingSourceRoot;

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

public class PricingSourcesApi {
  private ApiClient apiClient;

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

  public PricingSourcesApi(ApiClient apiClient) {
    this.apiClient = apiClient;
  }
  
  private static final Map getPAPricingSourcesResponseTypeMap = new HashMap();
  static {
    getPAPricingSourcesResponseTypeMap.put(200, new GenericType(){});
    getPAPricingSourcesResponseTypeMap.put(400, new GenericType(){});
    getPAPricingSourcesResponseTypeMap.put(404, 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 PA pricing sources
   * This endpoint lists all the PA pricing sources that can be applied to a PA calculation.
   * @param name PA pricing sources name (optional, default to )
   * @param category PA pricing sources category (optional, default to )
   * @param directory The directory to get the PA pricing sources in (optional, default to )
   * @return PAPricingSourceRoot
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 200 
 Expected response, returns a list of PA pricing sources 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * Age - Standard HTTP header. Header will specify the age of pricing sources list cached response. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 400 
 Invalid data provided. Please check the request parameters before attempting again. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 401 
 Missing or invalid authentication. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  
       
 403 
 User is forbidden with current credentials 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 404 
 Pricing sources not found. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 406 
 Unsupported Accept header. Header needs to be set to application/json. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 429 
 Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. 
  
       
 500 
 Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  
       
 503 
 Request timed out. Retry the request in sometime. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  
     
   */
  public PAPricingSourceRoot getPAPricingSources(String name, String category, String directory) throws ApiException {
    return getPAPricingSourcesWithHttpInfo(name, category, directory).getData();
  }

  /**
   * Get PA pricing sources
   * This endpoint lists all the PA pricing sources that can be applied to a PA calculation.
   * @param name PA pricing sources name (optional, default to )
   * @param category PA pricing sources category (optional, default to )
   * @param directory The directory to get the PA pricing sources in (optional, default to )
   * @return ApiResponse<PAPricingSourceRoot>
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 200 
 Expected response, returns a list of PA pricing sources 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * Age - Standard HTTP header. Header will specify the age of pricing sources list cached response. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 400 
 Invalid data provided. Please check the request parameters before attempting again. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 401 
 Missing or invalid authentication. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  
       
 403 
 User is forbidden with current credentials 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 404 
 Pricing sources not found. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 406 
 Unsupported Accept header. Header needs to be set to application/json. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 429 
 Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. 
  
       
 500 
 Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  
       
 503 
 Request timed out. Retry the request in sometime. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  
     
   */
  public ApiResponse getPAPricingSourcesWithHttpInfo(String name, String category, String directory) throws ApiException {
    Object localVarPostBody = null;
    
    // create path and map variables
    String localVarPath = "/analytics/engines/pa/v3/pricing-sources";

    // 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("", "category", category));
    localVarQueryParams.addAll(apiClient.parameterToPairs("", "directory", directory));

    
    
    
    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<
        
        PAPricingSourceRoot
      
    > apiResponse = apiClient.invokeAPI("PricingSourcesApi.getPAPricingSources", localVarPath, "GET", localVarQueryParams, localVarPostBody,
                               localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
                               localVarAuthNames, getPAPricingSourcesResponseTypeMap, false);

    return apiResponse;

  }
}