Class UserClient

Namespace

BoldSign.Api

Assembly

BoldSign.Api.dll

Represents a function to interact with the API endpoints. The function perform action such as getting the Api credit details and so on.

public class UserClient : IUserClient, IApiAccessor

Inheritance

object

UserClient

Implements

IUserClient

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

UserClient()

Initializes a new instance of the UserClient class.

public UserClient()

UserClient(ApiClient)

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

public UserClient(ApiClient apiClient)

Parameters

apiClient ApiClient

An instance of ApiClient.

UserClient(Configuration)

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

public UserClient(Configuration configuration = null)

Parameters

configuration Configuration

An instance of Configuration.

UserClient(string)

Initializes a new instance of the UserClient class.

public UserClient(string basePath)

Parameters

basePath string

A 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

CancelInvitation(string)

Cancel Invitation.

public void CancelInvitation(string userId)

Parameters

userId string

userId.

Exceptions

ApiException

Thrown when fails to make API call.

CancelInvitationAsync(string)

Cancel Invitation.

public Task CancelInvitationAsync(string userId)

Parameters

userId string

userId.

Returns

Task

CancelInvite.

Exceptions

ApiException

Thrown when fails to make API call.

CancelInvitationAsyncWithHttpInfo(string)

Cancel Invitation.

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

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

Invite the user.

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

Invite the user.

public 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 invite the user.

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

Parameters

createUserRequest List<CreateUserRequest>

The create user details.

Returns

Task<ApiResponse<CreateUserResponse>>

Task of ApiResponse.

Exceptions

ApiException

Thrown when fails to make API call.

CreateUserWithHttpInfo(List<CreateUserRequest>)

Gets invite the user.

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

GetBasePath()

Gets the base path of the API client.

public string GetBasePath()

Returns

string

The base path.

GetUserDetails(string)

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

public UserProperties GetUserDetails(string userId)

Parameters

userId string

User Id.

Returns

UserProperties

UserDetails.

Exceptions

ApiException

Thrown when fails to make API call.

GetUserDetailsAsync(string)

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

public Task<UserProperties> GetUserDetailsAsync(string userId)

Parameters

userId string

User Id.

Returns

Task<UserProperties>

Task of UserProperties.

Exceptions

ApiException

Thrown when fails to make API call.

GetUserDetailsAsyncWithHttpInfo(string)

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

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

Parameters

userId string

User Id.

Returns

Task<ApiResponse<UserProperties>>

ApiResponse of UserDetails.

Exceptions

ApiException

Thrown when fails to make API call.

GetUserDetailsWithHttpInfo(string)

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

public ApiResponse<UserProperties> GetUserDetailsWithHttpInfo(string userId)

Parameters

userId string

User Id.

Returns

ApiResponse<UserProperties>

ApiResponse of UserDetails.

Exceptions

ApiException

Thrown when fails to make API call.

IsValidEmail(string)

Validate Email.

public static bool IsValidEmail(string email)

Parameters

email string

Email Id.

Returns

bool

True if the email is valid.

ListUsers(int, int?, string)

Gets the user list.

public UserRecords ListUsers(int page, int? pageSize, 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.

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

Task of UserRecords.

ListUsersAsyncWithHttpInfo(int, int?, string)

Gets the user list.

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

Task of ApiResponse (UserRecords).

ListUsersWithHttpInfo(int, int?, string)

Gets the user list.

public ApiResponse<UserRecords> ListUsersWithHttpInfo(int page, int? pageSize, 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.

public void ResendInvitation(string userId)

Parameters

userId string

userId.

Exceptions

ApiException

Thrown when fails to make API call.

ResendInvitationAsync(string)

Resend Invitation.

public Task ResendInvitationAsync(string userId)

Parameters

userId string

userId.

Returns

Task

ResendInvite.

Exceptions

ApiException

Thrown when fails to make API call.

ResendInvitationAsyncWithHttpInfo(string)

Resend Invitation.

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

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

public void UpdateUser(UpdateUser updateUserQuery)

Parameters

updateUserQuery UpdateUser

update User Query.

Exceptions

ApiException

Thrown when fails to make API call.

UpdateUserAsync(UpdateUser)

Updates user role.

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

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

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

public ApiResponse<object> UpdateUserMetaDataWithHttpInfo(UpdateUserMetaData updateUserMetaData)

Parameters

updateUserMetaData UpdateUserMetaData

The user's metadata request payload.

Returns

ApiResponse<object>

A Task.

UpdateUserWithHttpInfo(UpdateUser)

Updates user role.

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

public void UpdateUsersMetaData(UpdateUserMetaData updateUserMetaData)

Parameters

updateUserMetaData UpdateUserMetaData

The users metaData.

UpdateUsersMetaDataAsync(UpdateUserMetaData)

Updates the user's metadata.

public Task UpdateUsersMetaDataAsync(UpdateUserMetaData updateUserMetaData)

Parameters

updateUserMetaData UpdateUserMetaData

The users metaData.

Returns

Task

Task of update metaData.