NotesApi class

Constructors

NotesApi([ApiClient? apiClient])

Properties

apiClient → ApiClient

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createBlock(String id, CreateBlockRequest createBlockRequest, {String? accountId, String? xWorkspaceID}) → Future<Block?>

Insert a block in a note.

createBlockWithHttpInfo(String id, CreateBlockRequest createBlockRequest, {String? accountId, String? xWorkspaceID}) → Future<Response>

Insert a block in a note.

createNote(CreateNoteRequest createNoteRequest, {String? accountId, String? provider, String? xWorkspaceID}) → Future<Note?>

Create a note.

createNoteComment(String id, CreateCommentRequest createCommentRequest, {String? accountId, String? xWorkspaceID}) → Future<CommentMutationResponse?>

Create a comment or reply.

createNoteCommentWithHttpInfo(String id, CreateCommentRequest createCommentRequest, {String? accountId, String? xWorkspaceID}) → Future<Response>

Create a comment or reply.

createNoteWithHttpInfo(CreateNoteRequest createNoteRequest, {String? accountId, String? provider, String? xWorkspaceID}) → Future<Response>

Create a note.

deleteBlock(String id, {String? accountId, String? xWorkspaceID}) → Future<SuccessFlag?>

Delete a block.

deleteBlockWithHttpInfo(String id, {String? accountId, String? xWorkspaceID}) → Future<Response>

Delete a block.

deleteNote(String id, {String? accountId, String? xWorkspaceID}) → Future<SuccessFlag?>

Delete a note.

deleteNoteComment(String id, String commentId, {String? accountId, String? xWorkspaceID}) → Future<SuccessFlag?>

Soft-delete (native) or hard-delete (provider) a comment.

deleteNoteCommentWithHttpInfo(String id, String commentId, {String? accountId, String? xWorkspaceID}) → Future<Response>

Soft-delete (native) or hard-delete (provider) a comment.

deleteNoteWithHttpInfo(String id, {String? accountId, String? xWorkspaceID}) → Future<Response>

Delete a note.

disableNoteShare(String id, {String? accountId, String? xWorkspaceID}) → Future<void>

Disable public sharing.

disableNoteShareWithHttpInfo(String id, {String? accountId, String? xWorkspaceID}) → Future<Response>

Disable public sharing.

enableNoteShare(String id, {String? accountId, String? xWorkspaceID, EnableShareRequest? enableShareRequest}) → Future<ShareSettings?>

Enable (or update password on) public sharing.

enableNoteShareWithHttpInfo(String id, {String? accountId, String? xWorkspaceID, EnableShareRequest? enableShareRequest}) → Future<Response>

Enable (or update password on) public sharing.

getBlock(String id, {String? accountId, String? xWorkspaceID}) → Future<Block?>

Fetch one block.

getBlockWithHttpInfo(String id, {String? accountId, String? xWorkspaceID}) → Future<Response>

Fetch one block.

getNote(String id, {String? accountId, String? xWorkspaceID}) → Future<Note?>

Fetch one note.

getNoteComment(String id, String commentId, {String? accountId, String? xWorkspaceID}) → Future<CommentResponse?>

Fetch one comment.

getNoteCommentWithHttpInfo(String id, String commentId, {String? accountId, String? xWorkspaceID}) → Future<Response>

Fetch one comment.

getNoteShareSettings(String id, {String? accountId, String? xWorkspaceID}) → Future<ShareSettings?>

Fetch share settings for a note.

getNoteShareSettingsWithHttpInfo(String id, {String? accountId, String? xWorkspaceID}) → Future<Response>

Fetch share settings for a note.

getNoteWithHttpInfo(String id, {String? accountId, String? xWorkspaceID}) → Future<Response>

Fetch one note.

getPublicNote(String token, {String? password}) → Future<Map<String, Object>?>

Fetch a publicly shared note.

getPublicNoteWithHttpInfo(String token, {String? password}) → Future<Response>

Fetch a publicly shared note.

listBlocks(String id, {String? accountId, String? xWorkspaceID, String? parentId, int? limit, int? offset}) → Future<BlockListResponse?>

List blocks under a note.

listBlocksWithHttpInfo(String id, {String? accountId, String? xWorkspaceID, String? parentId, int? limit, int? offset}) → Future<Response>

List blocks under a note.

listNoteComments(String id, {String? accountId, String? xWorkspaceID}) → Future<CommentListResponse?>

List comments on a note.

listNoteCommentsWithHttpInfo(String id, {String? accountId, String? xWorkspaceID}) → Future<Response>

List comments on a note.

listNotes({String? accountId, String? provider, String? xWorkspaceID, bool? archived, String? parentId, List<String>? tags, int? limit, int? offset, String? sortBy, String? sortOrder}) → Future<NoteListEnvelope?>

List notes across connected accounts.

listNotesWithHttpInfo({String? accountId, String? provider, String? xWorkspaceID, bool? archived, String? parentId, List<String>? tags, int? limit, int? offset, String? sortBy, String? sortOrder}) → Future<Response>

List notes across connected accounts.

moveBlock(String id, MoveBlockRequest moveBlockRequest, {String? accountId, String? xWorkspaceID}) → Future<SuccessFlag?>

