Package com.hellosign.openapi.api

Class TeamApi

java.lang.Object

com.hellosign.openapi.api.TeamApi

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class TeamApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
TeamApi()
TeamApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()	Get the API client
void	setApiClient(ApiClient apiClient)	Set the API client
TeamGetResponse	teamAddMember(TeamAddMemberRequest teamAddMemberRequest, java.lang.String teamId)	Add User to Team Invites a user (specified using the `email_address` parameter) to your Team.
ApiResponse<TeamGetResponse>	teamAddMemberWithHttpInfo(TeamAddMemberRequest teamAddMemberRequest, java.lang.String teamId)	Add User to Team Invites a user (specified using the `email_address` parameter) to your Team.
TeamGetResponse	teamCreate(TeamCreateRequest teamCreateRequest)	Create Team Creates a new Team and makes you a member.
ApiResponse<TeamGetResponse>	teamCreateWithHttpInfo(TeamCreateRequest teamCreateRequest)	Create Team Creates a new Team and makes you a member.
void	teamDelete()	Delete Team Deletes your Team.
ApiResponse<java.lang.Void>	teamDeleteWithHttpInfo()	Delete Team Deletes your Team.
TeamGetResponse	teamGet()	Get Team Returns information about your Team as well as a list of its members.
ApiResponse<TeamGetResponse>	teamGetWithHttpInfo()	Get Team Returns information about your Team as well as a list of its members.
TeamGetInfoResponse	teamInfo(java.lang.String teamId)	Get Team Info Provides information about a team.
ApiResponse<TeamGetInfoResponse>	teamInfoWithHttpInfo(java.lang.String teamId)	Get Team Info Provides information about a team.
TeamMembersResponse	teamMembers(java.lang.String teamId, java.lang.Integer page, java.lang.Integer pageSize)	List Team Members Provides a paginated list of members (and their roles) that belong to a given team.
ApiResponse<TeamMembersResponse>	teamMembersWithHttpInfo(java.lang.String teamId, java.lang.Integer page, java.lang.Integer pageSize)	List Team Members Provides a paginated list of members (and their roles) that belong to a given team.
TeamGetResponse	teamRemoveMember(TeamRemoveMemberRequest teamRemoveMemberRequest)	Remove User from Team Removes the provided user Account from your Team.
ApiResponse<TeamGetResponse>	teamRemoveMemberWithHttpInfo(TeamRemoveMemberRequest teamRemoveMemberRequest)	Remove User from Team Removes the provided user Account from your Team.
TeamSubTeamsResponse	teamSubTeams(java.lang.String teamId, java.lang.Integer page, java.lang.Integer pageSize)	List Sub Teams Provides a paginated list of sub teams that belong to a given team.
ApiResponse<TeamSubTeamsResponse>	teamSubTeamsWithHttpInfo(java.lang.String teamId, java.lang.Integer page, java.lang.Integer pageSize)	List Sub Teams Provides a paginated list of sub teams that belong to a given team.
TeamGetResponse	teamUpdate(TeamUpdateRequest teamUpdateRequest)	Update Team Updates the name of your Team.
ApiResponse<TeamGetResponse>	teamUpdateWithHttpInfo(TeamUpdateRequest teamUpdateRequest)	Update Team Updates the name of your Team.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TeamApi

public TeamApi()

TeamApi

public TeamApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

Get the API client

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client

Parameters:

apiClient - an instance of API client

teamAddMember

public TeamGetResponse teamAddMember(TeamAddMemberRequest teamAddMemberRequest,
                                     java.lang.String teamId)
                              throws ApiException

Add User to Team Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a HelloSign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned.

Parameters:

teamAddMemberRequest - (required)

teamId - The id of the team. (optional)

Returns:

TeamGetResponse

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

teamAddMemberWithHttpInfo

public ApiResponse<TeamGetResponse> teamAddMemberWithHttpInfo(TeamAddMemberRequest teamAddMemberRequest,
                                                              java.lang.String teamId)
                                                       throws ApiException

Add User to Team Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a HelloSign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned.

Parameters:

teamAddMemberRequest - (required)

teamId - The id of the team. (optional)

Returns:

ApiResponse<TeamGetResponse>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

teamCreate

public TeamGetResponse teamCreate(TeamCreateRequest teamCreateRequest)
                           throws ApiException

Create Team Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.

Parameters:

teamCreateRequest - (required)

Returns:

TeamGetResponse

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

teamCreateWithHttpInfo

public ApiResponse<TeamGetResponse> teamCreateWithHttpInfo(TeamCreateRequest teamCreateRequest)
                                                    throws ApiException

Create Team Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.

Parameters:

teamCreateRequest - (required)

Returns:

