DocuSign.Rooms by DocuSign

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

 DocumentsApi

Represents a collection of functions to interact with the API endpoints
public class GetDocumentOptions

Get information about the Document with the given DocumentId. Returns information about a document in a room. You can optionally request the contents of the document, which is returned in base64-encoded format.\\n\\nTo find the `documentId` of the document that you want to retrieve, use the Rooms::GetDocuments method.

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

Initializes a new instance of the DocumentsApi class using AplClient object

public DocumentUser CreateDocumentUser(string accountId, int? documentId, DocumentUserForCreate body = null)

Grants access to a document for a user. Grants a user access to a document. You specify the user's `userId` in the request body. The response is an object that specifies the access the user has.

public Task<DocumentUser> CreateDocumentUserAsync(string accountId, int? documentId, DocumentUserForCreate body = null)

Grants access to a document for a user. Grants a user access to a document. You specify the user's `userId` in the request body. The response is an object that specifies the access the user has.

public Task<ApiResponse<DocumentUser>> CreateDocumentUserAsyncWithHttpInfo(string accountId, int? documentId, DocumentUserForCreate body = null)

Grants access to a document for a user. Grants a user access to a document. You specify the user's `userId` in the request body. The response is an object that specifies the access the user has.

public ApiResponse<DocumentUser> CreateDocumentUserWithHttpInfo(string accountId, int? documentId, DocumentUserForCreate body = null)

Grants access to a document for a user. Grants a user access to a document. You specify the user's `userId` in the request body. The response is an object that specifies the access the user has.

public void DeleteDocument(string accountId, int? documentId)

Deletes a document. Permanently deletes a document. To find the `documentId` of a document that you want to delete, use the Rooms::GetDocuments method.\\n\\nIf the document is deleted successfully, the HTTP response code is 204 (No Content), so the response body is empty.

public Task DeleteDocumentAsync(string accountId, int? documentId)

Deletes a document. Permanently deletes a document. To find the `documentId` of a document that you want to delete, use the Rooms::GetDocuments method.\\n\\nIf the document is deleted successfully, the HTTP response code is 204 (No Content), so the response body is empty.

public Task<ApiResponse<object>> DeleteDocumentAsyncWithHttpInfo(string accountId, int? documentId)

Deletes a document. Permanently deletes a document. To find the `documentId` of a document that you want to delete, use the Rooms::GetDocuments method.\\n\\nIf the document is deleted successfully, the HTTP response code is 204 (No Content), so the response body is empty.

public ApiResponse<object> DeleteDocumentWithHttpInfo(string accountId, int? documentId)

Deletes a document. Permanently deletes a document. To find the `documentId` of a document that you want to delete, use the Rooms::GetDocuments method.\\n\\nIf the document is deleted successfully, the HTTP response code is 204 (No Content), so the response body is empty.

public string GetBasePath()

Gets the base path of the API client.

public Document GetDocument(string accountId, int? documentId, GetDocumentOptions options = null)

Get information about the Document with the given DocumentId. Returns information about a document in a room. You can optionally request the contents of the document, which is returned in base64-encoded format.\\n\\nTo find the `documentId` of the document that you want to retrieve, use the Rooms::GetDocuments method.

public Task<Document> GetDocumentAsync(string accountId, int? documentId, GetDocumentOptions options = null)

Get information about the Document with the given DocumentId. Returns information about a document in a room. You can optionally request the contents of the document, which is returned in base64-encoded format.\\n\\nTo find the `documentId` of the document that you want to retrieve, use the Rooms::GetDocuments method.

public Task<ApiResponse<Document>> GetDocumentAsyncWithHttpInfo(string accountId, int? documentId, GetDocumentOptions options = null)

Get information about the Document with the given DocumentId. Returns information about a document in a room. You can optionally request the contents of the document, which is returned in base64-encoded format.\\n\\nTo find the `documentId` of the document that you want to retrieve, use the Rooms::GetDocuments method.

public ApiResponse<Document> GetDocumentWithHttpInfo(string accountId, int? documentId, GetDocumentOptions options = null)

Get information about the Document with the given DocumentId. Returns information about a document in a room. You can optionally request the contents of the document, which is returned in base64-encoded format.\\n\\nTo find the `documentId` of the document that you want to retrieve, use the Rooms::GetDocuments method.