• Home
• com.factset.sdk
• factsettickhistory
• 0.33.2
• source code
• Level1Api.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.FactSetTickHistory.api.Level1Api Maven / Gradle / Ivy

package com.factset.sdk.FactSetTickHistory.api;

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

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

import com.factset.sdk.FactSetTickHistory.models.CompletedResponse;
import com.factset.sdk.FactSetTickHistory.models.CoverageResponse;
import com.factset.sdk.FactSetTickHistory.models.GetFilesMinuteResponse;
import com.factset.sdk.FactSetTickHistory.models.GetFilesResponse;
import com.factset.sdk.FactSetTickHistory.models.LeveloneRequest;
import com.factset.sdk.FactSetTickHistory.models.MinRequest;
import com.factset.sdk.FactSetTickHistory.models.Status;
import com.factset.sdk.FactSetTickHistory.models.SubmittedResponse;

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

public class Level1Api {
  private ApiClient apiClient;

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

  public Level1Api(ApiClient apiClient) {
    this.apiClient = apiClient;
  }
  
  private static final Map getLevel1FileStatusResponseTypeMap = new HashMap();
  static {
    getLevel1FileStatusResponseTypeMap.put(201, new GenericType(){});
    getLevel1FileStatusResponseTypeMap.put(202, new GenericType(){});
    getLevel1FileStatusResponseTypeMap.put(401, new GenericType(){});
    getLevel1FileStatusResponseTypeMap.put(403, new GenericType(){});
    getLevel1FileStatusResponseTypeMap.put(404, new GenericType(){});
    getLevel1FileStatusResponseTypeMap.put(500, new GenericType(){});
  }

  private static final Map getMinutebarsFileStatusResponseTypeMap = new HashMap();
  static {
    getMinutebarsFileStatusResponseTypeMap.put(201, new GenericType(){});
    getMinutebarsFileStatusResponseTypeMap.put(202, new GenericType(){});
    getMinutebarsFileStatusResponseTypeMap.put(401, new GenericType(){});
    getMinutebarsFileStatusResponseTypeMap.put(403, new GenericType(){});
    getMinutebarsFileStatusResponseTypeMap.put(404, new GenericType(){});
    getMinutebarsFileStatusResponseTypeMap.put(500, new GenericType(){});
  }

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

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

  private static final Map requestMinutebarsFilesResponseTypeMap = new HashMap();
  static {
    requestMinutebarsFilesResponseTypeMap.put(202, new GenericType(){});
    requestMinutebarsFilesResponseTypeMap.put(400, new GenericType(){});
    requestMinutebarsFilesResponseTypeMap.put(401, new GenericType(){});
    requestMinutebarsFilesResponseTypeMap.put(403, new GenericType(){});
    requestMinutebarsFilesResponseTypeMap.put(429, new GenericType(){});
    requestMinutebarsFilesResponseTypeMap.put(500, new GenericType(){});
  }

  private static final Map requestTickHistoryCoverageResponseTypeMap = new HashMap();
  static {
    requestTickHistoryCoverageResponseTypeMap.put(200, new GenericType(){});
    requestTickHistoryCoverageResponseTypeMap.put(400, new GenericType(){});
    requestTickHistoryCoverageResponseTypeMap.put(401, new GenericType(){});
    requestTickHistoryCoverageResponseTypeMap.put(403, new GenericType(){});
    requestTickHistoryCoverageResponseTypeMap.put(429, new GenericType(){});
    requestTickHistoryCoverageResponseTypeMap.put(500, new GenericType(){});
  }

