DocuSign.Rooms by DocuSign

<PackageReference Include="DocuSign.Rooms" Version="1.2.0-rc" />

 UsersApi

public class UsersApi : IUsersApi, IApiAccessor
Represents a collection of functions to interact with the API endpoints
public class GetUsersOptions

Gets a paged-list of users. Retrieves a paged-list of Company Users in the User's company using the given filter and sort parameters.

public ApiClient ApiClient { get; set; }

Gets or sets the ApiClient object

public ExceptionFactory ExceptionFactory { get; set; }

Provides a factory method hook for the creation of exceptions.

public UsersApi(ApiClient aplClient)

Initializes a new instance of the UsersApi class using AplClient object

public void AddUserToOffice(string accountId, int? userId, DesignatedOffice body = null)

Adds the user to the designated office. Adds the user to the designated office.

public Task AddUserToOfficeAsync(string accountId, int? userId, DesignatedOffice body = null)

Adds the user to the designated office. Adds the user to the designated office.

public Task<ApiResponse<object>> AddUserToOfficeAsyncWithHttpInfo(string accountId, int? userId, DesignatedOffice body = null)

Adds the user to the designated office. Adds the user to the designated office.

public ApiResponse<object> AddUserToOfficeWithHttpInfo(string accountId, int? userId, DesignatedOffice body = null)

Adds the user to the designated office. Adds the user to the designated office.

public void AddUserToRegion(string accountId, int? userId, DesignatedRegion body = null)

Adds the user to the designated region. Adds the user to the designated region.

public Task AddUserToRegionAsync(string accountId, int? userId, DesignatedRegion body = null)

Adds the user to the designated region. Adds the user to the designated region.

public Task<ApiResponse<object>> AddUserToRegionAsyncWithHttpInfo(string accountId, int? userId, DesignatedRegion body = null)

Adds the user to the designated region. Adds the user to the designated region.

public ApiResponse<object> AddUserToRegionWithHttpInfo(string accountId, int? userId, DesignatedRegion body = null)

Adds the user to the designated region. Adds the user to the designated region.

public string GetBasePath()

Gets the base path of the API client.

public User GetUser(string accountId, int? userId)

Retrieves user information for the user having the given UserId. Retrieves user information for the user having the given UserId.

public Task<User> GetUserAsync(string accountId, int? userId)

Retrieves user information for the user having the given UserId. Retrieves user information for the user having the given UserId.

public Task<ApiResponse<User>> GetUserAsyncWithHttpInfo(string accountId, int? userId)

Retrieves user information for the user having the given UserId. Retrieves user information for the user having the given UserId.

public UserSummaryList GetUsers(string accountId, GetUsersOptions options = null)

Gets a paged-list of users. Retrieves a paged-list of Company Users in the User's company using the given filter and sort parameters.

public Task<UserSummaryList> GetUsersAsync(string accountId, GetUsersOptions options = null)

Gets a paged-list of users. Retrieves a paged-list of Company Users in the User's company using the given filter and sort parameters.

public Task<ApiResponse<UserSummaryList>> GetUsersAsyncWithHttpInfo(string accountId, GetUsersOptions options = null)

Gets a paged-list of users. Retrieves a paged-list of Company Users in the User's company using the given filter and sort parameters.

public ApiResponse<UserSummaryList> GetUsersWithHttpInfo(string accountId, GetUsersOptions options = null)

Gets a paged-list of users. Retrieves a paged-list of Company Users in the User's company using the given filter and sort parameters.

public ApiResponse<User> GetUserWithHttpInfo(string accountId, int? userId)

Retrieves user information for the user having the given UserId. Retrieves user information for the user having the given UserId.

public User InviteClassicAdmin(string accountId, ClassicAdminToInvite body = null)

CLASSIC COMPANY ONLY. Send an invitation to join the company as an admin. Invites a new user to join a company account on Rooms Version 5 as an Admin.

