Interface IUserClient

Represents a function to interact with the API endpoints. The function perform action such as invite the user and so on.

Inherited Members

IApiAccessor.Configuration

IApiAccessor.ExceptionFactory

IApiAccessor.GetBasePath()

Namespace: BoldSign.Api

Assembly: BoldSign.Api.dll

Syntax

public interface IUserClient : IApiAccessor

Methods

| Improve this Doc View Source

CancelInvitation(String)

Cancel Invitation.

Declaration

void CancelInvitation(string userId)

Parameters

Type	Name	Description
System.String	userId	userId.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

CancelInvitationAsync(String)

Cancel Invitation.

Declaration

Task CancelInvitationAsync(string userId)

Parameters

Type	Name	Description
System.String	userId	userId.

Returns

Type	Description
Task	CancelInvite.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

CancelInvitationAsyncWithHttpInfo(String)

Cancel Invitation.

Declaration

Task<ApiResponse<object>> CancelInvitationAsyncWithHttpInfo(string userId)

Parameters

Type	Name	Description
System.String	userId	userId.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

CancelInvitationWithHttpInfo(String)

Cancel Invitation.

Declaration

ApiResponse<object> CancelInvitationWithHttpInfo(string userId)

Parameters

Type	Name	Description
System.String	userId	userId.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

CreateUser(List<CreateUserRequest>)

Create the user.

Declaration

CreateUserResponse CreateUser(List<CreateUserRequest> createUserRequest = null)

Parameters

Type	Name	Description
List<CreateUserRequest>	createUserRequest	The create user details.

Returns

Type	Description
CreateUserResponse	CreateUserResponse.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

CreateUserAsync(List<CreateUserRequest>)

Create the user.

Declaration

Task<CreateUserResponse> CreateUserAsync(List<CreateUserRequest> createUserRequest = null)

Parameters

Type	Name	Description
List<CreateUserRequest>	createUserRequest	The create user details.

Returns

Type	Description
Task<CreateUserResponse>	Task.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

CreateUserAsyncWithHttpInfo(List<CreateUserRequest>)

Gets Create the user.

Declaration

Task<ApiResponse<CreateUserResponse>> CreateUserAsyncWithHttpInfo(List<CreateUserRequest> createUserRequest = null)

Parameters

Type	Name	Description
List<CreateUserRequest>	createUserRequest	The create user details.

Returns

Type	Description
Task<ApiResponse<CreateUserResponse>>	ApiResponse of Object(CreateUserResponse).

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

CreateUserWithHttpInfo(List<CreateUserRequest>)

Gets Create the user.

Declaration

ApiResponse<CreateUserResponse> CreateUserWithHttpInfo(List<CreateUserRequest> createUserRequest = null)

Parameters

Type	Name	Description
List<CreateUserRequest>	createUserRequest	The create user details.

Returns

Type	Description
ApiResponse<CreateUserResponse>	ApiResponse of Object(CreateUserResponse).

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

GetUserDetails(String)

Get summary of the user details for the given user ID.

Declaration

UserProperties GetUserDetails(string userId)

Parameters

Type	Name	Description
System.String	userId	The User Id.

Returns

Type	Description
UserProperties	A Task.

| Improve this Doc View Source

GetUserDetailsAsync(String)

Get summary of the user details for the given user ID.

Declaration

Task<UserProperties> GetUserDetailsAsync(string userId)

Parameters

Type	Name	Description
System.String	userId	User Id.

Returns

Type	Description
Task<UserProperties>	UserProperties.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

GetUserDetailsAsyncWithHttpInfo(String)

Get summary of the user details for the given user ID.

Declaration

Task<ApiResponse<UserProperties>> GetUserDetailsAsyncWithHttpInfo(string userId)

Parameters

Type	Name	Description
System.String	userId	User Id.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

GetUserDetailsWithHttpInfo(String)

Get summary of the user details for the given user ID.

Declaration

ApiResponse<UserProperties> GetUserDetailsWithHttpInfo(string userId)

Parameters

