roles library

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

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

Classes

RolesResource
The roles endpoints with client already applied.
RolesUrls
SettingsRole
The settings role body, under role.
SettingsRoleList
One page of SettingsRole records, under data.

Functions

createSettingsRole(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>
POST /api/{api_version}/settings/roles
deleteSettingsRole(ExsitedClient client, Object roleId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>
DELETE /api/{api_version}/settings/roles/{role_id}
getSettingsRole(ExsitedClient client, Object roleId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsRole>>
GET /api/{api_version}/settings/roles/{role_id}
getSettingsRoles(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<SettingsRoleList>>
GET /api/{api_version}/settings/roles
updateSettingsRole(ExsitedClient client, Object roleId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>
PATCH /api/{api_version}/settings/roles/{role_id}