  private static final Map requestTickHistoryLevel1FilesResponseTypeMap = new HashMap();
  static {
    requestTickHistoryLevel1FilesResponseTypeMap.put(202, new GenericType(){});
    requestTickHistoryLevel1FilesResponseTypeMap.put(400, new GenericType(){});
    requestTickHistoryLevel1FilesResponseTypeMap.put(401, new GenericType(){});
    requestTickHistoryLevel1FilesResponseTypeMap.put(403, new GenericType(){});
    requestTickHistoryLevel1FilesResponseTypeMap.put(429, new GenericType(){});
    requestTickHistoryLevel1FilesResponseTypeMap.put(500, new GenericType(){});
  }

  
 /**
   * Wrapper to support GET /level1/files/status returning different types
   * per status code.
   *
   * 

   * Responses:
   * 

   *   
201 : {@code CompletedResponse }
 The Request has been created and the response has been created. 
   * 
   *   
202 : {@code SubmittedResponse }
The Request has not finished and the result has NOT been created. 
   * 
   *
   * 

   * Example:
   * 
{@code
   * GetLevel1FileStatusResponseWrapper response = ...;
   * switch (response.statusCode) {
   *   case 201:
   *     CompletedResponse data201 = response.getResponse201();
   *     break;
   *   case 202:
   *     SubmittedResponse data202 = response.getResponse202();
   *     break;
   *  }
   * }
   */
  public static class GetLevel1FileStatusResponseWrapper {
    public final int statusCode;
    public final Object response;

    public GetLevel1FileStatusResponseWrapper(int statusCode, Object response) {
      this.statusCode = statusCode;
      this.response = response;
    }

    public int getStatusCode() { return statusCode; }
    public Object getResponse() { return response; }
    
    public CompletedResponse getResponse201() throws ApiException {
      if (this.statusCode != 201) {
        throw new ApiException(500, "Invalid response getter called. getResponse201 can't return a " + this.statusCode + " response");
      }
      return (CompletedResponse) this.response;
    }
    
    public SubmittedResponse getResponse202() throws ApiException {
      if (this.statusCode != 202) {
        throw new ApiException(500, "Invalid response getter called. getResponse202 can't return a " + this.statusCode + " response");
      }
      return (SubmittedResponse) this.response;
    }
    

    @Override
    public boolean equals(Object o) {
      if (this == o) {
        return true;
      }
      if (o == null || getClass() != o.getClass()) {
        return false;
      }
      GetLevel1FileStatusResponseWrapper other = (GetLevel1FileStatusResponseWrapper) o;
      return this.statusCode == other.statusCode &&
        Objects.equals(this.response, other.response);
    }

    @Override
    public int hashCode() {
      return Objects.hash(statusCode, response);
    }

    @Override
    public String toString() {
      return "class GetLevel1FileStatusResponseWrapper {\n"
       + "    statusCode: " + statusCode + "\n"
       + "    response: "
       + Objects.toString(response).replace("\n", "\n    ")
       + "\n}";
    }
  }


 /**
   * Wrapper to support GET /level1/files/minute-bars/status returning different types
   * per status code.
   *
   * 

   * Responses:
   * 

   *   
201 : {@code CompletedResponse }
 The Request has been created and the response has been created. 
   * 
   *   
202 : {@code SubmittedResponse }
The Request has not finished and the result has NOT been created. 
   * 
   *
   * 

   * Example:
   * 
{@code
   * GetMinutebarsFileStatusResponseWrapper response = ...;
   * switch (response.statusCode) {
   *   case 201:
   *     CompletedResponse data201 = response.getResponse201();
   *     break;
   *   case 202:
   *     SubmittedResponse data202 = response.getResponse202();
   *     break;
   *  }
   * }
   */
  public static class GetMinutebarsFileStatusResponseWrapper {
    public final int statusCode;
    public final Object response;

    public GetMinutebarsFileStatusResponseWrapper(int statusCode, Object response) {
      this.statusCode = statusCode;
      this.response = response;
    }

    public int getStatusCode() { return statusCode; }
    public Object getResponse() { return response; }
    
    public CompletedResponse getResponse201() throws ApiException {
      if (this.statusCode != 201) {
        throw new ApiException(500, "Invalid response getter called. getResponse201 can't return a " + this.statusCode + " response");
      }
      return (CompletedResponse) this.response;
    }
    
