Package markets.alpaca.client.openapi.broker.api

Class IraApi

java.lang.Object
markets.alpaca.client.openapi.broker.api.IraApi
public class IraApi extends Object
Generated client for IraApi operations.

This class is generated from the configured OpenAPI spec. Operation method Javadocs include OAS summaries, descriptions, parameters, return types, response details, and external documentation links when present in the spec.

Operations

  • listIRAExcessContritbutions: Retrieve Excess Contributions

  • Constructor Details

    • IraApi

      public IraApi()

    • IraApi

      public IraApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)

    • listIRAExcessContritbutionsCall

      public okhttp3.Call listIRAExcessContritbutionsCall(ApiCallback _callback) throws ApiException
      Build call for listIRAExcessContritbutions
      Parameters:
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 list of overcontributed IRA accounts -
      0 error -

    • listIRAExcessContritbutions

      public List<OvercontributedIRAAccount> listIRAExcessContritbutions() throws ApiException
      Retrieve Excess Contributions Returns all overcontributed IRA accounts
      Returns:
      List<OvercontributedIRAAccount>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 list of overcontributed IRA accounts -
      0 error -

    • listIRAExcessContritbutionsWithHttpInfo

      public ApiResponse<List<OvercontributedIRAAccount>> listIRAExcessContritbutionsWithHttpInfo() throws ApiException
      Retrieve Excess Contributions Returns all overcontributed IRA accounts
      Returns:
      ApiResponse<List<OvercontributedIRAAccount>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 list of overcontributed IRA accounts -
      0 error -

    • listIRAExcessContritbutionsAsync

      public okhttp3.Call listIRAExcessContritbutionsAsync(ApiCallback<List<OvercontributedIRAAccount>> _callback) throws ApiException
      Retrieve Excess Contributions (asynchronously) Returns all overcontributed IRA accounts
      Parameters:
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      HTTP Response Details:
      Response Details
      Status Code Description Response Headers
      200 list of overcontributed IRA accounts -
      0 error -