note_groups library

The v4 note groups family: its endpoints, bound class, path templates and views.

Import it with a prefix, import 'package:exsited/note_groups.dart' as note_groups;, because families declare the same top-level names and a Dart export can neither rename nor prefix them.

Classes

NoteGroup
The note group body.
NoteGroupList
A page of NoteGroup records.
NoteGroupNotes
The note group notes body.
NoteGroupsResource
The note groups endpoints with client already applied.
NoteGroupsUrls

Functions

createNoteGroup(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<NoteGroup>>
POST /api/{api_version}/note_groups
deleteNoteGroup(ExsitedClient client, Object noteGroupId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>
DELETE /api/{api_version}/note_groups/{note_group_id}
getNoteGroup(ExsitedClient client, Object noteGroupId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<NoteGroup>>
GET /api/{api_version}/note_groups/{note_group_id}
getNoteGroupNotes(ExsitedClient client, Object noteGroupId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<NoteGroupNotes>>
GET /api/{api_version}/note_groups/{note_group_id}/notes
getNoteGroupNotesByUser(ExsitedClient client, Object noteGroupId, Object noteUser, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>
GET /api/{api_version}/note_groups/{note_group_id}/notes/user/{note_user}
getNoteGroups(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<NoteGroupList>>
GET /api/{api_version}/note_groups
updateNoteGroup(ExsitedClient client, Object noteGroupId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<NoteGroup>>
PATCH /api/{api_version}/note_groups/{note_group_id}