    public SubmittedResponse getResponse202() throws ApiException {
      if (this.statusCode != 202) {
        throw new ApiException(500, "Invalid response getter called. getResponse202 can't return a " + this.statusCode + " response");
      }
      return (SubmittedResponse) this.response;
    }
    

    @Override
    public boolean equals(Object o) {
      if (this == o) {
        return true;
      }
      if (o == null || getClass() != o.getClass()) {
        return false;
      }
      GetMinutebarsFileStatusResponseWrapper other = (GetMinutebarsFileStatusResponseWrapper) o;
      return this.statusCode == other.statusCode &&
        Objects.equals(this.response, other.response);
    }

    @Override
    public int hashCode() {
      return Objects.hash(statusCode, response);
    }

    @Override
    public String toString() {
      return "class GetMinutebarsFileStatusResponseWrapper {\n"
       + "    statusCode: " + statusCode + "\n"
       + "    response: "
       + Objects.toString(response).replace("\n", "\n    ")
       + "\n}";
    }
  }


 /**
   * Wrapper to support GET /level1/files/minute-bars/get returning different types
   * per status code.
   *
   * 

   * Responses:
   * 

   *   
200 : {@code GetFilesMinuteResponse }
Success</p> **To download the output file copy the response url in a browser**
   * 
   *   
202 : {@code SubmittedResponse }
The Request has not finished and the result has NOT been created. 
   * 
   *
   * 

   * Example:
   * 
{@code
   * GetMinutebarsFilesResponseWrapper response = ...;
   * switch (response.statusCode) {
   *   case 200:
   *     GetFilesMinuteResponse data200 = response.getResponse200();
   *     break;
   *   case 202:
   *     SubmittedResponse data202 = response.getResponse202();
   *     break;
   *  }
   * }
   */
  public static class GetMinutebarsFilesResponseWrapper {
    public final int statusCode;
    public final Object response;

    public GetMinutebarsFilesResponseWrapper(int statusCode, Object response) {
      this.statusCode = statusCode;
      this.response = response;
    }

    public int getStatusCode() { return statusCode; }
    public Object getResponse() { return response; }
    
    public GetFilesMinuteResponse getResponse200() throws ApiException {
      if (this.statusCode != 200) {
        throw new ApiException(500, "Invalid response getter called. getResponse200 can't return a " + this.statusCode + " response");
      }
      return (GetFilesMinuteResponse) this.response;
    }
    
    public SubmittedResponse getResponse202() throws ApiException {
      if (this.statusCode != 202) {
        throw new ApiException(500, "Invalid response getter called. getResponse202 can't return a " + this.statusCode + " response");
      }
      return (SubmittedResponse) this.response;
    }
    

    @Override
    public boolean equals(Object o) {
      if (this == o) {
        return true;
      }
      if (o == null || getClass() != o.getClass()) {
        return false;
      }
      GetMinutebarsFilesResponseWrapper other = (GetMinutebarsFilesResponseWrapper) o;
      return this.statusCode == other.statusCode &&
        Objects.equals(this.response, other.response);
    }

    @Override
    public int hashCode() {
      return Objects.hash(statusCode, response);
    }

    @Override
    public String toString() {
      return "class GetMinutebarsFilesResponseWrapper {\n"
       + "    statusCode: " + statusCode + "\n"
       + "    response: "
       + Objects.toString(response).replace("\n", "\n    ")
       + "\n}";
    }
  }


 /**
   * Wrapper to support GET /level1/files/get returning different types
   * per status code.
   *
   * 

   * Responses:
   * 

   *   
200 : {@code GetFilesResponse }
Success</p> **To download the output file copy the response url in a browser**
   * 
   *   
202 : {@code SubmittedResponse }
The Request has not finished and the result has NOT been created. 
   * 
   *
   * 

   * Example:
   * 
{@code
   * GetTickHistoryLevel1FilesResponseWrapper response = ...;
   * switch (response.statusCode) {
   *   case 200:
   *     GetFilesResponse data200 = response.getResponse200();
   *     break;
   *   case 202:
   *     SubmittedResponse data202 = response.getResponse202();
   *     break;
   *  }
   * }
   */
  public static class GetTickHistoryLevel1FilesResponseWrapper {
    public final int statusCode;
    public final Object response;