public Task<User> InviteClassicAdminAsync(string accountId, ClassicAdminToInvite body = null)

CLASSIC COMPANY ONLY. Send an invitation to join the company as an admin. Invites a new user to join a company account on Rooms Version 5 as an Admin.

CLASSIC COMPANY ONLY. Send an invitation to join the company as an admin. Invites a new user to join a company account on Rooms Version 5 as an Admin.

CLASSIC COMPANY ONLY. Send an invitation to join the company as an admin. Invites a new user to join a company account on Rooms Version 5 as an Admin.

public User InviteClassicAgent(string accountId, ClassicAgentToInvite body = null)

CLASSIC COMPANY ONLY. Send an invitation to join the company as an agent. Invites a new user to join a company account on Rooms Version 5 as an Agent.

public Task<User> InviteClassicAgentAsync(string accountId, ClassicAgentToInvite body = null)

CLASSIC COMPANY ONLY. Send an invitation to join the company as an agent. Invites a new user to join a company account on Rooms Version 5 as an Agent.

CLASSIC COMPANY ONLY. Send an invitation to join the company as an agent. Invites a new user to join a company account on Rooms Version 5 as an Agent.

CLASSIC COMPANY ONLY. Send an invitation to join the company as an agent. Invites a new user to join a company account on Rooms Version 5 as an Agent.

public User InviteClassicManager(string accountId, ClassicManagerToInvite body = null)

CLASSIC COMPANY ONLY. Send an invitation to join the company as a manager. Invites a new user to join a company account on Rooms Version 5 as a Manager.

public Task<User> InviteClassicManagerAsync(string accountId, ClassicManagerToInvite body = null)

CLASSIC COMPANY ONLY. Send an invitation to join the company as a manager. Invites a new user to join a company account on Rooms Version 5 as a Manager.

CLASSIC COMPANY ONLY. Send an invitation to join the company as a manager. Invites a new user to join a company account on Rooms Version 5 as a Manager.

CLASSIC COMPANY ONLY. Send an invitation to join the company as a manager. Invites a new user to join a company account on Rooms Version 5 as a Manager.

public User InviteUser(string accountId, UserToInvite body = null)

NON-CLASSIC COMPANY ONLY. Send an invitation to the user or non-user having the given email. Invites a new user to join a company account on Rooms Version 6.

public Task<User> InviteUserAsync(string accountId, UserToInvite body = null)

NON-CLASSIC COMPANY ONLY. Send an invitation to the user or non-user having the given email. Invites a new user to join a company account on Rooms Version 6.

public Task<ApiResponse<User>> InviteUserAsyncWithHttpInfo(string accountId, UserToInvite body = null)

NON-CLASSIC COMPANY ONLY. Send an invitation to the user or non-user having the given email. Invites a new user to join a company account on Rooms Version 6.

public ApiResponse<User> InviteUserWithHttpInfo(string accountId, UserToInvite body = null)

NON-CLASSIC COMPANY ONLY. Send an invitation to the user or non-user having the given email. Invites a new user to join a company account on Rooms Version 6.

public void LockUser(string accountId, int? userId, LockedOutDetails body = null)

Locks the account of the user. Locks the account of the user.

public Task LockUserAsync(string accountId, int? userId, LockedOutDetails body = null)

Locks the account of the user. Locks the account of the user.

public Task<ApiResponse<object>> LockUserAsyncWithHttpInfo(string accountId, int? userId, LockedOutDetails body = null)

Locks the account of the user. Locks the account of the user.

public ApiResponse<object> LockUserWithHttpInfo(string accountId, int? userId, LockedOutDetails body = null)

Locks the account of the user. Locks the account of the user.

public void ReinviteUser(string accountId, int? userId)

Reinvites the pending user with the given userId. Reinvites an unactivated user to join a company account. You can use this method with either Rooms Version 5 or Rooms Version 6.

public Task ReinviteUserAsync(string accountId, int? userId)

