Interface ITeamClient

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.

Inherited Members

IApiAccessor.Configuration

IApiAccessor.ExceptionFactory

IApiAccessor.GetBasePath()

Namespace: BoldSign.Api

Assembly: BoldSign.Api.dll

Syntax

public interface ITeamClient : IApiAccessor

Methods

| Improve this Doc View Source

CreateTeam(CreateTeam)

Creates a new Team.

Declaration

TeamCreated CreateTeam(CreateTeam createTeam)

Parameters

Type	Name	Description
CreateTeam	createTeam	create team.

Returns

Type	Description
TeamCreated	CreateTeam.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

CreateTeamAsync(CreateTeam)

Creates a new Team.

Declaration

Task<TeamCreated> CreateTeamAsync(CreateTeam createTeam)

Parameters

Type	Name	Description
CreateTeam	createTeam	crate team.

Returns

Type	Description
Task<TeamCreated>	CreateTeam.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

CreateTeamAsyncWithHttpInfo(CreateTeam)

Creates a new Team.

Declaration

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

Parameters

Type	Name	Description
CreateTeam	createTeam	create team.

Returns

Type	Description
Task<ApiResponse<TeamCreated>>	ApiResponse of CreateTeam.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

CreateTeamWithHttpInfo(CreateTeam)

Creates a new Team.

Declaration

ApiResponse<TeamCreated> CreateTeamWithHttpInfo(CreateTeam createTeam)

Parameters

Type	Name	Description
CreateTeam	createTeam	create team.

Returns

Type	Description
ApiResponse<TeamCreated>	ApiResponse of CreateTeam.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

GetTeamDetails(String)

Get team Details for the given team Id.

Declaration

TeamDetails GetTeamDetails(string teamId)

Parameters

Type	Name	Description
System.String	teamId	team Id.

Returns

Type	Description
TeamDetails	TeamDetails.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

GetTeamDetailsAsync(String)

Get team Details for the given team Id.

Declaration

Task<TeamDetails> GetTeamDetailsAsync(string teamId)

Parameters

Type	Name	Description
System.String	teamId	team Id.

Returns

Type	Description
Task<TeamDetails>	TeamDetails.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

GetTeamDetailsAsyncWithHttpInfo(String)

Get team Details for the given team Id.

Declaration

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

Parameters

Type	Name	Description
System.String	teamId	Team Id.

Returns

Type	Description
Task<ApiResponse<TeamDetails>>	ApiResponse of TeamDetails.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

GetTeamDetailsWithHttpInfo(String)

Get team Details for the given team Id.

Declaration

ApiResponse<TeamDetails> GetTeamDetailsWithHttpInfo(string teamId)

Parameters

Type	Name	Description
System.String	teamId	Team Id.

Returns

Type	Description
ApiResponse<TeamDetails>	ApiResponse of TeamDetails.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

ListTeam(Int32, Nullable<Int32>, String)

Get team list.

Declaration

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

Parameters

Type	Name	Description
System.Int32	page	Page.
System.Nullable<System.Int32>	pageSize	page Size (optional, default to 10).
System.String	searchKey	searchKey (optional).

Returns

Type	Description
TeamList	TeamDetails.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

ListTeamAsync(Int32, Nullable<Int32>, String)

Get team List.

Declaration

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

Parameters

Type	Name	Description
System.Int32	page	page.
System.Nullable<System.Int32>	pageSize	page Size (optional, default to 10).
System.String	searchKey	searchKey (optional).

Returns

Type	Description
Task<TeamList>	TeamList.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

ListTeamAsyncWithHttpInfo(Int32, Nullable<Int32>, String)

Get team List.

Declaration

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

Parameters

Type	Name	Description
System.Int32	page	page.
System.Nullable<System.Int32>	pageSize	page Size (optional, default to 10).
System.String	searchKey	searchKey (optional).

Returns

Type	Description
Task<ApiResponse<TeamList>>	ApiResponse of TeamListResponse.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

ListTeamWithHttpInfo(Int32, Nullable<Int32>, String)

Get team List.

Declaration

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

Parameters

Type	Name	Description
System.Int32	page	page.
System.Nullable<System.Int32>	pageSize	page Size (optional, default to 10).
System.String	searchKey	searchKey (optional).

Returns

Type	Description
ApiResponse<TeamList>	ApiResponse of TeamListResponse.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

UpdateTeam(UpdateTeam)

Updates team Name.

Declaration

void UpdateTeam(UpdateTeam updateTeam)

Parameters

Type	Name	Description
UpdateTeam	updateTeam	update team.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

UpdateTeamAsync(UpdateTeam)

Updates team Name.

Declaration

Task UpdateTeamAsync(UpdateTeam updateTeam)

Parameters

Type	Name	Description
UpdateTeam	updateTeam	update team.

Returns

Type	Description
Task	UpdateTeamName.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

UpdateTeamAsyncWithHttpInfo(UpdateTeam)

Updates team Name.

Declaration

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

Parameters

Type	Name	Description
UpdateTeam	updateTeam	update team.

Returns

Type	Description
Task<ApiResponse<System.Object>>	ApiResponse of Object(void).

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

UpdateTeamWithHttpInfo(UpdateTeam)

Updates team Name.

Declaration

ApiResponse<object> UpdateTeamWithHttpInfo(UpdateTeam updateTeam)

Parameters

Type	Name	Description
UpdateTeam	updateTeam	update team.

Returns

Type	Description
ApiResponse<System.Object>	ApiResponse of Object(void).

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.