    public GetTickHistoryLevel1FilesResponseWrapper(int statusCode, Object response) {
      this.statusCode = statusCode;
      this.response = response;
    }

    public int getStatusCode() { return statusCode; }
    public Object getResponse() { return response; }
    
    public GetFilesResponse getResponse200() throws ApiException {
      if (this.statusCode != 200) {
        throw new ApiException(500, "Invalid response getter called. getResponse200 can't return a " + this.statusCode + " response");
      }
      return (GetFilesResponse) this.response;
    }
    
    public SubmittedResponse getResponse202() throws ApiException {
      if (this.statusCode != 202) {
        throw new ApiException(500, "Invalid response getter called. getResponse202 can't return a " + this.statusCode + " response");
      }
      return (SubmittedResponse) this.response;
    }
    

    @Override
    public boolean equals(Object o) {
      if (this == o) {
        return true;
      }
      if (o == null || getClass() != o.getClass()) {
        return false;
      }
      GetTickHistoryLevel1FilesResponseWrapper other = (GetTickHistoryLevel1FilesResponseWrapper) o;
      return this.statusCode == other.statusCode &&
        Objects.equals(this.response, other.response);
    }

    @Override
    public int hashCode() {
      return Objects.hash(statusCode, response);
    }

    @Override
    public String toString() {
      return "class GetTickHistoryLevel1FilesResponseWrapper {\n"
       + "    statusCode: " + statusCode + "\n"
       + "    response: "
       + Objects.toString(response).replace("\n", "\n    ")
       + "\n}";
    }
  }




  /**
   * 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 the status of the ID
   * Need to plug-in the id get from /create endpoint into /status endpoint
   * @param id id returned by files create endpoint to poll and collect status of the query (required)
   * @return GetLevel1FileStatusResponseWrapper
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 201 
  The Request has been created and the response has been created.  
  * Location - Relative location to poll for status. 
  
       
 202 
 The Request has not finished and the result has NOT been created.  
  * Location - Relative location to poll for status. 
  
       
 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. 
  -  
       
 404 
 id not found 
  -  
       
 500 
 Internal Error 
  -  
     
   */
  public GetLevel1FileStatusResponseWrapper getLevel1FileStatus(String id) throws ApiException {
    return getLevel1FileStatusWithHttpInfo(id).getData();
  }

  /**
   * Returns the status of the ID
   * Need to plug-in the id get from /create endpoint into /status endpoint
   * @param id id returned by files create endpoint to poll and collect status of the query (required)
   * @return ApiResponse<GetLevel1FileStatusResponseWrapper>
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 201 
  The Request has been created and the response has been created.  
  * Location - Relative location to poll for status. 
  
       
 202 
 The Request has not finished and the result has NOT been created.  
  * Location - Relative location to poll for status. 
  
       
 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. 
  -  
       
 404 
 id not found 
  -  
       
 500 
 Internal Error 
  -  
     
   */
  public ApiResponse getLevel1FileStatusWithHttpInfo(String id) throws ApiException {
    Object localVarPostBody = null;
    
    // verify the required parameter 'id' is set
    if (id == null) {
      throw new ApiException(400, "Missing the required parameter 'id' when calling getLevel1FileStatus");
    }
    
    // create path and map variables
    String localVarPath = "/level1/files/status";

    // 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("", "id", id));

    
    
    
    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<
        Object
        
      
    > apiResponse = apiClient.invokeAPI("Level1Api.getLevel1FileStatus", localVarPath, "GET", localVarQueryParams, localVarPostBody,
                               localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
                               localVarAuthNames, getLevel1FileStatusResponseTypeMap, false);

    int statusCode = apiResponse.getStatusCode();
    GetLevel1FileStatusResponseWrapper responseWrapper = new GetLevel1FileStatusResponseWrapper(
      statusCode,
      apiResponse.getData()
    );

    return new ApiResponse(statusCode, apiResponse.getHeaders(), responseWrapper);


  }
  /**
   * Returns the status of the ID
   * Need to plug-in the id get from /create endpoint into /status endpoint
   * @param id id returned by files create endpoint to poll and collect status of the query (required)
   * @return GetMinutebarsFileStatusResponseWrapper
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 201 
  The Request has been created and the response has been created.  
  * Location - Relative location to poll for status. 
  
       
 202 
 The Request has not finished and the result has NOT been created.  
  * Location - Relative location to poll for status. 
  
       
 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. 
  -  
       
 404 
 id not found 
  -  
       
 500 
 Internal Error 
  -  
     
   */
  public GetMinutebarsFileStatusResponseWrapper getMinutebarsFileStatus(String id) throws ApiException {
    return getMinutebarsFileStatusWithHttpInfo(id).getData();
  }

  /**
   * Returns the status of the ID
   * Need to plug-in the id get from /create endpoint into /status endpoint
   * @param id id returned by files create endpoint to poll and collect status of the query (required)
   * @return ApiResponse<GetMinutebarsFileStatusResponseWrapper>
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 201 
  The Request has been created and the response has been created.  
  * Location - Relative location to poll for status. 
  
       
 202 
 The Request has not finished and the result has NOT been created.  
  * Location - Relative location to poll for status. 
  
       
 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. 
  -  
       
 404 
 id not found 
  -  
       
 500 
 Internal Error 
  -  
     
   */
  public ApiResponse getMinutebarsFileStatusWithHttpInfo(String id) throws ApiException {
    Object localVarPostBody = null;
    
    // verify the required parameter 'id' is set
    if (id == null) {
      throw new ApiException(400, "Missing the required parameter 'id' when calling getMinutebarsFileStatus");
    }
    
    // create path and map variables
    String localVarPath = "/level1/files/minute-bars/status";

    // 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("", "id", id));

    
    
    
    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<
        Object
        
      
    > apiResponse = apiClient.invokeAPI("Level1Api.getMinutebarsFileStatus", localVarPath, "GET", localVarQueryParams, localVarPostBody,
                               localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
                               localVarAuthNames, getMinutebarsFileStatusResponseTypeMap, false);

    int statusCode = apiResponse.getStatusCode();
    GetMinutebarsFileStatusResponseWrapper responseWrapper = new GetMinutebarsFileStatusResponseWrapper(
      statusCode,
      apiResponse.getData()
    );

    return new ApiResponse(statusCode, apiResponse.getHeaders(), responseWrapper);


  }
  /**
   * Returns the Minute bars data in files requested in the /create endpoint
   * Returns the files from tickhistory endpoint
   * @param id id returned by files create endpoint to poll and collect results of the query (required)
   * @param paginationLimit Specifies the maximum number of results to return per response page (optional, default to 20)
   * @param paginationOffset Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results (optional, default to 0)
   * @return GetMinutebarsFilesResponseWrapper
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 200 
 Success</p> **To download the output file copy the response url in a browser** 
  -  
       
 202 
 The Request has not finished and the result has NOT been created.  
  * Location - Relative location to poll for status. 
  
       
 400 
 Bad request 
  -  
       
 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. 
  -  
       
 404 
 id not found 
  -  
       
 500 
 Internal Error 
  -  
     
   */
  public GetMinutebarsFilesResponseWrapper getMinutebarsFiles(String id, Integer paginationLimit, Integer paginationOffset) throws ApiException {
    return getMinutebarsFilesWithHttpInfo(id, paginationLimit, paginationOffset).getData();
  }