Type	Name	Description
System.String	userId	The User Id.

Returns

Type	Description
ApiResponse<UserProperties>	A Task.

| Improve this Doc View Source

ListUsers(Int32, Nullable<Int32>, String)

Gets the user list.

Declaration

UserRecords ListUsers(int page, int? pageSize = null, string search = null)

Parameters

Type	Name	Description
System.Int32	page	The page number.
System.Nullable<System.Int32>	pageSize	The page size.
System.String	search	The search key.

Returns

Type	Description
UserRecords	A Task.

| Improve this Doc View Source

ListUsersAsync(Int32, Nullable<Int32>, String)

Gets the user list.

Declaration

Task<UserRecords> ListUsersAsync(int page, int? pageSize = null, string search = null)

Parameters

Type	Name	Description
System.Int32	page	The page number.
System.Nullable<System.Int32>	pageSize	The page size.
System.String	search	The search key.

Returns

Type	Description
Task<UserRecords>	A Task.

| Improve this Doc View Source

ListUsersAsyncWithHttpInfo(Int32, Nullable<Int32>, String)

Gets the user list.

Declaration

Task<ApiResponse<UserRecords>> ListUsersAsyncWithHttpInfo(int page, int? pageSize = null, string search = null)

Parameters

Type	Name	Description
System.Int32	page	The page number.
System.Nullable<System.Int32>	pageSize	The page size.
System.String	search	The search key.

Returns

Type	Description
Task<ApiResponse<UserRecords>>	A Task.

| Improve this Doc View Source

ListUsersWithHttpInfo(Int32, Nullable<Int32>, String)

Gets the user list.

Declaration

ApiResponse<UserRecords> ListUsersWithHttpInfo(int page, int? pageSize = null, string search = null)

Parameters

Type	Name	Description
System.Int32	page	The page number.
System.Nullable<System.Int32>	pageSize	The page size.
System.String	search	The search key.

Returns

Type	Description
ApiResponse<UserRecords>	A Task.

| Improve this Doc View Source

ResendInvitation(String)

Resend Invitation.

Declaration

void ResendInvitation(string userId)

Parameters

Type	Name	Description
System.String	userId	userId.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

ResendInvitationAsync(String)

Resend Invitation.

Declaration

Task ResendInvitationAsync(string userId)

Parameters

Type	Name	Description
System.String	userId	userId.

Returns

Type	Description
Task	ResendInvite.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

ResendInvitationAsyncWithHttpInfo(String)

Resend Invitation.

Declaration

Task<ApiResponse<object>> ResendInvitationAsyncWithHttpInfo(string userId)

Parameters

Type	Name	Description
System.String	userId	userId.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

ResendInvitationWithHttpInfo(String)

Resend Invitation.

Declaration

ApiResponse<object> ResendInvitationWithHttpInfo(string userId)

Parameters

Type	Name	Description
System.String	userId	userId.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

UpdateUser(UpdateUser)

Updates user role.

Declaration

void UpdateUser(UpdateUser updateUserQuery)

Parameters

Type	Name	Description
UpdateUser	updateUserQuery	update User Query.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

UpdateUserAsync(UpdateUser)

Updates user role.

Declaration

Task UpdateUserAsync(UpdateUser updateUserQuery)

Parameters

Type	Name	Description
UpdateUser	updateUserQuery	updateUserQuery.

Returns

Type	Description
Task	UpdateUserRole.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

UpdateUserAsyncWithHttpInfo(UpdateUser)

Updates user role.

Declaration

Task<ApiResponse<object>> UpdateUserAsyncWithHttpInfo(UpdateUser updateUserQuery)

Parameters

Type	Name	Description
UpdateUser	updateUserQuery	updateUserQuery.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

UpdateUserWithHttpInfo(UpdateUser)

Updates user role.

Declaration

ApiResponse<object> UpdateUserWithHttpInfo(UpdateUser updateUserQuery)

Parameters

Type	Name	Description
UpdateUser	updateUserQuery	update User Query.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.