Reinvites the pending user with the given userId. Reinvites an unactivated user to join a company account. You can use this method with either Rooms Version 5 or Rooms Version 6.

public Task<ApiResponse<object>> ReinviteUserAsyncWithHttpInfo(string accountId, int? userId)

Reinvites the pending user with the given userId. Reinvites an unactivated user to join a company account. You can use this method with either Rooms Version 5 or Rooms Version 6.

public ApiResponse<object> ReinviteUserWithHttpInfo(string accountId, int? userId)

Reinvites the pending user with the given userId. Reinvites an unactivated user to join a company account. You can use this method with either Rooms Version 5 or Rooms Version 6.

public void RemoveUser(string accountId, int? userId)

Removes a user from the company. Removes the user. Will fail if the user owns any Rooms. The rooms will need to be transferred to other agents before removing.

public Task RemoveUserAsync(string accountId, int? userId)

Removes a user from the company. Removes the user. Will fail if the user owns any Rooms. The rooms will need to be transferred to other agents before removing.

public Task<ApiResponse<object>> RemoveUserAsyncWithHttpInfo(string accountId, int? userId)

Removes a user from the company. Removes the user. Will fail if the user owns any Rooms. The rooms will need to be transferred to other agents before removing.

public void RemoveUserFromOffice(string accountId, int? userId, DesignatedOffice body = null)

Removes the user from the designated office. Removes the user from the designated office.

public Task RemoveUserFromOfficeAsync(string accountId, int? userId, DesignatedOffice body = null)

Removes the user from the designated office. Removes the user from the designated office.

public Task<ApiResponse<object>> RemoveUserFromOfficeAsyncWithHttpInfo(string accountId, int? userId, DesignatedOffice body = null)

Removes the user from the designated office. Removes the user from the designated office.

public ApiResponse<object> RemoveUserFromOfficeWithHttpInfo(string accountId, int? userId, DesignatedOffice body = null)

Removes the user from the designated office. Removes the user from the designated office.

public void RemoveUserFromRegion(string accountId, int? userId, DesignatedRegion body = null)

Removes the user from the designated region. Removes the user from the designated region.

public Task RemoveUserFromRegionAsync(string accountId, int? userId, DesignatedRegion body = null)

Removes the user from the designated region. Removes the user from the designated region.

public Task<ApiResponse<object>> RemoveUserFromRegionAsyncWithHttpInfo(string accountId, int? userId, DesignatedRegion body = null)

Removes the user from the designated region. Removes the user from the designated region.

public ApiResponse<object> RemoveUserFromRegionWithHttpInfo(string accountId, int? userId, DesignatedRegion body = null)

Removes the user from the designated region. Removes the user from the designated region.

public ApiResponse<object> RemoveUserWithHttpInfo(string accountId, int? userId)

Removes a user from the company. Removes the user. Will fail if the user owns any Rooms. The rooms will need to be transferred to other agents before removing.

public void UnlockUser(string accountId, int? userId)

Unlocks the account of the user. Unlocks the account of the user.

public Task UnlockUserAsync(string accountId, int? userId)

Unlocks the account of the user. Unlocks the account of the user.

public Task<ApiResponse<object>> UnlockUserAsyncWithHttpInfo(string accountId, int? userId)

Unlocks the account of the user. Unlocks the account of the user.

public ApiResponse<object> UnlockUserWithHttpInfo(string accountId, int? userId)

Unlocks the account of the user. Unlocks the account of the user.

public User UpdateUser(string accountId, int? userId, UserForUpdate body = null)

Updates user information Updates user information

public Task<User> UpdateUserAsync(string accountId, int? userId, UserForUpdate body = null)

Updates user information Updates user information

public Task<ApiResponse<User>> UpdateUserAsyncWithHttpInfo(string accountId, int? userId, UserForUpdate body = null)

Updates user information Updates user information

public ApiResponse<User> UpdateUserWithHttpInfo(string accountId, int? userId, UserForUpdate body = null)

Updates user information Updates user information