  /**
   * Returns the Minute bars data in files requested in the /create endpoint
   * Returns the files from tickhistory endpoint
   * @param id id returned by files create endpoint to poll and collect results of the query (required)
   * @param paginationLimit Specifies the maximum number of results to return per response page (optional, default to 20)
   * @param paginationOffset Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results (optional, default to 0)
   * @return ApiResponse<GetMinutebarsFilesResponseWrapper>
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 200 
 Success</p> **To download the output file copy the response url in a browser** 
  -  
       
 202 
 The Request has not finished and the result has NOT been created.  
  * Location - Relative location to poll for status. 
  
       
 400 
 Bad request 
  -  
       
 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. 
  -  
       
 404 
 id not found 
  -  
       
 500 
 Internal Error 
  -  
     
   */
  public ApiResponse getMinutebarsFilesWithHttpInfo(String id, Integer paginationLimit, Integer paginationOffset) throws ApiException {
    Object localVarPostBody = null;
    
    // verify the required parameter 'id' is set
    if (id == null) {
      throw new ApiException(400, "Missing the required parameter 'id' when calling getMinutebarsFiles");
    }
    
    // create path and map variables
    String localVarPath = "/level1/files/minute-bars/get";

    // 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("", "id", id));
    localVarQueryParams.addAll(apiClient.parameterToPairs("", "_paginationLimit", paginationLimit));
    localVarQueryParams.addAll(apiClient.parameterToPairs("", "_paginationOffset", paginationOffset));

    
    
    
    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<
        Object
        
      
    > apiResponse = apiClient.invokeAPI("Level1Api.getMinutebarsFiles", localVarPath, "GET", localVarQueryParams, localVarPostBody,
                               localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
                               localVarAuthNames, getMinutebarsFilesResponseTypeMap, false);

    int statusCode = apiResponse.getStatusCode();
    GetMinutebarsFilesResponseWrapper responseWrapper = new GetMinutebarsFilesResponseWrapper(
      statusCode,
      apiResponse.getData()
    );

    return new ApiResponse(statusCode, apiResponse.getHeaders(), responseWrapper);


  }
  /**
   * Returns the tick-by-tick data in files requested in the /create endpoint
   * Returns the files from tickhistory endpoint
   * @param id id returned by files create endpoint to poll and collect results of the query (required)
   * @param paginationLimit Specifies the maximum number of results to return per response page (optional, default to 20)
   * @param paginationOffset Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results (optional, default to 0)
   * @return GetTickHistoryLevel1FilesResponseWrapper
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 200 
 Success</p> **To download the output file copy the response url in a browser** 
  -  
       
 202 
 The Request has not finished and the result has NOT been created.  
  * Location - Relative location to poll for status. 
  
       
 400 
 Bad request 
  -  
       
 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. 
  -  
       
 404 
 id not found 
  -  
       
 500 
 Internal Error 
  -  
     
   */
  public GetTickHistoryLevel1FilesResponseWrapper getTickHistoryLevel1Files(String id, Integer paginationLimit, Integer paginationOffset) throws ApiException {
    return getTickHistoryLevel1FilesWithHttpInfo(id, paginationLimit, paginationOffset).getData();
  }

