Class TeamsApi


  • public class TeamsApi
    extends Object
    • Constructor Detail

      • TeamsApi

        public TeamsApi()
      • TeamsApi

        public TeamsApi​(ApiClient apiClient)
    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
      • setApiClient

        public void setApiClient​(ApiClient apiClient)
      • getTeamUsingGET

        public TeamResponseDTO getTeamUsingGET​(Long teamId)
                                        throws ApiException
        Get team details. This operation will retrieve details about a given team.
        Parameters:
        teamId - teamId (required)
        Returns:
        TeamResponseDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getTeamUsingGETWithHttpInfo

        public ApiResponse<TeamResponseDTO> getTeamUsingGETWithHttpInfo​(Long teamId)
                                                                 throws ApiException
        Get team details. This operation will retrieve details about a given team.
        Parameters:
        teamId - teamId (required)
        Returns:
        ApiResponse<TeamResponseDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getTeamUsingGETAsync

        public com.squareup.okhttp.Call getTeamUsingGETAsync​(Long teamId,
                                                             ApiCallback<TeamResponseDTO> callback)
                                                      throws ApiException
        Get team details. (asynchronously) This operation will retrieve details about a given team.
        Parameters:
        teamId - teamId (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
      • getTeamsUsingGETCall

        public com.squareup.okhttp.Call getTeamsUsingGETCall​(Long userId,
                                                             ProgressResponseBody.ProgressListener progressListener,
                                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                      throws ApiException
        Build call for getTeamsUsingGET
        Parameters:
        userId - The unique Id of the user you'd whose teams you'd like to query. (required)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getTeamsUsingGET

        public List<TeamResponseDTO> getTeamsUsingGET​(Long userId)
                                               throws ApiException
        Get teams. This operation will retrieve all teams for a given user.
        Parameters:
        userId - The unique Id of the user you'd whose teams you'd like to query. (required)
        Returns:
        List<TeamResponseDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getTeamsUsingGETWithHttpInfo

        public ApiResponse<List<TeamResponseDTO>> getTeamsUsingGETWithHttpInfo​(Long userId)
                                                                        throws ApiException
        Get teams. This operation will retrieve all teams for a given user.
        Parameters:
        userId - The unique Id of the user you'd whose teams you'd like to query. (required)
        Returns:
        ApiResponse<List<TeamResponseDTO>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getTeamsUsingGETAsync

        public com.squareup.okhttp.Call getTeamsUsingGETAsync​(Long userId,
                                                              ApiCallback<List<TeamResponseDTO>> callback)
                                                       throws ApiException
        Get teams. (asynchronously) This operation will retrieve all teams for a given user.
        Parameters:
        userId - The unique Id of the user you'd whose teams you'd like to query. (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
      • postTeamUsingPOST

        public TeamResponseDTO postTeamUsingPOST​(CreateTeamRequestDTO body,
                                                 Long userId)
                                          throws ApiException
        Create a team for a given user. This operation will create a team for a given user.
        Parameters:
        body - createTeamRequest (required)
        userId - The unique Id of the user for whom you'd like to create a team. (required)
        Returns:
        TeamResponseDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • postTeamUsingPOSTWithHttpInfo

        public ApiResponse<TeamResponseDTO> postTeamUsingPOSTWithHttpInfo​(CreateTeamRequestDTO body,
                                                                          Long userId)
                                                                   throws ApiException
        Create a team for a given user. This operation will create a team for a given user.
        Parameters:
        body - createTeamRequest (required)
        userId - The unique Id of the user for whom you'd like to create a team. (required)
        Returns:
        ApiResponse<TeamResponseDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • postTeamUsingPOSTAsync

        public com.squareup.okhttp.Call postTeamUsingPOSTAsync​(CreateTeamRequestDTO body,
                                                               Long userId,
                                                               ApiCallback<TeamResponseDTO> callback)
                                                        throws ApiException
        Create a team for a given user. (asynchronously) This operation will create a team for a given user.
        Parameters:
        body - createTeamRequest (required)
        userId - The unique Id of the user for whom you'd like to create a team. (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
      • updateTeamUsingPATCH

        public TeamResponseDTO updateTeamUsingPATCH​(UpdateTeamRequestDTO body,
                                                    Long teamId)
                                             throws ApiException
        Updates a team. This operation will update a team details.
        Parameters:
        body - updateTeamRquest (required)
        teamId - The unique Id of the team you'd like to update. (required)
        Returns:
        TeamResponseDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • updateTeamUsingPATCHWithHttpInfo

        public ApiResponse<TeamResponseDTO> updateTeamUsingPATCHWithHttpInfo​(UpdateTeamRequestDTO body,
                                                                             Long teamId)
                                                                      throws ApiException
        Updates a team. This operation will update a team details.
        Parameters:
        body - updateTeamRquest (required)
        teamId - The unique Id of the team you'd like to update. (required)
        Returns:
        ApiResponse<TeamResponseDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • updateTeamUsingPATCHAsync

        public com.squareup.okhttp.Call updateTeamUsingPATCHAsync​(UpdateTeamRequestDTO body,
                                                                  Long teamId,
                                                                  ApiCallback<TeamResponseDTO> callback)
                                                           throws ApiException
        Updates a team. (asynchronously) This operation will update a team details.
        Parameters:
        body - updateTeamRquest (required)
        teamId - The unique Id of the team you'd like to update. (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