Package markets.alpaca.client.openapi.trading.api

Class WatchlistsApi

java.lang.Object
markets.alpaca.client.openapi.trading.api.WatchlistsApi
public class WatchlistsApi extends Object
Generated client for WatchlistsApi 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

  • addAssetToWatchlist: Add Asset to Watchlist
  • addAssetToWatchlistByName: Add Asset to Watchlist By Name
  • deleteWatchlistById: Delete Watchlist By Id
  • deleteWatchlistByName: Delete Watchlist By Name
  • getWatchlistById: Get Watchlist by ID
  • getWatchlistByName: Get Watchlist by Name
  • getWatchlists: Get All Watchlists
  • postWatchlist: Create Watchlist
  • removeAssetFromWatchlist: Delete Symbol from Watchlist
  • updateWatchlistById: Update Watchlist By Id
  • updateWatchlistByName: Update Watchlist By Name

  • Constructor Details

    • WatchlistsApi

      public WatchlistsApi()

    • WatchlistsApi

      public WatchlistsApi(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)

    • addAssetToWatchlistCall

      public okhttp3.Call addAssetToWatchlistCall(@Nonnull UUID watchlistId, @Nullable AddAssetToWatchlistRequest addAssetToWatchlistRequest, ApiCallback _callback) throws ApiException
      Build call for addAssetToWatchlist
      Parameters:
      watchlistId - watchlist id (required)
      addAssetToWatchlistRequest - (optional)
      _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 Successful response -

    • addAssetToWatchlist

      public Watchlist addAssetToWatchlist(@Nonnull UUID watchlistId, @Nullable AddAssetToWatchlistRequest addAssetToWatchlistRequest) throws ApiException
      Add Asset to Watchlist Append an asset for the symbol to the end of watchlist asset list
      Parameters:
      watchlistId - watchlist id (required)
      addAssetToWatchlistRequest - (optional)
      Returns:
      Watchlist
      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 Successful response -

    • addAssetToWatchlistWithHttpInfo

      public ApiResponse<Watchlist> addAssetToWatchlistWithHttpInfo(@Nonnull UUID watchlistId, @Nullable AddAssetToWatchlistRequest addAssetToWatchlistRequest) throws ApiException
      Add Asset to Watchlist Append an asset for the symbol to the end of watchlist asset list
      Parameters:
      watchlistId - watchlist id (required)
      addAssetToWatchlistRequest - (optional)
      Returns:
      ApiResponse<Watchlist>
      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 Successful response -

    • addAssetToWatchlistAsync

      public okhttp3.Call addAssetToWatchlistAsync(@Nonnull UUID watchlistId, @Nullable AddAssetToWatchlistRequest addAssetToWatchlistRequest, ApiCallback<Watchlist> _callback) throws ApiException
      Add Asset to Watchlist (asynchronously) Append an asset for the symbol to the end of watchlist asset list
      Parameters:
      watchlistId - watchlist id (required)
      addAssetToWatchlistRequest - (optional)
      _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 Successful response -

    • addAssetToWatchlistByNameCall

      public okhttp3.Call addAssetToWatchlistByNameCall(@Nonnull String name, @Nullable AddAssetToWatchlistRequest addAssetToWatchlistRequest, ApiCallback _callback) throws ApiException
      Build call for addAssetToWatchlistByName
      Parameters:
      name - name of the watchlist (required)
      addAssetToWatchlistRequest - (optional)
      _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 Successful response -

    • addAssetToWatchlistByName

      public Watchlist addAssetToWatchlistByName(@Nonnull String name, @Nullable AddAssetToWatchlistRequest addAssetToWatchlistRequest) throws ApiException
      Add Asset to Watchlist By Name Append an asset for the symbol to the end of watchlist asset list
      Parameters:
      name - name of the watchlist (required)
      addAssetToWatchlistRequest - (optional)
      Returns:
      Watchlist
      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 Successful response -

    • addAssetToWatchlistByNameWithHttpInfo

      public ApiResponse<Watchlist> addAssetToWatchlistByNameWithHttpInfo(@Nonnull String name, @Nullable AddAssetToWatchlistRequest addAssetToWatchlistRequest) throws ApiException
      Add Asset to Watchlist By Name Append an asset for the symbol to the end of watchlist asset list
      Parameters:
      name - name of the watchlist (required)
      addAssetToWatchlistRequest - (optional)
      Returns:
      ApiResponse<Watchlist>
      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 Successful response -

    • addAssetToWatchlistByNameAsync

      public okhttp3.Call addAssetToWatchlistByNameAsync(@Nonnull String name, @Nullable AddAssetToWatchlistRequest addAssetToWatchlistRequest, ApiCallback<Watchlist> _callback) throws ApiException
      Add Asset to Watchlist By Name (asynchronously) Append an asset for the symbol to the end of watchlist asset list
      Parameters:
      name - name of the watchlist (required)
      addAssetToWatchlistRequest - (optional)
      _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 Successful response -

    • deleteWatchlistByIdCall

      public okhttp3.Call deleteWatchlistByIdCall(@Nonnull UUID watchlistId, ApiCallback _callback) throws ApiException
      Build call for deleteWatchlistById
      Parameters:
      watchlistId - watchlist id (required)
      _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
      204 No Content -
      404 Watchlist not found -

    • deleteWatchlistById

      public void deleteWatchlistById(@Nonnull UUID watchlistId) throws ApiException
      Delete Watchlist By Id Delete a watchlist. This is a permanent deletion.
      Parameters:
      watchlistId - watchlist id (required)
      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
      204 No Content -
      404 Watchlist not found -

    • deleteWatchlistByIdWithHttpInfo

      public ApiResponse<Void> deleteWatchlistByIdWithHttpInfo(@Nonnull UUID watchlistId) throws ApiException
      Delete Watchlist By Id Delete a watchlist. This is a permanent deletion.
      Parameters:
      watchlistId - watchlist id (required)
      Returns:
      ApiResponse<Void>
      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
      204 No Content -
      404 Watchlist not found -

    • deleteWatchlistByIdAsync

      public okhttp3.Call deleteWatchlistByIdAsync(@Nonnull UUID watchlistId, ApiCallback<Void> _callback) throws ApiException
      Delete Watchlist By Id (asynchronously) Delete a watchlist. This is a permanent deletion.
      Parameters:
      watchlistId - watchlist id (required)
      _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
      204 No Content -
      404 Watchlist not found -

    • deleteWatchlistByNameCall

      public okhttp3.Call deleteWatchlistByNameCall(@Nonnull String name, ApiCallback _callback) throws ApiException
      Build call for deleteWatchlistByName
      Parameters:
      name - name of the watchlist (required)
      _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
      204 No Content -

    • deleteWatchlistByName

      public void deleteWatchlistByName(@Nonnull String name) throws ApiException
      Delete Watchlist By Name Delete a watchlist. This is a permanent deletion.
      Parameters:
      name - name of the watchlist (required)
      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
      204 No Content -

    • deleteWatchlistByNameWithHttpInfo

      public ApiResponse<Void> deleteWatchlistByNameWithHttpInfo(@Nonnull String name) throws ApiException
      Delete Watchlist By Name Delete a watchlist. This is a permanent deletion.
      Parameters:
      name - name of the watchlist (required)
      Returns:
      ApiResponse<Void>
      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
      204 No Content -

    • deleteWatchlistByNameAsync

      public okhttp3.Call deleteWatchlistByNameAsync(@Nonnull String name, ApiCallback<Void> _callback) throws ApiException
      Delete Watchlist By Name (asynchronously) Delete a watchlist. This is a permanent deletion.
      Parameters:
      name - name of the watchlist (required)
      _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
      204 No Content -

    • getWatchlistByIdCall

      public okhttp3.Call getWatchlistByIdCall(@Nonnull UUID watchlistId, ApiCallback _callback) throws ApiException
      Build call for getWatchlistById
      Parameters:
      watchlistId - watchlist id (required)
      _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 Successful response -

    • getWatchlistById

      public Watchlist getWatchlistById(@Nonnull UUID watchlistId) throws ApiException
      Get Watchlist by ID Returns a watchlist identified by the ID.
      Parameters:
      watchlistId - watchlist id (required)
      Returns:
      Watchlist
      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 Successful response -

    • getWatchlistByIdWithHttpInfo

      public ApiResponse<Watchlist> getWatchlistByIdWithHttpInfo(@Nonnull UUID watchlistId) throws ApiException
      Get Watchlist by ID Returns a watchlist identified by the ID.
      Parameters:
      watchlistId - watchlist id (required)
      Returns:
      ApiResponse<Watchlist>
      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 Successful response -

    • getWatchlistByIdAsync

      public okhttp3.Call getWatchlistByIdAsync(@Nonnull UUID watchlistId, ApiCallback<Watchlist> _callback) throws ApiException
      Get Watchlist by ID (asynchronously) Returns a watchlist identified by the ID.
      Parameters:
      watchlistId - watchlist id (required)
      _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 Successful response -

    • getWatchlistByNameCall

      public okhttp3.Call getWatchlistByNameCall(@Nonnull String name, ApiCallback _callback) throws ApiException
      Build call for getWatchlistByName
      Parameters:
      name - name of the watchlist (required)
      _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 Successful response -

    • getWatchlistByName

      public Watchlist getWatchlistByName(@Nonnull String name) throws ApiException
      Get Watchlist by Name You can also call GET, PUT, POST and DELETE with watchlist name with another endpoint /v2/watchlists:by_name and query parameter name=<watchlist_name>, instead of /v2/watchlists/{watchlist_id} endpoints Returns a watchlist by name
      Parameters:
      name - name of the watchlist (required)
      Returns:
      Watchlist
      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 Successful response -

    • getWatchlistByNameWithHttpInfo

      public ApiResponse<Watchlist> getWatchlistByNameWithHttpInfo(@Nonnull String name) throws ApiException
      Get Watchlist by Name You can also call GET, PUT, POST and DELETE with watchlist name with another endpoint /v2/watchlists:by_name and query parameter name=<watchlist_name>, instead of /v2/watchlists/{watchlist_id} endpoints Returns a watchlist by name
      Parameters:
      name - name of the watchlist (required)
      Returns:
      ApiResponse<Watchlist>
      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 Successful response -

    • getWatchlistByNameAsync

      public okhttp3.Call getWatchlistByNameAsync(@Nonnull String name, ApiCallback<Watchlist> _callback) throws ApiException
      Get Watchlist by Name (asynchronously) You can also call GET, PUT, POST and DELETE with watchlist name with another endpoint /v2/watchlists:by_name and query parameter name=<watchlist_name>, instead of /v2/watchlists/{watchlist_id} endpoints Returns a watchlist by name
      Parameters:
      name - name of the watchlist (required)
      _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 Successful response -

    • getWatchlistsCall

      public okhttp3.Call getWatchlistsCall(ApiCallback _callback) throws ApiException
      Build call for getWatchlists
      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 Successful response -

    • getWatchlists

      public List<WatchlistWithoutAsset> getWatchlists() throws ApiException
      Get All Watchlists Returns the list of watchlists registered under the account.
      Returns:
      List<WatchlistWithoutAsset>
      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 Successful response -

    • getWatchlistsWithHttpInfo

      public ApiResponse<List<WatchlistWithoutAsset>> getWatchlistsWithHttpInfo() throws ApiException
      Get All Watchlists Returns the list of watchlists registered under the account.
      Returns:
      ApiResponse<List<WatchlistWithoutAsset>>
      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 Successful response -

    • getWatchlistsAsync

      public okhttp3.Call getWatchlistsAsync(ApiCallback<List<WatchlistWithoutAsset>> _callback) throws ApiException
      Get All Watchlists (asynchronously) Returns the list of watchlists registered under the account.
      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 Successful response -

    • postWatchlistCall

      public okhttp3.Call postWatchlistCall(@Nonnull CreateWatchlistRequest createWatchlistRequest, ApiCallback _callback) throws ApiException
      Build call for postWatchlist
      Parameters:
      createWatchlistRequest - (required)
      _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 Successful response -

    • postWatchlist

      public Watchlist postWatchlist(@Nonnull CreateWatchlistRequest createWatchlistRequest) throws ApiException
      Create Watchlist Create a new watchlist with initial set of assets.
      Parameters:
      createWatchlistRequest - (required)
      Returns:
      Watchlist
      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 Successful response -

    • postWatchlistWithHttpInfo

      public ApiResponse<Watchlist> postWatchlistWithHttpInfo(@Nonnull CreateWatchlistRequest createWatchlistRequest) throws ApiException
      Create Watchlist Create a new watchlist with initial set of assets.
      Parameters:
      createWatchlistRequest - (required)
      Returns:
      ApiResponse<Watchlist>
      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 Successful response -

    • postWatchlistAsync

      public okhttp3.Call postWatchlistAsync(@Nonnull CreateWatchlistRequest createWatchlistRequest, ApiCallback<Watchlist> _callback) throws ApiException
      Create Watchlist (asynchronously) Create a new watchlist with initial set of assets.
      Parameters:
      createWatchlistRequest - (required)
      _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 Successful response -

    • removeAssetFromWatchlistCall

      public okhttp3.Call removeAssetFromWatchlistCall(@Nonnull UUID watchlistId, @Nonnull String symbol, ApiCallback _callback) throws ApiException
      Build call for removeAssetFromWatchlist
      Parameters:
      watchlistId - Watchlist ID (required)
      symbol - symbol name to remove from the watchlist content (required)
      _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 Returns the updated watchlist -

    • removeAssetFromWatchlist

      public Watchlist removeAssetFromWatchlist(@Nonnull UUID watchlistId, @Nonnull String symbol) throws ApiException
      Delete Symbol from Watchlist Delete one entry for an asset by symbol name
      Parameters:
      watchlistId - Watchlist ID (required)
      symbol - symbol name to remove from the watchlist content (required)
      Returns:
      Watchlist
      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 Returns the updated watchlist -

    • removeAssetFromWatchlistWithHttpInfo

      public ApiResponse<Watchlist> removeAssetFromWatchlistWithHttpInfo(@Nonnull UUID watchlistId, @Nonnull String symbol) throws ApiException
      Delete Symbol from Watchlist Delete one entry for an asset by symbol name
      Parameters:
      watchlistId - Watchlist ID (required)
      symbol - symbol name to remove from the watchlist content (required)
      Returns:
      ApiResponse<Watchlist>
      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 Returns the updated watchlist -

    • removeAssetFromWatchlistAsync

      public okhttp3.Call removeAssetFromWatchlistAsync(@Nonnull UUID watchlistId, @Nonnull String symbol, ApiCallback<Watchlist> _callback) throws ApiException
      Delete Symbol from Watchlist (asynchronously) Delete one entry for an asset by symbol name
      Parameters:
      watchlistId - Watchlist ID (required)
      symbol - symbol name to remove from the watchlist content (required)
      _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 Returns the updated watchlist -

    • updateWatchlistByIdCall

      public okhttp3.Call updateWatchlistByIdCall(@Nonnull UUID watchlistId, @Nullable UpdateWatchlistRequest updateWatchlistRequest, ApiCallback _callback) throws ApiException
      Build call for updateWatchlistById
      Parameters:
      watchlistId - watchlist id (required)
      updateWatchlistRequest - (optional)
      _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 Successful response -

    • updateWatchlistById

      public Watchlist updateWatchlistById(@Nonnull UUID watchlistId, @Nullable UpdateWatchlistRequest updateWatchlistRequest) throws ApiException
      Update Watchlist By Id Update the name and/or content of watchlist
      Parameters:
      watchlistId - watchlist id (required)
      updateWatchlistRequest - (optional)
      Returns:
      Watchlist
      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 Successful response -

    • updateWatchlistByIdWithHttpInfo

      public ApiResponse<Watchlist> updateWatchlistByIdWithHttpInfo(@Nonnull UUID watchlistId, @Nullable UpdateWatchlistRequest updateWatchlistRequest) throws ApiException
      Update Watchlist By Id Update the name and/or content of watchlist
      Parameters:
      watchlistId - watchlist id (required)
      updateWatchlistRequest - (optional)
      Returns:
      ApiResponse<Watchlist>
      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 Successful response -

    • updateWatchlistByIdAsync

      public okhttp3.Call updateWatchlistByIdAsync(@Nonnull UUID watchlistId, @Nullable UpdateWatchlistRequest updateWatchlistRequest, ApiCallback<Watchlist> _callback) throws ApiException
      Update Watchlist By Id (asynchronously) Update the name and/or content of watchlist
      Parameters:
      watchlistId - watchlist id (required)
      updateWatchlistRequest - (optional)
      _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 Successful response -

    • updateWatchlistByNameCall

      public okhttp3.Call updateWatchlistByNameCall(@Nonnull String name, @Nullable UpdateWatchlistRequest updateWatchlistRequest, ApiCallback _callback) throws ApiException
      Build call for updateWatchlistByName
      Parameters:
      name - name of the watchlist (required)
      updateWatchlistRequest - (optional)
      _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 Successful response -

    • updateWatchlistByName

      public Watchlist updateWatchlistByName(@Nonnull String name, @Nullable UpdateWatchlistRequest updateWatchlistRequest) throws ApiException
      Update Watchlist By Name Update the name and/or content of watchlist
      Parameters:
      name - name of the watchlist (required)
      updateWatchlistRequest - (optional)
      Returns:
      Watchlist
      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 Successful response -

    • updateWatchlistByNameWithHttpInfo

      public ApiResponse<Watchlist> updateWatchlistByNameWithHttpInfo(@Nonnull String name, @Nullable UpdateWatchlistRequest updateWatchlistRequest) throws ApiException
      Update Watchlist By Name Update the name and/or content of watchlist
      Parameters:
      name - name of the watchlist (required)
      updateWatchlistRequest - (optional)
      Returns:
      ApiResponse<Watchlist>
      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 Successful response -

    • updateWatchlistByNameAsync

      public okhttp3.Call updateWatchlistByNameAsync(@Nonnull String name, @Nullable UpdateWatchlistRequest updateWatchlistRequest, ApiCallback<Watchlist> _callback) throws ApiException
      Update Watchlist By Name (asynchronously) Update the name and/or content of watchlist
      Parameters:
      name - name of the watchlist (required)
      updateWatchlistRequest - (optional)
      _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 Successful response -