  /**
   * Returns the tick-by-tick data in files requested in the /create endpoint
   * Returns the files from tickhistory endpoint
   * @param id id returned by files create endpoint to poll and collect results of the query (required)
   * @param paginationLimit Specifies the maximum number of results to return per response page (optional, default to 20)
   * @param paginationOffset Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results (optional, default to 0)
   * @return ApiResponse<GetTickHistoryLevel1FilesResponseWrapper>
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 200 
 Success</p> **To download the output file copy the response url in a browser** 
  -  
       
 202 
 The Request has not finished and the result has NOT been created.  
  * Location - Relative location to poll for status. 
  
       
 400 
 Bad request 
  -  
       
 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. 
  -  
       
 404 
 id not found 
  -  
       
 500 
 Internal Error 
  -  
     
   */
  public ApiResponse getTickHistoryLevel1FilesWithHttpInfo(String id, Integer paginationLimit, Integer paginationOffset) throws ApiException {
    Object localVarPostBody = null;
    
    // verify the required parameter 'id' is set
    if (id == null) {
      throw new ApiException(400, "Missing the required parameter 'id' when calling getTickHistoryLevel1Files");
    }
    
    // create path and map variables
    String localVarPath = "/level1/files/get";

    // 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("", "id", id));
    localVarQueryParams.addAll(apiClient.parameterToPairs("", "_paginationLimit", paginationLimit));
    localVarQueryParams.addAll(apiClient.parameterToPairs("", "_paginationOffset", paginationOffset));

    
    
    
    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<
        Object
        
      
    > apiResponse = apiClient.invokeAPI("Level1Api.getTickHistoryLevel1Files", localVarPath, "GET", localVarQueryParams, localVarPostBody,
                               localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
                               localVarAuthNames, getTickHistoryLevel1FilesResponseTypeMap, false);

    int statusCode = apiResponse.getStatusCode();
    GetTickHistoryLevel1FilesResponseWrapper responseWrapper = new GetTickHistoryLevel1FilesResponseWrapper(
      statusCode,
      apiResponse.getData()
    );

    return new ApiResponse(statusCode, apiResponse.getHeaders(), responseWrapper);


  }
  /**
   * Requests the creation of Minute bars file
   * 1-minute bars available from 20120101 to previous day. Per request able to fetch upto 6 months of data.
   * @param minRequest  (required)
   * @return SubmittedResponse
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 202 
 The Request has been Accepted 
  * Location - Relative location to poll for status. 
  * 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 
 Bad request 
  -  
       
 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. 
  -  
       
 429 
 Too many requests. 
  -  
       
 500 
 Internal Error 
  -  
     
   */
  public SubmittedResponse requestMinutebarsFiles(MinRequest minRequest) throws ApiException {
    return requestMinutebarsFilesWithHttpInfo(minRequest).getData();
  }

  /**
   * Requests the creation of Minute bars file
   * 1-minute bars available from 20120101 to previous day. Per request able to fetch upto 6 months of data.
   * @param minRequest  (required)
   * @return ApiResponse<SubmittedResponse>
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 202 
 The Request has been Accepted 
  * Location - Relative location to poll for status. 
  * 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 
 Bad request 
  -  
       
 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. 
  -  
       
 429 
 Too many requests. 
  -  
       
 500 
 Internal Error 
  -  
     
   */
  public ApiResponse requestMinutebarsFilesWithHttpInfo(MinRequest minRequest) throws ApiException {
    Object localVarPostBody = minRequest;
    
    // verify the required parameter 'minRequest' is set
    if (minRequest == null) {
      throw new ApiException(400, "Missing the required parameter 'minRequest' when calling requestMinutebarsFiles");
    }
    
    // create path and map variables
    String localVarPath = "/level1/files/minute-bars/create";

    // 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<
        
        SubmittedResponse
      
    > apiResponse = apiClient.invokeAPI("Level1Api.requestMinutebarsFiles", localVarPath, "POST", localVarQueryParams, localVarPostBody,
                               localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
                               localVarAuthNames, requestMinutebarsFilesResponseTypeMap, false);

    return apiResponse;

  }
  /**
   * Returns the coverage for the requested ticker/isin along with other response fields for Level1 data.
   * Returns coverage for specified tickers for Level1 Data
   * @param tickers <P> The requested list of one or more tickers.</p>   The `tickers` and `isins`  parameters provide two different ways to specify the identifiers for data retrieved. Please enter either the tickers or isins parameter.   <P> Maximum 10 tickers per request</p>      (optional)
   * @param factsetExchangeCode <p>This parameter is used to filter the results based on the FactSet specific regional or composite exchange code.</p> **NOTE**:Does not support multiple factsetExchangeCodes (optional)
   * @param isins <P> Specifies the ISIN of the record. </p>    Please enter either the `tickers` or `isins` parameter.     <P> Maximum 10 ISINs per request.</p>       (optional)
   * @return CoverageResponse
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 200 
 Success</p> 
  -  
       
 400 
 Bad request 
  -  
       
 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. 
  -  
       
 429 
 Too many requests. 
  -  
       
 500 
 Internal Error 
  -  
     
   */
  public CoverageResponse requestTickHistoryCoverage(java.util.List tickers, String factsetExchangeCode, java.util.List isins) throws ApiException {
    return requestTickHistoryCoverageWithHttpInfo(tickers, factsetExchangeCode, isins).getData();
  }

