Class TeamClient

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.

Inheritance
System.Object
TeamClient
Implements
Namespace: BoldSign.Api
Assembly: BoldSign.Api.dll
Syntax
public class TeamClient : object, ITeamClient, IApiAccessor

Constructors

| Improve this Doc View Source

TeamClient()

Initializes a new instance of the TeamClient class.

Declaration
public TeamClient()
| Improve this Doc View Source

TeamClient(ApiClient)

Initializes a new instance of the TeamClient class using Configuration object.

Declaration
public TeamClient(ApiClient apiClient)
Parameters
Type Name Description
ApiClient apiClient

An instance of ApiClient.
| Improve this Doc View Source

TeamClient(Configuration)

Initializes a new instance of the TeamClient class using Configuration object.

Declaration
public TeamClient(Configuration configuration = null)
Parameters
Type Name Description
Configuration configuration

An instance of Configuration.
| Improve this Doc View Source

TeamClient(String)

Initializes a new instance of the TeamClient class.

Declaration
public TeamClient(string basePath)
Parameters
Type Name Description
System.String basePath

Gets or set the basePath.

Properties

| Improve this Doc View Source

Configuration

Gets or sets the configuration object.

Declaration
public Configuration Configuration { get; set; }
Property Value
Type Description
Configuration

An instance of the Configuration.
| Improve this Doc View Source

ExceptionFactory

Gets or sets provides a factory method hook for the creation of exceptions.

Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
Type Description
ExceptionFactory

Methods

| Improve this Doc View Source

CreateTeam(CreateTeam)

Creates a new Team.

Declaration
public TeamCreated CreateTeam(CreateTeam createTeam)
Parameters
Type Name Description
CreateTeam createTeam

create team.
Returns
Type Description
TeamCreated

TeamCreated.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call.
| Improve this Doc View Source

CreateTeamAsync(CreateTeam)

Creates a new Team.

Declaration
public async Task<TeamCreated> CreateTeamAsync(CreateTeam createTeam)
Parameters
Type Name Description
CreateTeam createTeam

create team.
Returns
Type Description
Task<TeamCreated>

Task of TeamCreated.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call.
| Improve this Doc View Source

CreateTeamAsyncWithHttpInfo(CreateTeam)

Creates a new Team.

Declaration
public async Task<ApiResponse<TeamCreated>> CreateTeamAsyncWithHttpInfo(CreateTeam createTeam = null)
Parameters
Type Name Description
CreateTeam createTeam

create team.
Returns
Type Description
Task<ApiResponse<TeamCreated>>

Task of ApiResponse (TeamCreated).
Exceptions
Type Condition
ApiException

Thrown when fails to make API call.
| Improve this Doc View Source

CreateTeamWithHttpInfo(CreateTeam)

Creates a new Team.

Declaration
public ApiResponse<TeamCreated> CreateTeamWithHttpInfo(CreateTeam createTeam)
Parameters
Type Name Description
CreateTeam createTeam

create team.
Returns
Type Description
ApiResponse<TeamCreated>

ApiResponse of TeamCreated.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call.
| Improve this Doc View Source

GetBasePath()

Gets the base path of the API client.

Declaration
public string GetBasePath()
Returns
Type Description
System.String

The base path.
| Improve this Doc View Source

GetTeamDetails(String)

Get team Details for the given team Id.

Declaration
public 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
public async Task<TeamDetails> GetTeamDetailsAsync(string teamId)
Parameters
Type Name Description
System.String teamId

team Id.
Returns
Type Description
Task<TeamDetails>

Task of 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
public async Task<ApiResponse<TeamDetails>> GetTeamDetailsAsyncWithHttpInfo(string teamId)
Parameters
Type Name Description
System.String teamId

team Id.
Returns
Type Description
Task<ApiResponse<TeamDetails>>

Task of ApiResponse (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
public 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
public 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

TeamList.
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
public async 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>

Task of 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
public async 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>>

Task of ApiResponse (TeamList).
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
public 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 TeamList.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call.
| Improve this Doc View Source

UpdateTeam(UpdateTeam)

Updates team Name.

Declaration
public 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
public async Task UpdateTeamAsync(UpdateTeam updateTeam)
Parameters
Type Name Description
UpdateTeam updateTeam

update team.
Returns
Type Description
Task

Task of void.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call.
| Improve this Doc View Source

UpdateTeamAsyncWithHttpInfo(UpdateTeam)

Updates team Name.

Declaration
public async Task<ApiResponse<object>> UpdateTeamAsyncWithHttpInfo(UpdateTeam updateTeam)
Parameters
Type Name Description
UpdateTeam updateTeam

update team.
Returns
Type Description
Task<ApiResponse<System.Object>>

Task of ApiResponse.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call.
| Improve this Doc View Source

UpdateTeamWithHttpInfo(UpdateTeam)

Updates team Name.

Declaration
public 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.

Implements