DocuSign.Rooms by DocuSign

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

 IRoomsApi

public interface IRoomsApi : IApiAccessor
Represents a collection of functions to interact with the API endpoints
RoomDocument AddDocumentToRoom(string accountId, int? roomId, Document body = null)

Add a document to a room.

Task<RoomDocument> AddDocumentToRoomAsync(string accountId, int? roomId, Document body = null)

Add a document to a room.

Task<ApiResponse<RoomDocument>> AddDocumentToRoomAsyncWithHttpInfo(string accountId, int? roomId, Document body = null)

Add a document to a room.

RoomDocument AddDocumentToRoomViaFileUpload(string accountId, int? roomId, byte[] file)

Add a document to a room via file contents upload.

Task<RoomDocument> AddDocumentToRoomViaFileUploadAsync(string accountId, int? roomId, byte[] file)

Add a document to a room via file contents upload.

Task<ApiResponse<RoomDocument>> AddDocumentToRoomViaFileUploadAsyncWithHttpInfo(string accountId, int? roomId, byte[] file)

Add a document to a room via file contents upload.

ApiResponse<RoomDocument> AddDocumentToRoomViaFileUploadWithHttpInfo(string accountId, int? roomId, byte[] file)

Add a document to a room via file contents upload.

ApiResponse<RoomDocument> AddDocumentToRoomWithHttpInfo(string accountId, int? roomId, Document body = null)

Add a document to a room.

RoomDocument AddFormToRoom(string accountId, int? roomId, FormForAdd body = null)

Adds a DocuSign Form to a room

Task<RoomDocument> AddFormToRoomAsync(string accountId, int? roomId, FormForAdd body = null)

Adds a DocuSign Form to a room

Task<ApiResponse<RoomDocument>> AddFormToRoomAsyncWithHttpInfo(string accountId, int? roomId, FormForAdd body = null)

Adds a DocuSign Form to a room

ApiResponse<RoomDocument> AddFormToRoomWithHttpInfo(string accountId, int? roomId, FormForAdd body = null)

Adds a DocuSign Form to a room

Room CreateRoom(string accountId, RoomForCreate body = null)

Creates a new Room

Task<Room> CreateRoomAsync(string accountId, RoomForCreate body = null)

Creates a new Room

Creates a new Room

ApiResponse<Room> CreateRoomWithHttpInfo(string accountId, RoomForCreate body = null)

Creates a new Room

void DeleteRoom(string accountId, int? roomId)

Deletes the room having the given room ID.

Task DeleteRoomAsync(string accountId, int? roomId)

Deletes the room having the given room ID.

Task<ApiResponse<object>> DeleteRoomAsyncWithHttpInfo(string accountId, int? roomId)

Deletes the room having the given room ID.

ApiResponse<object> DeleteRoomWithHttpInfo(string accountId, int? roomId)

Deletes the room having the given room ID.

AssignableRoles GetAssignableRoles(string accountId, int? roomId, GetAssignableRolesOptions options = null)

Returns the roles for which the calling user, based on their role within the room, can assign to invitees.

Task<AssignableRoles> GetAssignableRolesAsync(string accountId, int? roomId, GetAssignableRolesOptions options = null)

Returns the roles for which the calling user, based on their role within the room, can assign to invitees.

Returns the roles for which the calling user, based on their role within the room, can assign to invitees.

Returns the roles for which the calling user, based on their role within the room, can assign to invitees.

RoomDocumentList GetDocuments(string accountId, int? roomId, GetDocumentsOptions options = null)

Get documents in the room accessible to the calling user.

Task<RoomDocumentList> GetDocumentsAsync(string accountId, int? roomId, GetDocumentsOptions options = null)

Get documents in the room accessible to the calling user.

Task<ApiResponse<RoomDocumentList>> GetDocumentsAsyncWithHttpInfo(string accountId, int? roomId, GetDocumentsOptions options = null)

Get documents in the room accessible to the calling user.

ApiResponse<RoomDocumentList> GetDocumentsWithHttpInfo(string accountId, int? roomId, GetDocumentsOptions options = null)

Get documents in the room accessible to the calling user.

Room GetRoom(string accountId, int? roomId, GetRoomOptions options = null)

Gets information about the given room.

Task<Room> GetRoomAsync(string accountId, int? roomId, GetRoomOptions options = null)

Gets information about the given room.

Task<ApiResponse<Room>> GetRoomAsyncWithHttpInfo(string accountId, int? roomId, GetRoomOptions options = null)

Gets information about the given room.

FieldData GetRoomFieldData(string accountId, int? roomId)

Returns the FieldData associated with the provided roomId.

Task<FieldData> GetRoomFieldDataAsync(string accountId, int? roomId)

Returns the FieldData associated with the provided roomId.

Returns the FieldData associated with the provided roomId.

ApiResponse<FieldData> GetRoomFieldDataWithHttpInfo(string accountId, int? roomId)

Returns the FieldData associated with the provided roomId.

FieldSet GetRoomFieldSet(string accountId, int? roomId)

Gets the field set associated with the room.

Task<FieldSet> GetRoomFieldSetAsync(string accountId, int? roomId)

Gets the field set associated with the room.