ApiResponse<TeamGetResponse>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

teamDelete

public void teamDelete()
                throws ApiException

Delete Team Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

teamDeleteWithHttpInfo

public ApiResponse<java.lang.Void> teamDeleteWithHttpInfo()
                                                   throws ApiException

Delete Team Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

teamGet

public TeamGetResponse teamGet()
                        throws ApiException

Get Team Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned.

Returns:

TeamGetResponse

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

teamGetWithHttpInfo

public ApiResponse<TeamGetResponse> teamGetWithHttpInfo()
                                                 throws ApiException

Get Team Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of \"not_found\" will be returned.

Returns:

ApiResponse<TeamGetResponse>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

teamInfo

public TeamGetInfoResponse teamInfo(java.lang.String teamId)
                             throws ApiException

Get Team Info Provides information about a team.

Parameters:

teamId - The id of the team. (optional)

Returns:

TeamGetInfoResponse

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

teamInfoWithHttpInfo

public ApiResponse<TeamGetInfoResponse> teamInfoWithHttpInfo(java.lang.String teamId)
                                                      throws ApiException

Get Team Info Provides information about a team.

Parameters:

teamId - The id of the team. (optional)

Returns:

ApiResponse<TeamGetInfoResponse>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

teamMembers

public TeamMembersResponse teamMembers(java.lang.String teamId,
                                       java.lang.Integer page,
                                       java.lang.Integer pageSize)
                                throws ApiException

List Team Members Provides a paginated list of members (and their roles) that belong to a given team.

Parameters:

teamId - The id of the team that a member list is being requested from. (required)

page - Which page number of the team member list to return. Defaults to `1`. (optional, default to 1)

pageSize - Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20)

Returns:

TeamMembersResponse

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

teamMembersWithHttpInfo

public ApiResponse<TeamMembersResponse> teamMembersWithHttpInfo(java.lang.String teamId,
                                                                java.lang.Integer page,
                                                                java.lang.Integer pageSize)
                                                         throws ApiException

List Team Members Provides a paginated list of members (and their roles) that belong to a given team.

Parameters:

teamId - The id of the team that a member list is being requested from. (required)

page - Which page number of the team member list to return. Defaults to `1`. (optional, default to 1)

pageSize - Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20)

Returns:

ApiResponse<TeamMembersResponse>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

teamRemoveMember

public TeamGetResponse teamRemoveMember(TeamRemoveMemberRequest teamRemoveMemberRequest)
                                 throws ApiException

Remove User from Team Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed.

Parameters:

teamRemoveMemberRequest - (required)

Returns:

TeamGetResponse

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

teamRemoveMemberWithHttpInfo

public ApiResponse<TeamGetResponse> teamRemoveMemberWithHttpInfo(TeamRemoveMemberRequest teamRemoveMemberRequest)
                                                          throws ApiException

Remove User from Team Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed.

Parameters:

teamRemoveMemberRequest - (required)

Returns:

ApiResponse<TeamGetResponse>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

teamSubTeams

public TeamSubTeamsResponse teamSubTeams(java.lang.String teamId,
                                         java.lang.Integer page,
                                         java.lang.Integer pageSize)
                                  throws ApiException

List Sub Teams Provides a paginated list of sub teams that belong to a given team.

Parameters:

teamId - The id of the parent Team. (required)

page - Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1)

pageSize - Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20)

Returns:

TeamSubTeamsResponse

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

teamSubTeamsWithHttpInfo

public ApiResponse<TeamSubTeamsResponse> teamSubTeamsWithHttpInfo(java.lang.String teamId,
                                                                  java.lang.Integer page,
                                                                  java.lang.Integer pageSize)
                                                           throws ApiException

List Sub Teams Provides a paginated list of sub teams that belong to a given team.

Parameters:

teamId - The id of the parent Team. (required)

page - Which page number of the SubTeam List to return. Defaults to `1`. (optional, default to 1)

pageSize - Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20)

Returns:

ApiResponse<TeamSubTeamsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

teamUpdate

public TeamGetResponse teamUpdate(TeamUpdateRequest teamUpdateRequest)
                           throws ApiException

Update Team Updates the name of your Team.

Parameters:

teamUpdateRequest - (required)

Returns:

TeamGetResponse

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-

teamUpdateWithHttpInfo

public ApiResponse<TeamGetResponse> teamUpdateWithHttpInfo(TeamUpdateRequest teamUpdateRequest)
                                                    throws ApiException

Update Team Updates the name of your Team.

Parameters:

teamUpdateRequest - (required)

Returns:

ApiResponse<TeamGetResponse>

Throws:

ApiException - if fails to make API call

Http Response Details

Status Code	Description	Response Headers
200	successful operation	* X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset -
4XX	failed_operation	-