  /**
   * Returns the coverage for the requested ticker/isin along with other response fields for Level1 data.
   * Returns coverage for specified tickers for Level1 Data
   * @param tickers <P> The requested list of one or more tickers.</p>   The `tickers` and `isins`  parameters provide two different ways to specify the identifiers for data retrieved. Please enter either the tickers or isins parameter.   <P> Maximum 10 tickers per request</p>      (optional)
   * @param factsetExchangeCode <p>This parameter is used to filter the results based on the FactSet specific regional or composite exchange code.</p> **NOTE**:Does not support multiple factsetExchangeCodes (optional)
   * @param isins <P> Specifies the ISIN of the record. </p>    Please enter either the `tickers` or `isins` parameter.     <P> Maximum 10 ISINs per request.</p>       (optional)
   * @return ApiResponse<CoverageResponse>
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 200 
 Success</p> 
  -  
       
 400 
 Bad request 
  -  
       
 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. 
  -  
       
 429 
 Too many requests. 
  -  
       
 500 
 Internal Error 
  -  
     
   */
  public ApiResponse requestTickHistoryCoverageWithHttpInfo(java.util.List tickers, String factsetExchangeCode, java.util.List isins) throws ApiException {
    Object localVarPostBody = null;
    
    // create path and map variables
    String localVarPath = "/level1/coverage";

    // 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", "tickers", tickers));
    localVarQueryParams.addAll(apiClient.parameterToPairs("", "factsetExchangeCode", factsetExchangeCode));
    localVarQueryParams.addAll(apiClient.parameterToPairs("csv", "isins", isins));

    
    
    
    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<
        
        CoverageResponse
      
    > apiResponse = apiClient.invokeAPI("Level1Api.requestTickHistoryCoverage", localVarPath, "GET", localVarQueryParams, localVarPostBody,
                               localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
                               localVarAuthNames, requestTickHistoryCoverageResponseTypeMap, false);

    return apiResponse;

  }
  /**
   * Requests the creation of tick-by-tick file
   * Data available from 20120101 to previous day.
   * @param leveloneRequest  (required)
   * @return SubmittedResponse
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 202 
 The Request has been Accepted 
  * Location - Relative location to poll for status. 
  * 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 
 Bad request 
  -  
       
 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. 
  -  
       
 429 
 Too many requests. 
  -  
       
 500 
 Internal Error 
  -  
     
   */
  public SubmittedResponse requestTickHistoryLevel1Files(LeveloneRequest leveloneRequest) throws ApiException {
    return requestTickHistoryLevel1FilesWithHttpInfo(leveloneRequest).getData();
  }

  /**
   * Requests the creation of tick-by-tick file
   * Data available from 20120101 to previous day.
   * @param leveloneRequest  (required)
   * @return ApiResponse<SubmittedResponse>
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 202 
 The Request has been Accepted 
  * Location - Relative location to poll for status. 
  * 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 
 Bad request 
  -  
       
 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. 
  -  
       
 429 
 Too many requests. 
  -  
       
 500 
 Internal Error 
  -  
     
   */
  public ApiResponse requestTickHistoryLevel1FilesWithHttpInfo(LeveloneRequest leveloneRequest) throws ApiException {
    Object localVarPostBody = leveloneRequest;
    
    // verify the required parameter 'leveloneRequest' is set
    if (leveloneRequest == null) {
      throw new ApiException(400, "Missing the required parameter 'leveloneRequest' when calling requestTickHistoryLevel1Files");
    }
    
    // create path and map variables
    String localVarPath = "/level1/files/create";

    // 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<
        
        SubmittedResponse
      
    > apiResponse = apiClient.invokeAPI("Level1Api.requestTickHistoryLevel1Files", localVarPath, "POST", localVarQueryParams, localVarPostBody,
                               localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
                               localVarAuthNames, requestTickHistoryLevel1FilesResponseTypeMap, false);

    return apiResponse;

  }
}