Interface IUserClient

Namespace

BoldSign.Api

Assembly

BoldSign.Api.dll

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

public interface IUserClient : IApiAccessor

Inherited Members

IApiAccessor.Configuration

IApiAccessor.ExceptionFactory

IApiAccessor.GetBasePath()

Methods

CancelInvitation(string)

Cancel Invitation.

void CancelInvitation(string userId)

Parameters

userId string

userId.

Exceptions

ApiException

Thrown when fails to make API call.

CancelInvitationAsync(string)

Cancel Invitation.

Task CancelInvitationAsync(string userId)

Parameters

userId string

userId.

Returns

Task

CancelInvite.

Exceptions

ApiException

Thrown when fails to make API call.

CancelInvitationAsyncWithHttpInfo(string)

Cancel Invitation.

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

Parameters

userId string

userId.

Returns

Task<ApiResponse<object>>

ApiResponse of Object(CancelInvite).

Exceptions

ApiException

Thrown when fails to make API call.

CancelInvitationWithHttpInfo(string)

Cancel Invitation.

ApiResponse<object> CancelInvitationWithHttpInfo(string userId)

Parameters

userId string

userId.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

CreateUser(List<CreateUserRequest>)

Create the user.

CreateUserResponse CreateUser(List<CreateUserRequest> createUserRequest = null)

Parameters

createUserRequest List<CreateUserRequest>

The create user details.

Returns

CreateUserResponse

CreateUserResponse.

Exceptions

ApiException

Thrown when fails to make API call.

CreateUserAsync(List<CreateUserRequest>)

Create the user.

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

Parameters

createUserRequest List<CreateUserRequest>

The create user details.

Returns

Task<CreateUserResponse>

Task.

Exceptions

ApiException

Thrown when fails to make API call.

CreateUserAsyncWithHttpInfo(List<CreateUserRequest>)

Gets Create the user.

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

Parameters

createUserRequest List<CreateUserRequest>

The create user details.

Returns

Task<ApiResponse<CreateUserResponse>>

ApiResponse of Object(CreateUserResponse).

Exceptions

ApiException

Thrown when fails to make API call.

CreateUserWithHttpInfo(List<CreateUserRequest>)

Gets Create the user.

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

Parameters

createUserRequest List<CreateUserRequest>

The create user details.

Returns

ApiResponse<CreateUserResponse>

ApiResponse of Object(CreateUserResponse).

Exceptions

ApiException

Thrown when fails to make API call.

GetUserDetails(string)

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

UserProperties GetUserDetails(string userId)

Parameters

userId string

The User Id.

Returns

UserProperties

A Task.

GetUserDetailsAsync(string)

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

Task<UserProperties> GetUserDetailsAsync(string userId)

Parameters

userId string

User Id.

Returns

Task<UserProperties>

UserProperties.

Exceptions

ApiException

Thrown when fails to make API call.

GetUserDetailsAsyncWithHttpInfo(string)

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

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

Parameters

userId string

User Id.

Returns

Task<ApiResponse<UserProperties>>

ApiResponse of UserProperties.

Exceptions

ApiException

Thrown when fails to make API call.

GetUserDetailsWithHttpInfo(string)

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

ApiResponse<UserProperties> GetUserDetailsWithHttpInfo(string userId)

Parameters

userId string

The User Id.

Returns

ApiResponse<UserProperties>

A Task.

ListUsers(int, int?, string)

Gets the user list.

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

Parameters

page int

The page number.

pageSize int?

The page size.

search string

The search key.

Returns

UserRecords

A Task.

ListUsersAsync(int, int?, string)

Gets the user list.

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

Parameters

page int

The page number.

pageSize int?

The page size.

search string

The search key.

Returns

Task<UserRecords>

A Task.

ListUsersAsyncWithHttpInfo(int, int?, string)

Gets the user list.

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

Parameters

page int

The page number.

pageSize int?

The page size.

search string

The search key.

Returns

Task<ApiResponse<UserRecords>>

A Task.

ListUsersWithHttpInfo(int, int?, string)

Gets the user list.

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

Parameters

page int

The page number.

pageSize int?

The page size.

search string

The search key.

Returns

ApiResponse<UserRecords>

A Task.

ResendInvitation(string)

Resend Invitation.

void ResendInvitation(string userId)

Parameters

userId string

userId.

Exceptions

ApiException

Thrown when fails to make API call.

ResendInvitationAsync(string)

Resend Invitation.

Task ResendInvitationAsync(string userId)

Parameters

userId string

userId.

Returns

Task

ResendInvite.

Exceptions

ApiException

Thrown when fails to make API call.

ResendInvitationAsyncWithHttpInfo(string)

Resend Invitation.

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

Parameters

userId string

userId.

Returns

Task<ApiResponse<object>>

ApiResponse of Object(ResendInvite).

Exceptions

ApiException

Thrown when fails to make API call.

ResendInvitationWithHttpInfo(string)

Resend Invitation.

ApiResponse<object> ResendInvitationWithHttpInfo(string userId)

Parameters

userId string

userId.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

UpdateUser(UpdateUser)

Updates user role.

void UpdateUser(UpdateUser updateUserQuery)

Parameters

updateUserQuery UpdateUser

update User Query.

Exceptions

ApiException

Thrown when fails to make API call.

UpdateUserAsync(UpdateUser)

Updates user role.

Task UpdateUserAsync(UpdateUser updateUserQuery)

Parameters

updateUserQuery UpdateUser

updateUserQuery.

Returns

Task

UpdateUserRole.

Exceptions

ApiException

Thrown when fails to make API call.

UpdateUserAsyncWithHttpInfo(UpdateUser)

Updates user role.

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

Parameters

updateUserQuery UpdateUser

updateUserQuery.

Returns

Task<ApiResponse<object>>

ApiResponse of Object(UpdateUserRole).

Exceptions

ApiException

Thrown when fails to make API call.

UpdateUserMetaDataAsyncWithHttpInfo(UpdateUserMetaData)

Updates the user's metadata.

Task<ApiResponse<object>> UpdateUserMetaDataAsyncWithHttpInfo(UpdateUserMetaData updateUserMetaData)

Parameters

updateUserMetaData UpdateUserMetaData

The user's metadata request payload.

Returns

Task<ApiResponse<object>>

A Task.

UpdateUserMetaDataWithHttpInfo(UpdateUserMetaData)

Updates the user's metadata.

ApiResponse<object> UpdateUserMetaDataWithHttpInfo(UpdateUserMetaData updateUserMetaData)

Parameters

updateUserMetaData UpdateUserMetaData

The user's metadata request payload.

Returns

ApiResponse<object>

A Task.

UpdateUserWithHttpInfo(UpdateUser)

Updates user role.

ApiResponse<object> UpdateUserWithHttpInfo(UpdateUser updateUserQuery)

Parameters

updateUserQuery UpdateUser

update User Query.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

UpdateUsersMetaData(UpdateUserMetaData)

Updates the user's metadata.

void UpdateUsersMetaData(UpdateUserMetaData updateUserMetaData)

Parameters

updateUserMetaData UpdateUserMetaData

The user's metadata request payload.

UpdateUsersMetaDataAsync(UpdateUserMetaData)

Updates the user's metadata.

Task UpdateUsersMetaDataAsync(UpdateUserMetaData updateUserMetaData)

Parameters

updateUserMetaData UpdateUserMetaData

The user's metadata request payload.

Returns

Task

A Task.