Task<ApiResponse<FieldSet>> GetRoomFieldSetAsyncWithHttpInfo(string accountId, int? roomId)

Gets the field set associated with the room.

ApiResponse<FieldSet> GetRoomFieldSetWithHttpInfo(string accountId, int? roomId)

Gets the field set associated with the room.

RoomSummaryList GetRooms(string accountId, GetRoomsOptions options = null)

Gets rooms available to the calling user.

Task<RoomSummaryList> GetRoomsAsync(string accountId, GetRoomsOptions options = null)

Gets rooms available to the calling user.

Gets rooms available to the calling user.

Gets rooms available to the calling user.

RoomUsersResult GetRoomUsers(string accountId, int? roomId, GetRoomUsersOptions options = null)

Retrieves the list of users in the given room.

Task<RoomUsersResult> GetRoomUsersAsync(string accountId, int? roomId, GetRoomUsersOptions options = null)

Retrieves the list of users in the given room.

Task<ApiResponse<RoomUsersResult>> GetRoomUsersAsyncWithHttpInfo(string accountId, int? roomId, GetRoomUsersOptions options = null)

Retrieves the list of users in the given room.

ApiResponse<RoomUsersResult> GetRoomUsersWithHttpInfo(string accountId, int? roomId, GetRoomUsersOptions options = null)

Retrieves the list of users in the given room.

ApiResponse<Room> GetRoomWithHttpInfo(string accountId, int? roomId, GetRoomOptions options = null)

Gets information about the given room.

RoomInviteResponse InviteUser(string accountId, int? roomId, RoomInvite body = null)

Invites a user to the room by email address.

Task<RoomInviteResponse> InviteUserAsync(string accountId, int? roomId, RoomInvite body = null)

Invites a user to the room by email address.

Task<ApiResponse<RoomInviteResponse>> InviteUserAsyncWithHttpInfo(string accountId, int? roomId, RoomInvite body = null)

Invites a user to the room by email address.

ApiResponse<RoomInviteResponse> InviteUserWithHttpInfo(string accountId, int? roomId, RoomInvite body = null)

Invites a user to the room by email address.

RoomUser PutRoomUser(string accountId, int? roomId, int? userId, RoomUserForUpdate body = null)

Updates the specified user's role and transaction side.

Task<RoomUser> PutRoomUserAsync(string accountId, int? roomId, int? userId, RoomUserForUpdate body = null)

Updates the specified user's role and transaction side.

Task<ApiResponse<RoomUser>> PutRoomUserAsyncWithHttpInfo(string accountId, int? roomId, int? userId, RoomUserForUpdate body = null)

Updates the specified user's role and transaction side.

ApiResponse<RoomUser> PutRoomUserWithHttpInfo(string accountId, int? roomId, int? userId, RoomUserForUpdate body = null)

Updates the specified user's role and transaction side.

void RestoreRoomUserAccess(string accountId, int? roomId, int? userId)

Restores the specified user's access to the room.

Task RestoreRoomUserAccessAsync(string accountId, int? roomId, int? userId)

Restores the specified user's access to the room.

Task<ApiResponse<object>> RestoreRoomUserAccessAsyncWithHttpInfo(string accountId, int? roomId, int? userId)

Restores the specified user's access to the room.

ApiResponse<object> RestoreRoomUserAccessWithHttpInfo(string accountId, int? roomId, int? userId)

Restores the specified user's access to the room.

void RevokeRoomUserAccess(string accountId, int? roomId, int? userId, RoomUserRemovalDetail body = null)

Revokes the specified user's access to the room.

Task RevokeRoomUserAccessAsync(string accountId, int? roomId, int? userId, RoomUserRemovalDetail body = null)

Revokes the specified user's access to the room.

Task<ApiResponse<object>> RevokeRoomUserAccessAsyncWithHttpInfo(string accountId, int? roomId, int? userId, RoomUserRemovalDetail body = null)

Revokes the specified user's access to the room.

ApiResponse<object> RevokeRoomUserAccessWithHttpInfo(string accountId, int? roomId, int? userId, RoomUserRemovalDetail body = null)

Revokes the specified user's access to the room.

RoomPicture UpdatePicture(string accountId, int? roomId, byte[] file, string fileName = "file.jpg")

Update the picture for a room.

Task<RoomPicture> UpdatePictureAsync(string accountId, int? roomId, byte[] file, string fileName = "file.jpg")

Update the picture for a room.

Task<ApiResponse<RoomPicture>> UpdatePictureAsyncWithHttpInfo(string accountId, int? roomId, byte[] file, string fileName = "file.jpg")

Update the picture for a room.

ApiResponse<RoomPicture> UpdatePictureWithHttpInfo(string accountId, int? roomId, byte[] file, string fileName = "file.jpg")

Update the picture for a room.

FieldData UpdateRoomFieldData(string accountId, int? roomId, FieldDataForUpdate body = null)

Updates room field data.

Task<FieldData> UpdateRoomFieldDataAsync(string accountId, int? roomId, FieldDataForUpdate body = null)

Updates room field data.

Updates room field data.

ApiResponse<FieldData> UpdateRoomFieldDataWithHttpInfo(string accountId, int? roomId, FieldDataForUpdate body = null)

Updates room field data.