Package com.mypurecloud.sdk.v2.api

Class StationsApi

java.lang.Object
com.mypurecloud.sdk.v2.api.StationsApi
public class StationsApi extends Object

  • Constructor Details

    • StationsApi

      public StationsApi()

    • StationsApi

      public StationsApi(ApiClient apiClient)

  • Method Details

    • deleteStationAssociateduser

      public void deleteStationAssociateduser(String stationId) throws IOException, ApiException
      Unassigns the user assigned to this station
      Parameters:
      stationId - Station ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteStationAssociateduserWithHttpInfo

      public ApiResponse<Void> deleteStationAssociateduserWithHttpInfo(String stationId) throws IOException
      Unassigns the user assigned to this station
      Parameters:
      stationId - Station ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteStationAssociateduser

      public void deleteStationAssociateduser(DeleteStationAssociateduserRequest request) throws IOException, ApiException
      Unassigns the user assigned to this station
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteStationAssociateduser

      public ApiResponse<Void> deleteStationAssociateduser(ApiRequest<Void> request) throws IOException
      Unassigns the user assigned to this station
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getStation

      public Station getStation(String stationId) throws IOException, ApiException
      Get station.
      Parameters:
      stationId - Station ID (required)
      Returns:
      Station
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getStationWithHttpInfo

      public ApiResponse<Station> getStationWithHttpInfo(String stationId) throws IOException
      Get station.
      Parameters:
      stationId - Station ID (required)
      Returns:
      Station
      Throws:
      IOException - if the request fails to be processed

    • getStation

      public Station getStation(GetStationRequest request) throws IOException, ApiException
      Get station.
      Parameters:
      request - The request object
      Returns:
      Station
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getStation

      public ApiResponse<Station> getStation(ApiRequest<Void> request) throws IOException
      Get station.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getStations

      public StationEntityListing getStations(Integer pageSize, Integer pageNumber, String sortBy, String name, String userSelectable, String webRtcUserId, String id, String lineAppearanceId) throws IOException, ApiException
      Get the list of available stations.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortBy - Sort by (optional, default to name)
      name - Name (optional)
      userSelectable - True for stations that the user can select otherwise false (optional)
      webRtcUserId - Filter for the webRtc station of the webRtcUserId (optional)
      id - Comma separated list of stationIds (optional)
      lineAppearanceId - lineAppearanceId (optional)
      Returns:
      StationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getStationsWithHttpInfo

      public ApiResponse<StationEntityListing> getStationsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, String name, String userSelectable, String webRtcUserId, String id, String lineAppearanceId) throws IOException
      Get the list of available stations.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      sortBy - Sort by (optional, default to name)
      name - Name (optional)
      userSelectable - True for stations that the user can select otherwise false (optional)
      webRtcUserId - Filter for the webRtc station of the webRtcUserId (optional)
      id - Comma separated list of stationIds (optional)
      lineAppearanceId - lineAppearanceId (optional)
      Returns:
      StationEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getStations

      public StationEntityListing getStations(GetStationsRequest request) throws IOException, ApiException
      Get the list of available stations.
      Parameters:
      request - The request object
      Returns:
      StationEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getStations

      public ApiResponse<StationEntityListing> getStations(ApiRequest<Void> request) throws IOException
      Get the list of available stations.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed