DocuSign.Rooms by DocuSign

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

 RoomsApi

public class RoomsApi : IRoomsApi, IApiAccessor
Represents a collection of functions to interact with the API endpoints

Returns the roles for which the calling user, based on their role within the room, can assign to invitees. This method returns the room-level roles that the current user can assign to the members that they invite to a room.

public class GetDocumentsOptions

Get documents in the room accessible to the calling user. This method returns a list of documents that the current user can access for a specific room.

public class GetRoomOptions

Gets information about the given room. Returns details about the given room

public class GetRoomsOptions

Gets rooms available to the calling user. Gets rooms available to the calling user

public class GetRoomUsersOptions

Retrieves the list of users in the given room. This method returns a list of users associated with a room.

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 RoomsApi(ApiClient aplClient)

Initializes a new instance of the RoomsApi class using AplClient object

public RoomDocument AddDocumentToRoom(string accountId, int? roomId, Document body = null)

Add a document to a room. Add a document to a room

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

Add a document to a room. Add a document to a room

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

Add a document to a room. Add a document to a room

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

Add a document to a room via file contents upload. This method uploads the contents of file as a room document for the room that you specify.

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

Add a document to a room via file contents upload. This method uploads the contents of file as a room document for the room that you specify.

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

Add a document to a room via file contents upload. This method uploads the contents of file as a room document for the room that you specify.

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

Add a document to a room via file contents upload. This method uploads the contents of file as a room document for the room that you specify.

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

Add a document to a room. Add a document to a room

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

Adds a DocuSign Form to a room Adds a form to a room.

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

Adds a DocuSign Form to a room Adds a form to a room.

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

Adds a DocuSign Form to a room Adds a form to a room.

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

Adds a DocuSign Form to a room Adds a form to a room.

public Room CreateRoom(string accountId, RoomForCreate body = null)

Creates a new Room Creates a new Room

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

Creates a new Room Creates a new Room

public Task<ApiResponse<Room>> CreateRoomAsyncWithHttpInfo(string accountId, RoomForCreate body = null)

Creates a new Room Creates a new Room

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

Creates a new Room Creates a new Room

public void DeleteRoom(string accountId, int? roomId)

Deletes the room having the given room ID. Deletes the room having the given room ID.

public Task DeleteRoomAsync(string accountId, int? roomId)

Deletes the room having the given room ID. Deletes the room having the given room ID.

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

Deletes the room having the given room ID. Deletes the room having the given room ID.

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

Deletes the room having the given room ID. Deletes the room having the given room ID.

public 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. This method returns the room-level roles that the current user can assign to the members that they invite to a room.

public 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. This method returns the room-level roles that the current user can assign to the members that they invite to a room.

