Interface ITeamClient

Namespace

BoldSign.Api

Assembly

BoldSign.Api.dll

Represents a collection of functions to interact with the API endpoints. The functions perform actions such as create a new team, update team name, get team details with its group members, and get list of teams in an organization.

public interface ITeamClient : IApiAccessor

Inherited Members

IApiAccessor.Configuration

IApiAccessor.ExceptionFactory

IApiAccessor.GetBasePath()

Methods

CreateTeam(CreateTeam)

Creates a new Team.

TeamCreated CreateTeam(CreateTeam createTeam)

Parameters

createTeam CreateTeam

create team.

Returns

TeamCreated

CreateTeam.

Exceptions

ApiException

Thrown when fails to make API call.

CreateTeamAsync(CreateTeam)

Creates a new Team.

Task<TeamCreated> CreateTeamAsync(CreateTeam createTeam)

Parameters

createTeam CreateTeam

crate team.

Returns

Task<TeamCreated>

CreateTeam.

Exceptions

ApiException

Thrown when fails to make API call.

CreateTeamAsyncWithHttpInfo(CreateTeam)

Creates a new Team.

Task<ApiResponse<TeamCreated>> CreateTeamAsyncWithHttpInfo(CreateTeam createTeam)

Parameters

createTeam CreateTeam

create team.

Returns

Task<ApiResponse<TeamCreated>>

ApiResponse of CreateTeam.

Exceptions

ApiException

Thrown when fails to make API call.

CreateTeamWithHttpInfo(CreateTeam)

Creates a new Team.

ApiResponse<TeamCreated> CreateTeamWithHttpInfo(CreateTeam createTeam)

Parameters

createTeam CreateTeam

create team.

Returns

ApiResponse<TeamCreated>

ApiResponse of CreateTeam.

Exceptions

ApiException

Thrown when fails to make API call.

GetTeamDetails(string)

Get team Details for the given team Id.

TeamDetails GetTeamDetails(string teamId)

Parameters

teamId string

team Id.

Returns

TeamDetails

TeamDetails.

Exceptions

ApiException

Thrown when fails to make API call.

GetTeamDetailsAsync(string)

Get team Details for the given team Id.

Task<TeamDetails> GetTeamDetailsAsync(string teamId)

Parameters

teamId string

team Id.

Returns

Task<TeamDetails>

TeamDetails.

Exceptions

ApiException

Thrown when fails to make API call.

GetTeamDetailsAsyncWithHttpInfo(string)

Get team Details for the given team Id.

Task<ApiResponse<TeamDetails>> GetTeamDetailsAsyncWithHttpInfo(string teamId)

Parameters

teamId string

Team Id.

Returns

Task<ApiResponse<TeamDetails>>

ApiResponse of TeamDetails.

Exceptions

ApiException

Thrown when fails to make API call.

GetTeamDetailsWithHttpInfo(string)

Get team Details for the given team Id.

ApiResponse<TeamDetails> GetTeamDetailsWithHttpInfo(string teamId)

Parameters

teamId string

Team Id.

Returns

ApiResponse<TeamDetails>

ApiResponse of TeamDetails.

Exceptions

ApiException

Thrown when fails to make API call.

ListTeam(int, int?, string)

Get team list.

TeamList ListTeam(int page, int? pageSize = null, string searchKey = null)

Parameters

page int

Page.

pageSize int?

page Size (optional, default to 10).

searchKey string

searchKey (optional).

Returns

TeamList

TeamDetails.

Exceptions

ApiException

Thrown when fails to make API call.

ListTeamAsync(int, int?, string)

Get team List.

Task<TeamList> ListTeamAsync(int page, int? pageSize = null, string searchKey = null)

Parameters

page int

page.

pageSize int?

page Size (optional, default to 10).

searchKey string

searchKey (optional).

Returns

Task<TeamList>

TeamList.

Exceptions

ApiException

Thrown when fails to make API call.

ListTeamAsyncWithHttpInfo(int, int?, string)

Get team List.

Task<ApiResponse<TeamList>> ListTeamAsyncWithHttpInfo(int page, int? pageSize = null, string searchKey = null)

Parameters

page int

page.

pageSize int?

page Size (optional, default to 10).

searchKey string

searchKey (optional).

Returns

Task<ApiResponse<TeamList>>

ApiResponse of TeamListResponse.

Exceptions

ApiException

Thrown when fails to make API call.

ListTeamWithHttpInfo(int, int?, string)

Get team List.

ApiResponse<TeamList> ListTeamWithHttpInfo(int page, int? pageSize = null, string searchKey = null)

Parameters

page int

page.

pageSize int?

page Size (optional, default to 10).

searchKey string

searchKey (optional).

Returns

ApiResponse<TeamList>

ApiResponse of TeamListResponse.

Exceptions

ApiException

Thrown when fails to make API call.

UpdateTeam(UpdateTeam)

Updates team Name.

void UpdateTeam(UpdateTeam updateTeam)

Parameters

updateTeam UpdateTeam

update team.

Exceptions

ApiException

Thrown when fails to make API call.

UpdateTeamAsync(UpdateTeam)

Updates team Name.

Task UpdateTeamAsync(UpdateTeam updateTeam)

Parameters

updateTeam UpdateTeam

update team.

Returns

Task

UpdateTeamName.

Exceptions

ApiException

Thrown when fails to make API call.

UpdateTeamAsyncWithHttpInfo(UpdateTeam)

Updates team Name.

Task<ApiResponse<object>> UpdateTeamAsyncWithHttpInfo(UpdateTeam updateTeam)

Parameters

updateTeam UpdateTeam

update team.

Returns

Task<ApiResponse<object>>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

UpdateTeamWithHttpInfo(UpdateTeam)

Updates team Name.

ApiResponse<object> UpdateTeamWithHttpInfo(UpdateTeam updateTeam)

Parameters

updateTeam UpdateTeam

update team.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.