Class TeamClient

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 class TeamClient : ITeamClient, IApiAccessor

Inheritance

object

TeamClient

Implements

ITeamClient

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TeamClient()

Initializes a new instance of the TeamClient class.

public TeamClient()

TeamClient(ApiClient)

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

public TeamClient(ApiClient apiClient)

Parameters

apiClient ApiClient

An instance of ApiClient.

TeamClient(Configuration)

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

public TeamClient(Configuration configuration = null)

Parameters

configuration Configuration

An instance of Configuration.

TeamClient(string)

Initializes a new instance of the TeamClient class.

public TeamClient(string basePath)

Parameters

basePath string

Gets or set the basePath.

Properties

Configuration

Gets or sets the configuration object.

public Configuration Configuration { get; set; }

Property Value

Configuration

An instance of the Configuration.

ExceptionFactory

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

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

ExceptionFactory

Methods

CreateTeam(CreateTeam)

Creates a new Team.

public TeamCreated CreateTeam(CreateTeam createTeam)

Parameters

createTeam CreateTeam

create team.

Returns

TeamCreated

TeamCreated.

Exceptions

ApiException

Thrown when fails to make API call.

CreateTeamAsync(CreateTeam)

Creates a new Team.

public Task<TeamCreated> CreateTeamAsync(CreateTeam createTeam)

Parameters

createTeam CreateTeam

create team.

Returns

Task<TeamCreated>

Task of TeamCreated.

Exceptions

ApiException

Thrown when fails to make API call.

CreateTeamAsyncWithHttpInfo(CreateTeam)

Creates a new Team.

public Task<ApiResponse<TeamCreated>> CreateTeamAsyncWithHttpInfo(CreateTeam createTeam = null)

Parameters

createTeam CreateTeam

create team.

Returns

Task<ApiResponse<TeamCreated>>

Task of ApiResponse (TeamCreated).

Exceptions

ApiException

Thrown when fails to make API call.

CreateTeamWithHttpInfo(CreateTeam)

Creates a new Team.

public ApiResponse<TeamCreated> CreateTeamWithHttpInfo(CreateTeam createTeam)

Parameters

createTeam CreateTeam

create team.

Returns

ApiResponse<TeamCreated>

ApiResponse of TeamCreated.

Exceptions

ApiException

Thrown when fails to make API call.

GetBasePath()

Gets the base path of the API client.

public string GetBasePath()

Returns

string

The base path.

GetTeamDetails(string)

Get team Details for the given team Id.

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

public Task<TeamDetails> GetTeamDetailsAsync(string teamId)

Parameters

teamId string

team Id.

Returns

Task<TeamDetails>

Task of TeamDetails.

Exceptions

ApiException

Thrown when fails to make API call.

GetTeamDetailsAsyncWithHttpInfo(string)

Get team Details for the given team Id.

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

Parameters

teamId string

team Id.

Returns

Task<ApiResponse<TeamDetails>>

Task of ApiResponse (TeamDetails).

Exceptions

ApiException

Thrown when fails to make API call.

GetTeamDetailsWithHttpInfo(string)

Get team Details for the given team Id.

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

public 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

TeamList.

Exceptions

ApiException

Thrown when fails to make API call.

ListTeamAsync(int, int?, string)

Get team List.

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

Task of TeamList.

Exceptions

ApiException

Thrown when fails to make API call.

ListTeamAsyncWithHttpInfo(int, int?, string)

Get team List.

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

Task of ApiResponse (TeamList).

Exceptions

ApiException

Thrown when fails to make API call.

ListTeamWithHttpInfo(int, int?, string)

Get team List.

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

Exceptions

ApiException

Thrown when fails to make API call.

UpdateTeam(UpdateTeam)

Updates team Name.

public void UpdateTeam(UpdateTeam updateTeam)

Parameters

updateTeam UpdateTeam

update team.

Exceptions

ApiException

Thrown when fails to make API call.

UpdateTeamAsync(UpdateTeam)

Updates team Name.

public Task UpdateTeamAsync(UpdateTeam updateTeam)

Parameters

updateTeam UpdateTeam

update team.

Returns

Task

Task of void.

Exceptions

ApiException

Thrown when fails to make API call.

UpdateTeamAsyncWithHttpInfo(UpdateTeam)

Updates team Name.

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

Parameters

updateTeam UpdateTeam

update team.

Returns

Task<ApiResponse<object>>

Task of ApiResponse.

Exceptions

ApiException

Thrown when fails to make API call.

UpdateTeamWithHttpInfo(UpdateTeam)

Updates team Name.

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