public Task<ApiResponse<AssignableRoles>> GetAssignableRolesAsyncWithHttpInfo(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. This method returns the room-level roles that the current user can assign to the members that they invite to a room.

public ApiResponse<AssignableRoles> GetAssignableRolesWithHttpInfo(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. This method returns the room-level roles that the current user can assign to the members that they invite to a room.

public string GetBasePath()

Gets the base path of the API client.

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

Get documents in the room accessible to the calling user. This method returns a list of documents that the current user can access for a specific room.

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

Get documents in the room accessible to the calling user. This method returns a list of documents that the current user can access for a specific room.

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

Get documents in the room accessible to the calling user. This method returns a list of documents that the current user can access for a specific room.

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

Get documents in the room accessible to the calling user. This method returns a list of documents that the current user can access for a specific room.

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

Gets information about the given room. Returns details about the given room

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

Gets information about the given room. Returns details about the given room

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

Gets information about the given room. Returns details about the given room

public FieldData GetRoomFieldData(string accountId, int? roomId)

Returns the FieldData associated with the provided roomId. Returns the field data associated with a room. This is the information that appears on the room's **Details** tab.

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

Returns the FieldData associated with the provided roomId. Returns the field data associated with a room. This is the information that appears on the room's **Details** tab.

public Task<ApiResponse<FieldData>> GetRoomFieldDataAsyncWithHttpInfo(string accountId, int? roomId)

Returns the FieldData associated with the provided roomId. Returns the field data associated with a room. This is the information that appears on the room's **Details** tab.

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

Returns the FieldData associated with the provided roomId. Returns the field data associated with a room. This is the information that appears on the room's **Details** tab.

public FieldSet GetRoomFieldSet(string accountId, int? roomId)

Gets the field set associated with the room. Returns the field set that a room uses.

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

Gets the field set associated with the room. Returns the field set that a room uses.

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

Gets the field set associated with the room. Returns the field set that a room uses.

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

Gets the field set associated with the room. Returns the field set that a room uses.

public RoomSummaryList GetRooms(string accountId, GetRoomsOptions options = null)

Gets rooms available to the calling user. Gets rooms available to the calling user

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

Gets rooms available to the calling user. Gets rooms available to the calling user

public Task<ApiResponse<RoomSummaryList>> GetRoomsAsyncWithHttpInfo(string accountId, GetRoomsOptions options = null)

Gets rooms available to the calling user. Gets rooms available to the calling user

public ApiResponse<RoomSummaryList> GetRoomsWithHttpInfo(string accountId, GetRoomsOptions options = null)

Gets rooms available to the calling user. Gets rooms available to the calling user

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

Retrieves the list of users in the given room. This method returns a list of users associated with a room.

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

Retrieves the list of users in the given room. This method returns a list of users associated with a room.

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

Retrieves the list of users in the given room. This method returns a list of users associated with a room.

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

Retrieves the list of users in the given room. This method returns a list of users associated with a room.

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

Gets information about the given room. Returns details about the given room

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

Invites a user to the room by email address. This method invites an existing or new member to a specific room.

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

Invites a user to the room by email address. This method invites an existing or new member to a specific room.

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

Invites a user to the room by email address. This method invites an existing or new member to a specific room.

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

Invites a user to the room by email address. This method invites an existing or new member to a specific room.

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

Updates the specified user's role and transaction side. Updates the specified user's role and transaction side.

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

Updates the specified user's role and transaction side. Updates the specified user's role and transaction side.

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

Updates the specified user's role and transaction side. Updates the specified user's role and transaction side.

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

Updates the specified user's role and transaction side. Updates the specified user's role and transaction side.

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

Restores the specified user's access to the room. Restores the specified user's access to the room.

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

Restores the specified user's access to the room. Restores the specified user's access to the room.

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

Restores the specified user's access to the room. Restores the specified user's access to the room.

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

Restores the specified user's access to the room. Restores the specified user's access to the room.

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

Revokes the specified user's access to the room. Revokes the specified user's access to the room.

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

Revokes the specified user's access to the room. Revokes the specified user's access to the room.

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

Revokes the specified user's access to the room. Revokes the specified user's access to the room.

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

Revokes the specified user's access to the room. Revokes the specified user's access to the room.

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

Update the picture for a room. This endpoint supports the following content types, application/json as JSON PictureForUpdate{\"fileName\":\"string\", \"Base64Contents\":\"string\"}, multipart/formdata and any other streamed binary content type (as long as either query parameter fileName or request header ContentDisposition filename is included).

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

Update the picture for a room. This endpoint supports the following content types, application/json as JSON PictureForUpdate{\"fileName\":\"string\", \"Base64Contents\":\"string\"}, multipart/formdata and any other streamed binary content type (as long as either query parameter fileName or request header ContentDisposition filename is included).

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

Update the picture for a room. This endpoint supports the following content types, application/json as JSON PictureForUpdate{\"fileName\":\"string\", \"Base64Contents\":\"string\"}, multipart/formdata and any other streamed binary content type (as long as either query parameter fileName or request header ContentDisposition filename is included).

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

Update the picture for a room. This endpoint supports the following content types, application/json as JSON PictureForUpdate{\"fileName\":\"string\", \"Base64Contents\":\"string\"}, multipart/formdata and any other streamed binary content type (as long as either query parameter fileName or request header ContentDisposition filename is included).

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

Updates room field data. Updates room field data.

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

Updates room field data. Updates room field data.

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

Updates room field data. Updates room field data.

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

Updates room field data. Updates room field data.