Reparent or reorder a block.

moveBlockWithHttpInfo(String id, MoveBlockRequest moveBlockRequest, {String? accountId, String? xWorkspaceID}) → Future<Response>

Reparent or reorder a block.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

rotateNoteShareToken(String id, {String? accountId, String? xWorkspaceID}) → Future<ShareSettings?>

Rotate the share token, invalidating any outstanding URLs.

rotateNoteShareTokenWithHttpInfo(String id, {String? accountId, String? xWorkspaceID}) → Future<Response>

Rotate the share token, invalidating any outstanding URLs.

toString() → String

A string representation of this object.

inherited

updateBlock(String id, UpdateBlockRequest updateBlockRequest, {String? accountId, String? xWorkspaceID}) → Future<Block?>

Update a block (partial).

updateBlockWithHttpInfo(String id, UpdateBlockRequest updateBlockRequest, {String? accountId, String? xWorkspaceID}) → Future<Response>

Update a block (partial).

updateNote(String id, UpdateNoteRequest updateNoteRequest, {String? accountId, String? xWorkspaceID}) → Future<Note?>

Update a note (partial).

updateNoteComment(String id, String commentId, UpdateCommentRequest updateCommentRequest, {String? accountId, String? xWorkspaceID}) → Future<CommentMutationResponse?>

Edit a comment.

updateNoteCommentWithHttpInfo(String id, String commentId, UpdateCommentRequest updateCommentRequest, {String? accountId, String? xWorkspaceID}) → Future<Response>

Edit a comment.

updateNoteWithHttpInfo(String id, UpdateNoteRequest updateNoteRequest, {String? accountId, String? xWorkspaceID}) → Future<Response>

Update a note (partial).

workspaceCreateNote(String org, String workspace, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Parameters:

workspaceCreateNoteBlock(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Parameters:

workspaceCreateNoteBlockWithHttpInfo(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Response>

Performs an HTTP 'POST /v1/organizations/{org}/workspaces/{workspace}/notes/{id}/blocks' operation and returns the Response. Parameters:

workspaceCreateNoteWithHttpInfo(String org, String workspace, Map<String, Object> requestBody) → Future<Response>

Performs an HTTP 'POST /v1/organizations/{org}/workspaces/{workspace}/notes' operation and returns the Response. Parameters:

workspaceDeleteNote(String org, String workspace, String id) → Future<void>

Parameters:

workspaceDeleteNoteBlock(String org, String workspace, String id) → Future<void>

Parameters:

workspaceDeleteNoteBlockWithHttpInfo(String org, String workspace, String id) → Future<Response>

Performs an HTTP 'DELETE /v1/organizations/{org}/workspaces/{workspace}/notes/blocks/{id}' operation and returns the Response. Parameters:

workspaceDeleteNoteWithHttpInfo(String org, String workspace, String id) → Future<Response>

Performs an HTTP 'DELETE /v1/organizations/{org}/workspaces/{workspace}/notes/{id}' operation and returns the Response. Parameters:

workspaceGetNote(String org, String workspace, String id) → Future<Map<String, Object>?>

Parameters:

workspaceGetNoteBlock(String org, String workspace, String id) → Future<Map<String, Object>?>

Parameters:

workspaceGetNoteBlockWithHttpInfo(String org, String workspace, String id) → Future<Response>

Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/notes/blocks/{id}' operation and returns the Response. Parameters:

workspaceGetNoteWithHttpInfo(String org, String workspace, String id) → Future<Response>

Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/notes/{id}' operation and returns the Response. Parameters:

workspaceListNoteBlocks(String org, String workspace, String id) → Future<Map<String, Object>?>

Parameters:

workspaceListNoteBlocksWithHttpInfo(String org, String workspace, String id) → Future<Response>

Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/notes/{id}/blocks' operation and returns the Response. Parameters:

workspaceListNotes(String org, String workspace) → Future<Map<String, Object>?>

Parameters:

workspaceListNotesWithHttpInfo(String org, String workspace) → Future<Response>

Performs an HTTP 'GET /v1/organizations/{org}/workspaces/{workspace}/notes' operation and returns the Response. Parameters:

workspaceMoveNoteBlock(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Parameters:

workspaceMoveNoteBlockWithHttpInfo(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Response>

Performs an HTTP 'POST /v1/organizations/{org}/workspaces/{workspace}/notes/blocks/{id}/move' operation and returns the Response. Parameters:

workspaceUpdateNote(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Parameters:

workspaceUpdateNoteBlock(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Map<String, Object>?>

Parameters:

workspaceUpdateNoteBlockWithHttpInfo(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Response>

Performs an HTTP 'PATCH /v1/organizations/{org}/workspaces/{workspace}/notes/blocks/{id}' operation and returns the Response. Parameters:

workspaceUpdateNoteWithHttpInfo(String org, String workspace, String id, Map<String, Object> requestBody) → Future<Response>

Performs an HTTP 'PATCH /v1/organizations/{org}/workspaces/{workspace}/notes/{id}' operation and returns the Response. Parameters:

Operators

operator ==(Object other) → bool

The equality operator.

inherited