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
Namespace: BoldSign.Api
Assembly: BoldSign.Api.dll
Syntax
public interface IUserClient : IApiAccessor
Methods
| Improve this Doc View SourceCancelInvitation(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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |